PolygonOverlayItem

A polygon overlay primitive used to plot a "do-not-enter" / restricted-area overlay onto the map without affecting entity selection or routing layers.

This is purely a data carrier consumed by plotPolygonOverlayOnTheMap. Plotting is additive (it does not recenter or zoom the camera). An overlay is uniquely identified by the tuple (propertyId, buildingId, floorId, polygonId) so it can be removed precisely via removePolygonOverlayFromTheMap.

Types

Link copied to clipboard
open class Builder
Link copied to clipboard
Coordinate space of the getGeoJsonArray positions.

Properties

Link copied to clipboard
open val buildingId: Int
Link copied to clipboard
@get:NonNull
open val fillColor: String
Link copied to clipboard
open val floorId: Int
Link copied to clipboard
GeoJSON-style polygon ring array: the outer ring is at index 0 and any subsequent rings (indices 1+) are holes.
Link copied to clipboard
@get:NonNull
open val lineColor: String
Link copied to clipboard
open val lineWidth: Float
Link copied to clipboard
Link copied to clipboard
@get:NonNull
open val polygonId: String
Link copied to clipboard
open val propertyId: Int

Functions

Link copied to clipboard
open fun getKey(): String
Stable key identifying this overlay on the map.
Link copied to clipboard
open fun key(propertyId: Int, buildingId: Int, floorId: Int, polygonId: String): String
Build the overlay key for the given identifying tuple.