Class: MapLabeledRingLayer<T>

A map layer that displays a ring (circle) with one or more labels.

Type parameters

Name	Type
T	extends MapLayerProps<any>

Hierarchy

• MapLayer<T>

  ↳ MapLabeledRingLayer

Constructors

constructor

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

Creates an instance of a DisplayComponent.

Type parameters

Name	Type
T	extends MapLayerProps<any>

Parameters

Name	Type	Description
props	T	The propertis of the component.

Returns

MapLabeledRingLayer<T>

Inherited from

MapLayer.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

canvasLayerRef

• Protected Readonly canvasLayerRef: NodeReference<MapSyncedCanvasLayer<MapLayerProps<any>>>

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:16

---

context

• Optional context: [] = undefined

The context on this component, if any.

Inherited from

MapLayer.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

MapLayer.contextType

Defined in

src/sdk/components/FSComponent.ts:67

---

isInit

• Protected isInit: boolean = false

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:27

---

labelContainerRef

• Protected Readonly labelContainerRef: NodeReference<HTMLDivElement>

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:15

---

props

• props: T & ComponentProps

The properties of the component.

Inherited from

MapLayer.props

Defined in

src/sdk/components/FSComponent.ts:61

Methods

applyStrokeToContext

▸ applyStrokeToContext(context, lineWidth, strokeStyle, dash): void

Applies a stroke to a canvas rendering context.

Parameters

Name	Type	Description
context	CanvasRenderingContext2D	The canvas to which to apply a stroke.
lineWidth	number	The stroke width.
strokeStyle	string | CanvasPattern | CanvasGradient	The stroke style.
dash	readonly number[]	The stroke dash.

Returns

void

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:232

---

createLabel

▸ createLabel<L>(content): null | MapLabeledRingLabel<L>

Creates a ring label. Labels can only be created after this layer has been rendered.

Type parameters

Name	Type
L	extends string | number | HTMLElement | SVGElement | DisplayComponent<any, []>

Parameters

Name	Type	Description
content	VNode	The content of the new label.

Returns

null | MapLabeledRingLabel<L>

the newly created ring label, or null if a label could not be created.

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:96

---

destroy

▸ destroy(): void

Destroys this component.

Returns

void

Overrides

MapLayer.destroy

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:265

---

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

MapLayer.getContext

Defined in

src/sdk/components/FSComponent.ts:106

---

getRingCenter

▸ getRingCenter(): Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>

Gets the center position of this layer's ring, in pixels.

Returns

Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>

the center position of this layer's ring.

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:35

---

getRingRadius

▸ getRingRadius(): number

Gets the radius of this layer's ring, in pixels.

Returns

number

the radius of this layer's ring.

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:43

---

isRingInView

▸ isRingInView(): boolean

Checks whether this layer's ring is in view.

Returns

boolean

whether this layer's ring is in view.

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:198

---

isVisible

▸ isVisible(): boolean

Checks whether this layer is visible.

Returns

boolean

whether this layer is visible.

Inherited from

MapLayer.isVisible

Defined in

src/sdk/components/map/MapLayer.ts:38

---

onAfterRender

▸ onAfterRender(node): void

A callback that is called after the component is rendered.

Parameters

Name	Type	Description
node	VNode	The component's VNode.

Returns

void

Inherited from

MapLayer.onAfterRender

Defined in

src/sdk/components/FSComponent.ts:87

---

onAttached

▸ onAttached(): void

This method is called when this layer is attached to its parent map component.

Returns

void

Overrides

MapLayer.onAttached

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:125

---

onBeforeRender

▸ onBeforeRender(): void

A callback that is called before the component is rendered.

Returns

void

Inherited from

MapLayer.onBeforeRender

Defined in

src/sdk/components/FSComponent.ts:80

---

onDetached

▸ onDetached(): void

This method is called when this layer is detached from its parent map component.

Returns

void

Inherited from

MapLayer.onDetached

Defined in

src/sdk/components/map/MapLayer.ts:108

---

onMapProjectionChanged

▸ onMapProjectionChanged(mapProjection, changeFlags): void

This method is called when the map projection changes.

Parameters

Name	Type	Description
mapProjection	MapProjection	this layer's map projection.
changeFlags	number	The types of changes made to the projection.

Returns

void

Overrides

MapLayer.onMapProjectionChanged

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:133

---

onSleep

▸ onSleep(): void

This method is called when this layer's parent map is put to sleep.

Returns

void

Inherited from

MapLayer.onSleep

Defined in

src/sdk/components/map/MapLayer.ts:81

---

onUpdated

▸ onUpdated(time, elapsed): void

This method is called once every map update cycle.

Parameters

Name	Type	Description
time	number	The current time as a UNIX timestamp.
elapsed	number	The elapsed time, in milliseconds, since the last update.

Returns

void

Overrides

MapLayer.onUpdated

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:143

---

onVisibilityChanged

▸ onVisibilityChanged(isVisible): void

This method is called when this layer's visibility changes.

Parameters

Name	Type	Description
isVisible	boolean	Whether the layer is now visible.

Returns

void

Overrides

MapLayer.onVisibilityChanged

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:118

---

onWake

▸ onWake(): void

This method is called when this layer's parent map is woken.

Returns

void

Inherited from

MapLayer.onWake

Defined in

src/sdk/components/map/MapLayer.ts:74

---

render

▸ render(): VNode

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

MapLayer.render

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:255

---

setRingOutlineStyles

▸ setRingOutlineStyles(width?, style?, dash?): void

Sets the styling for this layer's ring outline. Any style that is not explicitly defined will be left unchanged.

Parameters

Name	Type	Description
width?	number	The new outline width.
style?	string | CanvasPattern | CanvasGradient	The new outline style.
dash?	readonly number[]	The new outline dash.

Returns

void

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:83

---

setRingPosition

▸ setRingPosition(center, radius): void

Sets the center and radius of this layer's ring.

Parameters

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

Returns

void

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:52

---

setRingStrokeStyles

▸ setRingStrokeStyles(width?, style?, dash?): void

Sets the styling for this layer's ring stroke. Any style that is not explicitly defined will be left unchanged.

Parameters

Name	Type	Description
width?	number	The new stroke width.
style?	string | CanvasPattern | CanvasGradient	The new stroke style.
dash?	readonly number[]	The new stroke dash.

Returns

void

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:69

---

setVisible

▸ setVisible(val): void

Sets this layer's visibility.

Parameters

Name	Type	Description
val	boolean	Whether this layer should be visible.

Returns

void

Inherited from

MapLayer.setVisible

Defined in

src/sdk/components/map/MapLayer.ts:46

---

updateFromVisibility

▸ updateFromVisibility(): void

Updates this layer according to its current visibility.

Returns

void

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:159

---

updateRingPosition

▸ updateRingPosition(): void

Updates the position of this layer's ring.

Returns

void

Defined in

src/sdk/components/map/layers/MapLabeledRingLayer.tsx:168