Skip to main content

Interface: SynVisProps

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

Component props for the SynVisComponent.

Extends​

Properties​

bingDelay?​

optional bingDelay: number

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

The amount of time, in milliseconds, to delay binding the component's Bing instance. Defaults to 0.

bingId​

bingId: string

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

The unique ID to assign to the component's bound Bing instance.

bingSkipUnbindOnDestroy?​

optional bingSkipUnbindOnDestroy: boolean

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

Whether to skip unbinding the component's bound Bing instance when the component is destroyed. Defaults to false.

children?​

optional children: DisplayChildren[]

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

The children of the display component.

Inherited from​

ComponentProps.children

class?​

optional class: string | SubscribableSet<string>

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

CSS class(es) to add to the root of the component.

earthColors?​

optional earthColors: SubscribableArray<number>

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

The earth colors for the display. Index 0 defines the water color, and indexes 1 to the end of the array define the terrain colors. If not defined, all colors default to black.

earthColorsElevationRange?​

optional earthColorsElevationRange: Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

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

The elevation range over which to assign the earth terrain colors, as [minimum, maximum] in feet. The terrain colors are assigned at regular intervals over the entire elevation range, starting with the first terrain color at the minimum elevation and ending with the last terrain color at the maximum elevation. Terrain below and above the minimum and maximum elevation are assigned the first and last terrain colors, respectively. Defaults to [0, 30000].

ref?​

optional ref: NodeReference<any>

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

A reference to the display component.

Inherited from​

ComponentProps.ref

resolution​

resolution: Subscribable<Readonly<Omit<Float64Array<ArrayBufferLike>, "set" | "sort" | "copyWithin">>>

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

A subscribable which provides the internal resolution for the Bing component.

skyColor​

skyColor: Subscribable<number>

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

A subscribable which provides the sky color.