Interface: AbstractMapTextLabelOptions
Defined in: src/sdk/components/map/MapTextLabel.ts:32
Options for a AbstractMapTextLabel.
Extended by
Properties
anchor?
optional
anchor:Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>> |Subscribable
<Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>>>
Defined in: src/sdk/components/map/MapTextLabel.ts:37
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]
.
bgBorderRadius?
optional
bgBorderRadius:number
|Subscribable
<number
>
Defined in: src/sdk/components/map/MapTextLabel.ts:64
The border radius of the label's background, in pixels. Defaults to 0.
bgColor?
optional
bgColor:string
|Subscribable
<string
>
Defined in: src/sdk/components/map/MapTextLabel.ts:58
The label's background color. Defaults to 'black'
.
bgOutlineColor?
optional
bgOutlineColor:string
|Subscribable
<string
>
Defined in: src/sdk/components/map/MapTextLabel.ts:70
The outline color of the label's background. Defaults to 'white'
.
bgOutlineWidth?
optional
bgOutlineWidth:number
|Subscribable
<number
>
Defined in: src/sdk/components/map/MapTextLabel.ts:67
The outline width of the label's background, in pixels. Defaults to 0.
bgPadding?
optional
bgPadding:Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>> |Subscribable
<Readonly
<Omit
<Float64Array
,"set"
|"sort"
|"copyWithin"
>>>
Defined in: src/sdk/components/map/MapTextLabel.ts:61
The padding of the label's background, in pixels. Expressed as [top, right, bottom, left]
. Defaults to [0, 0, 0, 0]
.
font?
optional
font:string
|Subscribable
<string
>
Defined in: src/sdk/components/map/MapTextLabel.ts:40
The font type of the label. Defaults to ''
(the default canvas font).
fontColor?
optional
fontColor:string
|Subscribable
<string
>
Defined in: src/sdk/components/map/MapTextLabel.ts:46
The font color of the label. Defaults to 'white'
.
fontOutlineColor?
optional
fontOutlineColor:string
|Subscribable
<string
>
Defined in: src/sdk/components/map/MapTextLabel.ts:52
The font outline color of the label. Defaults to 'black'
.
fontOutlineWidth?
optional
fontOutlineWidth:number
|Subscribable
<number
>
Defined in: src/sdk/components/map/MapTextLabel.ts:49
The font outline width of the label, in pixels. Defaults to 0.
fontSize?
optional
fontSize:number
|Subscribable
<number
>
Defined in: src/sdk/components/map/MapTextLabel.ts:43
The font size of the label, in pixels. Defaults to 10 pixels.
showBg?
optional
showBg:boolean
|Subscribable
<boolean
>
Defined in: src/sdk/components/map/MapTextLabel.ts:55
Whether to show the background for the label. Defaults to false
.