Functions
string	AxMap.get_LayerDescription (int layerHandle)
	Gets the description of the layer from the associated .mwsymb file. More...

bool	AxMap.get_LayerDynamicVisibility (int layerHandle)
	Gets the boolean value which indicates whether the layer will be displayed at all scales or only within the chosen range of scales. More...

string	AxMap.get_LayerFilename (int layerHandle)
	Gets filename of datasource for the specified layer. More...

string	AxMap.get_LayerKey (int layerHandle)
	Gets a string associated with a layer in the map. More...

Labels	AxMap.get_LayerLabels (int layerHandle)
	Returns labels associated with layer. More...

double	AxMap.get_LayerMaxVisibleScale (int layerHandle)
	Gets the maximum scale at which the layer is visible on the map. More...

int	AxMap.get_LayerMaxVisibleZoom (int layerHandle)
	Gets maximum zoom at which the layer will be displayed. More...

double	AxMap.get_LayerMinVisibleScale (int layerHandle)
	Gets the minimum scale at which the layer is visible on the map. More...

int	AxMap.get_LayerMinVisibleZoom (int layerHandle)
	Gets minimum zoom at which the layer will be displayed. More...

string	AxMap.get_LayerName (int layerHandle)
	Gets the name of the specified layer. More...

bool	AxMap.get_LayerSkipOnSaving (int layerHandle)
	Gets a boolean value which indicates whether the layer will be serialized by appropriate routines. More...

bool	AxMap.get_LayerVisible (int layerHandle)
	Gets the visibility of the specified layer. More...

object	AxMap.GetColorScheme (int layerHandle)
	Returns a color scheme for the specified layer. More...

void	AxMap.set_LayerDescription (int layerHandle, string newValue)
	Sets the description of the layer. More...

void	AxMap.set_LayerDynamicVisibility (int layerHandle, bool newValue)
	Sets the boolean value which indicates whether the layer will be displayed at all scales or only within the chosen range of scales. More...

void	AxMap.set_LayerKey (int layerHandle, string newValue)
	Sets a string associated with a layer in the map. More...

void	AxMap.set_LayerLabels (int layerHandle, Labels newValue)
	Sets the labels associated with the layer. More...

void	AxMap.set_LayerMaxVisibleScale (int layerHandle, double newValue)
	Sets the maximum scale at which the layer is visible on the map. More...

void	AxMap.set_LayerMaxVisibleZoom (int layerHandle, int param0)
	Sets maximum zoom at which the layer will be displayed. More...

void	AxMap.set_LayerMinVisibleScale (int layerHandle, double newValue)
	Sets the minimum scale at which the layer is visible on the map. More...

void	AxMap.set_LayerMinVisibleZoom (int layerHandle, int param0)
	Sets minimum zoom at which the layer will be displayed. More...

void	AxMap.set_LayerName (int layerHandle, string newValue)
	Sets the name of the specified layer. More...

void	AxMap.set_LayerSkipOnSaving (int layerHandle, bool newValue)
	Sets a boolean value which indicates whether the layer will be serialized by appropriate routines. More...

void	AxMap.set_LayerVisible (int layerHandle, bool newValue)
	Sets the visibility of the specified layer. More...

bool	AxMap.SetImageLayerColorScheme (int layerHandle, object colorScheme)
	Sets the color scheme of an image layer More...

Detailed Description

Here is a list of properties common to all data layers. This module is a part of the documentation of AxMap class.

Graph description

Function Documentation

◆ get_LayerDescription()

string AxMap.get_LayerDescription ( int layerHandle )

Gets the description of the layer from the associated .mwsymb file.

Parameters

layerHandle The handle of the layer.

Returns: The string with description.

New API 4.8:: Added in version 4.8

◆ get_LayerDynamicVisibility()

bool AxMap.get_LayerDynamicVisibility ( int layerHandle )

Gets the boolean value which indicates whether the layer will be displayed at all scales or only within the chosen range of scales.

Parameters

layerHandle The handle of the layer.

Returns: True in case the layer will be displayed between specified scales only.

See also: AxMap.get_LayerMaxVisibleScale, AxMap.get_LayerMinVisibleScale

New API 4.8:: Added in version 4.8

◆ get_LayerFilename()

string AxMap.get_LayerFilename ( int layerHandle )

Gets filename of datasource for the specified layer.

Parameters

layerHandle Layer handle.

Returns: Filename of the layer including path.

