Skip To Content ArcGIS for Developers Sign In Dashboard

MobileScenePackage QML Type

Instances of this class represent a mobile scene package (.mspk file). More...

Import Statement: import Esri.ArcGISRuntime 100.6
Since: Esri.ArcGISRuntime 100.5
Inherits:

Object

Properties

Signals

Methods

Detailed Description

A mobile scene package is a transport mechanism for mobile scenes, their layers, and the layer's data. It contains metadata about the package (description, etc.), one or more mobile scenes, layers, data, and optionally networks and locators.

A mobile scene package can be created from ArcGIS Pro.

Mobile scene packages are a major part of the offline workflow. Scenes inside a mobile scene package can be used and programmatically edited (layers can be added or removed). Note, mobile scene packages are read-only; edits to scenes or layers are not persisted to disk.

MobileScenePackage implements the Loadable interface; the mobile scene package contents can be accessed after the mobile scene package has loaded.

The mobile scene package has a version property which application developers can use to determine if it can be opened in this version of the ArcGIS Runtime SDK. The ArcGIS Runtime will be backwards compatible to version 1.0 mobile scene packages and will open the latest supported major version, but will not be able to open future major versions of packages. Please see the system requirements for details on what scene package versions are currently supported.

See also Loadable.

Property Documentation

expiration : Expiration

Expiration details for this mobile scene package, if provided. (read-only).

If the mobile scene package was authored with expiration, this property will be populated when the package is loaded or fails to load.

If the package has expired and was authored as Enums.ExpirationTypePreventExpiredAccess then loading will fail and the package can no longer be used.

This property will still be populated even in the event of a load failure.


item : ArcGISItem

Returns an ArcGISItem object describing the contents of the mobile scene package (read-only).

This property can be retrieved after the MobileScenePackage is loaded.

The mobile scene package will contain information about itself. The information is equivalent to the JSON description of an item plus a few additional properties.


loadError : Error

Returns the load error (read-only).

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable.


loadStatus : Enums.LoadStatus

Returns the load status (read-only).

See also Loadable and Enums.LoadStatus.


locatorTask : LocatorTask

Returns the locator contained in the mobile scene package as a LocatorTask (read-only).

This property can be retrieved after the MobileScenePackage is loaded.


path : url

The path to the mobile scene package (.mspk file) or the root folder in case of an exploded mmpk.

This property cannot be set after the MobileScenePackage is loaded.


scenes : list<Scene>

Returns a list of the scenes contained in the mobile scene package (read-only).

This property can be retrieved after the MobileScenePackage is loaded.


version : string

Returns the version of this mobile scene package (read-only).


Signal Documentation

expirationChanged()

Emitted when the expiration property changes.


itemChanged()

Emitted when the item property changes.


loadErrorChanged()

Emitted when the loadError property changes.

Note: load errors are also reported on the error property and emit the errorChanged signal.

See also Loadable and Object.


loadStatusChanged()

Emitted when the loadStatus property changes.

See also Loadable.


locatorTaskChanged()

Emitted when the locatorTask property changes.


pathChanged()

Emitted when the path property changes.


scenesChanged()

Emitted when the scenes property changes.


versionChanged()

Emitted when the version property changes.


Method Documentation

void cancelLoad()

See also Loadable.


void close()

Closes a mobile scene package and frees file locks on the underlying .mspk file or directory.

All references to mobile scene package data (scenes, layers, tables, networks, locators, etc.) should be released before closing the package. If active references to mobile scene package data exist, this method will still close the package, but subsequent rendering and data access methods will fail. Results of accessing mobile scene package data after close are undefined.

After closing a mobile scene package, the underlying .mspk file or directory can be moved or deleted.

Closing a mobile scene package is not necessary if the package has not been loaded.

This QML method was introduced in Esri.ArcGISRuntime 100.6.

See also MobileMapPackage::close and Geodatabase::close.


void load()

See also Loadable.


void retryLoad()

See also Loadable.



Feedback on this topic?