catalogItem.json

{
  "type": "object",
  "defaultProperties": [
    "name",
    "type",
    "url"
  ],
  "properties": {
    "rectangle": {
      "type": "array",
      "title": "#Rectangle",
      "description": "The geographic rectangle (extent or bounding box) containing this data item.",
      "format": "table",
      "items": {
        "type": [
          "number",
          "string"
        ]
      },
      "options": {
        "collapsed": true,
        "disable_array_reorder": true
      },
      "maxItems": 4,
      "minItems": 2
    },
    "legendUrl": {
      "type": "string",
      "title": "#Legend URL",
      "description": "The URL of the legend for this data item, or undefined if this data item does not have a legend."
    },
    "url": {
      "type": "string",
      "title": "#URL",
      "description": "The URL of this data."
    },
    "dataCustodian": {
      "type": "string",
      "title": "#Data custodian",
      "description": "A description of the custodian of this data item.\nThis property is an HTML string that must be sanitized before display to the user."
    },
    "metadataUrl": {
      "type": "string",
      "title": "#Metadata URL",
      "description": "The URL from which this data item's metadata description can be retrieved, or undefined if\nmetadata is not available for this data item.  The format of the metadata depends on the type of data item.\nFor example, Web Map Service (WMS) data items provide their metadata via their GetCapabilities document."
    },
    "isEnabled": {
      "type": "boolean",
      "title": "#Is enabled",
      "description": "A value indicating whether this data item is enabled.  An enabled data item appears in the\n\"Now Viewing\" pane, but is not necessarily shown on the map.",
      "format": "checkbox"
    },
    "isShown": {
      "type": "boolean",
      "title": "#Is shown",
      "description": "A value indicating whether this data item is currently shown on the map.  In order to be shown,\nthe item must also be enabled.",
      "format": "checkbox"
    },
    "isLegendVisible": {
      "type": "boolean",
      "title": "#Is legend visible",
      "description": "A value indicating whether the legend for this data item is currently visible.",
      "format": "checkbox"
    },
    "isLoading": {
      "type": "boolean",
      "title": "#Is loading",
      "description": "A value indicating whether this data source is currently loading.",
      "format": "checkbox"
    },
    "isMappable": {
      "type": "boolean",
      "title": "#Is mappable",
      "description": "A value indicating whether this data source is mappable and should therefore show a checkbox.",
      "format": "checkbox"
    },
    "showsInfo": {
      "type": "boolean",
      "title": "#Shows info",
      "description": "A value indicating whether this data source should show an info icon.",
      "format": "checkbox"
    },
    "nowViewingMessage": {
      "type": "string",
      "title": "#Now viewing message",
      "description": "A message to show when this item is enabled for the first time in order to call attention to the Now Viewing panel."
    },
    "featureInfoTemplate": {
      "type": "string",
      "title": "#Feature info template",
      "description": "A template to display message in a info box."
    },
    "maximumShownFeatureInfos": {
      "type": "number",
      "title": "#Maximum shown feature infos",
      "description": "The maximum number of features whose information can be shown at one time in the FeatureInfoPanelViewModel, from this item.\nDefaults to terria.configParameters.defaultMaximumShownFeatureInfos"
    },
    "dataUrl": {
      "type": "string",
      "title": "#Data URL",
      "description": "The URL from which this data item's raw data can be retrieved, or undefined if raw data for\nthis data item is not available."
    },
    "dataUrlType": {
      "type": "string",
      "title": "#Data URL type",
      "description": "The type of the {@link CatalogItem#dataUrl}, or undefined if raw data for this data\nsource is not available.\nValid values are:\n * `direct` - A direct link to the data.\n * `wfs` - A Web Feature Service (WFS) base URL.  If {@link CatalogItem#dataUrl} is not\n           specified, the base URL will be this data item's URL.\n * `wfs-complete` - A complete, ready-to-use link to download features from a WFS server.\n * `none` - There is no data link."
    }
  },
  "description": "A data item in a {@link CatalogGroup}.",
  "title": "",
  "allOf": [
    {
      "$ref": "CatalogMember.json"
    }
  ]
}