Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface SceneView

Hierarchy

Index

Properties

allLayerViews

allLayerViews: Collection<LayerView>

Collection containing a flat list of all the created LayerViews related to the basemap, operational layers, and group layers in this view.

Read more...

alphaCompositingEnabled

alphaCompositingEnabled: boolean

Allows the view to be partially or fully transparent when composited with the webpage elements behind it.

Read more...

animation

animation: ViewAnimation

Represents an ongoing view animation initialized by goTo().

Read more...

basemapView

basemapView: BasemapView

Represents the view for a single basemap after it has been added to the map.

Read more...

breakpoints

A convenience property used for defining the breakpoints on the height and width of the view.

Read more...

camera

camera: Camera

The observation point from which the visible portion (or perspective) of the SceneView is determined.

Read more...

center

center: Point

Represents the view's center point; when setting the center you may pass a Point instance or an array of numbers representing at longitude/latitude pair ([-100.4593, 36.9014]).

Read more...

clippingArea

clippingArea: Extent

Represents an optional clipping area used to define the visible extent of a local scene.

Read more...

constraints

Specifies constraints for Camera tilt and altitude that may be applied to the SceneView.

Read more...

container

container: HTMLDivElement

The id or node representing the DOM element containing the view.

Read more...

declaredClass

declaredClass: string

destroyed

destroyed: boolean

environment

Specifies various properties of the environment's visualization in the view.

Read more...

extent

extent: Extent

The extent represents the visible portion of a map within the view as an instance of Extent.

Read more...

fatalError

fatalError: Error

A fatal error returned when the view loses its WebGL context.

Read more...

floors

floors: Collection<string>

Applies a display filter on the view for a specific set of floor levels.

Read more...

Readonly focused

focused: boolean

Indicates if the browser focus is on the view.

Read more...

graphics

graphics: Collection<Graphic>

Allows for adding graphics directly to the default graphics in the View.

Read more...

Readonly groundView

groundView: GroundView

The view for the ground of the map.

Read more...

Readonly height

height: number

The height of the view in pixels read from the view container element.

Read more...

heightBreakpoint

heightBreakpoint: "small" | "medium" | "large" | "xsmall" | "xlarge"

A convenience property indicating the general size of the view's height.

Read more...

highlightOptions

highlightOptions: SceneViewHighlightOptions

Options for configuring the highlight.

Read more...

initialized

initialized: boolean

Readonly input

input: Input

Options to configure input handling of the View.

Read more...

Readonly interacting

interacting: boolean

Indication whether the view is being interacted with (for example when panning or by an interactive tool).

Read more...

layerViews

layerViews: Collection<LayerView>

A collection containing a hierarchical list of all the created LayerViews of the operational layers in the map.

Read more...

Readonly magnifier

magnifier: Magnifier

The magnifier allows for showing a portion of the view as a magnifier image on top of the view.

Read more...

map

map: Map

An instance of a Map object to display in the view.

Read more...

Readonly navigating

navigating: boolean

Indication whether the view is being navigated (for example when panning).

Read more...

navigation

navigation: Navigation

Options to configure the navigation behavior of the View.

Read more...

Readonly orientation

orientation: "landscape" | "portrait"

A convenience property indicating the view's orientation.

Read more...

padding

padding: ViewPadding

Use the padding property to make the center, and extent, etc.

Read more...

Readonly performanceInfo

performanceInfo: SceneViewPerformanceInfo

This property contains performance information in a SceneView like global memory usage and additional details for layers about memory consumption and number of features.

Read more...

popup

popup: Popup

A Popup object that displays general content or attributes from layers in the map.

Read more...

qualityProfile

qualityProfile: "medium" | "low" | "high"

SceneView can draw scenes in three different quality modes: high, medium and low.

Read more...

Readonly ready

ready: boolean

When true, this property indicates whether the view successfully satisfied all dependencies, signaling that the following conditions are met.

Read more...

Readonly resizing

resizing: boolean

Indicates if the view is being resized.

Read more...

Readonly resolution

resolution: number

Represents the current value of one pixel in the unit of the view's spatialReference.

Read more...

scale

scale: number

Represents an approximation of the map scale at the center of the view.

Read more...

Readonly size

