Skip to content

MapboxVectorTileCatalogItem

"type": "mvt"

MapboxVectorTileCatalogItemTraits

Trait Type Default Description
lineColor string

This property exists for backward compatibility. The outline color of the features, specified as a CSS color string. This will only be used if layer trait has been set. For more complex styling - see style trait.
fillColor string

This property exists for backward compatibility. The fill color of the features, specified as a CSS color string. This will only be used if layer trait has been set. For more complex styling - see style trait.
layer string

This property exists for backward compatibility. It can be used to only show a particular layer in the tileset.
style any

JSON style spec for MVT. This supports subset of Mapbox style spec (https://docs.mapbox.com/mapbox-gl-js/style-spec/layers/).

For supported properties - refer to https://github.com/protomaps/protomaps.js/blob/master/src/compat/json_style.ts.

For example:

{
  "layers": [
    {
      "type": "fill",
      "source-layer": "buildings",
      "paint": {
        "fill-color": "black"
      }
    },
    {
      "type": "line",
      "source-layer": "buildings",
      "paint": {
        "line-color": "red",
        "line-width": 1
      }
    },
    {
      "type": "symbol",
      "source-layer": "places",
      "layout": {
        "text-size": 20,
        "text-font": "sans-serif"
      },
      "paint": {
        "text-color": "red"
      }
    }
  ]
}
styleUrl string

URL to JSON file for styling. See style trait for more info.
idProperty string FID

The name of the property that is a unique ID for features.
nameProperty string

The name of the property from which to obtain the name of features.
maximumNativeZoom number 12

The maximum zoom level for which tile files exist.
maximumZoom number 28

The maximum zoom level that can be displayed by using the data in the MapboxVectorTileCatalogItem#maximumNativeZoom tiles.
minimumZoom number

The minimum zoom level for which tile files exist.
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

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.
FeaturePickingTraits
allowFeaturePicking boolean true

Indicates whether features in this catalog item can be selected by clicking them on the map.
ImageryProviderTraits
leafletUpdateInterval number

Update a tile only once during this interval when the map is panned. Value should be specified in milliseconds.
tileErrorHandlingOptions TileErrorHandlingTraits

Options for handling tile errors
clipToRectangle boolean true

Gets or sets a value indicating whether this dataset should be clipped to the {@link CatalogItem#rectangle}. If true, no part of the dataset will be displayed outside the rectangle. This property is true by default, leading to better performance and avoiding tile request errors that might occur when requesting tiles outside the server-specified rectangle. However, it may also cause features to be cut off in some cases, such as if a server reports an extent that does not take into account that the representation of features sometimes require a larger spatial extent than the features themselves. For example, if a point feature on the edge of the extent is drawn as a circle with a radius of 5 pixels, half of that circle will be cut off.
minimumLevel number

The minimum level-of-detail supported by the imagery provider. Take care when specifying this that the number of tiles at the minimum level is small, such as four or less. A larger number is likely to result in rendering problems
maximumLevel number

The maximum level-of-detail supported by the imagery provider, or undefined if there is no limit
tileWidth number 256

Tile width in pixels. Default value is 256 pixels
tileHeight number 256

Tile height in pixels. Default value is 256 pixels
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

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.
OpacityTraits
opacity number 0.8

The opacity of the item.
disableOpacityControl boolean

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

If true, splitter funcitonality will be hidden for this model.
UrlTraits
url string

The base URL of the file or service.
forceProxy boolean true

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 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 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, id will be used)

TileErrorHandlingTraits

Trait Type Default Description
thresholdBeforeDisablingItem number

The number of tile failures before disabling the item.
treat403AsError boolean

Indicates whether a 403 response code when requesting a tile should be treated as an error. If false, 403s are assumed to just be missing tiles and need not be reported to the user.
treat404AsError boolean

Indicates whether a 404 response code when requesting a tile should be treated as an error. If false, 404s are assumed to just be missing tiles and need not be reported to the user.
ignoreUnknownTileErrors boolean

A flag indicating whether non-specific (no HTTP status code) tile errors should be ignored. This is a last resort, for dealing with odd cases such as data sources that return non-images (eg XML) with a 200 status code. No error messages will be shown to the user.

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 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 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 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 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.