CesiumTerrainCatalogItem
"type": "cesium-terrain"
CesiumTerrainCatalogItemTraits
Trait | Type | Default | Description |
---|---|---|---|
ionAssetId |
number |
The ID of the Cesium Ion Asset. If this is set url is ignored |
|
ionAccessToken |
string |
The Cesium Ion access token to use to access the terrain. If not specified, the token |
|
ionServer |
string |
the Cesium Ion access token to use to access the terrain. If not specified, the default Ion server, |
|
AttributionTraits | |||
attribution |
string |
The attribution to display with the data. |
|
CatalogMemberTraits | |||
name |
string |
The name of the catalog item. |
|
description |
string |
The description of the catalog item. Markdown and HTML may be used. |
|
nameInCatalog |
string |
The name of the item to be displayed in the catalog, if it is different from the one to display in the workbench. |
|
info |
InfoSectionTraits[] |
Human-readable information about this dataset. |
|
infoSectionOrder |
string[] |
An array of section titles defining the display order of info sections. If this property is not defined, {@link DataPreviewSections}'s DEFAULT_SECTION_ORDER is used |
|
isOpenInWorkbench |
boolean |
true |
Whether the item in the workbench open or collapsed. |
shortReport |
string |
Terrain status: In use |
A short report to show on the now viewing tab. |
shortReportSections |
ShortReportTraits[] |
A list of collapsible sections of the short report |
|
isExperiencingIssues |
boolean |
Whether the catalog item is experiencing issues which may cause its data to be unavailable |
|
hideSource |
boolean |
Indicates that the source of this data should be hidden from the UI (obviously this isn't super-secure as you can just look at the network requests). |
|
metadataUrls |
MetadataUrlTraits[] |
Metadata URLs to show in data catalog. |
|
dataUrls |
DataUrlTraits[] |
Data URLs to show in data catalog. |
|
dataCustodian |
string |
Gets or sets a description of the custodian of this data item. |
|
modelDimensions |
EnumDimensionTraits[] |
This provides ability to set model JSON through SelectableDimensions (a dropdown). When an option is selected, the |
|
disableAboutData |
boolean |
Disables the 'About Data' button in the workbench. |
|
MappableTraits | |||
rectangle |
RectangleTraits |
The bounding box rectangle that contains all the data in this catalog item. |
|
idealZoom |
IdealZoomTraits |
Override default ideal zoom if the given values are valid. |
|
disablePreview |
boolean |
Disables the preview on the Add Data panel. This is useful when the preview will be very slow to load. |
|
disableZoomTo |
boolean |
true |
Disables the zoom to (aka 'Ideal Zoom') button in the workbench. |
zoomOnAddToWorkbench |
boolean |
Zoom to dataset when added to workbench. Doesn't work if |
|
show |
boolean |
true |
Show or hide a workbench item. When show is false, a mappable item is removed from the map and a chartable item is removed from the chart panel. |
initialMessage |
InitialMessageTraits |
A message to show when the user adds the catalog item to the workbench. Useful for showing disclaimers. |
|
featureInfoTemplate |
FeatureInfoTemplateTraits |
A template object for formatting content in feature info panel |
|
showStringIfPropertyValueIsNull |
string |
If the value of a property is null or undefined, show the specified string as the value of the property. Otherwise, the property name will not be listed at all. |
|
maximumShownFeatureInfos |
number |
The maximum number of "feature infos" that can be displayed in feature info panel. |
|
UrlTraits | |||
url |
string |
The base URL of the file or service. |
|
forceProxy |
boolean |
Force the default proxy to be used for all network requests. |
|
cacheDuration |
string |
The cache duration to use for proxied URLs for this catalog member. If undefined, proxied URLs are effectively cachable forever. The duration is expressed as a Varnish-like duration string, such as '1d' (one day) or '10000s' (ten thousand seconds). |
InfoSectionTraits
Trait | Type | Default | Description |
---|---|---|---|
name |
string |
The name of the section. |
|
content |
string |
The content of the section, in Markdown and HTML format. Set this property to null to remove this section entirely. |
|
contentAsObject |
any |
The content of the section which is a JSON object. Set this property to null to remove this section entirely. |
|
show |
boolean |
true |
Indicates if this info section showing (not collapsed). |
ShortReportTraits
Trait | Type | Default | Description |
---|---|---|---|
name |
string |
The name of the section. |
|
content |
string |
The content of the section. |
|
show |
boolean |
true |
Indicates if this short report section showing. |
MetadataUrlTraits
Trait | Type | Default | Description |
---|---|---|---|
url |
string |
The metadata URL of the file or service. |
|
title |
string |
Title used for metadata URL button. |
DataUrlTraits
Trait | Type | Default | Description |
---|---|---|---|
type |
string |
Type of data URL. This value will be used to provide context or instruction on how to use the data URL. For example |
|
MetadataUrlTraits | |||
url |
string |
The metadata URL of the file or service. |
|
title |
string |
Title used for metadata URL button. |
EnumDimensionTraits
Trait | Type | Default | Description |
---|---|---|---|
id |
string |
Dimension ID |
|
name |
string |
Dimension name (human-readable) |
|
options |
DimensionOptionTraits[] |
Dimension options |
|
selectedId |
string |
Selected Option's ID |
|
allowUndefined |
boolean |
Allow dimension to be undefined |
|
disable |
boolean |
Hides dimension |
DimensionOptionTraits
Trait | Type | Default | Description |
---|---|---|---|
id |
string |
Option ID |
|
name |
string |
Option name (human-readable) |
|
value |
any |
Value (if this is undefined, |
RectangleTraits
Trait | Type | Default | Description |
---|---|---|---|
west |
number |
The westernmost longitude in degrees. |
|
south |
number |
The southernmost longitude in degrees. |
|
east |
number |
The easternmost longitude in degrees. |
|
north |
number |
The northernmost longitude in degrees. |
|
CameraTraits | |||
position |
VectorTraits |
Position of the camera in the Earth-centered Fixed frame in meters. |
|
direction |
VectorTraits |
The look direction of the camera in the Earth-centered Fixed frame. |
|
up |
VectorTraits |
The up vector direction of the camera in the Earth-centered Fixed frame. |
VectorTraits
Trait | Type | Default | Description |
---|---|---|---|
x |
number |
X component of vector in the Earth-centered Fixed frame. |
|
y |
number |
Y component of vector in the Earth-centered Fixed frame. |
|
z |
number |
Z component of vector in the Earth-centered Fixed frame. |
IdealZoomTraits
Trait | Type | Default | Description |
---|---|---|---|
lookAt |
LookAtTraits |
Parameters for camera to look at a target. |
|
camera |
CameraTraits |
Use camera position, direction and up if fully defined. Otherwise use rectangle if fully defined. |
LookAtTraits
Trait | Type | Default | Description |
---|---|---|---|
targetLongitude |
number |
Target longitude on the WGS84 ellipsoid in degrees |
|
targetLatitude |
number |
Target latitude on the WGS84 ellipsoid in degrees |
|
targetHeight |
number |
100 |
Target height in meters. Treat it as camera height. A positive value is above the WGS84 ellipsoid. Default to 100 meters. |
heading |
number |
Heading in degrees. Treat it as camera bearing. North is 0. A positive value rotates clockwise, negative anti-clockwise. Default to 0. |
|
pitch |
number |
45 |
Pitch in degrees. Treat it as camera pitch. A positive value is to look down, negative up. Default to 45. |
range |
number |
500 |
The range in meters. It is the distance between the target position and camera position projected onto the local plane. Not negative and default to 500. |
CameraTraits
Trait | Type | Default | Description |
---|---|---|---|
position |
VectorTraits |
Position of the camera in the Earth-centered Fixed frame in meters. |
|
direction |
VectorTraits |
The look direction of the camera in the Earth-centered Fixed frame. |
|
up |
VectorTraits |
The up vector direction of the camera in the Earth-centered Fixed frame. |
|
RectangleTraits | |||
west |
number |
The westernmost longitude in degrees. |
|
south |
number |
The southernmost longitude in degrees. |
|
east |
number |
The easternmost longitude in degrees. |
|
north |
number |
The northernmost longitude in degrees. |
InitialMessageTraits
Trait | Type | Default | Description |
---|---|---|---|
title |
string |
The title of the message. |
|
content |
string |
The content of the message. |
|
key |
string |
Identifier. If multiple messages with the same key are triggered, only the first will be displayed. |
|
confirmation |
boolean |
Whether the message requires confirmation. |
|
confirmText |
string |
If |
|
width |
number |
Width of the message. |
|
height |
number |
Height of the message. |
FeatureInfoTemplateTraits
Trait | Type | Default | Description |
---|---|---|---|
name |
string |
A mustache template string for formatting name |
|
template |
string |
A Mustache template string for formatting description |
|
showFeatureInfoDownloadWithTemplate |
boolean |
Show feature info download if a |
|
partials |
any |
An object, mapping partial names to a template string. Defines the partials used in Template. |
|
formats |
any |
An object, mapping field names to formatting options. |