Skip to main content

Class: MapLocationTextLabel

A text label associated with a specific geographic location.

Hierarchy

Constructors

constructor

new MapLocationTextLabel(text, priority, location, options?): MapLocationTextLabel

Constructor.

Parameters

NameTypeDescription
textstring | Subscribable<string>The text of this label, or a subscribable which provides it.
prioritynumber | Subscribable<number>The render priority of this label, or a subscribable which provides it.
locationGeoPointInterface | Subscribable<GeoPointInterface>The geographic location of this label, or a subscribable which provides it.
options?MapLocationTextLabelOptionsOptions with which to initialize this label.

Returns

MapLocationTextLabel

Overrides

AbstractMapTextLabel.constructor

Defined in

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

Properties

anchor

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

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

AbstractMapTextLabel.anchor

Defined in

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


bgBorderRadius

Readonly bgBorderRadius: Subscribable<number>

The border radius of this label's background.

Inherited from

AbstractMapTextLabel.bgBorderRadius

Defined in

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


bgColor

Readonly bgColor: Subscribable<string>

This label's background color.

Inherited from

AbstractMapTextLabel.bgColor

Defined in

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


bgOutlineColor

Readonly bgOutlineColor: Subscribable<string>

The outline color of this label's background.

Inherited from

AbstractMapTextLabel.bgOutlineColor

Defined in

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


bgOutlineWidth

Readonly bgOutlineWidth: Subscribable<number>

The outline width of this label's background.

Inherited from

AbstractMapTextLabel.bgOutlineWidth

Defined in

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


bgPadding

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

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

Inherited from

AbstractMapTextLabel.bgPadding

Defined in

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


font

Readonly font: Subscribable<string>

The font type of this label.

Inherited from

AbstractMapTextLabel.font

Defined in

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


fontColor

Readonly fontColor: Subscribable<string>

The font color of this label.

Inherited from

AbstractMapTextLabel.fontColor

Defined in

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


fontOutlineColor

Readonly fontOutlineColor: Subscribable<string>

The font outline color of this label.

Inherited from

AbstractMapTextLabel.fontOutlineColor

Defined in

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


fontOutlineWidth

Readonly fontOutlineWidth: Subscribable<number>

The font outline width of this label, in pixels.

Inherited from

AbstractMapTextLabel.fontOutlineWidth

Defined in

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


fontSize

Readonly fontSize: Subscribable<number>

The font size of this label, in pixels.

Inherited from

AbstractMapTextLabel.fontSize

Defined in

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


location

Readonly location: Subscribable<GeoPointInterface>

Defined in

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


offset

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

Defined in

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


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

AbstractMapTextLabel.priority

Defined in

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


showBg

Readonly showBg: Subscribable<boolean>

Whether to show the background for this label.

Inherited from

AbstractMapTextLabel.showBg

Defined in

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


text

Readonly text: Subscribable<string>

The text of this label.

Inherited from

AbstractMapTextLabel.text

Defined in

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


tempVec2

Static Protected Readonly tempVec2: Float64Array

Inherited from

AbstractMapTextLabel.tempVec2

Defined in

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

Methods

draw

draw(context, mapProjection): void

Draws this label to a canvas.

Parameters

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

Returns

void

Inherited from

AbstractMapTextLabel.draw

Defined in

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


drawBackground

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

Draws this label's background to a canvas.

Parameters

NameTypeDescription
contextCanvasRenderingContext2DThe canvas rendering context.
centerXnumberThe x-coordinate of the center of the label, in pixels.
centerYnumberthe y-coordinate of the center of the label, in pixels.
widthnumberThe width of the background, in pixels.
heightnumberThe height of the background, in pixels.

Returns

void

Inherited from

AbstractMapTextLabel.drawBackground

Defined in

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


drawText

drawText(context, centerX, centerY): void

Draws this label's text to a canvas.

Parameters

NameTypeDescription
contextCanvasRenderingContext2DThe canvas rendering context.
centerXnumberThe x-coordinate of the center of the label, in pixels.
centerYnumberthe y-coordinate of the center of the label, in pixels.

Returns

void

Inherited from

AbstractMapTextLabel.drawText

Defined in

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


getPosition

getPosition(mapProjection, out): Float64Array

Gets the projected position of the label, in pixels.

Parameters

NameTypeDescription
mapProjectionMapProjectionThe map projection to use.
outFloat64ArrayThe vector to which to write the result.

Returns

Float64Array

The projected position of the label.

Overrides

AbstractMapTextLabel.getPosition

Defined in

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


loadBackgroundPath

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

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

Parameters

NameTypeDescription
contextCanvasRenderingContext2DThe canvas rendering context to use.
leftnumberThe x-coordinate of the left edge of the background, in pixels.
topnumberThe y-coordinate of the top edge of the background, in pixels.
widthnumberThe width of the background, in pixels.
heightnumberThe height of the background, in pixels.
radiusnumberThe border radius of the background, in pixels.

Returns

void

Inherited from

AbstractMapTextLabel.loadBackgroundPath

Defined in

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


setTextStyle

setTextStyle(context): void

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

Parameters

NameTypeDescription
contextCanvasRenderingContext2DThe canvas rendering context to use.

Returns

void

Inherited from

AbstractMapTextLabel.setTextStyle

Defined in

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