Interface MapWidgetModelMembers

Documentation for the members of MapWidgetModel.

interface MapWidgetModelMembers {
    get camera(): any;
    get center(): any;
    get clippingArea(): any;
    get constraints(): Constraints;
    get environment(): any;
    get extent(): any;
    findLayerInMap(layerIdPath: undefined | string): LayerLookupResult;
    height: undefined | number;
    initialExtent: any;
    initialViewMode: undefined | ViewMode;
    initialViewParameters: undefined | Record<string, any>;
    get map(): Map;
    get navigation(): Navigation;
    get padding(): any;
    ready: undefined | boolean;
    rotation: undefined | number;
    scale: undefined | number;
    get spatialReference(): any;
    get timeExtent(): any;
    updating: undefined | boolean;
    view: any;
    get viewingMode(): undefined | "global" | "local";
    viewmode: ViewMode;
    get viewpoint(): any;
    width: undefined | number;
    zoom: undefined | number;
}

Properties

height initialExtent initialViewMode initialViewParameters ready rotation scale updating view viewmode width zoom

Accessors

camera center clippingArea constraints environment extent map navigation padding spatialReference timeExtent viewingMode viewpoint

Methods

findLayerInMap

Properties

Readonlyheight

height: undefined | number

The current height of the view. Readonly.

It's provided for convenience, so that it is not required to watch for "view" changes.

See

View

ReadonlyinitialExtent

initialExtent: any

Provides access to the first initial extent after initialization. This property is initialized when the first view is set on the MapWidgetModel.

It is intended to support "zoom to initial extent" requirements.

ReadonlyinitialViewMode

initialViewMode: undefined | ViewMode

Provides access to the first initial viewmode (2D or 3D) after initialization. This property is initialized when the first view is set on the MapWidgetModel.

It is intended to support "restore initial view" requirements.

ReadonlyinitialViewParameters

initialViewParameters: undefined | Record<string, any>

Provides access to the first initial view parameter (e.g. extent, zoom etc.) after initialization. This property is initialized when the first view is set on the MapWidgetModel.

It is intended to support "restore initial view" requirements.

Readonlyready

ready: undefined | boolean

true: current state is matching view state. Check for view.ready and view.viewpoint === model.viewpoint; and model.viewmode == view.type

rotation

rotation: undefined | number

The map's rotation state. Only available if viewmode is 2D.

It's provided for convenience, so that it is not required to watch for "view" changes.

See

MapView

scale

scale: undefined | number

The map's scale.

It's provided for convenience, so that it is not required to watch for "view" changes.

See

MapView

Readonlyupdating

updating: undefined | boolean

If true then data requests are currently pending.

It's provided for convenience, so that it is not required to watch for "view" changes.

See

MapView

view

view: any

Provides access to the current view implementation.

This value is set by the MapWidget if the viewmode changes. This value is undefined until the view is initialized by the MapWidget.

viewmode

viewmode: ViewMode

The current view mode. Possible values are "2D", "3D". If this state is changed, then the value of the "view" property changes.

Readonlywidth

width: undefined | number

The current width of the view. Readonly.

It's provided for convenience, so that it is not required to watch for "view" changes.

See

View

zoom

zoom: undefined | number

The current zoom level.

It's provided for convenience, so that it is not required to watch for "view" changes.

See

MapView

Accessors

camera

  • get camera(): any

  • The scene camera. Only available if viewmode is 3D.

    It's provided for convenience, so that it is not required to watch for "view" changes.

    Returns any

    See

    SceneView

center

  • get center(): any

  • The map's center point.

    It's provided for convenience, so that it is not required to watch for "view" changes.

    Returns any

    See

    MapView

clippingArea

  • get clippingArea(): any

  • The view's current clipping area. Only available if viewmode is 3D and if the viewingMode is local.

    Returns any

    See

    SceneView

constraints

  • get constraints(): Constraints

  • Provides access to the current constraints (2D or 3D).

    Any property changed will result in an update of the corresponding MapView or SceneView but not the other way around. Changes of the constraints of the view will not be synchronized to this constraints property.

    Returns Constraints

environment

  • get environment(): any

  • Properties of the environment's visualization in the view. Only available if viewmode is 3D.

    Returns any

    See

    SceneView

extent

  • get extent(): any

  • The map's extent.

    It's provided for convenience, so that it is not required to watch for "view" changes.

    Returns any

    See

    MapView

map

  • get map(): Map

  • The map, it contains the layer structure.

    Returns Map

    See

    Map

navigation

  • Provides access to the current navigation settings.

    All property changes on this object will be applied to the current view and will be reapplied whenever the current view changes. Property changes done directly on the view will not be synchronized back to this object.

    Returns Navigation

padding

  • get padding(): any

  • The map's padding. Has to be updated as whole object, single values (left, right, ...) won't trigger View update.

    Returns any

spatialReference

  • get spatialReference(): any

  • The spatial reference system of the map.

    Returns any

    See

    MapView

timeExtent

  • get timeExtent(): any

  • The map's time extent.

    It's provided for convenience, so that it is not required to watch for "view" changes.

    Returns any

    See

    MapView

viewingMode

  • get viewingMode(): undefined | "global" | "local"

  • Returns the current viewing mode of the view. Only available if viewmode is 3D.

    Returns undefined | "global" | "local"

    See

    SceneView

viewpoint

  • get viewpoint(): any

  • The map's viewpoint.

    It's provided for convenience, so that it is not required to watch for "view" changes.

    Returns any

    See

    MapView

Methods

findLayerInMap

  • findLayerInMap(layerIdPath: undefined | string): LayerLookupResult

  • Finds a layer by id in the map. The layerIdPath is e.g. <layerId> or <layerId>/<sublayerId>.

    Parameters

    • layerIdPath: undefined | string

      The layer id path.

    Returns LayerLookupResult

Settings

Member Visibility

On This Page

Properties
Accessors
Methods