Class: MapCullableLocationTextLabel

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

A cullable (hides labels that collide with other labels) text label associated with a specific geographic location.

Extends

• MapLocationTextLabel

Extended by

• FlightPathWaypointLabel
• FlightPathWaypointLabel

Implements

• MapCullableTextLabel

Constructors

Constructor

new MapCullableLocationTextLabel(text, priority, location, alwaysShow, options?): MapCullableLocationTextLabel

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

Constructor.

Parameters

Parameter	Type	Description
text	string | Subscribable<string>	The text of this label, or a subscribable which provides it.
priority	number | Subscribable<number>	The priority of this label, or a subscribable which provides it.
location	GeoPointInterface | Subscribable<GeoPointInterface>	The geographic location of this label, or a subscribable which provides it.
alwaysShow	boolean | Subscribable<boolean>	Whether this label is immune to culling, or a subscribable which provides it.
options?	MapLocationTextLabelOptions	Options with which to initialize this label.

Returns

MapCullableLocationTextLabel

Overrides

MapLocationTextLabel.constructor

Properties

alwaysShow

readonly alwaysShow: Subscribable<boolean>

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

Whether this label is immune to culling.

Implementation of

MapCullableTextLabel.alwaysShow

---

anchor

readonly anchor: Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

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

The anchor point of this label, expressed relative to this label's width/height. [0, 0] is the top-left corner, and [1, 1] is the bottom-right corner.

Inherited from

MapLocationTextLabel.anchor

---

bgBorderRadius

readonly bgBorderRadius: Subscribable<number>

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

The border radius of this label's background.

Inherited from

MapLocationTextLabel.bgBorderRadius

---

bgColor

readonly bgColor: Subscribable<string>

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

This label's background color.

Inherited from

MapLocationTextLabel.bgColor

---

bgOutlineColor

readonly bgOutlineColor: Subscribable<string>

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

The outline color of this label's background.

Inherited from

MapLocationTextLabel.bgOutlineColor

---

bgOutlineWidth

readonly bgOutlineWidth: Subscribable<number>

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

The outline width of this label's background.

Inherited from

MapLocationTextLabel.bgOutlineWidth

---

bgPadding

readonly bgPadding: Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

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

The padding of this label's background, in pixels. Expressed as [top, right, bottom, left].

Inherited from

MapLocationTextLabel.bgPadding

---

bounds

readonly bounds: Float64Array<ArrayBuffer>

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

The bounding box of this label, as [left, top, right, bottom].

Implementation of

MapCullableTextLabel.bounds

---

drawData

protected readonly drawData: object

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

size

size: Float64Array<ArrayBufferLike>

textSize

textSize: Float64Array<ArrayBufferLike>

textTopLeft

textTopLeft: Float64Array<ArrayBufferLike>

topLeft

topLeft: Float64Array<ArrayBufferLike>

Inherited from

MapLocationTextLabel.drawData

---

font

readonly font: Subscribable<string>

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

The font type of this label.

Inherited from

MapLocationTextLabel.font

---

fontColor

readonly fontColor: Subscribable<string>

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

The font color of this label.

Inherited from

MapLocationTextLabel.fontColor

---

fontOutlineColor

readonly fontOutlineColor: Subscribable<string>

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

The font outline color of this label.

Inherited from

MapLocationTextLabel.fontOutlineColor

---

fontOutlineWidth

readonly fontOutlineWidth: Subscribable<number>

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

The font outline width of this label, in pixels.

Inherited from

MapLocationTextLabel.fontOutlineWidth

---

fontSize

readonly fontSize: Subscribable<number>

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

The font size of this label, in pixels.

Inherited from

MapLocationTextLabel.fontSize

---

invalidation

readonly invalidation: SubEventInterface<MapCullableLocationTextLabel, void>

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

An invalidation event.

Implementation of

MapCullableTextLabel.invalidation

---

location

readonly location: Subscribable<GeoPointInterface>

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

Inherited from

MapLocationTextLabel.location

---

offset

readonly offset: Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

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

Inherited from

MapLocationTextLabel.offset

---

onDraw

readonly onDraw: ReadonlySubEvent<MapCullableLocationTextLabel, AbstractMapTextLabelDrawData>

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

