Skip to main content

Interface: AbstractMapTextLabelOptions

Options for a AbstractMapTextLabel.

Hierarchy​

Properties​

anchor​

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

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].

Defined in​

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

bgBorderRadius​

• Optional bgBorderRadius: number | Subscribable<number>

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

Defined in​

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

bgColor​

• Optional bgColor: string | Subscribable<string>

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

Defined in​

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

bgOutlineColor​

• Optional bgOutlineColor: string | Subscribable<string>

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

Defined in​

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

bgOutlineWidth​

• Optional bgOutlineWidth: number | Subscribable<number>

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

Defined in​

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

bgPadding​

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

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

Defined in​

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

font​

• Optional font: string | Subscribable<string>

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

Defined in​

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

fontColor​

• Optional fontColor: string | Subscribable<string>

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

Defined in​

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

fontOutlineColor​

• Optional fontOutlineColor: string | Subscribable<string>

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

Defined in​

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

fontOutlineWidth​

• Optional fontOutlineWidth: number | Subscribable<number>

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

Defined in​

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

fontSize​

• Optional fontSize: number | Subscribable<number>

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

Defined in​

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

showBg​

• Optional showBg: boolean | Subscribable<boolean>

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

Defined in​

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