Module Filter

Render only layer's features that has attributeId having value between start and end attributes, including equals values.

Only one attribute filter can be set for a specific layer and attributeId at the same time.

throws

Error if layer or attribute is not found

example

// Will render only features having "level" greater or equals to 2 and lower or equals to 10 for layer 4
JMap.Map.Filter.applyAttributeValueBetween(4, "level", 2, 10)

Render only layer's features that has attributeId having value equals to attributeValue

Only one attribute filter can be set for a specific layer and attributeId at the same time.

throws

Error if layer or attribute is not found

example

// Will render features having "name" equals to "Aquarius" for layer 4
JMap.Map.Filter.applyAttributeValueEqualTo(4, "name", "Aquarius")

Render only layer's features that has attributeId having value greater or equals to attributeValue.

Only one attribute filter can be set for a specific layer and attributeId at the same time.

throws

Error if layer or attribute is not found

example

// Will render features having "level" greater or equals to 2 for layer 4
JMap.Map.Filter.applyAttributeValueGreaterOrEqualsTo(4, "level", 2)

Render only layer's features that has attributeId having value strictly greater to attributeValue.

Only one attribute filter can be set for a specific layer and attributeId at the same time.

throws

Error if layer or attribute is not found

example

// Will render features having "level" strictly greater than 2 for layer 4
JMap.Map.Filter.applyAttributeValueGreaterThan(4, "level", 2)

Render only layer's features that has attributeId having value matching any values in attributeValues.

Only one attribute filter can be set for a specific layer and attributeId at the same time.

throws

Error if layer or attribute is not found

example

// Will render features having "level" equals to 4 or 5, for layer 4
JMap.Map.Filter.applyAttributeValueIn(4, "level", [ 4, 5 ])

Render only layer's features that has attributeId having value lower or equals to attributeValue.

Only one attribute filter can be set for a specific layer and attributeId at the same time.

throws

Error if layer or attribute is not found

example

// Will render features having "level" lower or equals to 5 for layer 4
JMap.Map.Filter.applyAttributeValueLowerOrEqualsTo(4, "level", 5)

Render only layer's features that has attributeId having value strictly lower to attributeValue.

Only one attribute filter can be set for a specific layer and attributeId at the same time.

throws

Error if layer or attribute is not found

example

// Will render features having "level" strictly lower to 5 for layer 4
JMap.Map.Filter.applyAttributeValueLowerThan(4, "level", 5)

Render only layer's features that has attributeId not having value equals to attributeValue

Only one attribute filter can be set for a specific layer and attributeId at the same time.

throws

Error if layer or attribute is not found

example

// Will hide features having "name" equals "Aquarius" for layer 4
JMap.Map.Filter.applyAttributeValueNotEqualTo(4, "name", "Aquarius")

Render only layer's features that has attributeId having value not matching any values in attributeValues.

Only one attribute filter can be set for a specific layer and attributeId at the same time.

throws

Error if layer or attribute is not found

example

// Will render features having "level" not equals to 4 or 5, for layer 4
JMap.Map.Filter.applyAttributeValueNotIn(4, "level", [ 4, 5 ])

Render only layer's features that has the attribute defined in their properties. If the feature attribute is defined but its value is undefined, the feature will be rendered.

Only one attribute filter can be set for a specific layer and attributeId at the same time.

throws

Error if layer or attribute is not found

example

// Will render only features having attribute "name" for layer 4
JMap.Map.Filter.applyHasAttribute(4, "name")

Render only layer's features that hasn't the attribute defined in their properties. If the property is defined but value is undefined, the feature will not be rendered.

Only one attribute filter can be set for a specific layer and attributeId at the same time.

throws

Error if layer or attribute is not found

example

// Will hide features having attribute "name" for layer 4
JMap.Map.Filter.applyHasNotAttribute(4, "name")

Render only layer's features that intersect the filterGeometry area.

Only one spatial filter can be set for a specific layer at the same time.

throws

Error if layer is not found, or filterGeometry format is not good

example

// Will render features that intersect the circle of radius 500 (in km) centered at location x=20 and y=10.
JMap.Map.Filter.applySpatial(4, { radius: 500, center: { x: 20, y: 10 }})

// Will render features that intersect the polygon (in this case a square)
JMap.Map.Filter.applySpatial(4, [ [ 20.44, 10.32 ], [ 20.44, 78.44 ], [ 40.56, 78.44 ], [ 40.56, 10.32 ], [ 20.44, 10.32 ] ])

Remove all spatial and attributes filters for layer.

example

// Remove all filters (spatial + attribute) for layer 3
JMap.Map.Filter.removeAllFilters(3)

Remove the filter on the map following the filter id passed in parameter.

example

// Remove spatial filter on layer 3
JMap.Map.Filter.removeByFilterId("spatial-3")

// Remove attribute filter on attribute id="on_off", on layer 4
JMap.Map.Filter.removeByFilterId("attribute-4-on_off")