Interface: MapLabeledRingLabel<T>
Defined in: src/sdk/components/map/MapLabeledRingLabel.ts:12
A map ring label.
Type Parameters
| Type Parameter |
|---|
T extends MapLabeledRingLabelContent |
Properties
content
readonlycontent:T
Defined in: src/sdk/components/map/MapLabeledRingLabel.ts:14
The content of this label.
Methods
getAnchor()
getAnchor():
ReadonlyFloat64Array
Defined in: src/sdk/components/map/MapLabeledRingLabel.ts:21
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
this label's anchor point.
getRadialAngle()
getRadialAngle():
number
Defined in: src/sdk/components/map/MapLabeledRingLabel.ts:28
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.
getRadialOffset()
getRadialOffset():
number
Defined in: src/sdk/components/map/MapLabeledRingLabel.ts:35
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.
setAnchor()
setAnchor(
anchor):void
Defined in: src/sdk/components/map/MapLabeledRingLabel.ts:42
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
| Parameter | Type | Description |
|---|---|---|
anchor | ReadonlyFloat64Array | The new anchor point. |
Returns
void
setRadialAngle()
setRadialAngle(
angle):void
Defined in: src/sdk/components/map/MapLabeledRingLabel.ts:49
Sets the angle of the radial on which this label is positioned, in radians. Radial 0 is in the positive x direction.
Parameters
| Parameter | Type | Description |
|---|---|---|
angle | number | The new radial angle. |
Returns
void
setRadialOffset()
setRadialOffset(
offset):void
Defined in: src/sdk/components/map/MapLabeledRingLabel.ts:56
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
| Parameter | Type | Description |
|---|---|---|
offset | number | The new radial offset. |
Returns
void