YDYRCatalogFunction

"type": "ydyr"

YDYRCatalogFunctionTraits

Trait	Type	Default	Description
CatalogFunctionTraits
`parameters`	`any`		Function parameters (only contains key-value pairs).
CatalogMemberTraits
`name`	`string`		The name of the catalog item.
`description`	`string`	`Your Data Your Regions (YDYR) is an API for the conversion of data between different Australian geographic boundaries. See ydyr.info for more information`	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.
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.