Inheritance diagram for TPG.GeoFramework.Map.Core.MapResources:

Public Member Functions

MapResources (IMapServiceRasterLayerDataFactory sublayerDataFactory)

void ClearLayerData ()

Remove all layers, including categorized layers.

Dictionary< string, string > GetMapLayers ()

Get all layernames and corresponding layerids in active template. The layerid returned for dynamic layers is a group id. Use that id as input to GetReferencedMapLayers to fetch referenced overlays.

Returns: Returns a dictionary with layernames and corresponding layerids (guid-string)

IEnumerable< IRasterLayerData > GetReferencedMapLayers (string dynamicLayerId)

Get all referenced overlays for a dynamic templatelayer.

Parameters

id Layer id

Returns: Returns a list of all referenced overlays

bool RemoveLayerData (IRasterLayerData rld)

Remove layer.

Parameters

rld	Remove layer referencing this object

Returns

bool RemoveLayerData (Guid layerId)

Remove identified layer.

Parameters

layerId Id of layer to remove

Returns

void RemoveCategorizedLayer (string id)

Remove categorized layer.

Parameters

id

void AddCategorizedLayer (string id, List< IRasterLayerData > layers)

Add categorized layers.

Parameters

id
layers

void AddLayerData (IRasterLayerData rld)

Add rasterlayer data to end of layer list (displayed on top)

Parameters

rld	Raster layer data

void SetLayerData (Guid layerId, IRasterLayerData rld)

Set identified layer data. If exists, will replace current entry.

Parameters

layerId	Id of layer
rld	Raster layer data

void ReserveLayer (Guid layerId)

Reserve position for identified layer. If layer with that id is set later, the placement of that layer within the layer list will be maintained.

bool ProcessMapTemplateLayer (MapTemplateLayer tl)

Process template layer.

void Reset ()

Clear any contents.

bool SetupBookmarks (List< Bookmark > bookmarks)

MapTemplate GenerateMapTemplate ()

Generate a template from the current raster layer data. Note that this only includes map layers, not propagation or other categorized layers.

void AddLayerData (IRasterLayerData rld)

Add rasterlayer data to end of layer list (displayed on top)

void SetLayerData (Guid layerId, IRasterLayerData rld)

Set identified layer data. If exists, will replace current entry.

void ReserveLayer (Guid layerId)

Reserve position for identified layer. If layer with that id is set later, the placement of that layer within the layer list will be maintained.

bool RemoveLayerData (IRasterLayerData rld)

Remove layer.

bool RemoveLayerData (Guid layerId)

Remove identified layer.

void RemoveCategorizedLayer (string id)

Remove categorized layer.

void AddCategorizedLayer (string id, List< IRasterLayerData > layers)

Add categorized layers.

bool SetupBookmarks (List< Bookmark > bookmarks)

void ClearLayerData ()

Remove all layers, including categorized layers.

Dictionary< string, string > GetMapLayers ()

Get all layernames and corresponding layerids in active template. The layerid returned for dynamic layers is a group id. Use that id as input to GetReferencedMapLayers to fetch referenced overlays.

IEnumerable< IRasterLayerData > GetReferencedMapLayers (string id)

Get all referenced overlays for a dynamic templatelayer.

MapTemplate GenerateMapTemplate ()

Generate a template from the current raster layer data. Note that this only includes map layers, not propagation or other categorized layers.

bool ProcessMapTemplateLayer (MapTemplateLayer mapTemplateLayer)

Process template layer.

void Reset ()

Clear any contents.

Properties
List< string >	RasterLayerDataOrder `[get, set]`
	Get or set a list of raster layer data ids that represents the order the layers are rendered. The first id in the list is the first layer to be rendered and the last id in the list is the last layer to be rendered (on top of the other layers).

IMapServiceRasterLayerDataFactory	RasterLayerDataFactory `[get]`
	Gets the Raster Layer Data factory to use.

