Class: DefaultMapLabeledRingLabel<T>

A default implementation of MapLabeledRingLabel.

Type parameters

Name	Type
T	extends MapLabeledRingLabelContent

Hierarchy

• DisplayComponent<ComponentProps>

  ↳ DefaultMapLabeledRingLabel

Implements

• MapLabeledRingLabel<T>

Constructors

constructor

• new DefaultMapLabeledRingLabel<T>(props): DefaultMapLabeledRingLabel<T>

Creates an instance of a DisplayComponent.

Type parameters

Name	Type
T	extends MapLabeledRingLabelContent

Parameters

Name	Type	Description
props	ComponentProps	The propertis of the component.

Returns

DefaultMapLabeledRingLabel<T>

Inherited from

DisplayComponent.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

DisplayComponent.context

Defined in

src/sdk/components/FSComponent.ts:64

---

contextType

• Optional Readonly contextType: readonly [] = undefined

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

props

• props: ComponentProps

The properties of the component.

Inherited from

DisplayComponent.props

Defined in

src/sdk/components/FSComponent.ts:61

Accessors

content

• get content(): T

The content of this label.

Returns

T

Implementation of

MapLabeledRingLabel.content

Defined in

src/sdk/components/map/DefaultMapLabeledRingLabel.tsx:23

Methods

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy

Defined in

src/sdk/components/map/DefaultMapLabeledRingLabel.tsx:133

---

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.

Implementation of

MapLabeledRingLabel.getAnchor

Defined in

src/sdk/components/map/DefaultMapLabeledRingLabel.tsx:44

---

getContext

▸ getContext(context): never

Gets a context data subscription from the context collection.

Parameters

Name	Type	Description
context	never	The context to get the subscription for.

Returns

never

The requested context.

Throws

An error if no data for the specified context type could be found.

Inherited from

DisplayComponent.getContext

Defined in

src/sdk/components/FSComponent.ts:106

---

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.

Implementation of

MapLabeledRingLabel.getRadialAngle

Defined in

src/sdk/components/map/DefaultMapLabeledRingLabel.tsx:49

---

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.

Implementation of

MapLabeledRingLabel.getRadialOffset

Defined in

src/sdk/components/map/DefaultMapLabeledRingLabel.tsx:54

---

onAfterRender

▸ onAfterRender(thisNode): void

A callback that is called after the component is rendered.

Parameters

Name	Type	Description
thisNode	VNode	The component's VNode.

Returns

void

Overrides

DisplayComponent.onAfterRender

Defined in

src/sdk/components/map/DefaultMapLabeledRingLabel.tsx:38

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80

---

render

▸ render(): VNode

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

Defined in

src/sdk/components/map/DefaultMapLabeledRingLabel.tsx:117

---

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

Implementation of

MapLabeledRingLabel.setAnchor

Defined in

src/sdk/components/map/DefaultMapLabeledRingLabel.tsx:59

---

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

Implementation of

MapLabeledRingLabel.setRadialAngle

Defined in

src/sdk/components/map/DefaultMapLabeledRingLabel.tsx:67

---

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

Implementation of

MapLabeledRingLabel.setRadialOffset

Defined in

src/sdk/components/map/DefaultMapLabeledRingLabel.tsx:78

---

setRingPosition

▸ setRingPosition(center, radius): void

Updates this label with the center and radius of its parent ring.

Parameters

Name	Type	Description
center	Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>	The center of the ring, in pixels.
radius	number	The radius of the ring, in pixels.

Returns

void

Defined in

src/sdk/components/map/DefaultMapLabeledRingLabel.tsx:93