Class: SynVisComponent

Defined in: src/sdk/components/synvis/SynVisComponent.tsx:52

A synthetic vision display.

Extends

• DisplayComponent<SynVisProps>

Constructors

Constructor

new SynVisComponent(props): SynVisComponent

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

Creates an instance of a DisplayComponent.

Parameters

Parameter	Type	Description
props	SynVisProps	The propertis of the component.

Returns

SynVisComponent

Inherited from

DisplayComponent.constructor

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

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

The context on this component, if any.

Inherited from

DisplayComponent.context

---

contextType?

readonly optional contextType: readonly [] = undefined

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

The type of context for this component, if any.

Inherited from

DisplayComponent.contextType

---

isRendered

protected isRendered: boolean = false

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

---

props

props: SynVisProps & ComponentProps

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

The properties of the component.

Inherited from

DisplayComponent.props

Methods

destroy()

destroy(): void

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

Destroys this component.

Returns

void

Overrides

DisplayComponent.destroy

---

getContext()

protected getContext(context): never

Defined in: src/sdk/components/FSComponent.ts:106

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

---

isAwake()

isAwake(): boolean

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

Checks whether this display is awake.

Returns

boolean

whether this display is awake.

---

onAfterRender()

onAfterRender(): void

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

A callback that is called after the component is rendered.

Returns

void

Overrides

DisplayComponent.onAfterRender

---

onBeforeRender()

onBeforeRender(): void

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

A callback that is called before the component is rendered.

Returns

void

Inherited from

DisplayComponent.onBeforeRender

---

onBingBound()

protected onBingBound(): void

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

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

Returns

void

---

render()

render(): VNode

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

Renders the component.

Returns

VNode

A JSX element to be rendered.

Overrides

DisplayComponent.render

---

sleep()

sleep(): void

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

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

Returns

void

---

wake()

wake(): void

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

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

Returns

void