insula

Vector feature property Schema

https://cgi-italy.github.io/insula/schemas/v1.1.1/common/vector-feature-property.schema.json

Definition of a vector feature property

Abstract	Extensible	Status	Identifiable	Custom Properties	Additional Properties	Access Restrictions	Defined In
Can be instantiated	No	Unknown status	Unknown identifiability	Forbidden	Allowed	none	vector-feature-property.schema.json

Vector feature property Type

merged type (Vector feature property)

all of

• Vector feature property common attributes

• one (and only one) of

  • Vector feature string property

  • Boolean feature attribute

  • Numeric feature attribute

  • Enum feature attribute

  • Date feature attribute

Vector feature property Examples

{
  "id": "numeric_property",
  "name": "Numeric property",
  "type": "number",
  "domain": {
    "min": 0,
    "max": 100
  },
  "filterable": true,
  "sortable": true
}

{
  "id": "string_property",
  "name": "String property",
  "type": "string",
  "filterable": true,
  "sortable": true
}

{
  "id": "enum_property",
  "name": "Enum property",
  "type": "enum",
  "domain": {
    "values": [
      {
        "value": 0,
        "label": "Zero",
        "color": "#FF0000"
      },
      {
        "value": 1,
        "label": "One",
        "color": "#00FF00"
      }
    ]
  },
  "filterable": true,
  "sortable": true
}

Vector feature property Definitions

Definitions group common

Reference this group by using

{"$ref":"https://cgi-italy.github.io/insula/schemas/v1.1.1/common/vector-feature-property.schema.json#/$defs/common"}

Property	Type	Required	Nullable	Defined by
id	string	Required	cannot be null	Vector feature property
name	string	Required	cannot be null	Vector feature property
description	string	Optional	cannot be null	Vector feature property
filterable	boolean	Optional	cannot be null	Vector feature property
sortable	boolean	Optional	cannot be null	Vector feature property
quantity	object	Optional	cannot be null	Vector feature property

id

The property id (e.g. column name)

id

• is required

• Type: string (Property identifier)

• cannot be null

• defined in: Vector feature property

id Type

string (Property identifier)

name

The property human readable title

name

• is required

• Type: string (Property title)

• cannot be null

• defined in: Vector feature property

name Type

string (Property title)

description

The property description

description

• is optional

• Type: string (Property description)

• cannot be null

• defined in: Vector feature property

description Type

string (Property description)

filterable

A flag indicating if filtering should be enabled for this property

filterable

• is optional

• Type: boolean (Property filtering flag)

• cannot be null

• defined in: Vector feature property

filterable Type

boolean (Property filtering flag)

filterable Default Value

The default value is:

true

sortable

A flag indicating if sorting should be enabled for this property

sortable

• is optional

• Type: boolean (Property sorting flag)

• cannot be null

• defined in: Vector feature property

sortable Type

boolean (Property sorting flag)

sortable Default Value

The default value is:

true

quantity

The quantity measured by a variable

quantity

• is optional

• Type: object (Measured quantity)

• cannot be null

• defined in: Vector feature property

quantity Type

object (Measured quantity)

quantity Examples

{
  "id": "area_m2",
  "name": "Area",
  "description": "Area in squared meters",
  "units": "m²"
}

Definitions group stringProperty

Reference this group by using

{"$ref":"https://cgi-italy.github.io/insula/schemas/v1.1.1/common/vector-feature-property.schema.json#/$defs/stringProperty"}

Property	Type	Required	Nullable	Defined by
type	string	Required	cannot be null	Vector feature property
subType	string	Optional	cannot be null	Vector feature property

type

type

• is required

• Type: string (String property type constant)

• cannot be null

• defined in: Vector feature property

type Type

string (String property type constant)

type Constraints

constant: the value of this property must be equal to:

"string"

subType

subType

• is optional

• Type: string (String property subtype)

• cannot be null

• defined in: Vector feature property

subType Type

string (String property subtype)

subType Constraints

enum: the value of this property must be equal to one of the following values:

Value	Explanation
"url"	The string should be interpreted as an URL
"imageUrl"	The string should be interpreted as an image URL

