Class: Hsi

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/Hsi.tsx:57

The HSI component of the PFD.

Extends

• DisplayComponent<HSIProps>

Constructors

Constructor

new Hsi(props): Hsi

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	HSIProps	The propertis of the component.

Returns

Hsi

Inherited from

DisplayComponent.constructor

Properties

context?

optional context: [] = undefined

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

props

props: HSIProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/Hsi.tsx:377

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

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

Gets a context data subscription from the context collection.

Parameters

Parameter	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

---

onAfterRender()

onAfterRender(): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/Hsi.tsx:111

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

---

onEvent()

onEvent(event): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/Hsi.tsx:189

Responds to events sent to this container's parent display pane view.

Parameters

Parameter	Type	Description
event	DisplayPaneViewEvent	A display pane view event.

Returns

void

---

onInteractionEvent()

onInteractionEvent(event): boolean

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/Hsi.tsx:204

Handles an interaction event.

Parameters

Parameter	Type	Description
event	string	The interaction event to handle.

Returns

boolean

Whether the interaction event was handled.

---

onUpdate()

onUpdate(time): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/Hsi.tsx:180

Responds to when this HSI's parent display pane view is updated.

Parameters

Parameter	Type	Description
time	number	The current real time, as a UNIX timestamp in milliseconds.

Returns

void

---

render()

render(): VNode

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/Hsi.tsx:315

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

sleep()

sleep(): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/Hsi.tsx:168

Puts this HSI to sleep. When this HSI is asleep, it will not be visible and will not respond to interaction events.

Returns

void

Throws

Error if this HSI has been destroyed.

---

wake()

wake(): void

Defined in: workingtitle-instruments-g3000/html_ui/PFD/Components/HSI/Hsi.tsx:155

Wakes this HSI. When this HSI is awake, it will automatically update its appearance and respond to interaction events.

Returns

void

Throws

Error if this HSI has been destroyed.