layer.ospp

Layer property

type

object

properties

  • clusteringType

Clustering contained in the layer.

Default value is [“MEDIUM”]

type

string

enum

NONE, VERY_CLOSE, CLOSE, MEDIUM, FAR, VERY_FAR

default

MEDIUM

  • description

The layer description to describe what is represented here.

type

string

  • icons

Allowed icons on this layer.

Default value is [[]]

type

array

default

items

type

string

  • isTemplateGeneratedByOspComposer

Name of the playbook that generated this file. If present, the file is managed by the Composer and may be overwritten on regeneration. Used for selective clean. Do not edit or set manually.

type

string

  • layerType

The type of this layer.

type

string

enum

STANDARD, SEVERITY, ICON

  • mapSources

The map sources for this layer.

type

array

items

oneOf

STATIC

COLLECTIONS

ALARMS

  • name

The layer name.

type

string

  • templateId

The id of the template to use for this file

type

string

  • templateVariables

The variables and their values to be replaced from the template

type

object

additionalProperties

  • valueType

The type of the values contained in the layer.

type

string

enum

POINT, LINE, POLYGON

  • variablesFiles

The variables files to use to replace the variables. The first file of the list will take precedence over the following one. Template variables take precedence over the contents of the files.

type

array

items

type

string

additionalProperties

False

STATIC

type

object

properties

  • type

type

string

enum

STATIC

default

STATIC

  • linkedValues

Values linked to this static source.

type

array

items

type

string

  • severityConfigurations

Severity values linked to this static source.

type

array

items

SeverityConfiguration

additionalProperties

False

SeverityConfiguration

type

object

properties

  • count

The itemId of the alarm count.

type

string

  • dashboard

The itemId of the dashboard to display on click.

type

string

  • severity

The itemId of the alarm severity.

type

string

additionalProperties

False

COLLECTIONS

type

object

properties

  • type

type

string

enum

COLLECTIONS

default

COLLECTIONS

  • collectionSource

Collection source (schema.ospp) identifier for dynamic collection sources.

type

string

  • displayRules

Display rules necessary if not only standard points for dynamic collection sources.

type

array

items

DisplayRule

  • filter

Filter references for dynamic sources this list of filters are the ones to use from the schema.ospp.

type

array

items

type

string

  • geometry

Geometry field in the collection corresponding to the GeoJson field that will be usable.

type

string

additionalProperties

False

DisplayRule

type

object

properties

  • iconName

Icon name used by this rule.

type

string

  • visibleExpression

Expression defining if this icon is visible.

type

string

additionalProperties

False

ALARMS

type

object

properties

  • type

type

string

enum

ALARMS

default

ALARMS

  • displayRules

Display rules for icons only. Those rules apply on the field available in the alarms (serial, severity, acknowledged …).

type

array

items

DisplayRule

  • filter

Those are the filter.ospp files used by alarms. Declaring those filter here means they will be usable on this layer.

type

array

items

type

string

  • geometry

Geometry path for dynamic sources in the alarms database (for example additionalData.geomtery).

type

string

  • view

View reference for dynamic alarms sources.

type

string

additionalProperties

False