Types
import type { WebSceneUpdateFromOptions, WebSceneUpdateThumbnailOptions, WebSceneThumbnailSize, WebSceneSliceAnalysis, FeatureReferenceIdUnion } from "@arcgis/core/webscene/types.js";
Since
ArcGIS Maps SDK for JavaScript 4.33

A module for importing types used in WebScene modules.

Type definitions

WebSceneUpdateFromOptions

Type definition

Options for updating a web scene from a view.

See also

environmentExcluded

Property
Type
boolean | undefined

Do not update the initial environment from the view.

Default value
false

viewpointExcluded

Property
Type
boolean | undefined

Do not update the initial viewpoint from the view.

Default value
false

thumbnailExcluded

Property
Type
boolean | undefined

Do not update the thumbnail from the view. If viewpointExcluded is set to true, then this will default also to true.

Default value
false

thumbnailSize

Property
Type
WebSceneThumbnailSize | undefined

The size of the thumbnail. Defaults to 600x400 (ratio 1.5

). Note that the thumbnail size may currently not be larger than the size of the view.

Default value
{ width: 600, heigth: 400 }

widgetsExcluded

Property
Type
boolean | undefined

When true, the webscene's WebScene.widgets property will not be updated. When false, the definition of the first TimeSlider assigned to the View will be used to update the WebScene.widgets property.

Default value
false

WebSceneUpdateThumbnailOptions

Type definition

Options for updating a web scene thumbnail from a view.

See also

size

Property
Type
WebSceneThumbnailSize | undefined

The size of the thumbnail. Defaults to 600x400 (ratio 1.5

). Note that the thumbnail size may currently not be larger than the size of the view.

Default value
{ width: 600, heigth: 400 }

WebSceneThumbnailSize

Type definition

Options for the thumbnail size when updating a web scene thumbnail from a view.

See also

width

Property
Type
number

The width of the thumbnail.

height

Property
Type
number

The height of the thumbnail.

WebSceneSliceAnalysis

Type definition
Supertypes
default

FeatureReferenceIdUnion

Type definition