Interface: MapCullableTextLabel

A map text label which can be culled to prevent collision with other labels.

Hierarchy

• MapTextLabel

  ↳ MapCullableTextLabel

Implemented by

• MapCullableLocationTextLabel

Properties

alwaysShow

• Readonly alwaysShow: Subscribable<boolean>

Whether this label is immune to culling.

Defined in

src/sdk/components/map/MapCullableTextLabel.ts:14

---

bounds

• Readonly bounds: Float64Array

The bounding box of this label.

Defined in

src/sdk/components/map/MapCullableTextLabel.ts:17

---

invalidation

• Readonly invalidation: ReadonlySubEvent<MapCullableTextLabel, void>

An invalidation event.

Defined in

src/sdk/components/map/MapCullableTextLabel.ts:20

---

priority

• Readonly priority: Subscribable<number>

The render priority of this label. Higher numbers will render on top of labels with lower numbers when used with a MapCullableTextLabelManager.

Inherited from

MapTextLabel.priority

Defined in

src/sdk/components/map/MapTextLabel.ts:19

---

text

• Readonly text: Subscribable<string>

The text of this label.

Inherited from

MapTextLabel.text

Defined in

src/sdk/components/map/MapTextLabel.ts:13

Methods

draw

▸ draw(context, mapProjection): void

Draws this label to a canvas.

Parameters

Name	Type	Description
context	CanvasRenderingContext2D	The canvas rendering context to use to draw.
mapProjection	MapProjection	The projection to use to project the location of the label.

Returns

void

Inherited from

MapTextLabel.draw

Defined in

src/sdk/components/map/MapTextLabel.ts:26

---

updateBounds

▸ updateBounds(mapProjection): void

Updates this label's bounding box.

Parameters

Name	Type	Description
mapProjection	MapProjection	The map projection to use.

Returns

void

Defined in

src/sdk/components/map/MapCullableTextLabel.ts:26