Abstract Class: DisplayComponent<P, Contexts>
Defined in: src/sdk/components/FSComponent.ts:58
A display component in the component framework.
Extended by
BingComponent
AbstractNumberUnitDisplay
DigitScroller
DurationDisplay
LatLonDisplay
HardwareUiControl
HorizonSharedCanvasSubLayer
HorizonComponent
HorizonLayer
DefaultMapLabeledRingLabel
MapComponent
MapLayer
MapSharedCanvasSubLayer
SynVisComponent
CollectionComponent
Type Parameters
Type Parameter | Default type |
---|---|
P | - |
Contexts extends unknown [] | [] |
Constructors
Constructor
new DisplayComponent<
P
,Contexts
>(props
):DisplayComponent
<P
,Contexts
>
Defined in: src/sdk/components/FSComponent.ts:73
Creates an instance of a DisplayComponent.
Parameters
Parameter | Type | Description |
---|---|---|
props | P | The propertis of the component. |
Returns
DisplayComponent
<P
, Contexts
>
Properties
context?
optional
context: [...ContextSubcriptions<Contexts>[]
] =undefined
Defined in: src/sdk/components/FSComponent.ts:64
The context on this component, if any.
contextType?
readonly
optional
contextType: readonly [ContextTypes
<Contexts
>] =undefined
Defined in: src/sdk/components/FSComponent.ts:67
The type of context for this component, if any.
props
props:
P
&ComponentProps
Defined in: src/sdk/components/FSComponent.ts:61
The properties of the component.
Methods
destroy()
destroy():
void
Defined in: src/sdk/components/FSComponent.ts:98
Destroys this component.
Returns
void
getContext()
protected
getContext(context
):ContextSubcriptions
<Contexts
>[number
]
Defined in: src/sdk/components/FSComponent.ts:106
Gets a context data subscription from the context collection.
Parameters
Parameter | Type | Description |
---|---|---|
context | ContextTypes <Contexts >[number ] | The context to get the subscription for. |
Returns
ContextSubcriptions
<Contexts
>[number
]
The requested context.
Throws
An error if no data for the specified context type could be found.
onAfterRender()
onAfterRender(
node
):void
Defined in: src/sdk/components/FSComponent.ts:87
A callback that is called after the component is rendered.
Parameters
Parameter | Type | Description |
---|---|---|
node | VNode | The component's VNode. |
Returns
void
onBeforeRender()
onBeforeRender():
void
Defined in: src/sdk/components/FSComponent.ts:80
A callback that is called before the component is rendered.
Returns
void
render()
abstract
render():null
|VNode
Defined in: src/sdk/components/FSComponent.ts:93
Renders the component.
Returns
null
| VNode
A JSX element to be rendered.