Class: CesiumTerrain

CesiumTerrain()

A CesiumTerrain Model comprises the information required to fetch 3D terrain, such as mountain peaks and valleys, to display in Cesium. A terrain model also contains metadata about the terrain source data, such as an attribution and a description.

Constructor

new CesiumTerrain()

Since:
  • 2.18.0
Source:

Extends

Members

defaults :Object

Default attributes for CesiumTerrain models
Type:
  • Object
Properties:
Name Type Description
type 'CesiumTerrainProvider' A string indicating a Cesium Terrain Provider, see https://cesium.com/learn/cesiumjs/ref-doc/?classFilter=TerrainProvider
cesiumModel Cesium.TerrainProvider 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/TerrainProvider.html
cesiumOptions CesiumTerrain#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

createCesiumModel(recreate)

Creates a Cesium TerrainProvider that contains information about where the terrain data should be requested from and how to render it in Cesium. See https://cesium.com/learn/cesiumjs/ref-doc/TerrainProvider.html?classFilter=terrain
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.
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

fetchIcon(pid)

Fetches an SVG given a pid, sanitizes it, then updates the model's icon attribute with the new and SVG string (after sanitizing it)
Parameters:
Name Type Description
pid string
Inherited From:
Source:

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, properties) → {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
properties Object key-value pairs representing existing properties in a Feature
Since:
  • 2.19.0
Inherited From:
Source:
Returns:
The new string for the given Feature property
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

initialize(attributesopt, optionsopt)

Executed when a new CesiumTerrain model is created.
Parameters:
Name Type Attributes Description
attributes Object <optional>
The initial values of the attributes, which will be set on the model.
options Object <optional>
Options for the initialize function.
Source:

isSVG(str) → {Boolean}

Simple test to see if a string is an SVG
Parameters:
Name Type Description
str string The string to check
Inherited From:
Source:
Returns:
Returns true if the string starts with ``, regardless of case
Type
Boolean

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

resetStatus()

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

sanitizeIcon(icon, callback)

Takes an SVG string and returns it with only the allowed tags and attributes
Parameters:
Name Type Description
icon string The SVG icon string to sanitize
callback function Function to call once the icon has been sanitized. Will pass the sanitized icon string.
Inherited From:
Source:

setCesiumURL()

Checks whether there is an asset ID for a Cesium Ion resource set in the cesium asset options. If there is, then adds or replaces the URL property the cesium asset options with a URL created by Cesium.
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:

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

Type Definitions

cesiumOptions

Options that are supported for creating terrain in Cesium. Any properties provided here are passed to the Cesium constructor function for the Terrain Provider, so other properties that are documented in Cesium are also supported. See `options` here: https://cesium.com/learn/cesiumjs/ref-doc/CesiumTerrainProvider.html?classFilter=TerrainProvider
Type:
  • Object
Properties:
Name Type Description
ionAssetId string | number If this terrain is hosted by Cesium Ion, then Ion asset ID.
Source: