Interface: MapLabeledRingLabel<T>
A map ring label.
Type parameters
| Name | Type |
|---|---|
T | extends MapLabeledRingLabelContent |
Implemented by
Properties
content
• Readonly content: T
The content of this label.
Defined in
src/sdk/components/map/MapLabeledRingLabel.ts:14
Methods
getAnchor
▸ getAnchor(): Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>
Gets this label's anchor point. The anchor point is expressed relative to the label's width and height, such that (0, 0) is located at the top-left corner and (1, 1) is located at the bottom-right corner.
Returns
Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>
this label's anchor point.
Defined in
src/sdk/components/map/MapLabeledRingLabel.ts:21
getRadialAngle
▸ getRadialAngle(): number
Gets the angle of the radial on which this label is positioned, in radians. Radial 0 is in the positive x direction.
Returns
number
the angle of the radial on which this label is positioned.
Defined in
src/sdk/components/map/MapLabeledRingLabel.ts:28
getRadialOffset
▸ getRadialOffset(): number
Gets the radial offset of this label from its parent ring, in pixels. Positive values denote displacement away from the center of the ring.
Returns
number
the radial offset of this label from its parent ring, in pixels.
Defined in
src/sdk/components/map/MapLabeledRingLabel.ts:35
setAnchor
▸ setAnchor(anchor): void
Sets this label's anchor point. The anchor point is expressed relative to the label's width and height, such that (0, 0) is located at the top-left corner and (1, 1) is located at the bottom-right corner.
Parameters
| Name | Type | Description |
|---|---|---|
anchor | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | The new anchor point. |
Returns
void
Defined in
src/sdk/components/map/MapLabeledRingLabel.ts:42
setRadialAngle
▸ setRadialAngle(angle): void
Sets the angle of the radial on which this label is positioned, in radians. Radial 0 is in the positive x direction.
Parameters
| Name | Type | Description |
|---|---|---|
angle | number | The new radial angle. |
Returns
void
Defined in
src/sdk/components/map/MapLabeledRingLabel.ts:49
setRadialOffset
▸ setRadialOffset(offset): void
Sets the radial offset of this label from its parent ring, in pixels. Positive values denote displacement away from the center of the ring.
Parameters
| Name | Type | Description |
|---|---|---|
offset | number | The new radial offset. |
Returns
void
Defined in
src/sdk/components/map/MapLabeledRingLabel.ts:56