Dictionary< string, List< IRasterLayerData > >	CategorizedLayers `[get]`
	Maintained by other parts of the system. Template connects to categorized layers through placeholders.

int	RasterLayerDataGeneration `[get]`
	Generation counter for the raster layer data structure.

IEnumerable< IRasterLayerData >	RasterLayerData `[get]`

IMapVisualSettings	MapVisualSettings `[get]`

IList< Bookmark >	Bookmarks `[get]`

MapTemplate	CompositeMapTemplate `[get, set]`
	The template that was used to create the raster layer datas.

Properties inherited from TPG.GeoFramework.Map.Core.Contracts.IMapResources
int	RasterLayerDataGeneration `[get]`
	Generation counter for the raster layer data structure.

IEnumerable< IRasterLayerData >	RasterLayerData `[get]`

Dictionary< string, List< IRasterLayerData > >	CategorizedLayers `[get]`

IMapVisualSettings	MapVisualSettings `[get]`

IList< Bookmark >	Bookmarks `[get]`

MapTemplate	CompositeMapTemplate `[get]`
	The template that was used to create the raster layer datas.

List< string >	RasterLayerDataOrder `[get, set]`
	Get or set a list of raster layer data ids that represents the order the layers are rendered. The first id in the list is the first layer to be rendered and the last id in the list is the last layer to be rendered (on top of the other layers).

IMapServiceRasterLayerDataFactory	RasterLayerDataFactory `[get]`
	Gets the Raster Layer Data factory to use.

Properties inherited from TPG.GeoFramework.Map.Core.Contracts.IMapTemplateLayerHandler
MapTemplate	CompositeMapTemplate `[get, set]`
	Template source.

Member Function Documentation

◆ AddCategorizedLayer()

void TPG.GeoFramework.Map.Core.MapResources.AddCategorizedLayer	(	string	id,
		List< IRasterLayerData >	layers
	)

inline

Add categorized layers.

Parameters

id
layers

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ AddLayerData()

void TPG.GeoFramework.Map.Core.MapResources.AddLayerData ( IRasterLayerData rld )

inline

Add rasterlayer data to end of layer list (displayed on top)

Parameters

rld	Raster layer data

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ ClearLayerData()

void TPG.GeoFramework.Map.Core.MapResources.ClearLayerData ( )

inline

Remove all layers, including categorized layers.

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ GenerateMapTemplate()

MapTemplate TPG.GeoFramework.Map.Core.MapResources.GenerateMapTemplate ( )

inline

Generate a template from the current raster layer data. Note that this only includes map layers, not propagation or other categorized layers.

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ GetMapLayers()

Dictionary< string, string > TPG.GeoFramework.Map.Core.MapResources.GetMapLayers ( )

inline

Get all layernames and corresponding layerids in active template. The layerid returned for dynamic layers is a group id. Use that id as input to GetReferencedMapLayers to fetch referenced overlays.

Returns: Returns a dictionary with layernames and corresponding layerids (guid-string)

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ GetReferencedMapLayers()

IEnumerable< IRasterLayerData > TPG.GeoFramework.Map.Core.MapResources.GetReferencedMapLayers ( string dynamicLayerId )

inline

Get all referenced overlays for a dynamic templatelayer.

Parameters

id Layer id

Returns: Returns a list of all referenced overlays

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ ProcessMapTemplateLayer()

bool TPG.GeoFramework.Map.Core.MapResources.ProcessMapTemplateLayer ( MapTemplateLayer mapTemplateLayer )

inline

Process template layer.

Parameters

mapTemplateLayer Template layer to process

Returns: If layer is handled, returns true

Implements TPG.GeoFramework.Map.Core.Contracts.IMapTemplateLayerHandler.

◆ RemoveCategorizedLayer()

void TPG.GeoFramework.Map.Core.MapResources.RemoveCategorizedLayer ( string id )

inline

Remove categorized layer.

Parameters

id

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ RemoveLayerData() [1/2]