New API 4.9.0:: Added in version 4.9.0

◆ get_LayerKey()

string AxMap.get_LayerKey ( int layerHandle )

Gets a string associated with a layer in the map.

This string can be used to store any string data desired by the developer.

Parameters

layerHandle The handle for the layer for which the layer key is to be set.

Returns: The layer key for the specified layer in string format.

◆ get_LayerLabels()

Labels AxMap.get_LayerLabels ( int layerHandle )

Returns labels associated with layer.

Labels can also be obtained by using Shapefile.Labels and Image.Labels.

Parameters

layerHandle The handle of the layer.

Returns: The labels associated with the layer.

New API 4.8:: Added in version 4.8

◆ get_LayerMaxVisibleScale()

double AxMap.get_LayerMaxVisibleScale ( int layerHandle )

Gets the maximum scale at which the layer is visible on the map.

Parameters

layerHandle The handle of the layer.

Returns: The maximum visible scale for the layer.

New API 4.8:: Added in version 4.8

◆ get_LayerMaxVisibleZoom()

int AxMap.get_LayerMaxVisibleZoom ( int layerHandle )

Gets maximum zoom at which the layer will be displayed.

Parameters

layerHandle

Returns

It's analogous to get_LayerMaxVisibleScale, only scale specified as zoom level of the current tile provider (Map.Tiles.Provider).

New API 4.9.1:: Added in version 4.9.1

◆ get_LayerMinVisibleScale()

double AxMap.get_LayerMinVisibleScale ( int layerHandle )

Gets the minimum scale at which the layer is visible on the map.

Parameters

layerHandle The handle of the layer.

Returns: The minimum visible scale for the layer.

New API 4.8:: Added in version 4.8

◆ get_LayerMinVisibleZoom()

int AxMap.get_LayerMinVisibleZoom ( int layerHandle )

Gets minimum zoom at which the layer will be displayed.

Parameters

layerHandle

Returns

It's analogous to get_LayerMinVisibleScale, only scale specified as zoom level of the current tile provider (Map.Tiles.Provider).

New API 4.9.1:: Added in version 4.9.1

◆ get_LayerName()

string AxMap.get_LayerName ( int layerHandle )

Gets the name of the specified layer.

Parameters

layerHandle The handle of the layer for which the name is to be set.

Returns: The layer name for the specified layer.

Examples: SortLayers.cs, and SplitByAttribute.cs.

◆ get_LayerSkipOnSaving()

bool AxMap.get_LayerSkipOnSaving ( int layerHandle )

Gets a boolean value which indicates whether the layer will be serialized by appropriate routines.

This property affects AxMap.SaveMapState, AxMap.SerializeMapState.

Parameters

layerHandle The handle of the layer.

Returns: True in case the layer will be excluded from serialization and false otherwise.

New API 4.8:: Added in version 4.8

◆ get_LayerVisible()

bool AxMap.get_LayerVisible ( int layerHandle )

Gets the visibility of the specified layer.

Parameters

layerHandle The handle of the layer for which the visibility is being set.

Returns: A boolean value representing whether the layer is to be visible or not.

◆ GetColorScheme()

object AxMap.GetColorScheme ( int layerHandle )

Returns a color scheme for the specified layer.

Parameters

layerHandle The layer handle of the layer for which the coloring scheme is required

Returns: The color scheme for the specified layer

◆ set_LayerDescription()

void AxMap.set_LayerDescription	(	int	layerHandle,
		string	newValue
	)

Sets the description of the layer.

The information will be stored in .mwsymb file associated with data layer.

Parameters

layerHandle	The handle of the layer.
newValue	The description of the layer.

New API 4.8:: Added in version 4.8

◆ set_LayerDynamicVisibility()

void AxMap.set_LayerDynamicVisibility	(	int	layerHandle,
		bool	newValue
	)

Sets the boolean value which indicates whether the layer will be displayed at all scales or only within the chosen range of scales.

Parameters

layerHandle	The handle of the layer.
newValue	True in case the layer will be displayed between specified scales only.

See also: set_LayerMaxVisibleScale, set_LayerMinVisibleScale

New API 4.8:: Added in version 4.8

◆ set_LayerKey()

void AxMap.set_LayerKey	(	int	layerHandle,
		string	newValue
	)

Sets a string associated with a layer in the map.

This string can be used to store any string data desired by the developer.

Parameters

