Interface: CircleConfig

Represents the configuration for the creation of a metric radius circle on a map. The radius is expressed in meters (geographic), so the drawn circle stays metrically accurate at every zoom level.

Example


const circleConfig: CircleConfig = {
  id: "geofence-1",
  coordinate: { lat: 40.7128, lng: -74.006 },
  radiusMeters: 150,
  fillOpacity: 0.2,
}

Properties

allFloors?


optional allFloors?: boolean;

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

Default Value


false

coordinate


coordinate: LatLng

The geographic coordinates of the circle center. Latitude must be between -90 and 90; longitude between -180 and 180.

See

LatLng for coordinate structure

Throws

Error if coordinates are out of bounds.

fillColor?


optional fillColor?: string;

Fill color of the circle in any valid CSS color format.

Default Value

MAPVX_BRAND_COLOR

fillOpacity?


optional fillOpacity?: number;

Opacity of the circle fill, between 0 and 1. Values outside this range are automatically clamped.

Default Value


0.14

floorId?


optional floorId?: string;

Identifier for the floor on which the circle is located. A circle with a floor is shown only while that floor is displayed. A circle without a floor is shown while no floor is displayed, and in outdoor contexts — the same predicate markers and shapes answer through, so the semantics of MarkerConfig.floorId are literally the same rule, not merely a matching one.

id?


optional id?: string;

Unique identifier for the circle. If not provided, a hexadecimal key will be generated automatically.

radiusMeters


radiusMeters: number

Radius of the circle in meters (geographic, not pixels). Must be a positive finite number. The circle keeps its metric size at every zoom level.

Throws

Error if radiusMeters is ≤ 0 or non-finite.

renderOrder?


optional renderOrder?: CircleRenderOrder;

Where the circle renders relative to other map layers.

See

CircleRenderOrder for the available placements.

Default Value


"aboveBasemap"

strokeColor?


optional strokeColor?: string;

Stroke (outline) color of the circle in any valid CSS color format.

Default Value

MAPVX_BRAND_COLOR

strokeOpacity?


optional strokeOpacity?: number;

Opacity of the circle outline, between 0 and 1. Values outside this range are automatically clamped.

Default Value


0.65

strokeWidth?


optional strokeWidth?: number;

Width of the circle outline in pixels.