Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Code Block
titleExample of a dataset with advanced displayOptions
collapsetrue
{
    "name": "roads_dwh",
    "type": "dataset",
    "title": "Roads",
    "properties": {
        "featureTitle": {
            "type": "property",
            "value": "id"
        }
    },
    "ref": {
        "type": "dwh",
        "subtype": "geometryLine",
        "geometry": "roads-9gzct7",
        "visualizations": [
            {
                "type": "line"
            }
        ],
        "table": "roads_1",
        "primaryKey": "id",
        "categorizable": true,
        "fullTextIndex": true,
        "properties": [
            {
                "name": "id",
                "title": "id",
                "column": "id",
                "type": "string",
                "filterable": false
            },
            {
                "name": "surface",
                "title": "surface",
                "column": "surface",
                "type": "string",
                "filterable": true,
                "displayOptions": {
                    "valueOptions": [
                        {
                            "value": "green",
                            "color": "green"
                        },
                        {
                            "value": "lime",
                            "color": "lime"
                        },
                        {
                            "value": "yellow",
                            "color": "yellow"
                        },
                        {
                            "value": "orange",
                            "color": "orange"
                        },
                        {
                            "value": "red",
                            "color": "red"
                        }
                    ]
                }
            },
            {
                "name": "road_class",8ac314a472a91c42bfbeac9cf90a30aa
                "title": "road_class",
                "column": "road_class",
                "type": "string",
                "filterable": true,
                "displayOptions": {
                    "valueOptions": [
                        {
                            "value": "solid",
                            "pattern": "solid"
                        },
                        {
                            "value": "longdash",
                            "pattern": "longdash"
                        },
                        {
                            "value": "dash",
                            "pattern": "dash"
                        },
                        {
                            "value": "dotdash",
                            "pattern": "dotdash"
                        },
                        {
                            "value": "dot",
                            "pattern": "dot"
                        }
                    ]
                }
            },
            {
                "name": "traffic",
                "title": "traffic",
                "column": "traffic",
                "type": "string",
                "filterable": true,
                "displayOptions": {
                    "valueOptions": [
                        {
                            "value": "1",
                            "weight": 1.0
                        },
                        {
                            "value": "2",
                            "weight": 2.0
                        },
                        {
                            "value": "3",
                            "weight": 3.0
                        },
                        {
                            "value": "4",
                            "weight": 4.0
                        },
                        {
                            "value": "5",
                            "weight": 5.0
                        }
                    ]
                }
            },
            {
                "name": "y_min",
                "title": "y_min",
                "column": "y_min",
                "type": "decimal(19,16)",
                "filterable": false
            },
            {
                "name": "y_max",
                "title": "y_max",
                "column": "y_max",
                "type": "decimal(19,16)",
                "filterable": false
            },
            {
                "name": "x_min",
                "title": "x_min",
                "column": "x_min",
                "type": "decimal(19,16)",
                "filterable": false
            },
            {
                "name": "x_max",
                "title": "x_max",
                "column": "x_max",
                "type": "decimal(19,16)",
                "filterable": false
            }
        ]
    }
}

...

KeyTypeOptionalityDescriptionConstraints
datasetstring

Status
colourRed
titlerequired

URL link to a dataset object representing the markers/rest/projects/$projectId/md/datasets?name={datasetName}
markersarray
Status
colourRed
titlerequired
an array of marker objects
linkedLayersarray
Status
colourGreen
titleoptional
an array of objects specifying layers linked to the marker category
itemIdstring
Status
colourRed
titlerequired
Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId 7537131 section.[a-z0-9]{32}

There are two rules surrounding marker selector categories to note:

...

KeyTypeOptionalityDescriptionConstraints
markerstring

Status
colourRed
titlerequired

URI link to a marker object representing marker in a category/rest/projects/$projectId/md/markers?name={markerName}
visibleboolean
Status
colourRed
titlerequired

sets the default visibility of the marker

default = true

[true, false]

addOnExpandboolean
Status
colourGreen
titleoptional

specifies if the marker should become visible after clicking on the category, when by default it is set to visible = false

[true, false]
itemIdstring
Status
colourRed
titlerequired
Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId 7537131 section.[a-z0-9]{32}

content.categories.linkedLayers

...

KeyTypeOptionalityDescriptionConstraints
datasetstring

Status
colourRed
titlerequired

URL link to a dataset object representing the linked layers/rest/projects/$projectId/md/datasets?name={datasetName}
stylearray
Status
colourGreen
titleoptional

specifies the style of the layer

[outline, outline_black, line_red_1, line_red_3, line_red_5]

visibleboolean
Status
colourGreen
titleoptional
sets the default visibility of the layer[true, false]
itemIdstring
Status
colourRed
titlerequired
Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId 7537131 section.[a-z0-9]{32}

content.granularityCategories.granularityCategory

KeyTypeOptionalityDescriptionConstraints
datasetstring

Status
colourRed
titlerequired

URL link to a dataset object representing the linked granularities/rest/projects/$projectId/md/datasets?name={datasetName}
splitPropertyNamestring
Status
colourRed
titlerequired
dataset property, by which the marker will be filtered{datasetProperty}
styleTypestring
Status
colourRed
titlerequired
type of the visualization style[color, pattern, weight]
itemIdstring
Status
colourRed
titlerequired
Generated ID for this item to be used for matching it within a parent array while rebasing share objects. For more details see content.**.itemId 7537131 section.[a-z0-9]{32}

content.keepFiltered

...