Interface: MapLocationTextLabelOptions
Options for a MapLocationTextLabel.
Hierarchy
↳
MapLocationTextLabelOptions
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].
Inherited from
AbstractMapTextLabelOptions.anchor
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.
Inherited from
AbstractMapTextLabelOptions.bgBorderRadius
Defined in
src/sdk/components/map/MapTextLabel.ts:64
bgColor
• Optional bgColor: string | Subscribable<string>
The label's background color. Defaults to 'black'.
Inherited from
AbstractMapTextLabelOptions.bgColor
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'.
Inherited from
AbstractMapTextLabelOptions.bgOutlineColor
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.
Inherited from
AbstractMapTextLabelOptions.bgOutlineWidth
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].
Inherited from
AbstractMapTextLabelOptions.bgPadding
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).
Inherited from
AbstractMapTextLabelOptions.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'.
Inherited from
AbstractMapTextLabelOptions.fontColor
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'.
Inherited from
AbstractMapTextLabelOptions.fontOutlineColor
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.
Inherited from
AbstractMapTextLabelOptions.fontOutlineWidth
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.
Inherited from
AbstractMapTextLabelOptions.fontSize
Defined in
src/sdk/components/map/MapTextLabel.ts:43
offset
• Optional offset: Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>
The offset of the label from its projected position, as [x, y] in pixels. Defaults to [0, 0].
Defined in
src/sdk/components/map/MapTextLabel.ts:307
showBg
• Optional showBg: boolean | Subscribable<boolean>
Whether to show the background for the label. Defaults to false.
Inherited from
AbstractMapTextLabelOptions.showBg
Defined in
src/sdk/components/map/MapTextLabel.ts:55