Skip To Content ArcGIS for Developers Sign In Dashboard

EncEnvironmentSettings QML Type

An Electronic Navigation Chart (ENC) environment settings object. More...

Import Statement: import Esri.ArcGISRuntime 100.9
Since: Esri.ArcGISRuntime 100.2




Detailed Description

Uses this singleton type to access to ENC display settings, to set paths to your local files, and to connect to errorChanged signal.

// sets ENC settings using QML declaration
EncLayer {
    encEnvironmentSettings.sencDataPath: dataPath
    encEnvironmentSettings.resourcePath: resourcePath
    encEnvironmentSettings.displaySettings.marinerSettings.displayCategories.standardDisplay: true

// sets ENC settings using JS function
function setupEncEnvironmentSettings() {
    EncEnvironmentSettings.sencDataPath = dataPath;
    EncEnvironmentSettings.resourcePath = resourcePath;
    EncEnvironmentSettings.displaySettings.marinerSettings.displayCategories.standardDisplay = true;

Note: You cannot declare or create a component of this type in QML code. Rather, an instance is automatically created and only that single instance is available for use in the application.

See also EncLayer.

Property Documentation

displaySettings : EncDisplaySettings

Returns the S-52 display properties for the environment (read-only).

resourcePath : url

The path to the ENC resource files.

You would rarely need to set this, as the build process will auto-deploy these resources in the correct default location, and should only be set if you want to override/update these resource, or share them across multiple apps.

In dektop platforms, the default path is the runtime install path, defined in ArcGISRuntimeEnvironment.installPath. In mobile platforms, the default path is the application deployment path.

Note: The resources path must be set before ENC content can be used (regardless of whether that use involves content display).

See also ArcGISRuntimeEnvironment.

sencDataPath : url

The path to the SENC resource files.

The default path is the system's temporary path.

SENC is an acronym for System Electronic Navigational Chart. ENC data is converted into an internal SENC format for optimal chart display.

Note: Subsequent loads of an ENC cell or exchange set will ignore the underlying cells (.000 files). Runtime will instead read from the internal SENC files directly.

Note: It is up to the developer to maintain this data between sessions. If a path is not explicitly set, the Runtime temp path will be used.

Signal Documentation


Emitted when the resourcePath property changes.

Note: The corresponding handler is onResourcePathChanged.


Emitted when the sencDataPath property changes.

Note: The corresponding handler is onSencDataPathChanged.

Feedback on this topic?