Class: SynVisComponent

A synthetic vision display.

Hierarchy

• DisplayComponent<SynVisProps>

  ↳ SynVisComponent

Constructors

constructor

• new SynVisComponent(props): SynVisComponent

Creates an instance of a DisplayComponent.

Parameters

Name	Type	Description
props	SynVisProps	The propertis of the component.

Returns

SynVisComponent

Inherited from

DisplayComponent.constructor

Defined in

src/sdk/components/FSComponent.ts:73

Properties

_isAwake

• Protected _isAwake: boolean = true

Defined in

src/sdk/components/synvis/SynVisComponent.tsx:56

---

bingRef

• Protected Readonly bingRef: NodeReference<BingComponent>

Defined in

src/sdk/components/synvis/SynVisComponent.tsx:53

---

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

---

isRendered

• Protected isRendered: boolean = false

Defined in

src/sdk/components/synvis/SynVisComponent.tsx:55

---

props

• props: SynVisProps & 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

Overrides

DisplayComponent.destroy

Defined in

src/sdk/components/synvis/SynVisComponent.tsx:125

---

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

---

isAwake

▸ isAwake(): boolean

Checks whether this display is awake.

Returns

boolean

whether this display is awake.

Defined in

src/sdk/components/synvis/SynVisComponent.tsx:78

---

onAfterRender

▸ onAfterRender(): void

A callback that is called after the component is rendered.

Returns

void

Overrides

DisplayComponent.onAfterRender

Defined in

src/sdk/components/synvis/SynVisComponent.tsx:66

---

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

---

onBingBound

▸ onBingBound(): void

A callback which is called when the Bing component is bound.

Returns

void

Defined in

src/sdk/components/synvis/SynVisComponent.tsx:61

---

render

▸ render(): VNode

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

Defined in

src/sdk/components/synvis/SynVisComponent.tsx:107

---

sleep

▸ sleep(): void

Puts this display to sleep. While asleep, this display cannot make changes to the Bing instance to which it is bound.

Returns

void

Defined in

src/sdk/components/synvis/SynVisComponent.tsx:98

---

wake

▸ wake(): void

Wakes this display. Upon awakening, this display will synchronize its state to the Bing instance to which it is bound.

Returns

void

Defined in

src/sdk/components/synvis/SynVisComponent.tsx:86