TerriaJS JSON (function)

Note

This page is automatically generated from the source code, and is a bit rough. If you have trouble, check the source code for this type or post a message to the forum.

A CatalogFunction that issues an HTTP GET to a service with a set of query parameters specified by the TerriaJsonCatalogFunction's inputs property, and expects to receive back TerriaJS catalog/share JSON.

When this CatalogFunction is added to the catalog, TerriaJS automatically creates a user interface for it based on the inputs. When the user clicks "Run Analysis", it issues an HTTP GET with the user-specified inputs supplied as part of the query string. The returned TerriaJS catalog/share JSON can add items to the workbench, configure the catalog, change the camera view, and more.

Example:

{
  "name": "Simple Example",
  "type": "terria-json",
  "url": "https://putsreq.com/PK2GvS6jHfWhlBmkadrG",
  "inputs": [
    {
      "id": "position",
      "type": "point",
      "name": "Position",
      "description": "The position to pass to the service.",
      "formatter": "longitudeCommaLatitude"
    },
    {
      "id": "someOtherParameter",
      "type": "string",
      "name": "Some Other Parameter",
      "description": "This is another parameter that will be passed to the service."
    }
  ]
}

For this CatalogFunction TerriaJS will present a user interface with two elements: a position on the map and a string. When invoked, TerriaJS will GET a URL like: https://putsreq.com/PK2GvS6jHfWhlBmkadrG?position=151.0%2C-33.0&someOtherParameter=some%20text

The service is expected to return JSON using the application/json content type, and have a body with any of the following:

  • A single catalog member

For example:

{
  "type": "csv",
  "data": "POSTCODE,value\n2000,1"
}

The catalog member will be added to the catalog inside a catalog group directly below this CatalogFunction. Catalog items will also be added to the workbench unless isEnabled is explicitly set to false.

If the catalog item does not have a name, as in the above example, its name will be the name of this CatalogFunction followed by the date and time it was invoked in ISO8601 format. If the catalog item does not have a description, it will be given a description explaining that this is the result of executing a service and will include the input parameters sent to the service.

  • An array of catalog members

An array of catalog members as described above.

For example:

[
  {
    "type": "csv",
    "data": "POSTCODE,value\n2000,1"
  },
  {
    "name": "My Result WMS Layer",
    "type": "wms",
    "url": "http://ereeftds.bom.gov.au/ereefs/tds/wms/ereefs/mwq_gridAgg_P1A",
    "layers": "Chl_MIM_mean"
  }
]
  • A catalog file

For example:

{
  "catalog": [
    {
      "name": "National Datasets",
      "type": "group",
      "items": [
        {
          "name": "My Result WMS Layer",
          "type": "wms",
          "url": "http://ereeftds.bom.gov.au/ereefs/tds/wms/ereefs/mwq_gridAgg_P1A",
          "layers": "Chl_MIM_mean",
          "isEnabled": true
        }
      ]
    }
  ],
  "initialCamera": {
    "west": 141.0,
    "south": -26.0,
    "east": 157.0,
    "north": -9.0
  }
}

Please note that in this case, catalog items are not automatically enabled or named. The name property is required. If isEnabled is not set to true, the catalog item will not appear on the workbench.

  • Share data

Similar to the above except that it allows multiple init sources (catalog files) and has a version property for backward compatibility. For example:

{
  "version": "0.0.05",
  "initSources": [
    {
      "catalog": [
        {
          "name": "National Datasets",
          "type": "group",
          "items": [
            {
              "name": "My Result WMS Layer",
              "type": "wms",
              "url": "http://ereeftds.bom.gov.au/ereefs/tds/wms/ereefs/mwq_gridAgg_P1A",
              "layers": "Chl_MIM_mean",
              "isEnabled": true
            }
          ]
        }
      ],
    },
    {
      "initialCamera": {
        "west": 141.0,
        "south": -26.0,
        "east": 157.0,
        "north": -9.0
      }
    }
  ]
}

Initialization File properties:

"type": "terria-json"

cacheDuration

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

customProperties

The dictionary of custom item properties.

description

The description of the item.

forceProxy

Gets or sets whether or not this member should be forced to use a proxy. This property is not observable.

hideSource

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

id

An optional unique id for this member, that is stable across renames and moves. Use uniqueId to get the canonical unique id for this CatalogMember, which is present even if there is no id.

info

The array of section titles and contents for display in the layer info panel. In future this may replace 'description' above - this list should not contain sections named 'description' or 'Description' if the 'description' property is also set as both will be displayed. The object is of the form {name:string, content:string}. Content will be rendered as Markdown with HTML.

infoSectionOrder

The array of section titles definining the display order of info sections. If this property is not defined, DataPreviewSections's DEFAULT_SECTION_ORDER is used.

initialMessage

A message object that is presented to the user when an item or group is initially clicked The object is of the form {title:string, content:string, key: string, confirmation: boolean, confirmText: string, width: number, height: number}.

isHidden

A value indicating whether this item is hidden from the catalog. This property is observable.

isLoading

A value indicating whether the group is currently loading. This property is observable.

isPromoted

A value indicating whether this item is kept above other non-promoted items.

isUserSupplied

A value indicating whether this member was supplied by the user rather than loaded from one of the Terria's initSources. User-supplied members must be serialized completely when, for example, serializing enabled members for sharing.

isWaitingForDisclaimer

Whether this catalog member is waiting for a disclaimer to be accepted before showing itself.

name

The name of the item.

nameInCatalog

The name of this catalog member in the catalog. By default this is just name, but can be overridden.

shareKeys

An array of all possible keys that can be used to match to this catalog member when specified in a share link - used for maintaining backwards compatibility when adding or changing CatalogMember's id.

shortReport

A short report to show on the now viewing tab.

url

The URL of the REST server.