Maria GDK 4.5.0.133
Documentation of managed code in release branch
Loading...
Searching...
No Matches
TPG.GeoFramework.Map.Core.Contracts.IMapResources Interface Reference
Inheritance diagram for TPG.GeoFramework.Map.Core.Contracts.IMapResources:
TPG.GeoFramework.Map.Core.Contracts.IMapTemplateLayerHandler TPG.GeoFramework.Map.Core.MapResources

Public Member Functions

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< IRasterLayerDataGetReferencedMapLayers (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.
 
- Public Member Functions inherited from TPG.GeoFramework.Map.Core.Contracts.IMapTemplateLayerHandler
bool ProcessMapTemplateLayer (MapTemplateLayer mapTemplateLayer)
 Process template layer.
 
void Reset ()
 Clear any contents.
 

Properties

int RasterLayerDataGeneration [get]
 Generation counter for the raster layer data structure.
 
IEnumerable< IRasterLayerDataRasterLayerData [get]
 
Dictionary< string, List< IRasterLayerData > > CategorizedLayers [get]
 
IMapVisualSettings MapVisualSettings [get]
 
IList< BookmarkBookmarks [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.Contracts.IMapResources.AddCategorizedLayer ( string  id,
List< IRasterLayerData layers 
)

Add categorized layers.

Parameters
id
layers

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ AddLayerData()

void TPG.GeoFramework.Map.Core.Contracts.IMapResources.AddLayerData ( IRasterLayerData  rld)

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

Parameters
rldRaster layer data

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ ClearLayerData()

void TPG.GeoFramework.Map.Core.Contracts.IMapResources.ClearLayerData ( )

Remove all layers, including categorized layers.

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ GenerateMapTemplate()

MapTemplate TPG.GeoFramework.Map.Core.Contracts.IMapResources.GenerateMapTemplate ( )

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

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ GetMapLayers()

Dictionary< string, string > TPG.GeoFramework.Map.Core.Contracts.IMapResources.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)

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ GetReferencedMapLayers()

IEnumerable< IRasterLayerData > TPG.GeoFramework.Map.Core.Contracts.IMapResources.GetReferencedMapLayers ( string  id)

Get all referenced overlays for a dynamic templatelayer.

Parameters
idLayer id
Returns
Returns a list of all referenced overlays

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ RemoveCategorizedLayer()

void TPG.GeoFramework.Map.Core.Contracts.IMapResources.RemoveCategorizedLayer ( string  id)

Remove categorized layer.

Parameters
id

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ RemoveLayerData() [1/2]

bool TPG.GeoFramework.Map.Core.Contracts.IMapResources.RemoveLayerData ( Guid  layerId)

Remove identified layer.

Parameters
layerIdId of layer to remove
Returns

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ RemoveLayerData() [2/2]

bool TPG.GeoFramework.Map.Core.Contracts.IMapResources.RemoveLayerData ( IRasterLayerData  rld)

Remove layer.

Parameters
rldRemove layer referencing this object
Returns

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ ReserveLayer()

void TPG.GeoFramework.Map.Core.Contracts.IMapResources.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.

Parameters
layerId

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ SetLayerData()

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

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

Parameters
layerIdId of layer
rldRaster layer data

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ SetupBookmarks()

bool TPG.GeoFramework.Map.Core.Contracts.IMapResources.SetupBookmarks ( List< Bookmark bookmarks)

Property Documentation

◆ Bookmarks

IList<Bookmark> TPG.GeoFramework.Map.Core.Contracts.IMapResources.Bookmarks
get

◆ CategorizedLayers

Dictionary<string, List<IRasterLayerData> > TPG.GeoFramework.Map.Core.Contracts.IMapResources.CategorizedLayers
get

◆ CompositeMapTemplate

MapTemplate TPG.GeoFramework.Map.Core.Contracts.IMapResources.CompositeMapTemplate
get

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

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

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ MapVisualSettings

IMapVisualSettings TPG.GeoFramework.Map.Core.Contracts.IMapResources.MapVisualSettings
get

◆ RasterLayerData

IEnumerable<IRasterLayerData> TPG.GeoFramework.Map.Core.Contracts.IMapResources.RasterLayerData
get

◆ RasterLayerDataFactory

IMapServiceRasterLayerDataFactory TPG.GeoFramework.Map.Core.Contracts.IMapResources.RasterLayerDataFactory
get

Gets the Raster Layer Data factory to use.

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ RasterLayerDataGeneration

int TPG.GeoFramework.Map.Core.Contracts.IMapResources.RasterLayerDataGeneration
get

Generation counter for the raster layer data structure.

Implemented in TPG.GeoFramework.Map.Core.MapResources.

◆ RasterLayerDataOrder

List<string> TPG.GeoFramework.Map.Core.Contracts.IMapResources.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).

Implemented in TPG.GeoFramework.Map.Core.MapResources.


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