Class: Cesium3DTileset

Cesium3DTileset()

A Cesium3DTileset Model is a special type of vector layer that can be used in Cesium maps, and that follows the 3d-tiles specification. See https://github.com/CesiumGS/3d-tiles

Constructor

new Cesium3DTileset()

Since:
  • 2.18.0
Source:

Extends

Members

defaults :Object

Default attributes for Cesium3DTileset models
Type:
  • Object
Properties:
Name Type Attributes Default Description
type 'Cesium3DTileset' The format of the data. Must be 'Cesium3DTileset'.
filters VectorFilters <optional>
 new VectorFilters() A set of conditions used to show or hide specific features of this tileset.
colorPalette AssetColorPalette <optional>
 new AssetColorPalette() The color or colors mapped to attributes of this asset. Used to style the features and to make a legend.
cesiumModel Cesium.Cesium3DTileset A model created and used by Cesium that organizes the data to display in the Cesium Widget. See https://cesium.com/learn/cesiumjs/ref-doc/Cesium3DTileset.html
cesiumOptions Cesium3DTileset#cesiumOptions options are passed to the function that creates the Cesium model. The properties of options are specific to each type of asset.
Overrides:
Source:

type :string

The name of this type of model
Type:
  • string
Overrides:
Source:

Methods

addCustomProperties(properties) → {object}

Given a set of properties from a Feature from this Map Asset model, add any custom properties to the properties object and return it.
Parameters:
Name Type Description
properties object A set of key-value pairs representing the existing properties of a feature from this asset.
Since:
  • 2.19.0
Inherited From:
Source:
Returns:
The properties object with any custom properties added.
Type
object

containsFeature(feature) → {boolean}

Given a feature object from a Feature model, checks if it is part of the selectedFeatures collection. See featureObject property from Feature#defaults. For vector and 3d tile models only.
Parameters:
Name Type Description
feature * An object that a Map widget uses to represent this feature in the map, e.g. a Cesium.Entity or a Cesium.Cesium3DTileFeature
Since:
  • 2.25.0
Inherited From:
Source:
Returns:
Returns true if the given feature is part of the selectedFeatures collection in this asset
Type
boolean

createCesiumModel(recreate)

Creates a Cesium.Cesium3DTileset model and sets it to this model's 'cesiumModel' attribute. This cesiumModel contains all the information required for Cesium to render tiles. See https://cesium.com/learn/cesiumjs/ref-doc/Cesium3DTileset.html?classFilter=3Dtiles
Parameters:
Name Type Description
recreate Boolean Set recreate to true to force the function create the Cesium Model again. Otherwise, if a cesium model already exists, that is returned instead.
Source:

featureIsSelected(feature) → {boolean}

Given a feature object from a Feature model, checks if it is part of the selectedFeatures collection. See featureObject property from Feature#defaults. For vector and 3d tile models only.
Parameters:
Name Type Description
feature * An object that a Map widget uses to represent this feature in the map, e.g. a Cesium.Entity or a Cesium.Cesium3DTileFeature
Inherited From:
Source:
Returns:
Returns true if the given feature is part of the selectedFeatures collection in this asset
Type
boolean

featureIsVisible(properties) → {boolean}

