Skip to main content

Class: DefaultMapLabeledRingLabel<T>

Defined in: src/sdk/components/map/DefaultMapLabeledRingLabel.tsx:10

A default implementation of MapLabeledRingLabel.

Extends

Type Parameters

Type Parameter
T extends MapLabeledRingLabelContent

Implements

Constructors

Constructor

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

Defined in: src/sdk/components/FSComponent.ts:73

Creates an instance of a DisplayComponent.

Parameters

ParameterTypeDescription
propsComponentPropsThe propertis of the component.

Returns

DefaultMapLabeledRingLabel<T>

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

Defined in: src/sdk/components/FSComponent.ts:64

The context on this component, if any.

Inherited from

DisplayComponent.context


contextType?

readonly optional contextType: readonly [] = undefined

Defined in: src/sdk/components/FSComponent.ts:67

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType


props

props: ComponentProps

Defined in: src/sdk/components/FSComponent.ts:61

The properties of the component.

Inherited from

DisplayComponent.props

Accessors

content

Get Signature

get content(): T

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

The content of this label.

Returns

T

The content of this label.

Implementation of

MapLabeledRingLabel.content

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy


getAnchor()

getAnchor(): ReadonlyFloat64Array

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

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

ReadonlyFloat64Array

this label's anchor point.

Implementation of

MapLabeledRingLabel.getAnchor


getContext()

protected getContext(context): never

Defined in: src/sdk/components/FSComponent.ts:106

Gets a context data subscription from the context collection.

Parameters

ParameterTypeDescription
contextneverThe 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


getRadialAngle()

getRadialAngle(): number

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

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


getRadialOffset()

getRadialOffset(): number

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

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


onAfterRender()

onAfterRender(thisNode): void

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

A callback that is called after the component is rendered.

Parameters

ParameterTypeDescription
thisNodeVNodeThe component's VNode.

Returns

void

Overrides

DisplayComponent.onAfterRender


onBeforeRender()

onBeforeRender(): void

Defined in: src/sdk/components/FSComponent.ts:80

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender


render()

render(): VNode

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

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render


setAnchor()

setAnchor(anchor): void

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

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

ParameterTypeDescription
anchorReadonlyFloat64ArrayThe new anchor point.

Returns

void

Implementation of

MapLabeledRingLabel.setAnchor


setRadialAngle()

setRadialAngle(angle): void

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

Sets the angle of the radial on which this label is positioned, in radians. Radial 0 is in the positive x direction.

Parameters

ParameterTypeDescription
anglenumberThe new radial angle.

Returns

void

Implementation of

MapLabeledRingLabel.setRadialAngle


setRadialOffset()

setRadialOffset(offset): void

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

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

ParameterTypeDescription
offsetnumberThe new radial offset.

Returns

void

Implementation of

MapLabeledRingLabel.setRadialOffset


setRingPosition()

setRingPosition(center, radius): void

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

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

Parameters

ParameterTypeDescription
centerReadonlyFloat64ArrayThe center of the ring, in pixels.
radiusnumberThe radius of the ring, in pixels.

Returns

void