CzmlCatalogItem

Creates one catalog item from url that points to a czml file.

Note: If the model is not visible, try to disable the terrain by unchecking the box "Terrain hides underground features".

Example usage

{
  "type": "czml",
  "url": "https://tiles.terria.io/terriajs-examples/czml/smooth.czml",
  "name": "czml example",
  "id": "some unique ID"
}

CzmlCatalogItemTraits

Trait	Type	Default	Description
`czmlData`	`any`		A CZML data array.
`czmlString`	`string`		A CZML string.
AttributionTraits
`attribution`	`string`		The attribution to display with the data.
AutoRefreshingTraits
`refreshInterval`	`number`		How often the data in this model is refreshed, in seconds
`refreshEnabled`	`boolean`	`true`	Toggle for enabling auto refresh.
CatalogMemberTraits
`name`	`string`		The name of the catalog item.
`description`	`string`		The description of the catalog item. Markdown and HTML may be used.
`hideDefaultDescription`	`boolean`		If true, then no generic default description will be displayed if `description` is undefined.
`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`		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 `value` property will be used to call `updateModelFromJson()`. All string properties support Mustache templates (with the catalog member as context)
`disableAboutData`	`boolean`		Disables the 'About Data' button in the workbench.
LegendOwnerTraits
`legends`	`LegendTraits[]`		The legends to display on the workbench.
`legendBackgroundColor`	`string`		Apply background color to all legends. This can be useful if legends are transparent and clash with Terria colours
`hideLegendInWorkbench`	`boolean`		Whether the legend is hidden in the workbench for this catalog member.
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`		Disables the zoom to (aka 'Ideal Zoom') button in the workbench.
`zoomOnAddToWorkbench`	`boolean`		Zoom to dataset when added to workbench. Doesn't work if `disableZoomTo` is true.
`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.
TimeVaryingTraits
`timeLabel`	`string`		Time label which is shown in workbench next to date/time selector (Will default to t("dateTime.selectorLabel") = "Time:").
`currentTime`	`string`		The current time at which to show this dataset.
`initialTimeSource`	`string`	`now`	The initial time to use if `Current Time` is not specified. Valid values are * `start` - the dataset's start time * `stop` - the dataset's stop time * `now` - the current system time. If the system time is after `Stop Time`, `Stop Time` is used. If the system time is before `Start Time`, `Start Time` is used. * `none` - do not automatically set an initial time This value is ignored if `Current Time` is specified.
`startTime`	`string`		The earliest time for which this dataset is available. This will be the start of the range shown on the timeline control.
`stopTime`	`string`		The latest time for which this dataset is available. This will be the end of the range shown on the timeline control.
`multiplier`	`number`		The multiplier to use in progressing time for this dataset. For example, `5.0` means that five seconds of dataset time will pass for each one second of real time.
`isPaused`	`boolean`	`true`	True if time is currently paused for this dataset, or false if it is progressing.
`dateFormat`	`string`		A dateformat string (using the dateformat package) used to adjust the presentation of the date in various spots in the UI for a catalog item. For example, to just show the year set to 'yyyy'. Used in places like the the Workbench Item and Bottom Dock
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	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 `wcs` will provide a link to WCS docs. Current supported values are: - `wfs` = A Web Feature Service (WFS) base URL - `wcs` = A Web Coverage Service (WCS) base URL - `wfs-complete` = A complete, ready-to-use link to download features from a WCS server - `wcs-complete` = A complete, ready-to-use link to download features from a WFS server - `direct` = Direct URL to dataset (this is the default if no `type` is specified) - `none` = Hide data URL
MetadataUrlTraits
`url`	`string`	The metadata URL of the file or service.
`title`	`string`	Title used for metadata URL button.

EnumDimensionTraits

Trait	Type	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	Description
`id`	`string`	Option ID
`name`	`string`	Option name (human-readable)
`value`	`any`	Value (if this is undefined, `id` will be used)

LegendTraits

Trait	Type	Default	Description
`title`	`string`		A title to be displayed above the legend.
`url`	`string`		The URL of the legend image. If the URL suffix isn't one of the following `png\|jpg\|jpeg\|gif\|svg`, then `urlMimeType` must be defined - otherwise a hyperlink will be shown.
`imageScaling`	`number`	`1`	Scaling of the legend. For example, a high DPI legend may have scaling = `0.5`, so it will be scaled down 50%
`urlMimeType`	`string`		The MIME type of the `URL` legend image. For example `"image/png"`
`items`	`LegendItemTraits[]`
`backgroundColor`	`string`		Apply background color to entire legend. This can be useful if legend is transparent and clashes with Terria colours. This will override `legendBackgroundColor`.

LegendItemTraits

Trait	Type	Default	Description
`title`	`string`		The title to display next to this legend item.
`multipleTitles`	`string`		Multiple titles to display next to this legend item.
`maxMultipleTitlesShowed`	`string`	`10`	Maximum number of multiple titles to display next to this legend item. (Default is 10)
`titleAbove`	`string`		The title to display above this legend item, i.e. marking the top of a box on the legend.
`titleBelow`	`string`		The title to display below this legend item, i.e. marking the bottom of a box on the legend.
`color`	`string`		The CSS color to display for this item. This property is ignored if `Legend URL` is specified.
`outlineColor`	`string`		The CSS color with which to outline this item.
`outlineWidth`	`number`		The width of outline in pixels
`multipleColors`	`string[]`		Multiple colors to show with this item in a grid arrangement.
`imageUrl`	`string`		The URL of an image to display with this item.
`marker`	`string`		Maki marker ID to display with this item (eg "circle").
`rotation`	`number`		The degrees to rotate legend item.
`addSpacingAbove`	`boolean`		True to add a bit of extra spacing above this item in order to separate it visually from the rest of the legend.
`imageHeight`	`number`	`20`	The height of the legend image.
`imageWidth`	`number`	`20`	The width of the legend image.

RectangleTraits

Trait	Type	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	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	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	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 `confirmation` is true, the text to put on the confirmation button.
`width`	`number`	Width of the message.
`height`	`number`	Height of the message.

FeatureInfoTemplateTraits

Trait	Type	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 `template` has been provided. If no `template` is provided, then download will always show.
`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.