ArcGisFeatureServerCatalogItem
Creates a single item in the catalog from one ESRI WFS layer.
Note: Must specify layer ID, e.g. /0
, in the URL path.
Example usage
{
"url": "https://services5.arcgis.com/OvOcYIrJnM97ABBA/arcgis/rest/services/Australian_Public_Hospitals_WFL1/FeatureServer/0",
"type": "esri-featureServer",
"name": "Australian Public Hospitals",
"id": "some id"
}
ArcGisFeatureServerCatalogItemTraits
Trait | Type | Default | Description |
---|---|---|---|
clampToGround |
boolean |
true |
Whether the features in this service should be clamped to the terrain surface. |
useStyleInformationFromService |
boolean |
true |
Whether to symbolise the data using the drawingInfo object available in the service endpoint. |
layerDef |
string |
1=1 |
DEPRECATED, use |
where |
string |
1=1 |
The 'where' string to pass to the server when requesting geometry. |
maxFeatures |
number |
5000 |
The maximum number of features to be retrieved from the feature service. |
featuresPerRequest |
number |
1000 |
The number of features to be retrieved from the feature service in each request. This should be equal to the maxRecordCount specified by the server. |
supportsPagination |
boolean |
Whether this feature service supports pagination. By default, this will be inferred from the server's response. |
|
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. |
|
hideDefaultDescription |
boolean |
If true, then no generic default description will be displayed if |
|
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 |
|
disableAboutData |
boolean |
Disables the 'About Data' button in the workbench. |
|
shareable |
boolean |
true |
True (default) if this catalog member may be included in share links. False to exclude it from share links. |
ChartPointOnMapTraits | |||
chartPointOnMap |
LatLonHeightTraits |
The point on map where the current chart for the item was generated from. A marker will be shown at this point if the chart is active. |
|
ChartTraits | |||
chartType |
string |
Type determines how the data availibility will be plotted on chart. eg: momentLines, momentPoints |
|
chartDisclaimer |
string |
A HTML string to show above the chart as a disclaimer |
|
chartColor |
string |
The color to use when the data set is displayed on the chart. The value can be any html color string, eg: 'cyan' or '#00ffff' or 'rgba(0, 255, 255, 1)' for the color cyan. |
|
chartGlyphStyle |
string |
The glyph style to use for points plotted on the chart. Allowed values include circle, cross, diamond, square, star, triangle, wye. Default is "circle". |
|
DiscretelyTimeVaryingTraits | |||
fromContinuous |
string |
nearest |
Specifies how a continuous time (e.g. the timeline control) is mapped to a discrete time for this dataset. Valid values are: |
showInChartPanel |
boolean |
true |
Whether to plot data availability on a chart. |
disableDateTimeSelector |
boolean |
true |
When true, disables the date time selector in the workbench |
multiplierDefaultDeltaStep |
number |
2 |
The multiplierDefaultDeltaStep is used to set the default multiplier (see |
ExportableTraits | |||
disableExport |
boolean |
Disable user export functionality |
|
FeatureInfoUrlTemplateTraits | |||
featureInfoUrlTemplate |
string |
A template URL string for fetching feature info. Template values of the form {x} will be replaced with corresponding property values from the picked feature. |
|
maxRequests |
number |
10 |
Max number of feature info requests to send to API url. Keep this number small to avoid sending to many requests to server (default 10). |
GeoJsonTraits | |||
enableManualRegionMapping |
boolean |
If enabled, there will be controls to set region column and region type. |
|
useOutlineColorForLineFeatures |
boolean |
If enabled, TableOutlineStyleTraits will be used to color Line Features, otherwise TableColorStyleTraits will be used. |
|
style |
StyleTraits |
Styling rules that follow simplestyle-spec. If defined, then |
|
forceCesiumPrimitives |
boolean |
Force rendering GeoJSON features as Cesium primitives. This will be true if you are using |
|
filterByProperties |
any |
Filter GeoJSON features by properties. If the properties of a feature match |
|
perPropertyStyles |
PerPropertyGeoJsonStyleTraits[] |
Override feature styles according to their properties. This is only supported for cesium primitives (see |
|
timeProperty |
string |
The property of each GeoJSON feature that specifies which point in time that feature is associated with. If not specified, it is assumed that the dataset is constant throughout time. This is only supported for cesium primitives (see |
|
heightProperty |
string |
The property of each GeoJSON feature that specifies the height. If defined, polygons will be extruded to this property (in meters) above terrain. This is only supported for cesium primitives (see |
|
czmlTemplate |
any |
CZML template to be used to replace each GeoJSON Point and Polygon/MultiPolygon feature. Feature coordinates and properties will automatically be applied to CZML packet, so they can be used as references.
|
|
explodeMultiPoints |
boolean |
true |
Replaces |
LayerOrderingTraits | |||
keepOnTop |
boolean |
Keeps the layer on top of all other imagery layers. |
|
supportsReordering |
boolean |
true |
Does this layer support reordering 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 |
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. |
|
OpacityTraits | |||
opacity |
number |
1 |
The opacity of the item. |
disableOpacityControl |
boolean |
true |
When true, the user will be unable to change the opacity of the item |
SplitterTraits | |||
splitDirection |
number |
The side of the splitter to display this imagery layer on. Defaults to both sides. |
|
disableSplitter |
boolean |
true |
If true, splitter funcitonality will be hidden for this model. |
TableTraits | |||
showUnmatchedRegionsWarning |
boolean |
true |
True to show a warning when some of the region IDs in the CSV file could not be matched to a region. False to silently ignore unmatched regions. |
columns |
TableColumnTraits[] |
Options for individual columns/variables. |
|
defaultColumn |
TableColumnTraits |
The default settings to use for all columns/variables |
|
styles |
TableStyleTraits[] |
The set of styles that can be used to visualize this dataset. |
|
defaultStyle |
TableStyleTraits |
The default style to apply when visualizing any column/variable. |
|
activeStyle |
string |
The ID of the currently-selected style. |
|
showDisableStyleOption |
boolean |
true |
If enabled, there will be an option in styleDimension to disable styling. |
showDisableTimeOption |
boolean |
If enabled, there will be an checkbox to disable time. |
|
columnTitles |
string[] |
An optional array of column/variable titles that override the individual |
|
columnUnits |
string[] |
An optional array of column/variable units that override the individual |
|
removeDuplicateRows |
boolean |
If two rows in the table are identical, only retain one copy. This could cause performance issues, and so should be used only when absolutely necessary. |
|
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 |
start |
The initial time to use if |
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, |
|
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. |
|
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 |
1d |
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, |
LatLonHeightTraits
Trait | Type | Default | Description |
---|---|---|---|
latitude |
number |
Latitude in degrees |
|
longitude |
number |
Longitude in degrees |
|
height |
number |
Height above ellipsoid in metres |
StyleTraits
Trait | Type | Default | Description |
---|---|---|---|
marker-size |
string |
Marker size. Valid values are |
|
marker-color |
string |
Marker color |
|
marker-symbol |
string |
Marker symbol. (only supported with Cesium Primitives) |
|
marker-opacity |
number |
Marker opacity. |
|
marker-url |
string |
Marker URL. (only supported with Cesium Primitives) |
|
stroke |
string |
Stroke color. |
|
stroke-opacity |
number |
Stroke opacity. |
|
stroke-width |
number |
Stroke width. |
|
marker-stroke |
string |
Marker stroke color. (This is will override stroke for Point geojson-vt features) - not apart of simplestyle-spec and will not apply to cesium primitives |
|
marker-stroke-width |
number |
Marker stroke width. (This is will override stroke-width for Point geojson-vt features) - not apart of simplestyle-spec and will not apply to cesium primitives |
|
polyline-stroke |
string |
Polyline stroke color. (This is will override stroke for Polyline geojson-vt features) - not apart of simplestyle-spec and will not apply to cesium primitives |
|
polyline-stroke-width |
number |
Polyline stroke width. (This is will override stroke-width for Polyline geojson-vt features) - not apart of simplestyle-spec and will not apply to cesium primitives |
|
polygon-stroke |
string |
Polygon stroke color. (This is will override stroke for Polygon geojson-vt features) - not apart of simplestyle-spec and will not apply to cesium primitives |
|
polygon-stroke-width |
number |
Polygon stroke width. (This is will override stroke-width for Polygon geojson-vt features) - not apart of simplestyle-spec and will not apply to cesium primitives |
|
fill |
string |
Fill color. |
|
fill-opacity |
number |
Fill opacity. |
PerPropertyGeoJsonStyleTraits
Trait | Type | Default | Description |
---|---|---|---|
properties |
any |
If the properties of a feature match these properties, then apply the style to that feature |
|
style |
StyleTraits |
Styling rules to apply, following simplestyle-spec |
|
caseSensitive |
boolean |
True if properties should be matched in a case sensitive fashion |
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 |
|
imageScaling |
number |
1 |
Scaling of the legend. For example, a high DPI legend may have scaling = |
urlMimeType |
string |
The MIME type of the |
|
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 |
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 |
|
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 | 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 |
true |
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. |
TableColumnTraits
Trait | Type | Default | Description |
---|---|---|---|
name |
string |
The name of the column. |
|
title |
string |
The displayed title of the column. |
|
units |
string |
The units for the column values. |
|
transformation |
ColumnTransformationTraits |
Transformation to apply to this column |
|
type |
string |
The type of the column. If not specified, the type is guessed from the column's name and values. Valid types are:
|
|
regionType |
string |
The type of region referenced by the values in this column. If |
|
regionDisambiguationColumn |
string |
The name of the column to use to disambiguate region matches in this column. |
|
replaceWithZeroValues |
string[] |
Values of the column to replace with 0.0, such as |
|
replaceWithNullValues |
string[] |
Values of the column to replace with null, such as |
|
format |
any |
The formatting options to pass to |
ColumnTransformationTraits
Trait | Type | Default | Description |
---|---|---|---|
expression |
string |
Transformation expression used to change column values (row-by-row). This uses http://bugwheels94.github.io/math-expression-evaluator . For example |
|
dependencies |
string[] |
Array of column names which are 'injected' in to the expression. For example, to use the expression |
TableStyleTraits
Trait | Type | Default | Description |
---|---|---|---|
id |
string |
The ID of the style. |
|
title |
string |
The human-readable title of the style. Set this to null to remove the style entirely. |
|
regionColumn |
string |
The column to use for region mapping. |
|
latitudeColumn |
string |
The column to use for the latitude of points. If |
|
longitudeColumn |
string |
The column to use for the longitude of points. If |
|
color |
TableColorStyleTraits |
Options for controlling the color of points or regions. |
|
point |
TablePointStyleTraits |
Options for controlling the symbolization. This excludes color (see TableColorStyleTraits) and pointSize (see TablePointSizeStyleTraits). |
|
outline |
TableOutlineStyleTraits |
Options for controlling the symbolization. This excludes color (see TableColorStyleTraits) and pointSize (see TablePointSizeStyleTraits). |
|
trail |
TableTrailStyleTraits |
Options for controlling the trail or path behind a time-series point. |
|
label |
TableLabelStyleTraits |
Options for controlling the labels. |
|
pointSize |
TablePointSizeStyleTraits |
Options for controlling the size of points. This property is ignored for regions. This will override TablePointStyleTraits marker width/height if |
|
chart |
TableChartStyleTraits |
Options for controlling the chart created from this CSV. |
|
time |
TableTimeStyleTraits |
Options for controlling how the visualization changes with time. |
|
hidden |
boolean |
Hide style from "Display Variable" drop-down in workbench. It is hidden by default if number of colors (enumColors or numberOfBins) is less than 2 - as a ColorMap with a single color isn't super useful |
TableColorStyleTraits
Trait | Type | Default | Description |
---|---|---|---|
mapType |
string |
The type of style map. Valid values are "continuous", "enum", "bin", "constant" |
|
colorColumn |
string |
The column to use to color points or regions. |
|
nullColor |
string |
The color to use when the value is null, specified as a CSS color string. |
|
outlierColor |
string |
The color to use when the value is lies outside minimumValue and maximumValue (and therefore not shown on color scale), specified as a CSS color string. This only applies to ContinuousColorMap |
|
regionColor |
string |
#02528d |
The color to use when the styling the region, specified as a CSS color string. |
nullLabel |
string |
The label to use in the legend for null values. |
|
outlierLabel |
string |
The label to use in the legend for outlier values. |
|
minimumValue |
number |
The minimum value to use when creating ColorMaps. This is only applied for |
|
maximumValue |
number |
The maximum value to use when creating ColorMaps. This is only applied for |
|
numberOfBins |
number |
The number of different colors to bin the data into. This property is ignored if |
|
binMaximums |
number[] |
The maximum values of the bins to bin the data into, specified as an array of numbers. The first bin extends from the dataset's minimum value to the first value in this array. The second bin extends from the first value in this array to the second value in this array. And so on. If the maximum value of the dataset is greater than the last value in this array, an additional bin is added automatically. This property is ignored if the |
|
binColors |
string[] |
The colors to use for the bins, each specified as a CSS color string. If there are more colors than bins, the extra colors are ignored. If there are more bins than colors, the colors are repeated as necessary. |
|
enumColors |
EnumColorTraits[] |
The colors to use for enumerated values. This property is ignored if the |
|
colorPalette |
string |
The name of a ColorBrewer palette to use when mapping values to colors. This property is ignored if |
|
legendTicks |
number |
7 |
The number of tick marks (in addition to the top and bottom) to show on the legend for Continuous color scales |
legend |
LegendTraits |
The legend to show with this style. If not specified, a suitable is created automatically from the other parameters. |
|
zScoreFilter |
number |
Treat values outside of specified z-score as outliers, and therefore do not include in color scale. This value is magnitude of z-score - it will apply to positive and negative z-scores. For example a value of |
|
zScoreFilterEnabled |
boolean |
True, if z-score filter is enabled. |
|
rangeFilter |
number |
0.3 |
This is applied after the |
EnumColorTraits
Trait | Type | Default | Description |
---|---|---|---|
value |
string |
The enumerated value to map to a color. |
|
color |
string |
The CSS color to use for the enumerated value. |
TablePointStyleTraits
Trait | Type | Default | Description |
---|---|---|---|
enum |
EnumPointSymbolTraits[] |
The point style to use for enumerated values. |
|
bin |
BinPointSymbolTraits[] |
The point style to use for bin values. |
|
null |
PointSymbolTraits |
The default point style. |
|
TableStyleMapTraits | |||
enabled |
boolean |
true |
True to enable. |
mapType |
string |
The type of style map. Valid values are "continuous", "enum", "bin", "constant" |
|
column |
string |
The column to use for styling. |
EnumPointSymbolTraits
Trait | Type | Default | Description |
---|---|---|---|
EnumStyleTraits | |||
value |
string |
The enumerated value to map to a style. |
|
PointSymbolTraits | |||
marker |
string |
point |
Marker used to symbolize points. Default is "point"/"circle". This can be a URL, data URI or one of the supported Maki icons (eg "hospital") |
rotation |
number |
Rotation of marker in degrees (clockwise). |
|
pixelOffset |
number[] |
Pixel offset in screen space from the origin. [x, y] format |
|
height |
number |
16 |
Height of the marker (in pixels). |
width |
number |
16 |
Width of the marker (in pixels). |
scaleByDistance |
ScaleByDistanceTraits |
Scales a point, billboard or label feature by its distance from the camera. |
|
disableDepthTestDistance |
number |
The distance from camera at which to disable depth testing, for example to prevent clipping of features againts terrain. Set to a very large value like 99999999 to disable depth testing altogether. When not defined or set to 0, depth testing is always applied. |
|
TableStyleMapSymbolTraits | |||
legendTitle |
string |
The enumerated value to map to a color. |
ScaleByDistanceTraits
Trait | Type | Default | Description |
---|---|---|---|
near |
number |
The lower bound of the camera distance range. |
|
nearValue |
number |
1 |
The scale value to use when the camera is at the |
far |
number |
1 |
The upper bound of the camera distance range. |
farValue |
number |
1 |
The scale value to use when the camera is at the |
BinPointSymbolTraits
Trait | Type | Default | Description |
---|---|---|---|
BinStyleTraits | |||
maxValue |
number |
The maximum value of the bin for a given style. |
|
PointSymbolTraits | |||
marker |
string |
point |
Marker used to symbolize points. Default is "point"/"circle". This can be a URL, data URI or one of the supported Maki icons (eg "hospital") |
rotation |
number |
Rotation of marker in degrees (clockwise). |
|
pixelOffset |
number[] |
Pixel offset in screen space from the origin. [x, y] format |
|
height |
number |
16 |
Height of the marker (in pixels). |
width |
number |
16 |
Width of the marker (in pixels). |
scaleByDistance |
ScaleByDistanceTraits |
Scales a point, billboard or label feature by its distance from the camera. |
|
disableDepthTestDistance |
number |
The distance from camera at which to disable depth testing, for example to prevent clipping of features againts terrain. Set to a very large value like 99999999 to disable depth testing altogether. When not defined or set to 0, depth testing is always applied. |
|
TableStyleMapSymbolTraits | |||
legendTitle |
string |
The enumerated value to map to a color. |
PointSymbolTraits
Trait | Type | Default | Description |
---|---|---|---|
marker |
string |
point |
Marker used to symbolize points. Default is "point"/"circle". This can be a URL, data URI or one of the supported Maki icons (eg "hospital") |
rotation |
number |
Rotation of marker in degrees (clockwise). |
|
pixelOffset |
number[] |
Pixel offset in screen space from the origin. [x, y] format |
|
height |
number |
16 |
Height of the marker (in pixels). |
width |
number |
16 |
Width of the marker (in pixels). |
scaleByDistance |
ScaleByDistanceTraits |
Scales a point, billboard or label feature by its distance from the camera. |
|
disableDepthTestDistance |
number |
The distance from camera at which to disable depth testing, for example to prevent clipping of features againts terrain. Set to a very large value like 99999999 to disable depth testing altogether. When not defined or set to 0, depth testing is always applied. |
|
TableStyleMapSymbolTraits | |||
legendTitle |
string |
The enumerated value to map to a color. |
TableOutlineStyleTraits
Trait | Type | Default | Description |
---|---|---|---|
enum |
EnumOutlineSymbolTraits[] |
The outline style to use for enumerated values. |
|
bin |
BinOutlineSymbolTraits[] |
The outline style to use for bin values. |
|
null |
OutlineSymbolTraits |
The default outline style. |
|
TableStyleMapTraits | |||
enabled |
boolean |
true |
True to enable. |
mapType |
string |
The type of style map. Valid values are "continuous", "enum", "bin", "constant" |
|
column |
string |
The column to use for styling. |
EnumOutlineSymbolTraits
Trait | Type | Default | Description |
---|---|---|---|
EnumStyleTraits | |||
value |
string |
The enumerated value to map to a style. |
|
OutlineSymbolTraits | |||
color |
string |
Outline color. |
|
width |
number |
1 |
Outline width (in pixels). |
TableStyleMapSymbolTraits | |||
legendTitle |
string |
The enumerated value to map to a color. |
BinOutlineSymbolTraits
Trait | Type | Default | Description |
---|---|---|---|
BinStyleTraits | |||
maxValue |
number |
The maximum value of the bin for a given style. |
|
OutlineSymbolTraits | |||
color |
string |
Outline color. |
|
width |
number |
1 |
Outline width (in pixels). |
TableStyleMapSymbolTraits | |||
legendTitle |
string |
The enumerated value to map to a color. |
OutlineSymbolTraits
Trait | Type | Default | Description |
---|---|---|---|
color |
string |
Outline color. |
|
width |
number |
1 |
Outline width (in pixels). |
TableStyleMapSymbolTraits | |||
legendTitle |
string |
The enumerated value to map to a color. |
TableTrailStyleTraits
Trait | Type | Default | Description |
---|---|---|---|
enabled |
boolean |
True to enable. False by default |
|
materialType |
string |
solidColor |
The type of material to use. Possible values: |
enum |
EnumTrailSymbolTraits[] |
The colors to use for enumerated values. This property is ignored if the |
|
bin |
BinTrailSymbolTraits[] |
The colors to use for enumerated values. This property is ignored if the |
|
null |
TrailSymbolTraits |
The colors to use for enumerated values. This property is ignored if the |
|
TableStyleMapTraits | |||
mapType |
string |
The type of style map. Valid values are "continuous", "enum", "bin", "constant" |
|
column |
string |
The column to use for styling. |
EnumTrailSymbolTraits
Trait | Type | Default | Description |
---|---|---|---|
EnumStyleTraits | |||
value |
string |
The enumerated value to map to a style. |
|
PolylineMaterialTraits | |||
polylineGlow |
PolylineGlowMaterialTraits |
Polyline glow material. Must also set |
|
solidColor |
SolidColorMaterialTraits |
Solid color material. |
|
TableStyleMapSymbolTraits | |||
legendTitle |
string |
The enumerated value to map to a color. |
|
TrailSymbolTraits | |||
leadTime |
number |
The number of seconds in front of the object to show. |
|
trailTime |
number |
10 |
The number of seconds behind the object to show. |
width |
number |
1 |
The width in pixels. |
resolution |
number |
60 |
The maximum number of seconds to step when sampling the position. |
PolylineGlowMaterialTraits
Trait | Type | Default | Description |
---|---|---|---|
color |
string |
#ffffff |
The color. |
glowPower |
number |
0.25 |
The strength of the glow, as a percentage of the total line width. |
taperPower |
number |
1 |
The strength of the glow tapering effect, as a percentage of the total line length. If 1.0 or higher, no taper effect is used. |
SolidColorMaterialTraits
Trait | Type | Default | Description |
---|---|---|---|
color |
string |
#ffffff |
The color. |
BinTrailSymbolTraits
Trait | Type | Default | Description |
---|---|---|---|
BinStyleTraits | |||
maxValue |
number |
The maximum value of the bin for a given style. |
|
PolylineMaterialTraits | |||
polylineGlow |
PolylineGlowMaterialTraits |
Polyline glow material. Must also set |
|
solidColor |
SolidColorMaterialTraits |
Solid color material. |
|
TableStyleMapSymbolTraits | |||
legendTitle |
string |
The enumerated value to map to a color. |
|
TrailSymbolTraits | |||
leadTime |
number |
The number of seconds in front of the object to show. |
|
trailTime |
number |
10 |
The number of seconds behind the object to show. |
width |
number |
1 |
The width in pixels. |
resolution |
number |
60 |
The maximum number of seconds to step when sampling the position. |
TrailSymbolTraits
Trait | Type | Default | Description |
---|---|---|---|
leadTime |
number |
The number of seconds in front of the object to show. |
|
trailTime |
number |
10 |
The number of seconds behind the object to show. |
width |
number |
1 |
The width in pixels. |
resolution |
number |
60 |
The maximum number of seconds to step when sampling the position. |
PolylineMaterialTraits | |||
polylineGlow |
PolylineGlowMaterialTraits |
Polyline glow material. Must also set |
|
solidColor |
SolidColorMaterialTraits |
Solid color material. |
|
TableStyleMapSymbolTraits | |||
legendTitle |
string |
The enumerated value to map to a color. |
TableLabelStyleTraits
Trait | Type | Default | Description |
---|---|---|---|
enabled |
boolean |
True to enable. False by default |
|
enum |
EnumLabelSymbolTraits[] |
The colors to use for enumerated values. This property is ignored if the |
|
bin |
BinLabelSymbolTraits[] |
The colors to use for enumerated values. This property is ignored if the |
|
null |
LabelSymbolTraits |
The colors to use for enumerated values. This property is ignored if the |
|
TableStyleMapTraits | |||
mapType |
string |
The type of style map. Valid values are "continuous", "enum", "bin", "constant" |
|
column |
string |
The column to use for styling. |
EnumLabelSymbolTraits
Trait | Type | Default | Description |
---|---|---|---|
EnumStyleTraits | |||
value |
string |
The enumerated value to map to a style. |
|
LabelSymbolTraits | |||
labelColumn |
string |
ID of column to use as label |
|
font |
string |
30px sans-serif |
Font CSS string. Default is |
style |
string |
FILL |
Label style. Possible values are |
scale |
number |
1 |
The scale of the label. The scale is multiplied with the pixel size of the label's text. |
scaleByDistance |
ScaleByDistanceTraits |
Scales a point, billboard or label feature by its distance from the camera. |
|
disableDepthTestDistance |
number |
The distance from camera at which to disable depth testing, for example to prevent clipping of features againts terrain. Set to a very large value like 99999999 to disable depth testing altogether. When not defined or set to 0, depth testing is always applied. |
|
fillColor |
string |
#ffffff |
The fill color of the label. |
outlineColor |
string |
#000000 |
The outline color of the label. |
outlineWidth |
number |
1 |
The outline width of the label. |
pixelOffset |
number[] |
0,0 |
The number of pixels up and to the right to place the label. |
horizontalOrigin |
string |
LEFT |
The horizontal location of an origin relative to an object. For example, LEFT will place the label on the right of the point. Possible values are |
verticalOrigin |
string |
CENTER |
The vertical location of an origin relative to an object. For example, TOP will place the label above the point. Possible values are |
TableStyleMapSymbolTraits | |||
legendTitle |
string |
The enumerated value to map to a color. |
BinLabelSymbolTraits
Trait | Type | Default | Description |
---|---|---|---|
BinStyleTraits | |||
maxValue |
number |
The maximum value of the bin for a given style. |
|
LabelSymbolTraits | |||
labelColumn |
string |
ID of column to use as label |
|
font |
string |
30px sans-serif |
Font CSS string. Default is |
style |
string |
FILL |
Label style. Possible values are |
scale |
number |
1 |
The scale of the label. The scale is multiplied with the pixel size of the label's text. |
scaleByDistance |
ScaleByDistanceTraits |
Scales a point, billboard or label feature by its distance from the camera. |
|
disableDepthTestDistance |
number |
The distance from camera at which to disable depth testing, for example to prevent clipping of features againts terrain. Set to a very large value like 99999999 to disable depth testing altogether. When not defined or set to 0, depth testing is always applied. |
|
fillColor |
string |
#ffffff |
The fill color of the label. |
outlineColor |
string |
#000000 |
The outline color of the label. |
outlineWidth |
number |
1 |
The outline width of the label. |
pixelOffset |
number[] |
0,0 |
The number of pixels up and to the right to place the label. |
horizontalOrigin |
string |
LEFT |
The horizontal location of an origin relative to an object. For example, LEFT will place the label on the right of the point. Possible values are |
verticalOrigin |
string |
CENTER |
The vertical location of an origin relative to an object. For example, TOP will place the label above the point. Possible values are |
TableStyleMapSymbolTraits | |||
legendTitle |
string |
The enumerated value to map to a color. |
LabelSymbolTraits
Trait | Type | Default | Description |
---|---|---|---|
labelColumn |
string |
ID of column to use as label |
|
font |
string |
30px sans-serif |
Font CSS string. Default is |
style |
string |
FILL |
Label style. Possible values are |
scale |
number |
1 |
The scale of the label. The scale is multiplied with the pixel size of the label's text. |
scaleByDistance |
ScaleByDistanceTraits |
Scales a point, billboard or label feature by its distance from the camera. |
|
disableDepthTestDistance |
number |
The distance from camera at which to disable depth testing, for example to prevent clipping of features againts terrain. Set to a very large value like 99999999 to disable depth testing altogether. When not defined or set to 0, depth testing is always applied. |
|
fillColor |
string |
#ffffff |
The fill color of the label. |
outlineColor |
string |
#000000 |
The outline color of the label. |
outlineWidth |
number |
1 |
The outline width of the label. |
pixelOffset |
number[] |
0,0 |
The number of pixels up and to the right to place the label. |
horizontalOrigin |
string |
LEFT |
The horizontal location of an origin relative to an object. For example, LEFT will place the label on the right of the point. Possible values are |
verticalOrigin |
string |
CENTER |
The vertical location of an origin relative to an object. For example, TOP will place the label above the point. Possible values are |
TableStyleMapSymbolTraits | |||
legendTitle |
string |
The enumerated value to map to a color. |
TablePointSizeStyleTraits
Trait | Type | Default | Description |
---|---|---|---|
pointSizeColumn |
string |
The column to use to size points. This column must be of type |
|
nullSize |
number |
9 |
The point size, in pixels, to use when the column has no value. |
sizeFactor |
number |
14 |
The size, in pixels, of the point is:
|
sizeOffset |
number |
10 |
The size, in pixels, of the point is:
|
TableChartStyleTraits
Trait | Type | Default | Description |
---|---|---|---|
xAxisColumn |
string |
The column to use as the X-axis. |
|
lines |
TableChartLineStyleTraits[] |
Lines on the chart, each of which is formed by plotting a column as the Y-axis. |
TableChartLineStyleTraits
Trait | Type | Default | Description |
---|---|---|---|
name |
string |
Chart line name (will replace y-column name). |
|
yAxisColumn |
string |
The column to use as the Y-axis. |
|
yAxisMinimum |
number |
The minimum value to show on the Y axis of the chart. |
|
yAxisMaximum |
number |
The maximum value to show on the Y axis of the chart. |
|
color |
string |
The color of the line. If not specified, a unique color will be assigned automatically. |
|
isSelectedInWorkbench |
boolean |
true |
The selection state of the line in the workbench. |
TableTimeStyleTraits
Trait | Type | Default | Description |
---|---|---|---|
timeColumn |
string |
The column that indicates the time of a sample or the start time of an interval. |
|
endTimeColumn |
string |
The column that indicates the end time of an interval. |
|
idColumns |
string[] |
The columns that identify an entity as it changes over time. |
|
isSampled |
boolean |
True if the rows in this CSV correspond to "sampled" data, and so the feature position, color, and size should be interpolated to produce smooth animation of the features over time. If False, then times are treated as the start of discrete periods and feature positions, colors, and sizes are kept constant until the next time. This value is ignored if the CSV does not have both a time column and an ID column. |
|
displayDuration |
number |
Display duration for each row in the table, in minutes. |
|
spreadStartTime |
boolean |
Indicates if start time of feature should be "spread" so that all features are displayed at the earliest time step. This is useful for non-contiguous sensor data. If true, the earliest time step will display the earliest values for all features (eg sensor IDs) - even if the time value is after the earliest time step. This means that at time step 0, all features will be displayed. |
|
spreadFinishTime |
boolean |
Indicates if finish time of feature should be "spread" so that all features are displayed at the latest time step. See also |