Interface: SynVisProps

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

Component props for the SynVisComponent.

Extends

• ComponentProps

Properties

bingDelay?

optional bingDelay: number

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

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:16

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

---

bingSkipUnbindOnDestroy?

optional bingSkipUnbindOnDestroy: boolean

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

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:58

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 Bing component. Index 0 defines the water color, and indexes 1 to the end of the array define the terrain colors. Each color should be expressed as R + G * 256 + B * 256^2. 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].

---

fov?

optional fov: Subscribable<number>

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

The field of view for the component, in degrees. The field of view is measured vertically from the top of the rendered viewport to the bottom. Defaults to 50 degrees.

---

onBoundCallback()?

optional onBoundCallback: (component) => void

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

A callback to call when the underlying Bing component is bound.

Parameters

Parameter	Type
component	SynVisComponent

Returns

void

---

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:25

The internal resolution for the component, as [width, height] in pixels.

---

skyColor

skyColor: Subscribable<number>

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

The sky color for the component. The color should be expressed as R + G * 256 + B * 256^2.