An event that notifies subscribers when this label is drawn (when draw() is called). The sender of the event is this label. The event data describes the draw operation that triggered the event. When the draw operation did not draw a visible label, the event is triggered with all NaN values.

The data object passed to event handlers is only guaranteed to be valid at the moment the handler is called. If a handler needs to retain the data past this moment, then it is recommended that a copy of the data be made.

Inherited from

MapLocationTextLabel.onDraw

---

priority

readonly priority: Subscribable<number>

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

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

Implementation of

MapCullableTextLabel.priority

Inherited from

MapLocationTextLabel.priority

---

showBg

readonly showBg: Subscribable<boolean>

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

Whether to show the background for this label.

Inherited from

MapLocationTextLabel.showBg

---

text

readonly text: Subscribable<string>

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

The text of this label.

Implementation of

MapCullableTextLabel.text

Inherited from

MapLocationTextLabel.text

---

tempVec2

protected readonly static tempVec2: Float64Array<ArrayBuffer>

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

Inherited from

MapLocationTextLabel.tempVec2

Methods

destroy()

destroy(): void

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

Destroys this label.

Returns

void

---

draw()

draw(context, mapProjection): void

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

Draws this label to a canvas.

Parameters

Parameter	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

Implementation of

MapCullableTextLabel.draw

Inherited from

MapLocationTextLabel.draw

---

drawBackground()

protected drawBackground(context, centerX, centerY, width, height): void

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

Draws this label's background to a canvas.

Parameters

Parameter	Type	Description
context	CanvasRenderingContext2D	The canvas rendering context.
centerX	number	The x-coordinate of the center of the label, in pixels.
centerY	number	the y-coordinate of the center of the label, in pixels.
width	number	The width of the background, in pixels.
height	number	The height of the background, in pixels.

Returns

void

Inherited from

MapLocationTextLabel.drawBackground

---

drawText()

protected drawText(context, centerX, centerY): void

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

Draws this label's text to a canvas.

Parameters

Parameter	Type	Description
context	CanvasRenderingContext2D	The canvas rendering context.
centerX	number	The x-coordinate of the center of the label, in pixels.
centerY	number	the y-coordinate of the center of the label, in pixels.

Returns

void

Inherited from

MapLocationTextLabel.drawText

---

getLastDrawData()

getLastDrawData(): AbstractMapTextLabelDrawData

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

Gets data describing this label's last executed drawing operation (the last time that draw() was called). If the label has not been drawn yet or the last draw operation did not draw a visible label, then the data will report all NaN values.

Returns

AbstractMapTextLabelDrawData

Data describing this label's last executed drawing operation. The returned data object passed is only guaranteed to be valid at the moment it is returned. If you need to retain the data past this moment, then it is recommended that a copy of the data be made.

Inherited from

MapLocationTextLabel.getLastDrawData

---

getPosition()

protected getPosition(mapProjection, out): Float64Array

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

Gets the projected position of the label, in pixels.

Parameters

Parameter	Type	Description
mapProjection	MapProjection	The map projection to use.
out	Float64Array	The vector to which to write the result.

Returns

Float64Array

The projected position of the label.

Inherited from

MapLocationTextLabel.getPosition

---

loadBackgroundPath()

protected loadBackgroundPath(context, left, top, width, height, radius): void

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

Loads the path of this label's background to a canvas rendering context.

Parameters

Parameter	Type	Description
context	CanvasRenderingContext2D	The canvas rendering context to use.
left	number	The x-coordinate of the left edge of the background, in pixels.
top	number	The y-coordinate of the top edge of the background, in pixels.
width	number	The width of the background, in pixels.
height	number	The height of the background, in pixels.
radius	number	The border radius of the background, in pixels.

Returns

void

Inherited from

MapLocationTextLabel.loadBackgroundPath

---

setTextStyle()

protected setTextStyle(context): void

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

Loads this label's text style to a canvas rendering context.

Parameters

Parameter	Type	Description
context	CanvasRenderingContext2D	The canvas rendering context to use.

Returns

void

Inherited from

MapLocationTextLabel.setTextStyle

---

updateBounds()

updateBounds(mapProjection): void

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

Updates this label's bounding box.

Parameters

Parameter	Type	Description
mapProjection	MapProjection	The map projection to use.

Returns

void

Implementation of

MapCullableTextLabel.updateBounds