Class: MapCullableTextLabelManager

Defined in: src/sdk/components/map/MapCullableTextLabel.ts:118

Manages a set of MapCullableTextLabels. Colliding labels will be culled based on their render priority. Labels with lower priorities will be culled before labels with higher priorities.

Constructors

Constructor

new MapCullableTextLabelManager(cullingEnabled): MapCullableTextLabelManager

Defined in: src/sdk/components/map/MapCullableTextLabel.ts:154

Creates an instance of the MapCullableTextLabelManager.

Parameters

Parameter	Type	Default value	Description
cullingEnabled	boolean	true	Whether or not culling of labels is enabled.

Returns

MapCullableTextLabelManager

Accessors

visibleLabels

Get Signature

get visibleLabels(): readonly MapCullableTextLabel[]

Defined in: src/sdk/components/map/MapCullableTextLabel.ts:140

An array of labels registered with this manager that are visible.

Returns

readonly MapCullableTextLabel[]

Methods

deregister()

deregister(label): void

Defined in: src/sdk/components/map/MapCullableTextLabel.ts:173

Deregisters a label with this manager. Newly deregistered labels will be processed with the next manager update.

Parameters

Parameter	Type	Description
label	MapCullableTextLabel	The label to deregister.

Returns

void

---

register()

register(label): void

Defined in: src/sdk/components/map/MapCullableTextLabel.ts:160

Registers a label with this manager. Newly registered labels will be processed with the next manager update.

Parameters

Parameter	Type	Description
label	MapCullableTextLabel	The label to register.

Returns

void

---

setCullingEnabled()

setCullingEnabled(enabled): void

Defined in: src/sdk/components/map/MapCullableTextLabel.ts:190

Sets whether or not text label culling is enabled.

Parameters

Parameter	Type	Description
enabled	boolean	Whether or not culling is enabled.

Returns

void

---

update()

update(mapProjection): void

Defined in: src/sdk/components/map/MapCullableTextLabel.ts:199

Updates this manager.

Parameters

Parameter	Type	Description
mapProjection	MapProjection	The projection of the map to which this manager's labels are to be drawn.

Returns

void