Skip to main content

Interface: MapCullableTextLabel

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

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

Extends

Properties

alwaysShow

readonly alwaysShow: Subscribable<boolean>

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

Whether this label is immune to culling.


bounds

readonly bounds: Float64Array

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

The bounding box of this label.


invalidation

readonly invalidation: ReadonlySubEvent<this, void>

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

An invalidation event.


priority

readonly priority: Subscribable<number>

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

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


text

readonly text: Subscribable<string>

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

The text of this label.

Inherited from

MapTextLabel.text

Methods

draw()

draw(context, mapProjection): void

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

Draws this label to a canvas.

Parameters

ParameterTypeDescription
contextCanvasRenderingContext2DThe canvas rendering context to use to draw.
mapProjectionMapProjectionThe projection to use to project the location of the label.

Returns

void

Inherited from

MapTextLabel.draw


updateBounds()

updateBounds(mapProjection): void

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

Updates this label's bounding box.

Parameters

ParameterTypeDescription
mapProjectionMapProjectionThe map projection to use.

Returns

void