Table of Contents | ||
---|---|---|
|
Vector products are accessible through the GIBS WMTS and WMS visualization services. WMTS responses are formatted as gzip-compressed Mapbox vector tiles (specification), or "MVTs", while WMS responses are available as raster images.
The data behind each visualization service is the same, however the mechanism for styling differs. A client application is responsible for applying styling to MVTs when using the WMTS API. Conversely, GIBS applies a default style when rendering vector data as a raster when using the WMS API. See the Vector Layer Styles section below for more information.
An MVT returned via the WMTS service contains information for a client to draw the features within the user interface, but also a set of properties that contain data associated with the feature. The Mapbox vector tile specification provides structure for representing these dataThe Mapbox vector tile specification provides structure for including data values as properties associated with a feature, but no mechanism for interpreting the meaning or intended use. As such, additional metadata is required. GIBS has developed a specification for defining each property contained within MVTs in its vector products. See the Vector Layer Metadata section below for more information.
The following sections provide examples for how to detect and interact with vector products within the GIBS WMTS and WMS services
As mentioned previously, the Mapbox vector tile specification provides structure for representing these data, but no mechanism for interpreting the meaning or intended use. As such, GIBS has developed the following specification for defining each property contained within MVTs in its vector products. Each vector product has an associated associated JSON vector layer metadata file which provides the following information:
Note |
---|
Insert link to JSON schema when it's available via link. For how, it's attached here. |
The following table outlines the content of the GIBS vector metadata specification.
Name | Description | Type | Required? |
---|
Sample Value | ||||
---|---|---|---|---|
Identifier | The unique identifier of the MVT property. | String | FRP | |
Title | A human readable title for the property. | String | Fire Radiative Power | |
Description | A human readable description for the property. | String | A measure of the rate of radiant heat output from a fire. | |
Units | The units value to be applied to the actual value of this property. | String | MW | |
DataType | The data type of this property. | Enumeration | float | |
ValueList | A listing of the possible valid values for a 'string' property type, if the property has a controlled list. | Array | Only one may be used | [ "Lake Ice", "Sea Ice", "Not Ice" ] |
ValueRanges | A listing of mutually exclusive min and max value pairs representing ranges of valid values for the 'Integer', 'float', and 'datetime' property types. | Array of Objects | [ { "Min": 0, "Max": 99999999 } ] | |
ValueMap | A map of the possible valid values for 'string' or 'int' property types, and their associated description. This facilitates a key-value lookup table allowing for a simplified property value (i.e. the ‘key’). | Object | { 10 : “Processed Fire Pixel”, 20 : “Saturated Fire Pixel” } | |
Function | The property’s intended function as a part of the visualization product. | Enumeration | Describe | |
IsOptional | Indicates whether the property is optional. | Boolean | true | |
IsLabel | Indicates whether the property should be used to label the point in a user interface. | Boolean | true |
The following "business logic" rules are applied :
UI Expand | ||
---|---|---|
| ||
Description The property’s intended function as a part of the visualization product. Possible functions include:
Sample Value “Identify” |
A vector layer metadata file is a list of content blocks defining each property. The following snippet shows an example of a single property's definition within the vector layer metadata file.
Code Block | ||||
---|---|---|---|---|
| ||||
{ "Identifier" : "NumReactor", "Title" : "Number of Reactors", "Description": "Number of Active Reactors at a given Plant", "Units" : "Reactors", "DataType" : "int", "ValueRanges": [ { "Min": 1, "Max": 9 } ], "Function" : "Style", "IsOptional" : false, "IsLabel" : false } |
The following block provides a full example of a vector layer metadata file.
Code Block | ||||||
---|---|---|---|---|---|---|
| ||||||
{ "id": "Nuclear_Power_Plant_Locations", "mvt_properties": [ { "Identifier" : "Plant", "Title" : "Plant Site Name", "Description": "Name of Nuclear Plant", "DataType" : "string", "Function" : "Identify", "IsOptional" : false, "IsLabel" : true }, { "Identifier" : "NumReactor", "Title" : "Number of Reactors", "Description": "Number of Active Reactors at a given Plant", "Units" : "Reactors", "DataType" : "int", "ValueRanges": [ { "Min": 1, "Max": 9 } ], "Function" : "Style", "IsOptional" : false, "IsLabel" : false }, { "Identifier" : "p10_30", "Title" : "Population within 30km (2010)", "Description": "Total population within a 30km radius of the nuclear plant (2010)", "Units" : "Persons", "DataType" : "int", "ValueRanges": [ { "Min": 275, "Max": 7170590 } ], "Function" : "Describe", "IsOptional" : false, "IsLabel" : false } } |
Stuff...
UI Expand | ||
---|---|---|
| ||
Description The unique identifier of the MVT property. Sample Value “FRP” |
UI Expand | ||
---|---|---|
| ||
Description The unique identifier of the MVT property. Sample Value “FRP” |
UI Expand | ||
---|---|---|
| ||
Description A human readable description for the property written using HTML notation. Newlines within the markdown must be escaped. This value is used for informational dialogues. Sample Value “The Fire Radiative Power (FRP) is a measure of the rate of radiant heat output from a fire. It has been demonstrated in small-scale experimental fires that the FRP of a fire is related to the rate at which fuel is being consumed (Wooster et al., 2005) and smoke emissions released (Freeborn et al., 2008).” |
UI Expand | ||
---|---|---|
| ||
Description An optional units value to be applied to the actual value of this property. Sample Value “MW” |
title | Data Type |
---|
Description
The data type of this property. Valid values include:
Sample Value
“double”
UI Expand | |||||||||||||||
---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| |||||||||||||||
|
title | Function |
---|
Description
The property’s intended function as a part of the visualization product. Possible functions include:
Sample Value
“Identify”
UI Expand | ||
---|---|---|
| ||
Description Indicates whether the property is optional. Sample Value True |
UI Expand | ||
---|---|---|
| ||
Description Indicates whether the property should be used to label the point in a user interface. Sample Value True |
Hide comments |
---|