bool TPG.GeoFramework.Map.Core.MapResources.RemoveLayerData ( Guid layerId )

inline

Remove identified layer.

Parameters

layerId Id of layer to remove

Returns

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ RemoveLayerData() [2/2]

bool TPG.GeoFramework.Map.Core.MapResources.RemoveLayerData ( IRasterLayerData rld )

inline

Remove layer.

Parameters

rld	Remove layer referencing this object

Returns

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ ReserveLayer()

void TPG.GeoFramework.Map.Core.MapResources.ReserveLayer ( Guid layerId )

inline

Reserve position for identified layer. If layer with that id is set later, the placement of that layer within the layer list will be maintained.

Parameters

layerId

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ Reset()

void TPG.GeoFramework.Map.Core.MapResources.Reset ( )

inline

Clear any contents.

Implements TPG.GeoFramework.Map.Core.Contracts.IMapTemplateLayerHandler.

◆ SetLayerData()

void TPG.GeoFramework.Map.Core.MapResources.SetLayerData	(	Guid	layerId,
		IRasterLayerData	rld
	)

inline

Set identified layer data. If exists, will replace current entry.

Parameters

layerId	Id of layer
rld	Raster layer data

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ SetupBookmarks()

bool TPG.GeoFramework.Map.Core.MapResources.SetupBookmarks ( List< Bookmark > bookmarks )

inline

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

Property Documentation

◆ Bookmarks

IList<Bookmark> TPG.GeoFramework.Map.Core.MapResources.Bookmarks

get

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ CategorizedLayers

Dictionary<string, List<IRasterLayerData> > TPG.GeoFramework.Map.Core.MapResources.CategorizedLayers

get

Maintained by other parts of the system. Template connects to categorized layers through placeholders.

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ CompositeMapTemplate

MapTemplate TPG.GeoFramework.Map.Core.MapResources.CompositeMapTemplate

getset

The template that was used to create the raster layer datas.

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ MapVisualSettings

IMapVisualSettings TPG.GeoFramework.Map.Core.MapResources.MapVisualSettings

get

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ RasterLayerData

IEnumerable<IRasterLayerData> TPG.GeoFramework.Map.Core.MapResources.RasterLayerData

get

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ RasterLayerDataFactory

IMapServiceRasterLayerDataFactory TPG.GeoFramework.Map.Core.MapResources.RasterLayerDataFactory

get

Gets the Raster Layer Data factory to use.

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ RasterLayerDataGeneration

int TPG.GeoFramework.Map.Core.MapResources.RasterLayerDataGeneration

get

Generation counter for the raster layer data structure.

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

◆ RasterLayerDataOrder

List<string> TPG.GeoFramework.Map.Core.MapResources.RasterLayerDataOrder

getset

Get or set a list of raster layer data ids that represents the order the layers are rendered. The first id in the list is the first layer to be rendered and the last id in the list is the last layer to be rendered (on top of the other layers).

Implements TPG.GeoFramework.Map.Core.Contracts.IMapResources.

The documentation for this class was generated from the following file:

Src/Layers/Map/TPG.GeoFramework.Map.Core/MapResources.cs

Public Member Functions

Properties

Member Function Documentation

◆ AddCategorizedLayer()

◆ AddLayerData()

◆ ClearLayerData()

◆ GenerateMapTemplate()

◆ GetMapLayers()

◆ GetReferencedMapLayers()

◆ ProcessMapTemplateLayer()

◆ RemoveCategorizedLayer()

◆ RemoveLayerData() [1/2]

◆ RemoveLayerData() [2/2]

◆ ReserveLayer()

◆ Reset()

◆ SetLayerData()

◆ SetupBookmarks()

Property Documentation

◆ Bookmarks

◆ CategorizedLayers

◆ CompositeMapTemplate

◆ MapVisualSettings

◆ RasterLayerData

◆ RasterLayerDataFactory

◆ RasterLayerDataGeneration

◆ RasterLayerDataOrder