ImageTiledLayer QML Type

  • Esri.ArcGISRuntime
  • ImageTiledLayer
  • A base type for layers that display cached maps. More...

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

    ImageAdjustmentLayer

    Inherited By:

    ArcGISTiledLayer, ServiceImageTiledLayer, and WmtsLayer

    Properties

    Signals

    Detailed Description

    ImageTiledLayer defines a base type for layers that display tiled map services and cached image services. This is an abstract type that can be derived in a custom type to implement a local tile data scheme. To implement a custom ImageTiledLayer, for example to load your own local tile data, you should derive from this type and supply the data for each tile as it is requested. You would typically work with one or more sub-types of this type.

    Implement this type if you want to create a custom tiled layer where the cached images cannot be referenced by a simple URL. If your images can be referenced by a simple URL, you should instead implement ServiceImageTiledLayer.

    Creating a custom ImageTiledLayer

    When tiles must be displayed, a request is made to request the tile corresponding to a given tile key - based on the geographic location. The custom image tiled layer must then supply a valid URL for a local tile image.

    The tileInfo property defines the format of requested images (image format, DPI, width and height), the limits of extent, and scale factor for requests.

    You can supply a JavaScript callback function for the tileCallback property which defines how the local URL for a given tile request should be formed:

    ImageTiledLayer {
        id: customTiledLayer
        fullExtent: Envelope { ... }
        tileInfo: TileInfo { ... }
    
        // supply JavaScript callback to return specific tile
        tileCallback: function(level, row, column) {
            var localileUrl = "file:///local/path/" + level + "/" + row + "/" + column + ".png");
            return localileUrl;
        }
    }

    See also Cancelable, LayerContent, and Loadable.

    Property Documentation

    [since Esri.ArcGISRuntime 100.1] attribution : string

    The attribution text that should be displayed with the layer.

    This property was introduced in Esri.ArcGISRuntime 100.1.


    [since Esri.ArcGISRuntime 100.2] fullExtent : Envelope

    The full extent of the layer.

    This property was introduced in Esri.ArcGISRuntime 100.2.


    noDataTileBehavior : Enums.NoDataTileBehavior

    the NoDataTileBehavior for the layer.

    Determines how a tile request that returns 'NoData' is resampled.

    Zooming in can result in tile requests with no tiles at the requested level of detail. In this case, there are options that control what to display where the tile should be.

    Below are the default values for a loaded layer.

    Layer SituationDefault Value
    Unbound (not added to the map/scene)Enums.NoDataTileBehaviorUpSample
    Basemap reference layerEnums.NoDataTileBehaviorBlank
    Basemap base layerEnums.NoDataTileBehaviorUpSample
    Map operational layerEnums.NoDataTileBehaviorUpSample

    [since Esri.ArcGISRuntime 100.2] tileCallback : var

    The callback function that is called when a tile is requested.

    The callback can make use of 3 JavaScript arguments and should return an URL to local file, or a component:

    • level.
    • row.
    • column.

    This property was introduced in Esri.ArcGISRuntime 100.2.

    See also TileKey.


    [since Esri.ArcGISRuntime 100.2] tileInfo : TileInfo

    Defines the image format and limits for request.

    This property is populated after the layer loads.

    This property was introduced in Esri.ArcGISRuntime 100.2.


    Signal Documentation

    [since Esri.ArcGISRuntime 100.2] fullExtentChanged()

    Emitted when the fullExtent property changes.

    Note: The corresponding handler is onFullExtentChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.2.


    noDataTileBehaviorChanged()

    Emitted when the noDataTileBehavior property changes.

    Note: The corresponding handler is onNoDataTileBehaviorChanged.


    [since Esri.ArcGISRuntime 100.2] tileCallbackChanged()

    Emitted when the tileCallback property changes.

    Note: The corresponding handler is onTileCallbackChanged.

    This signal was introduced in Esri.ArcGISRuntime 100.2.


    tileInfoChanged()

    Emitted when the tileInfo property changes.

    Note: The corresponding handler is onTileInfoChanged.


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