A raster layer that displays raster data in a Map.

It retrieves the map image as a collection of small tiles which are composed together in the browser.

Use this to add raster tileset models to your map.

Note that you can also use this layer for elevation tileset models to your map. However, elevation data will only be visible as terrain geometry on a 3D map. It will not be colored with a height color map.

Hierarchy (View Summary)

Constructors

Accessors

  • get children(): LayerTreeNode[]

    The list of direct children of the node. The children are ordered according to the painting order (the bottom layer is the first element in the array). Note that also the nodes that are not visible will be included.

    Returns LayerTreeNode[]

  • get detailFactor(): number

    The detail factor modifies the quality/detail of the loaded data. It affects the scale point at which a raster level is selected, which also changes the number of raster pixels that are rendered per CSS pixel.

    These are the possible values:

    • detailFactor = 1 (default): the same raster tiles are loaded as on a classic 96 DPI map. This means 1 raster pixel will be rendered per CSS pixel.
    • detailFactor > 1: the layer loads more detailed tiles and renders more raster pixels per CSS pixel. For example: if the detailFactor is 2, one more level is loaded, which causes 4 times as many tiles to be loaded.
    • detailFactor < 1: the layer loads less detailed tiles and renders multiple CSS pixels for 1 raster pixel.

    Increasing the detail factor results in sharper images and crisper text, but it might have a negative impact on performance.

    Setting the detail factor to map.displayScale, results in (device) pixel-perfect rasters.

    Returns number

    2024.1

  • set detailFactor(val: number): void

    Parameters

    • val: number

    Returns void

  • get editable(): boolean

    Denotes whether the layer can be edited

    Returns boolean

  • set editable(editable: boolean): void

    Parameters

    • editable: boolean

    Returns void

  • get id(): string

    The node's ID (immutable). This ID was configured at construction time and is unique over the whole layer tree. If no ID was given, a UUID will have been generated automatically.

    Returns string

  • get label(): string

    The node's label. This label was configured at construction time. If no label was given, the label will correspond to the layer's ID.

    Returns string

  • set label(value: string): void

    Parameters

    • value: string

    Returns void

  • get map(): null | Map

    The map this note is attached to, or null. This property will be null if this node is not attached to a map.

    Returns null | Map

  • get parent(): null | LayerGroup

    The parent of this node or null. This property will be null if this node has not been added as the child of another node yet.

    Returns null | LayerGroup

  • get rasterStyle(): RasterStyle

    The raster style for this layer. This is an object literal. It may contain following properties

    • alpha: a number with an opacity value between 0 and 1. 0 is fully transparent, 1 is fully opaque. By default, the value is 1.

    You should assign rasterStyle with a complete literal. You cannot modify properties of rasterStyle directly.

    Returns RasterStyle

  • set rasterStyle(style: RasterStyle): void

    Parameters

    Returns void

  • get scaleRange(): Interval

    The scale range of this layer.

    Returns Interval

  • get type(): LayerType

    The LayerType of this layer. The layer type is used by the Map to optimize rendering. It is an optional parameter of the layer constructor.

    Returns LayerType

  • get visible(): boolean

    Denotes whether the node is visible. This can be considered to be the master visibility switch: Setting this to false makes the layer entirely invisible. If it is true, the visible paint representations will be visible.

    This property does not reflect whether this node's parent is visible as well, If this is desired, use visibleInTree instead.

    Returns boolean

  • set visible(visible: boolean): void

    Parameters

    • visible: boolean

    Returns void

  • get visibleInTree(): boolean

    Denotes whether this layer is visible on the map. This method will only return true if this layer and every parent layer up to the root of the layer tree is visible.

    If visibleInTree is set to true, this will ensure that every parent LayerTreeNode up to the of the tree is configured to be visible as well.

    Returns boolean

  • set visibleInTree(value: boolean): void

    Parameters

    • value: boolean

    Returns void

Methods

  • Returns the layer with the given ID if that layer is this node or one of its children. Note that the layer's ID does not correspond with the layer's label.

    Parameters

    • id: string

      The id of the layer that you want to retrieve.

    Returns Layer

    the requested layer or undefined if it is not present in the tree

  • Returns the layer group with the given ID if that layer is this node or one of its children.

    Parameters

    • id: string

      The id of the layer group that you want to retrieve.

    Returns LayerGroup

    the requested layer group or undefined if it is not present in the tree

    2014.0

  • Returns the layer tree node with the given ID if that layer is this node or one of its children. This may be a layer-group or a layer.

    Parameters

    • id: string

      The id of the layerTreeNode that you want to retrieve.

    Returns LayerTreeNode

    the requested layerTreeNode or undefined if it is not present in the tree

    2014.0

  • Returns the area of the map that is currently visible, expressed in model coordinates.

    Returns null | Bounds

    the visible bounds in model coordinates or null if nothing is visible

    Please use mapBounds instead.

  • Indicates whether the specified paint representation is supported for this layer. Not every LayerTreeNode may support all paint representations. E.g. raster layers may not b have a PaintRepresentation.LABEL paint representation.

    Parameters

    Returns boolean

    true when paintRepresentation is supported, false otherwise.

  • Indicates whether the specified paint representation is visible on the map. This method will only return true if this paint representation is visible for this layer and every parent layer up to the layer tree.

    Parameters

    Returns boolean

    true when paintRepresentation is supported and visible, false otherwise

  • Called when the map has detected a single click on an object that is contained by this layer. This method can be overridden to take action when the click is detected. The default implementation of this method simply returns false.

    Parameters

    • object: Feature

      the object that was clicked on

    Returns boolean

    true to indicate that the click was handled and default behavior should not occur; false otherwise

  • Called when the map is going to display a context menu for an object that is contained by this layer. This method can be overridden to populate the given context menu with additional items.

    Parameters

    • contextMenu: ContextMenu

      The context menu to populate

    • map: Map

      The map that is about to show a context menu

    • contextMenuInfo: any

      The object that was passed to the map when requesting the context menu. The context menu info object. This object may contain arbitrary data. The default implementation expects a pickInfo object which will be passed to the appropriate Layer's onCreateContextMenu method. A pickInfo object is JavaScript object with two properties: the objects that were touched (an array of Features) and the layer that object resides in.

    Returns void

  • Sets the visibility of a specific paint representation in a layer tree. If it set to true, this will ensure that the paint representation of every parent LayerTreeNode up to the roof of the tree is configured to be visible as well.

    Parameters

    Returns void

  • Wait until this layer or layer group is finished with all possible work related to any change that happened before this call.
    At that moment, the screen is up-to-date with all changes.

    Examples:

      map.mapNavigator.fit({ bounds: somewhere });
    map.layerTree.whenReady().then(makeScreenshot);

    or

        layer.painter.invalidateAll();
    layer.whenReady().then(alert);

    or

        layer.model.add(newFeature);
    layer.whenReady().then(alert);

    This call can be used to have a reliable, programmatic way to wait for all work leading up to the call to be reflected on the screen.
    The returned promise will always resolve once, when the layer is ready. The promise is rejected when the layer does not become ready in 5 minutes.

    Examples (not exhaustive) of aspects this promise will wait for:

    • While loading image data when it displayed for the first time, or after navigating the view
    • While loading image data after changing raster model properties such as WMS style
    • While loading feature data when it displayed for the first time, enters its scale range, or after navigating the view
    • While loading feature data after invalidating the layer query provider
    • While processing features after invalidating the layer feature painter or shape provider, or changing the layer filter
    • While processing features after they were added, updated or removed to/in/from a model or workingSet

    NOTE: The promise gets resolved also when an error (QueryStatus.QUERY_ERROR) occurs while handling underlying query or when the node is invisible.

    A LayerTree will wait until all its children are ready.

    Returns Promise<LayerTreeNode>

    A promise that resolves to the LayerTreeNode when all current work is done

Events

  • Registers a callback function for a given event type.

    Parameters

    • event: string

      the event type to register on

    • callback: (...args: any[]) => void

      the callback function to register

    • Optionalcontext: any

      the context in which the callback function should be invoked implementation dependent.

    Returns Handle

    a handle to the registered callback with a single function 'remove'. This function can be used to unregister the callback function.

  • Event hook that is called when RasterTileSetLayer.detailFactor changes.

    Parameters

    • event: "DetailFactorChanged"

      The "DetailFactorChanged" event type

    • callback: (detailFactor: number) => void

      Callback to be invoked when the detail factor changes.

    • Optionalcontext: any

      value to use as this when executing callback

    Returns Handle

    2024.1