Interface: SynVisProps
Component props for the SynVisComponent.
Hierarchy
↳
SynVisProps
Properties
bingDelay
• Optional bingDelay: number
The amount of time, in milliseconds, to delay binding the component's Bing instance. Defaults to 0.
Defined in
src/sdk/components/synvis/SynVisComponent.tsx:18
bingId
• bingId: string
The unique ID to assign to the component's bound Bing instance.
Defined in
src/sdk/components/synvis/SynVisComponent.tsx:15
children
• Optional children: DisplayChildren[]
The children of the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:122
class
• Optional class: string | SubscribableSet<string>
CSS class(es) to add to the root of the component.
Defined in
src/sdk/components/synvis/SynVisComponent.tsx:46
earthColors
• Optional earthColors: SubscribableArray<number>
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.
Defined in
src/sdk/components/synvis/SynVisComponent.tsx:29
earthColorsElevationRange
• Optional earthColorsElevationRange: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>
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].
Defined in
src/sdk/components/synvis/SynVisComponent.tsx:38
ref
• Optional ref: NodeReference<any>
A reference to the display component.
Inherited from
Defined in
src/sdk/components/FSComponent.ts:125
resolution
• resolution: Subscribable<Readonly<Omit<Float64Array, "set" | "sort" | "copyWithin">>>
A subscribable which provides the internal resolution for the Bing component.
Defined in
src/sdk/components/synvis/SynVisComponent.tsx:23
skyColor
• skyColor: Subscribable<number>
A subscribable which provides the sky color.
Defined in
src/sdk/components/synvis/SynVisComponent.tsx:43