Class MapsuiLayerBands

Namespace

EncDotNet.S100.Renderers.Mapsui

Assembly

EncDotNet.S100.Renderers.Mapsui.dll

Owns the ordered basemap, dataset, overlay, and tool layer bands of a Mapsui.Map.

public sealed class MapsuiLayerBands : IMapsuiOverlayLayerHost, IS100MapLayerHost

Inheritance

object

MapsuiLayerBands

Implements

IMapsuiOverlayLayerHost

IS100MapLayerHost

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

The component mutates the supplied map directly and does not marshal calls to a UI thread. UI-framework hosts remain responsible for invoking it from the thread required by their map control.

Constructors

MapsuiLayerBands(Map)

Creates layer-band bookkeeping for map.

public MapsuiLayerBands(Map map)

Parameters

map Map

The Mapsui map whose layers are managed.

Exceptions

ArgumentNullException

map is null.

Methods

AddDatasetLayer(ILayer)

Adds a layer to the dataset band.

public void AddDatasetLayer(ILayer layer)

Parameters

layer ILayer

The dataset layer to add.

Exceptions

ArgumentNullException

layer is null.

ArgumentException

layer belongs to another managed band or is already present in the map.

AddOverlayLayer(ILayer)

Adds a layer to the overlay band above all dataset layers.

public void AddOverlayLayer(ILayer layer)

Parameters

layer ILayer

The overlay layer to add.

Exceptions

ArgumentNullException

layer is null.

ArgumentException

layer belongs to another managed band or is already present in the map.

AddToolLayer(ILayer)

Adds a layer to the topmost tool band.

public void AddToolLayer(ILayer layer)

Parameters

layer ILayer

The tool layer to add.

Exceptions

ArgumentNullException

layer is null.

ArgumentException

layer belongs to another managed band or is already present in the map.

RemoveDatasetLayer(ILayer)

Removes a layer from the dataset band.

public void RemoveDatasetLayer(ILayer layer)

Parameters

layer ILayer

The dataset layer to remove.

Exceptions

ArgumentNullException

layer is null.

RemoveOverlayLayer(ILayer)

Removes a layer from the overlay band.

public void RemoveOverlayLayer(ILayer layer)

Parameters

layer ILayer

The overlay layer to remove.

Exceptions

ArgumentNullException

layer is null.

RemoveToolLayer(ILayer)

Removes a layer from the tool band.

public void RemoveToolLayer(ILayer layer)

Parameters

layer ILayer

The tool layer to remove.

Exceptions

ArgumentNullException

layer is null.

ReplaceDatasetLayers(IReadOnlyList<ILayer>)

Replaces the complete dataset band with orderedDatasetLayers.

public void ReplaceDatasetLayers(IReadOnlyList<ILayer> orderedDatasetLayers)

Parameters

orderedDatasetLayers IReadOnlyList<ILayer>

The authoritative dataset layers in bottom-to-top order.

Exceptions

ArgumentNullException

orderedDatasetLayers is null.

ArgumentException

The sequence contains a null, duplicate, basemap, overlay, tool, or unmanaged layer already present in the map.

SetBasemapLayer(ILayer?)

Replaces the current basemap layer, or removes it when layer is null.

public void SetBasemapLayer(ILayer? layer)

Parameters

layer ILayer

The new basemap layer, or null.

Exceptions

ArgumentException

layer belongs to another managed band or is already present in the map.