This function checks whether a feature from the MapAsset is visible on the map based on the properties of the feature and the MapAsset's filter settings.
Parameters:
Name Type Description
properties object The properties of the feature to be filtered. (See the 'properties' attribute of Feature#defaults.)
Inherited From:
Source:
Returns:
Returns true if the feature passes all the filters, or if there are no filters set for this MapAsset. Returns false if the feature fails any of the filters.
Type
boolean

formatDateProperty(config, properties) → {string}

Given a definition for a new date property, and the properties that already exist on a specific feature, returns a new string with the formatted date.
Parameters:
Name Type Description
config MapConfig#CustomDateProperty An object that defines the new date property to create
properties object key-value pairs representing existing properties in a Feature
Since:
  • 2.19.0
Inherited From:
Source:
Returns:
The value for the new date property, formatted as defined by config, for the given feature
Type
string

formatStringProperty(config) → {string}

For a given set of Feature properties and a definition for a new sting property, returns the value of the custom property. Note that since only static strings are supported so far, this function essentially just returns the value of config.value. This function exists to allow support of dynamic strings in the future (e.g. combining strings from existing properties)
Parameters:
Name Type Description
config MapConfig#CustomStringProperty The object the defines the new custom property
Since:
  • 2.19.0
Inherited From:
Source:
Returns:
The new string for the given Feature property
Type
string

getBoundingSphere() → {Promise}

Gets a Cesium Bounding Sphere that can be used to navigate to view the full extent of the tileset. See https://cesium.com/learn/cesiumjs/ref-doc/BoundingSphere.html.
Source:
Returns:
Returns a promise that resolves to a Cesium Bounding Sphere when ready
Type
Promise

getCesiumModelFromFeature(feature) → {Cesium3DTileset}

Return the Cesium3DTileset model for a feature from a Cesium 3D tileset
Parameters:
Name Type Description
feature Cesium.Cesium3DTileFeature A Cesium 3D Tile feature
Since:
  • 2.25.0
Source:
Returns:
The model
Type
Cesium3DTileset

getCesiumOptions() → {object}

Get the asset config's cesiumOptions, if it has any. This will return a copy of the cesiumOptions object, so that changes made to the returned object will not affect the original cesiumOptions object.
Since:
  • 2.26.0
Inherited From:
Source:
Returns:
A copy of the cesiumOptions object, or null if there are no cesiumOptions.
Type
object

getCesiumURL() → {string}

Checks whether there is an asset ID for a Cesium Ion resource and if so, return the URL to the resource.
Since:
  • 2.26.0
Source:
Returns:
The URL to the Cesium Ion resource
Type
string

getColor(properties) → {AssetColor#Color}

Given properties of a Feature model from this MapAsset, returns the color associated with that feature.
Parameters:
Name Type Description
properties object The properties of the feature to get the color for; An object containing key-value mapping of property names to properties. (See the 'properties' attribute of Feature#defaults.)
Inherited From:
Source:
Returns:
The color associated with the given set of properties.
Type
AssetColor#Color

getColorFunction() → {function}

Creates a function that takes a Cesium3DTileFeature (see https://cesium.com/learn/cesiumjs/ref-doc/Cesium3DTileFeature.html) and returns a Cesium color based on the colorPalette property set on this model. The returned function is designed to be used as the evaluateColor function that is set in the color property of a Cesium3DTileStyle StyleExpression. See https://cesium.com/learn/cesiumjs/ref-doc/Cesium3DTileStyle.html#color
Source:
Returns:
A Cesium 3dTile evaluate color function
Type
function

getFeatureAttributes(feature) → {object}

Given a feature object from a Feature model, returns the attributes needed to create a Feature model. For vector and 3d tile models only.
Parameters:
Name Type Description
feature * An object that a Map widget uses to represent this feature in the map, e.g. a Cesium.Entity or a Cesium.Cesium3DTileFeature
Inherited From:
Source:
Returns:
An object with properties, mapAsset, featureID, featureObject, and label properties. Returns null if the feature is not the correct type for this asset model.
Type
object

getIDFromFeature(feature) → {string}

Return the ID used by Cesium for a feature from a Cesium 3D tileset
Parameters:
Name Type Description
feature Cesium.Cesium3DTileFeature A Cesium 3D Tile feature
Since:
  • 2.25.0
Source:
Returns:
The ID
Type
string

getLabelFromFeature(feature) → {string}

Return the label for a feature from a Cesium 3D tileset
Parameters:
Name Type Description
feature Cesium.Cesium3DTileFeature A Cesium 3D Tile feature
Since:
  • 2.25.0
Source:
Returns:
The label
Type
string

getPropertiesFromFeature(feature) → {Object}

Given a feature from a Cesium 3D tileset, returns any properties that are set on the feature, similar to an attributes table.
Parameters:
Name Type Description
feature Cesium.Cesium3DTileFeature A Cesium 3D Tile feature
Source:
Returns:
An object containing key-value mapping of property names to properties.
Type
Object

handleError()

When the asset can't be loaded, hide it from the map and show an error.
Since:
  • 2.27.0
Inherited From:
Source:

initialize(assetConfigopt)

Executed when a new Cesium3DTileset model is created.
Parameters:
Name Type Attributes Description
assetConfig MapConfig#MapAssetConfig <optional>
 The initial values of the attributes, which will be set on the model.
Overrides:
Source:

isVisible() → {boolean}

Checks that the visible attribute is set to true and that the opacity attribute is greater than zero. If both conditions are met, returns true.
Inherited From:
Source:
Returns:
Returns true if the MapAsset has opacity > 0 and is visible.
Type
boolean

listenToSelectedFeatures()

Update the appearance of features from this asset when they are selected or deselected in the map widget.
Since:
  • 2.27.0
Inherited From:
Source:

resetStatus()

Resets the Map Asset's status and statusDetails attributes to their default values.
Since:
  • 2.21.0
Inherited From:
Source:

setError(error)

Set an error status and message for this asset.
Parameters:
Name Type Description
error object | string An error object with a status code attribute or or string with details about the error.
Since:
  • 2.27.0
Inherited From:
Source:

setListeners()

Set listeners that update the cesium model when the backbone model is updated.
Overrides:
Source:

setReady()

Set a ready status for this asset.
Since:
  • 2.27.0
Inherited From:
Source:

show()

Make sure the layer is visible. Sets visibility to true if false, and sets opacity to 0.5 if it's less than 0.05.
Inherited From:
Source:

updateAppearance()

Sets a new Cesium3DTileStyle on the Cesium 3D tileset model's style property, based on the attributes set on this model.
Source:

updateFeatureVisibility()

Updates the Cesium style set on this tileset. Adds a new expression to the show property that will filter the features based on the filters set on this model.
Source:

updateIcon(icon)

Sanitizes an SVG string and updates the model's 'icon' attribute the sanitized string. Also sets the 'iconStatus' attribute to 'success'.
Parameters:
Name Type Description
icon string An SVG string to use for the MapAsset icon
Inherited From:
Source:

usesFeatureType(feature) → {boolean}

Checks if a feature from the map (a Cesium object) is the type of feature that this map asset model contains. For example, if a Cesium3DTilesetFeature is passed to this function, this function will return true if it is a Cesium3DTileset model, and false if it is a CesiumVectorData model.
Parameters:
Name Type Description
feature Cesium.Cesium3DTilesetFeature | Cesium.Entity feature to be checked.
Since:
  • 2.25.0
Inherited From:
Source:
Returns:
true if the feature is an instance of the feature type set on the asset model, false otherwise.
Type
boolean

whenReady() → {Promise}

Checks if the asset information has been fetched and is ready to use.
Inherited From:
Source:
Returns:
Returns a promise that resolves to this model when ready.
Type
Promise

zoomTo(target)

Indicate that the map widget should navigate to a given target from this MapAsset.
Parameters:
Name Type Description
target MapConfig#CameraPosition The target to navigate to.
Since:
  • 2.27.0
Inherited From:
Source:

Type Definitions

cesiumOptions

Options that are supported for creating 3D tilesets. The object will be passed to `Cesium.Cesium3DTileset(options)` as options, so the properties listed in the Cesium3DTileset documentation are also supported, see https://cesium.com/learn/cesiumjs/ref-doc/Cesium3DTileset.html
Type:
  • Object
Properties:
Name Type Description
ionAssetId string | number If this tileset is hosted by Cesium Ion, then Ion asset ID.
cesiumToken string If this tileset is hosted by Cesium Ion, then the token needed to access this resource. If one is not set, then the default set in the repository's AppConfig#cesiumToken will be used.
Source: