Interface WebSceneJson

An Esri web scene.

The web scene is the core element of 3D mapping across the ArcGIS platform. It defines the content, style, environment, and slides of your scene and it can be shared across multiple ArcGIS web and desktop applications. Web scenes can be created, published, and consumed in ArcGIS Pro and ArcGIS Online with the Scene Viewer. The web scene is saved as a JSON document that can be consumed by the ArcGIS API for JavaScript via the WebScene class to easily create compelling 3D applications.

See https://developers.arcgis.com/web-scene-specification/objects/webscene/.

interface WebSceneJson {
    applicationProperties?: ApplicationPropertiesJson;
    authoringApp?: string;
    authoringAppVersion?: string;
    baseMap: BasemapJson;
    clippingArea?: {
        clip?: boolean;
        geometry: ExtentJson;
    };
    ground?: GroundJson;
    heightModelInfo?: HeightModelInfoJson;
    initialState?: InitialStateJson;
    mapFloorInfo?: MapFloorInfoJson;
    mapRangeInfo?: MapRangeInfoJson;
    operationalLayers?: OperationalLayerJson[];
    presentation?: PresentationJson;
    spatialReference: SpatialReferenceJson;
    tables?: TableJson[];
    timeZone?: string;
    version: string;
    viewingMode?: "local" | "global";
    widgets?: WidgetsJson;
}

Hierarchy (view full)

Properties

applicationProperties? authoringApp? authoringAppVersion? baseMap clippingArea? ground? heightModelInfo? initialState? mapFloorInfo? mapRangeInfo? operationalLayers? presentation? spatialReference tables? timeZone? version viewingMode? widgets?

Properties

OptionalapplicationProperties

applicationProperties?: ApplicationPropertiesJson

The applicationProperties object is one of the objects at the top level of the JSON web map JSON schema. This is responsible for containing the viewing and editing properties of the web map. There are specific objects within this object that are applicable only to Collector and are explained within the property descriptions.

OptionalauthoringApp

authoringApp?: string

String value indicating the application which authored the webmap.

OptionalauthoringAppVersion

authoringAppVersion?: string

String value indicating the authoring App's version number.

baseMap

baseMap: BasemapJson

The map's basemap layer(s). Layers are drawn based on the index position in the array; The first layer in the array is the first layer drawn, the next layer in the array is drawn on top of it, and so on.

OptionalclippingArea

clippingArea?: {
    clip?: boolean;
    geometry: ExtentJson;
}

Defines are to be clipped for display. See https://developers.arcgis.com/web-scene-specification/objects/clippingArea/.

Type declaration

  • Optionalclip?: boolean

    Enable / disable clipping.

  • geometry: ExtentJson

    Envelope of clip area.

Optionalground

ground?: GroundJson

Ground defines the main surface of the web scene, based on elevation layers.

OptionalheightModelInfo

heightModelInfo?: HeightModelInfoJson

An object that defines the characteristics of the vertical coordinate system used by the web scene.

OptionalinitialState

initialState?: InitialStateJson

The initial state at which to open the map.

OptionalmapFloorInfo

mapFloorInfo?: MapFloorInfoJson

Contains floor-awareness information for the map.

OptionalmapRangeInfo

mapRangeInfo?: MapRangeInfoJson

Map range information.

OptionaloperationalLayers

operationalLayers?: OperationalLayerJson[]

Operational layers contain your business data. They are used to make thematic maps. Usually, a basemap sits beneath your operational layers to give them geographic context. See https://developers.arcgis.com/web-map-specification/objects/operationalLayers/.

Optionalpresentation

presentation?: PresentationJson

A presentation consists of multiple slides. Each slide has a different title, extent, basemap, layers etc.

spatialReference

spatialReference: SpatialReferenceJson

An object used to specify the spatial reference of the given geometry.

Optionaltables

tables?: TableJson[]

Specify an array of table objects.

OptionaltimeZone

timeZone?: string

TODO: Not yet documented in web map spec, but present in 2.29 web maps generated by Maps SDK 4.28.

version

version: string

Root element in the web map specifying a string value indicating the web map version. See https://developers.arcgis.com/web-map-specification/objects/version/.

OptionalviewingMode

viewingMode?: "local" | "global"

Must be one of the following values: "global" | "local".

Optionalwidgets

widgets?: WidgetsJson

The widgets object contains widgets that should be exposed to the user.

Settings

Member Visibility

On This Page

Properties