Interface: UiPaneContent<P>
Content rendered inside a UI pane.
Type parameters
| Name | Type |
|---|---|
P | extends ComponentProps = ComponentProps |
Hierarchy
DisplayComponent<P>↳
UiPaneContent
Implemented by
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
isUiPaneContent
• Readonly isUiPaneContent: true
Flags this component as a UiPaneContent.
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneContent.ts:9
props
• props: P & ComponentProps
The properties of the component.
Inherited from
DisplayComponent.props
Defined in
src/sdk/components/FSComponent.ts:61
Methods
destroy
▸ destroy(): void
Destroys this component.
Returns
void
Inherited from
DisplayComponent.destroy
Defined in
src/sdk/components/FSComponent.ts:98
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
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
DisplayComponent.onAfterRender
Defined in
src/sdk/components/FSComponent.ts:87
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
onInit
▸ onInit(sizeMode, dimensions): void
Responds to when this content is initially rendered to its parent pane.
Parameters
| Name | Type | Description |
|---|---|---|
sizeMode | UiPaneSizeMode | The size mode of this content's parent pane. |
dimensions | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | The dimensions of this content's parent pane, as [width, height] in pixels. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneContent.ts:16
onPause
▸ onPause(): void
Responds to when this content's parent pane is made either hidden or asleep.
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneContent.ts:28
onResize
▸ onResize(sizeMode, dimensions): void
Responds when this content's parent pane is resized while it is visible and awake.
Parameters
| Name | Type | Description |
|---|---|---|
sizeMode | UiPaneSizeMode | The new size mode of this content's pane. |
dimensions | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | The new dimensions of this content's pane, as [width, height] in pixels. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneContent.ts:35
onResume
▸ onResume(sizeMode, dimensions): void
Responds to when this content's parent pane is made visible and awake.
Parameters
| Name | Type | Description |
|---|---|---|
sizeMode | UiPaneSizeMode | The size mode of this content's parent pane. |
dimensions | Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">> | The dimensions of this content's parent pane, as [width, height] in pixels. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneContent.ts:23
onUpdate
▸ onUpdate(time): void
Called every update cycle.
Parameters
| Name | Type | Description |
|---|---|---|
time | number | The current real (operating system) time, as a Javascript timestamp. |
Returns
void
Defined in
src/workingtitle-instruments-g3x-touch/html_ui/Pages/VCockpit/Instruments/NavSystems/G3XTouch/Shared/UiSystem/UiPaneContent.ts:41
render
▸ render(): null | VNode
Renders the component.
Returns
null | VNode
A JSX element to be rendered.
Inherited from
DisplayComponent.render
Defined in
src/sdk/components/FSComponent.ts:93