EncExchangeSet QML Type

  • Esri.ArcGISRuntime
  • EncExchangeSet
  • An Electronic Navigation Chart (ENC) exchange set object. More...

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

    Object

    Properties

    Signals

    Methods

    Detailed Description

    An exchange set is a package of files that contains one catalog file and at least one S-57 dataset file. An exchange set may be created using the S-57 tools in ArcGIS Desktop's Nautical Toolbox.

    // create EncExchangeSet using paths
    EncExchangeSet {
        id: encExchangeSet
        paths: paths
    }
    
    function displayNames() {
        // get the list of EncDataset
        var encDatasets = encExchangeSet.datasets;
    
        // display the names of EncDataset
        for (var i = 0; i < encDatasets.length; ++i) {
          console.log(encDatasets[i].name);
        }
    }

    See also Loadable and EncLayer.

    Property Documentation

    [read-only] datasets : list<EncDataset>

    Returns the ENC datasets available in the exchange set (read-only).

    ENC exchange sets consist of one or more datasets and a catalog.

    The exchange set's datasets can be used to create EncCell objects, which can be used to create EncLayer objects for display in a map.


    [read-only] 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.


    [read-only] loadStatus : Enums.LoadStatus

    Returns the load status enumeration (read-only).

    See also Loadable and Enums.LoadStatus.


    paths : list<string>

    The list of paths to ENC data.

    Note: An ENC exchange set can be loaded with the path to a single exchange set and zero or more update exchange sets.

    If an exchange set which only contains updates is loaded, the corresponding exchange set with the base cells must be loaded simultaneously.


    [read-only] readme : url

    The Readme.txt file path of the ENC exchange set (read-only).


    Signal Documentation

    datasetsChanged()

    Emitted when the datasets property changes.

    Note: The corresponding handler is onDatasetsChanged.


    loadErrorChanged()

    Emitted when the loadError property changes.

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

    Note: The corresponding handler is onLoadErrorChanged.

    See also Loadable and Object.


    loadStatusChanged()

    Emitted when the loadStatus property changes.

    Note: The corresponding handler is onLoadStatusChanged.

    See also Loadable.


    pathsChanged()

    Emitted when the paths property changes.

    Note: The corresponding handler is onPathsChanged.


    readmeChanged()

    Emitted when the readme property changes.

    Note: The corresponding handler is onReadmeChanged.


    Method Documentation

    void cancelLoad()

    See also Loadable.


    void load()

    Subsequent loads of an exchange set and the component data sets will not read the cell information. Instead, ArcGIS Maps SDK will load the data from the internal SENC database.

    See also Loadable.


    void retryLoad()

    See also Loadable.


    Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.