Skip to main content

Class: SectionOutline

Defined in: workingtitle-instruments-epic2/shared/Components/SectionOutline.tsx:16

The SectionOutline component.

Extends​

  • DisplayComponent<SectionOutlineProps>

Constructors​

Constructor​

new SectionOutline(props): SectionOutline

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

Creates an instance of a DisplayComponent.

Parameters​

ParameterTypeDescription
propsSectionOutlinePropsThe propertis of the component.

Returns​

SectionOutline

Inherited from​

DisplayComponent<SectionOutlineProps>.constructor

Properties​

context?​

optional context: [] = undefined

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

The context on this component, if any.

Inherited from​

DisplayComponent.context


contextType?​

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from​

DisplayComponent.contextType


instrumentMouseLeaveSub​

protected readonly instrumentMouseLeaveSub: Subscription

Defined in: workingtitle-instruments-epic2/shared/Components/SectionOutline.tsx:18


outlineActive​

readonly outlineActive: Subject<boolean>

Defined in: workingtitle-instruments-epic2/shared/Components/SectionOutline.tsx:20


outlineElement​

readonly outlineElement: NodeReference<HTMLElement>

Defined in: workingtitle-instruments-epic2/shared/Components/SectionOutline.tsx:17


props​

props: SectionOutlineProps & ComponentProps

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

The properties of the component.

Inherited from​

DisplayComponent.props

Methods​

destroy()​

destroy(): void

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

Destroys this component.

Returns​

void

Inherited from​

DisplayComponent.destroy


forceOutline()​

forceOutline(state): void

Defined in: workingtitle-instruments-epic2/shared/Components/SectionOutline.tsx:28

Forces the outline to be active - useful for some components such as the flight plan list item where you want to show that they are still selected

Parameters​

ParameterTypeDescription
statebooleanWhether to force the outline to be active

Returns​

void


getContext()​

protected getContext(context): never

Defined in: 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


onAfterRender()​

onAfterRender(): void

Defined in: workingtitle-instruments-epic2/shared/Components/SectionOutline.tsx:34

Returns​

void

Inherit Doc​

Overrides​

DisplayComponent.onAfterRender


onBeforeRender()​

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns​

void

Inherited from​

DisplayComponent.onBeforeRender


onDestroy()​

onDestroy(): void

Defined in: workingtitle-instruments-epic2/shared/Components/SectionOutline.tsx:72

Returns​

void

Inherit Doc​


onMouseOut()​

onMouseOut(): void

Defined in: workingtitle-instruments-epic2/shared/Components/SectionOutline.tsx:51

Set the outline inactive

Returns​

void


onMouseOver()​

onMouseOver(): void

Defined in: workingtitle-instruments-epic2/shared/Components/SectionOutline.tsx:47

Set the outline active

Returns​

void


render()​

render(): VNode

Defined in: workingtitle-instruments-epic2/shared/Components/SectionOutline.tsx:58

Returns​

VNode

Inherit Doc​

Overrides​

DisplayComponent.render