layerHandle	The handle of the layer.
newValue	The string to be associated with layer.

◆ set_LayerLabels()

void AxMap.set_LayerLabels	(	int	layerHandle,
		Labels	newValue
	)

Sets the labels associated with the layer.

Parameters

layerHandle	The handle of the layer.
newValue	The new instance of the Labels class to be associated with the layer.

New API 4.8:: Added in version 4.8

◆ set_LayerMaxVisibleScale()

void AxMap.set_LayerMaxVisibleScale	(	int	layerHandle,
		double	newValue
	)

Sets the maximum scale at which the layer is visible on the map.

Parameters

layerHandle	The handle of the layer.
newValue	The maximum visible scale for the layer.

New API 4.8:: Added in version 4.8

◆ set_LayerMaxVisibleZoom()

void AxMap.set_LayerMaxVisibleZoom	(	int	layerHandle,
		int	param0
	)

Sets maximum zoom at which the layer will be displayed.

Parameters

layerHandle	Layer handle.
param0	The new value of max zoom.

It's analogous to set_LayerMaxVisibleScale, only scale specified as zoom level of the current tile provider (Map.Tiles.Provider).

New API 4.9.1:: Added in version 4.9.1

◆ set_LayerMinVisibleScale()

void AxMap.set_LayerMinVisibleScale	(	int	layerHandle,
		double	newValue
	)

Sets the minimum scale at which the layer is visible on the map.

Parameters

layerHandle	The handle of the layer.
newValue	The minimum visible scale for the layer.

New API 4.8:: Added in version 4.8

◆ set_LayerMinVisibleZoom()

void AxMap.set_LayerMinVisibleZoom	(	int	layerHandle,
		int	param0
	)

Sets minimum zoom at which the layer will be displayed.

Parameters

layerHandle	Layer handle.
param0	The new value of max zoom.

It's analogous to set_LayerMinVisibleScale, only scale specified as zoom level of the current tile provider (Map.Tiles.Provider).

New API 4.9.1:: Added in version 4.9.1

◆ set_LayerName()

void AxMap.set_LayerName	(	int	layerHandle,
		string	newValue
	)

Sets the name of the specified layer.

Parameters

layerHandle	The handle of the layer for which the name is to be set.
newValue	The name to be set for the layer.

Examples: AddLayers.cs, and SplitByAttribute.cs.

◆ set_LayerSkipOnSaving()

void AxMap.set_LayerSkipOnSaving	(	int	layerHandle,
		bool	newValue
	)

Sets a boolean value which indicates whether the layer will be serialized by appropriate routines.

This property affects AxMap.SaveMapState, AxMap.SerializeMapState.

Parameters

layerHandle	The handle of the layer.
newValue	True in case the layer will be excluded from serialization and false otherwise.

New API 4.8:: Added in version 4.8

◆ set_LayerVisible()

void AxMap.set_LayerVisible	(	int	layerHandle,
		bool	newValue
	)

Sets the visibility of the specified layer.

Parameters

layerHandle	The handle of the layer for which the visibility is returned.
newValue	A boolean value representing whether the layer is to be visible or not.

◆ SetImageLayerColorScheme()

bool AxMap.SetImageLayerColorScheme	(	int	layerHandle,
		object	colorScheme
	)

Sets the color scheme of an image layer

Parameters

layerHandle	The handle if the layer the color scheme needs to set
colorScheme	The color scheme

Returns: True on success

Functions

Detailed Description

Function Documentation

◆ get_LayerDescription()

◆ get_LayerDynamicVisibility()

◆ get_LayerFilename()

◆ get_LayerKey()

◆ get_LayerLabels()

◆ get_LayerMaxVisibleScale()

◆ get_LayerMaxVisibleZoom()

◆ get_LayerMinVisibleScale()

◆ get_LayerMinVisibleZoom()

◆ get_LayerName()

◆ get_LayerSkipOnSaving()

◆ get_LayerVisible()

◆ GetColorScheme()

◆ set_LayerDescription()

◆ set_LayerDynamicVisibility()

◆ set_LayerKey()

◆ set_LayerLabels()

◆ set_LayerMaxVisibleScale()

◆ set_LayerMaxVisibleZoom()

◆ set_LayerMinVisibleScale()

◆ set_LayerMinVisibleZoom()

◆ set_LayerName()

◆ set_LayerSkipOnSaving()

◆ set_LayerVisible()

◆ SetImageLayerColorScheme()