Skip to main content

Class: NavSourceDataField

Defined in: workingtitle-instruments-wt21/shared/LowerSection/LeftInfoPanel/NavSourceDataField.tsx:23

A display component in the component framework.

Extends​

Constructors​

Constructor​

new NavSourceDataField(props): NavSourceDataField

Defined in: sdk/components/FSComponent.ts:76

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsNavSourceDataFieldPropsThe propertis of the component.

Returns​

NavSourceDataField

Inherited from​

DisplayComponent.constructor

Properties​

context?​

optional context: [Subscribable<WT21NavIndicators>] = undefined

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

The context on this component, if any.

Inherited from​

DisplayComponent.context


contextType​

readonly contextType: readonly [Context<WT21NavIndicators>]

Defined in: workingtitle-instruments-wt21/shared/LowerSection/LeftInfoPanel/NavSourceDataField.tsx:24

The type of context for this component, if any.

Overrides​

DisplayComponent.contextType


props​

props: NavSourceDataFieldProps & ComponentProps

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

The properties of the component.

Inherited from​

DisplayComponent.props

Methods​

destroy()​

destroy(): void

Defined in: sdk/components/FSComponent.ts:101

Destroys this component.

Returns​

void

Inherited from​

DisplayComponent.destroy


getContext()​

protected getContext(context): Subscribable<WT21NavIndicators>

Defined in: sdk/components/FSComponent.ts:109

Gets a context data subscription from the context collection.

Parameters​

ParameterTypeDescription
contextContext<WT21NavIndicators>The context to get the subscription for.

Returns​

Subscribable<WT21NavIndicators>

The requested context.

Throws​

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

Inherited from​

DisplayComponent.getContext


onAfterRender()​

onAfterRender(): void

Defined in: workingtitle-instruments-wt21/shared/LowerSection/LeftInfoPanel/NavSourceDataField.tsx:51

A callback that is called after the component is rendered.

Returns​

void

Overrides​

DisplayComponent.onAfterRender


onBeforeRender()​

onBeforeRender(): void

Defined in: sdk/components/FSComponent.ts:83

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

DisplayComponent.onBeforeRender


render()​

render(): VNode

Defined in: workingtitle-instruments-wt21/shared/LowerSection/LeftInfoPanel/NavSourceDataField.tsx:123

Renders the component.

Returns​

VNode

A JSX element to be rendered.

Overrides​

DisplayComponent.render