size: number[]

An array containing the width and height of the view in pixels, e.g.

Read more...

spatialReference

spatialReference: SpatialReference

The spatial reference of the view.

Read more...

Readonly stationary

stationary: boolean

Indication whether the view is animating, being navigated with or resizing.

Read more...

Readonly suspended

suspended: boolean

Indicates if the view is visible on the page.

Read more...

timeExtent

timeExtent: TimeExtent

The view's time extent.

Read more...

Readonly type

type: "3d"

The type of the view.

Read more...

ui

Exposes the default widgets available in the view and allows you to toggle them on and off.

Read more...

Readonly updating

updating: boolean

Indicates whether the view is being updated by additional data requests to the network, or by processing received data.

Read more...

viewingMode

viewingMode: "local" | "global"

The viewing mode (local or global).

Read more...

viewpoint

viewpoint: Viewpoint

Represents the current view as a Viewpoint or point of observation on the view.

Read more...

Readonly width

width: number

The width of the view in pixels read from the view container element.

Read more...

widthBreakpoint

widthBreakpoint: "small" | "medium" | "large" | "xsmall" | "xlarge"

A convenience property indicating the general size of the view's width.

Read more...

zoom

zoom: number

Represents the level of detail (LOD) at the center of the view.

Read more...

Methods

Protected _get

  • _get(propertyName: string): any
  • _get<T>(propertyName: string): T
  • Parameters

    • propertyName: string

    Returns any

  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

Protected _set

  • _set<T>(propertyName: string, value: T): SceneView
  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns SceneView

destroy

  • destroy(): void
  • Destroys the view, and any associated resources, including its map, popup, and UI elements.

    Read more...

    Returns void

emit

  • emit(type: string, event?: any): boolean
  • Emits an event on the instance.

    Read more...

    Parameters

    • type: string
    • Optional event: any

    Returns boolean

focus

  • focus(): void
  • Sets the focus on the view.

    Read more...

    Returns void

get

  • get<T>(propertyName: string): T
  • get(propertyName: string): any
  • Type parameters

    • T

    Parameters

    • propertyName: string

    Returns T

  • Parameters

    • propertyName: string

    Returns any

goTo

  • Sets the view to a given target.

    Read more...

    Parameters

    Returns Promise<any>

hasEventListener

  • hasEventListener(type: string): boolean
  • Indicates whether there is an event listener on the instance that matches the provided event name.

    Read more...

    Parameters

    • type: string

    Returns boolean

hitTest

isFulfilled

  • isFulfilled(): boolean
  • isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

    Read more...

    Returns boolean

isRejected

  • isRejected(): boolean
  • isRejected() may be used to verify if creating an instance of the class is rejected.

    Read more...

    Returns boolean

isResolved

  • isResolved(): boolean
  • isResolved() may be used to verify if creating an instance of the class is resolved.

    Read more...

    Returns boolean

Protected notifyChange

  • notifyChange(propertyName: string): void
  • Parameters

    • propertyName: string

    Returns void

on

  • Registers an event handler on the instance.

    Read more...

    Parameters

    Returns IHandle

set

  • Type parameters

    • T

    Parameters

    • propertyName: string
    • value: T

    Returns SceneView

  • Parameters

    Returns SceneView

takeScreenshot

toMap

toScreen

tryFatalErrorRecovery

  • tryFatalErrorRecovery(): void
  • Call this method to clear any fatal errors resulting from a lost WebGL context.

    Read more...

    Returns void

watch

  • Parameters

    • path: string | string[]
    • callback: WatchCallback
    • Optional sync: boolean

    Returns WatchHandle

when

  • when(callback?: Function, errback?: Function): Promise<any>
  • when() may be leveraged once an instance of the class is created.

    Read more...

    Parameters

    • Optional callback: Function
    • Optional errback: Function

    Returns Promise<any>

whenLayerView

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<PointCloudLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<StreamLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<FeatureLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<CSVLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<GeoJSONLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<GeoRSSLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<GraphicsLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<ImageryLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<KMLLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<SceneLayerView>

  • Gets the LayerView created on the view for the given layer.

    Read more...

    Parameters

    Returns Promise<LayerView>

Generated using TypeDoc