Definitions group booleanProperty

Reference this group by using

{"$ref":"https://cgi-italy.github.io/insula/schemas/v1.1.1/common/vector-feature-property.schema.json#/$defs/booleanProperty"}

Property	Type	Required	Nullable	Defined by
type	string	Required	cannot be null	Vector feature property

type

type

• is required

• Type: string (Boolean property type constant)

• cannot be null

• defined in: Vector feature property

type Type

string (Boolean property type constant)

type Constraints

constant: the value of this property must be equal to:

"boolean"

Definitions group numericProperty

Reference this group by using

{"$ref":"https://cgi-italy.github.io/insula/schemas/v1.1.1/common/vector-feature-property.schema.json#/$defs/numericProperty"}

Property	Type	Required	Nullable	Defined by
type	string	Required	cannot be null	Vector feature property
domain	object	Optional	cannot be null	Vector feature property

type

type

• is required

• Type: string (Numeric property type constant)

• cannot be null

• defined in: Vector feature property

type Type

string (Numeric property type constant)

type Constraints

constant: the value of this property must be equal to:

"number"

domain

Definition of a numeric variable domain

domain

• is optional

• Type: object (Numeric domain)

• cannot be null

• defined in: Vector feature property

domain Type

object (Numeric domain)

domain Examples

{
  "min": 0,
  "max": 100,
  "step": 1,
  "noData": -1
}

Definitions group enumProperty

Reference this group by using

{"$ref":"https://cgi-italy.github.io/insula/schemas/v1.1.1/common/vector-feature-property.schema.json#/$defs/enumProperty"}

Property	Type	Required	Nullable	Defined by
type	string	Required	cannot be null	Vector feature property
domain	object	Required	cannot be null	Vector feature property
multifilterSupported	boolean	Optional	cannot be null	Vector feature property

type

type

• is required

• Type: string (Enum property type constant)

• cannot be null

• defined in: Vector feature property

type Type

string (Enum property type constant)

type Constraints

constant: the value of this property must be equal to:

"enum"

domain

Definition of a categorical variable domain

domain

• is required

• Type: object (Categorical domain)

• cannot be null

• defined in: Vector feature property

domain Type

object (Categorical domain)

domain Examples

{
  "values": [
    {
      "value": 0,
      "label": "First"
    },
    {
      "value": 1,
      "label": "Second"
    }
  ]
}

multifilterSupported

When set allow to specify multiple options when filtering by this attribute

multifilterSupported

• is optional

• Type: boolean (Enable Multi filtering)

• cannot be null

• defined in: Vector feature property

multifilterSupported Type

boolean (Enable Multi filtering)

Definitions group dateProperty

Reference this group by using

{"$ref":"https://cgi-italy.github.io/insula/schemas/v1.1.1/common/vector-feature-property.schema.json#/$defs/dateProperty"}

Property	Type	Required	Nullable	Defined by
type	string	Required	cannot be null	Vector feature property
domain	object	Optional	cannot be null	Vector feature property
outputStringFormat	string	Optional	cannot be null	Vector feature property
inputStringFormat	string	Optional	cannot be null	Vector feature property

type

type

• is required

• Type: string

• cannot be null

• defined in: Vector feature property

type Type

string

type Constraints

constant: the value of this property must be equal to:

"date"

domain

Definition of a date variable domain

domain

• is optional

• Type: object (Time domain)

• cannot be null

• defined in: Vector feature property

domain Type

object (Time domain)

domain Examples

{
  "min": "1928-12-16T00:00:00Z",
  "max": "1982-03-02T23:59:59Z"
}

outputStringFormat

The format used for displaying the date values (ref: https://momentjs.com/docs/#/displaying/format/)

outputStringFormat

• is optional

• Type: string (String format)

• cannot be null

• defined in: Vector feature property

outputStringFormat Type

string (String format)

inputStringFormat

The format used to parse date values from input string. Not supported. Use ISO8601 format

inputStringFormat

• is optional

• Type: string (Input string format)

• cannot be null

• defined in: Vector feature property

inputStringFormat Type

string (Input string format)