WebProcessingServiceCatalogFunctionJob

"type": "wps-result"

WebProcessingServiceCatalogJobTraits

Trait	Type	Default	Description
`wpsParameters`	`WPSParameterTraits[]`		Parameter names & values for this result item
`wpsResponse`	`any`		The WPS response object
`geojsonFeatures`	`any`		Geojson feature collection of input features.
`wpsResponseUrl`	`string`		WPS response URL
AttributionTraits
`attribution`	`string`		The attribution to display with the data.
CatalogFunctionJobTraits
`refreshInterval`	`number`	`2`	How often the job will poll for results, in seconds. (This overrides `AutoRefreshingTraits`)
`refreshEnabled`	`boolean`		Toggle for enabling auto refresh. (This overrides Trait in AutoRefreshingTraits)
`logs`	`string[]`		Job logs.
`jobStatus`	`string`	`inactive`	Job status.
`downloadedResults`	`boolean`		Downloaded results.
CatalogFunctionTraits
`parameters`	`any`		Function parameters (only contains key-value pairs).
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`	`Job is inactive`	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.
`shareable`	`boolean`	`true`	True (default) if this catalog member may be included in share links. False to exclude it from share links.
GroupTraits
`excludeMembers`	`string[]`		An array of strings of excluded group and item names (or ids). A group or item name (or id) that appears in this list will not be shown to the user. This is case-insensitive and will also apply to all child/nested groups
`includeMembersRegex`	`string`		A regular expression that is matched against the member names and ids. Only members (groups and items) that match against the regular expression will be shown to the user. This is case-insensitive and will only apply to the first level of members (not in nested groups). This is applied before excludeMembers.
`isOpen`	`boolean`		True if this group is open and its contents are visible; otherwise, false.
`mergeGroupsByName`	`boolean`		Merge member groups by name.
`sortMembersBy`	`string`		Sort members by the given property/trait. For example `name`, will sort all members by alphabetically
`members`	`ModelReference`		The members of this group.
`displayGroup`	`boolean`		Allow adding all members to the workbench with one click. Show Add All / Remove All button
ItemPropertiesTraits
`itemProperties`	`any`		Sets traits on group member items (note - will not set traits to sub-groups). This applies to all nested group members (eg members in sub-groups). Also see `itemPropertiesByType` and `itemPropertiesByIds`. Item properties will be set in the following order (highest to lowest priority) `itemPropertiesByIds`, `itemPropertiesByType`, `itemProperties`.
`itemPropertiesByType`	`ItemPropertiesByTypeTraits[]`		Sets traits on group member items by model `type` (eg `csv` or `geojson`). This applies to all nested group members (eg members in sub-groups). Only one `itemProperties` can be specified per `type`. Item properties will be set in the following order (highest to lowest priority) `itemPropertiesByIds`, `itemPropertiesByType`, `itemProperties`.
`itemPropertiesByIds`	`ItemPropertiesByIdTraits[]`		Sets traits on group member items by model `ID`. This applies to all nested group members (eg members in sub-groups). Only one `itemProperties` can be specified per `id`. Item properties will be set in the following order (highest to lowest priority) `itemPropertiesByIds`, `itemPropertiesByType`, `itemProperties`.
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.
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).
WebProcessingServiceCatalogFunctionTraits
`executeWithHttpGet`	`boolean`		If true, sends a `GET` request to the Execute endpoint instead of the default `POST` request.
`storeSupported`	`boolean`		Indicates if the output can be stored by the WPS server and be accessed via a URL.
`statusSupported`	`boolean`		Indicates if Execute operation can return just the status information and perform the actual operation asynchronously.
`identifier`	`string`		The identifier for the process
`forceConvertResultsToV8`	`boolean`		If true, then all results will be converted from v7 to v8. If false, then the `result.version` string will be checked to see if conversion is necessary.

WPSParameterTraits

Trait	Type	Description
`inputIdentifier`	`string`	WPS input parameter identifier
`inputValue`	`string`	WPS input parameter value
`inputType`	`string`	WPS input parameter type

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)

ItemPropertiesByTypeTraits

Trait	Type	Default	Description
`type`	`string`		The type of model to apply `itemProperties` to. This must be defined.
`itemProperties`	`any`		Sets traits on group member items of specified `type`. This applies to all nested group members (eg members in sub-groups)

ItemPropertiesByIdTraits

Trait	Type	Default	Description
`ids`	`string[]`		The IDs of models to apply `itemProperties` to.
`itemProperties`	`any`		Sets traits on group member items of specified `id`. This applies to all nested group members (eg members in sub-groups)

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.