Skip to content

ArcGisPortalItemReference

"type": "arcgis-portal-item"

ArcGisPortalItemTraits

Trait Type Default Description
itemId string

The ID of the portal item.

ArcGisPortalSharedTraits
itemProperties any

An object of properties that will be set on the item created from the CKAN resource.

supportedFormats ArcGisPortalItemFormatTraits[]

The supported formats and their mapping to Terria types. These are listed in order of preference.

AttributionTraits
attribution string

The attribution to display with the data.

CatalogMemberReferenceTraits
name string

The name to use for this catalog member before the reference is loaded.

description string

The description to use for this catalog member before the reference is loaded. Markdown and HTML may be used.

dataCustodian string

Gets or sets a description of the custodian of this data item.

isGroup boolean

Is the target of this reference expected to be a catalog group?

isFunction boolean

Is the target of this reference expected to be a catalog function?

isMappable boolean

Is the target of this reference expected to have map items?

isChartable boolean

Is the target of this reference expected to have chart items?

MappableTraits
rectangle RectangleTraits

The bounding box rectangle that contains all the data in this catalog item.

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.

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.

ReferenceTraits
isOpenInWorkbench boolean true

Whether the item in the workbench open or collapsed.

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 0d

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

ArcGisPortalItemFormatTraits

Trait Type Default Description
id string

The ID of this items format.

urlRegex any

A regular expression that is matched against the items url.

formatRegex string

A regular expression that is matched against the item format.

definition any

The catalog member definition to use when the URL and Format regular expressions match. The URL property will also be set.

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.

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.