Skip to main content

Interface: MapLocationTextLabelOptions

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

Options for a MapLocationTextLabel.

Extends​

Properties​

anchor?​

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

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

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

Inherited from​

AbstractMapTextLabelOptions.anchor

bgBorderRadius?​

optional bgBorderRadius: number | Subscribable<number>

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

The border radius of the label's background, in pixels. Defaults to 0.

Inherited from​

AbstractMapTextLabelOptions.bgBorderRadius

bgColor?​

optional bgColor: string | Subscribable<string>

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

The label's background color. Defaults to 'black'.

Inherited from​

AbstractMapTextLabelOptions.bgColor

bgOutlineColor?​

optional bgOutlineColor: string | Subscribable<string>

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

The outline color of the label's background. Defaults to 'white'.

Inherited from​

AbstractMapTextLabelOptions.bgOutlineColor

bgOutlineWidth?​

optional bgOutlineWidth: number | Subscribable<number>

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

The outline width of the label's background, in pixels. Defaults to 0.

Inherited from​

AbstractMapTextLabelOptions.bgOutlineWidth

bgPadding?​

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

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

The padding of the label's background, in pixels. Expressed as [top, right, bottom, left]. Defaults to [0, 0, 0, 0].

Inherited from​

AbstractMapTextLabelOptions.bgPadding

font?​

optional font: string | Subscribable<string>

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

The font type of the label. Defaults to '' (the default canvas font).

Inherited from​

AbstractMapTextLabelOptions.font

fontColor?​

optional fontColor: string | Subscribable<string>

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

The font color of the label. Defaults to 'white'.

Inherited from​

AbstractMapTextLabelOptions.fontColor

fontOutlineColor?​

optional fontOutlineColor: string | Subscribable<string>

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

The font outline color of the label. Defaults to 'black'.

Inherited from​

AbstractMapTextLabelOptions.fontOutlineColor

fontOutlineWidth?​

optional fontOutlineWidth: number | Subscribable<number>

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

The font outline width of the label, in pixels. Defaults to 0.

Inherited from​

AbstractMapTextLabelOptions.fontOutlineWidth

fontSize?​

optional fontSize: number | Subscribable<number>

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

The font size of the label, in pixels. Defaults to 10 pixels.

Inherited from​

AbstractMapTextLabelOptions.fontSize

offset?​

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

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

The offset of the label from its projected position, as [x, y] in pixels. Defaults to [0, 0].

showBg?​

optional showBg: boolean | Subscribable<boolean>

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

Whether to show the background for the label. Defaults to false.

Inherited from​

AbstractMapTextLabelOptions.showBg