Skip to Content
APIShapesInterface: ShapeBaseConfig

Interface: ShapeBaseConfig

Options shared by polylines and polygons.

Extended by

Properties

allFloors?

optional allFloors?: boolean;

Show the shape on every floor and outdoors, instead of following the floorId rule.

Default Value

false

floorId?

optional floorId?: string;

Identifier for the floor the shape is drawn on. A shape with a floor is shown only while that floor is displayed; a shape without one is shown while no floor is displayed, and in outdoor contexts. Markers, circles and shapes all answer this through one predicate, so the rule is literally the same for all three.


id?

optional id?: string;

Unique identifier for the shape. If not provided, a hexadecimal key will be generated automatically. Polylines and polygons share one id space.


renderOrder?

optional renderOrder?: CircleRenderOrder;

Where the shape renders relative to other map layers.

See

ShapeRenderOrder for the available placements.

Default Value

"aboveBasemap"
Last updated on