GlobalSettings Class Reference

Holds global settings for MapWinGIS. Allows to retrieve GDAL errors. More...

Collaboration diagram for GlobalSettings:
Collaboration graph

Public Member Functions

string LocalizedString (tkLocalizedStrings stringValue)
 Gets the localized version for a specified string used in the GUI. More...
 
void LocalizedString (tkLocalizedStrings stringValue, string newValue)
 Sets the localized version for a specified string used in the GUI. More...
 
void ResetGdalError ()
 Clears information about last GDAL error. More...
 
void SetHereMapsApiKey (string appId, string appCode)
 Sets application credentials for Here Maps online tiles. Without these credentials Here Maps providers are not available. More...
 
void SetHttpUserAgent (string userAgent)
 Sets the user-agent string that will be used when requesting tiles. More...
 
bool StartLogTileRequests (string filename, bool errorsOnly=false)
 Starts logging of tile requests. More...
 
void StopLogTileRequests ()
 Stops the logging of the tile requests to a logfile More...
 
bool TestBingApiKey (string key)
 Requests URL address for tiles download from Bing Maps server. More...
 

Properties

bool AllowLayersWithIncompleteReprojection [get, set]
 Allow layers with incomplete reprojection. More...
 
bool AllowLayersWithoutProjections [get, set]
 Gets or sets a value indicating whether layers without metadata about coordinate system / projection can be added to the map. More...
 
bool AllowProjectionMismatch [get, set]
 Gets or sets a value indicating whether layers with coordinate system / projection different from those of the map can be added to the map. More...
 
ICallback ApplicationCallback [get, set]
 Gets or sets global callback object to report information about progress and errors taking place inside MapWinGIS. More...
 
bool AutoChooseOgrLoadingMode [get, set]
 Gets or sets a value which indicates whether OgrLayer.DynamicLoading mode will be chosen automatically based on the number of features. More...
 
bool AutoChooseRenderingHintForLabels [get, set]
 When set to true rendering hint for Labels will be chosen automatically to ensure better performance and visual quality. More...
 
string BingApiKey [get, set]
 Gets or sets API key to access Bing maps. Without API key Bing Maps provider isn't available. More...
 
bool CacheDbfRecords [get, set]
 Gets or sets a value indicating whether caching DBF records is enabled. More...
 
bool CacheShapeRenderingData [get, set]
 Gets or sets a value indicating whether caching of rendering data for shapes is enabled. More...
 
tkCallbackVerbosity CallbackVerbosity [get, set]
 Gets or sets the callback verbosity. More...
 
double ClipperGcsMultiplicationFactor [get, set]
 Gets or sets a value which defines the multiplication coefficient for data in decimal degrees.

‍The default value is 10000.0.

More...
 
tkTiffCompression CompressOverviews [get, set]
 Gets or sets the value indicating which compression mode will be used to compress image overviews. More...
 
PredefinedColorScheme DefaultColorSchemeForGrids [get, set]
 Gets or sets color scheme to be used for rendering grids. More...
 
bool ForceHideLabels [get, set]
 When set to true, any labels added to any instance of AxMap won't be rendered. More...
 
string GdalDataPath [get, set]
 Gets or sets the path where data necessary for GDAL coordinate systems / projections will be searched for. More...
 
string GdalLastErrorMsg [get]
 Extracts the last error message reported by GDAL library. More...
 
tkGdalError GdalLastErrorNo [get]
 Gets a subtype of the last error reported by GDAL library. More...
 
tkGdalErrorType GdalLastErrorType [get]
 Gets a type of the last error reported by GDAL library. More...
 
string GdalPluginPath [get, set]
 Gets or sets the path where GDAL plug-ins will be searched for. More...
 
string GdalReprojectionErrorMsg [get]
 Gets last error reported by GDAL reprojection routine. More...
 
string GdalVersion [get]
 Gets the version of GDAL library which current build of MapWinGIS uses. More...
 
tkGeometryEngine GeometryEngine [get, set]
 Gets or sets initial value to be set for Shapefile.GeometryEngine property of newly created shapefiles. More...
 
bool GridFavorGreyscale [get, set]
 Gets or sets a value indicating whether greyscale or color scheme rendering will be used for grids by default. More...
 
tkGridProxyFormat GridProxyFormat [get, set]
 Gets or sets format to be used for displaying grid datasources using image proxy. More...
 
tkGridProxyMode GridProxyMode [get, set]
 Gets or sets preferred display mode for grid datasources. More...
 
bool GridUseHistogram [get, set]
 Gets or sets a value indicating whether histogram will be computed and used for grid by default. More...
 
int HotTrackingMaxShapeCount [get, set]
 Gets or sets maximum number of shapes within view for hot tracking functionality to work. More...
 
tkInterpolationMode ImageDownsamplingMode [get, set]
 Gets or sets default value of Image.DownsamplingMode property. More...
 
tkInterpolationMode ImageUpsamplingMode [get, set]
 Gets or sets default value of Image.UpsamplingMode property. More...
 
tkCollisionMode LabelsCollisionMode [get, set]
 Sets collision mode for all instances of Labels class (which represent labels for either shapefiles or images). More...
 
tkCompositingQuality LabelsCompositingQuality [get, set]
 Gets or sets GDI+ compositing quality for label drawing which will be used for all newly added layers. More...
 
tkSmoothingMode LabelsSmoothingMode [get, set]
 Gets or sets GDI+ smoothing mode for label drawing which will be used for all newly added layers. More...
 
bool LoadSymbologyOnAddLayer [get, set]
 Gets or sets a value indicating whether layer symbology from .mwsymb XML file should be automatically applied on adding layer to the map. More...
 
bool LogTileErrorsOnly [get, set]
 Gets or sets a value indicating whether only errors will be logged to the for TMS/WMS requests. More...
 
double MaxDirectGridSizeMb [get, set]
 Gets or sets maximum allowable size in MB for a grid datasource to be opened without proxy creation. More...
 
int MaxReprojectionShapeCount [get, set]
 Gets or sets a value which limits the maximum number of shapes within a vector layer to run on-the-fly reprojection. More...
 
int MaxUniqueValuesCountForGridScheme [get, set]
 Gets or sets the maximum allowable number of unique values in grid color scheme. More...
 
double MinAreaToPerimeterRatio [get, set]
 Gets or sets a value which is used to weed out long narrow "splintered" polygons generated by geoprocessing routines. More...
 
int MinOverviewWidth [get, set]
 Gets or sets the minimum width of image for GDAL overviews to be created. For images with smaller width no GDAL overviews will be created. More...
 
double MinPolygonArea [get, set]
 Gets or sets the minimal area of polygon which will be passed to the output by geoprocessing routines. More...
 
double MouseTolerance [get, set]
 Gets or sets a value which determines how close to a particular object mouse cursor should be in order to select it with mouse click. More...
 
bool OgrInterpretYNStringAsBoolean [get, set]
 Gets or sets a value which indicates whether to interpret single-character Ogr strings as Logical/Boolean values, as long as the character contained in the string is one of valid DBF logical characters (e.g. Y, N, T, F). More...
 
bool OgrLayerForceUpdateMode [get, set]
 When set to true the opening of any OGR layer will be first made with forUpdate parameter. If this first attempt fails, the layer will be opened without update flag. More...
 
int OgrLayerMaxFeatureCount [get, set]
 Gets or sets the maximum number of features that can be loaded into memory for a single OGR layer. More...
 
bool OgrShareConnection [get, set]
 Share connection between layers (may be unstable). For large read-only layers it will increase performance. More...
 
tkOgrEncoding OgrStringEncoding [get, set]
 Gets or sets string encoding used to communicate with OGR drivers. More...
 
bool OverrideLocalCallback [get, set]
 Gets or sets a value indicating whether instances of ICallback assigned to particular classes will be overriden by global callback assined to GlobalSettings.ApplicationCallback property. More...
 
tkPixelOffsetMode PixelOffsetMode [get, set]
 Gets or sets pixel offset mode to be used during the rendering of vector layers. More...
 
string ProjPath [get, set]
 Gets or sets the path where the PROJ resource files (proj.db) will be searched for (starting with PROJ 6). More...
 
bool RandomColorSchemeForGrids [get, set]
 Gets or sets a value indicating whether color scheme set in GlobalsSettings.DefaultColorSchemeForGrids or a radom one should be used on opening grids. More...
 
tkRasterOverviewCreation RasterOverviewCreation [get, set]
 Gets or sets a value indicating whether automatic creation of GDAL overviews will be performed for large datasets. More...
 
tkGDALResamplingMethod RasterOverviewResampling [get, set]
 Gets or sets resampling method for creation of GDAL overviews. More...
 
bool ReprojectLayersOnAdding [get, set]
 Gets or sets a value which determines whether automatic on-the-fly reprojection of the vector layer will be performed on adding a new layer to the map with different projection. More...
 
bool SaveGridColorSchemeToFile [get, set]
 Gets or sets a value indicating whether color scheme for grid will be saved to .mwleg to be reused on the next opening. More...
 
bool ShapefileFastMode [get, set]
 Gets or sets the value which indicates whether all the new instances of Shapefile class will be initialized with the fast mode turned on. More...
 
bool ShapefileFastUnion [get, set]
 Gets or sets a value which affects the speed of Shapefile.Union operation. More...
 
tkShapeValidationMode ShapeInputValidationMode [get, set]
 Sets validation mode for input of geoprocessing operations. More...
 
tkShapeValidationMode ShapeOutputValidationMode [get, set]
 Sets validation mode for output of geoprocessing operations. More...
 
tkTiffCompression TiffCompression [get, set]
 Gets or sets compression mode to be used for TIFF proxies created for grid rendering. More...
 
string TileLogFilename [get]
 Gets the filename of the file to log TMS/WMS requests to. More...
 
bool TileLogIsOpened [get]
 Gets a value indicating whether tile log is opened. More...
 
int TilesMinZoomOnProjectionMismatch [get, set]
 Gets or sets minimum available zoom level for tiles when map projection and server projection don't match. More...
 
int TilesThreadPoolSize [get, set]
 Gets or sets the number of threads to be used for downloading tiles from remote server. More...
 
bool WmsDiskCaching [get, set]
 Gets or sets a value indicating whether WMS data will cached to the disk by default. More...
 
bool ZoomToFirstLayer [get, set]
 Gets or sets a value indicating whether a map will zoom automatically to the first layer added with AxMap.AddLayer. More...
 

Detailed Description

Holds global settings for MapWinGIS. Allows to retrieve GDAL errors.

All the properties of this class are defined as global variables and therefore changes in any instance of this class will affect all the instances of MapWinGIS control hosted by the application.

The major part of properties require advanced understanding of MapWinGIS functioning therefore it's not recommended to change them without a good reason.

Sometimes properties can be added to this class to provide a switch for testing new functions. Such properties may be removed afterwards (GlobalSettings.ShapefileFastUnion for example).

New API 4.8:
Added in version 4.8

Member Function Documentation

◆ LocalizedString() [1/2]

string GlobalSettings.LocalizedString ( tkLocalizedStrings  stringValue)

Gets the localized version for a specified string used in the GUI.

Parameters
stringValueString to get localized version for.
Returns
Localized string.
// Usage:
var gs = new GlobalSettings();
gs.LocalizedString[tkLocalizedStrings.lsKilometers]; // Notice the square brackets
// or
gs.get_LocalizedString(tkLocalizedStrings.lsKilometers); // Notice the parentheses and the 'get_' prefix
tkLocalizedStrings
GUI strings that may be localized.
Definition: Enumerations.cs:2058
Holds global settings for MapWinGIS. Allows to retrieve GDAL errors.
Definition: GlobalSettings.cs:29
New API 4.9.1:
Added in version 4.9.1

◆ LocalizedString() [2/2]

void GlobalSettings.LocalizedString ( tkLocalizedStrings  stringValue,
string  newValue 
)

Sets the localized version for a specified string used in the GUI.

Parameters
stringValueString to set localized version for.
newValueNew localized value.
// Usage:
var gs = new GlobalSettings();
gs.LocalizedString[tkLocalizedStrings.lsMiles] = "Mijl"; // Notice the square brackets
// or
gs.set_LocalizedString(tkLocalizedStrings.lsMiles, "Mijl"); // Notice the parentheses and the 'set_' prefix
New API 4.9.1:
Added in version 4.9.1

◆ ResetGdalError()

void GlobalSettings.ResetGdalError ( )

◆ SetHereMapsApiKey()

void GlobalSettings.SetHereMapsApiKey ( string  appId,
string  appCode 
)

Sets application credentials for Here Maps online tiles. Without these credentials Here Maps providers are not available.

Note
Needs to be updated. Here Maps uses an API key now.
Parameters
appIdApplication Id. Can be obtained by registering on the site of the service.
appCodeApplication code. Can be obtained by registering on the site of the service.
New API 4.9.3:
Added in version 4.9.3

◆ SetHttpUserAgent()

void GlobalSettings.SetHttpUserAgent ( string  userAgent)

Sets the user-agent string that will be used when requesting tiles.

‍Default value is MapWinGIS/5.0

Parameters
userAgent
New API 5.1:
Added in version 5.1.0

◆ StartLogTileRequests()

bool GlobalSettings.StartLogTileRequests ( string  filename,
bool  errorsOnly = false 
)

Starts logging of tile requests.

See also
Tiles.LogFilename
GlobalSettings.StopLogTileRequests
Parameters
filenameThe filename.
errorsOnlyIf set to true only errors will be logged.
Returns
True on success.
New API 4.9.4:
Added in version 4.9.4

◆ StopLogTileRequests()

void GlobalSettings.StopLogTileRequests ( )

Stops the logging of the tile requests to a logfile

See also
Tiles.LogFilename
GlobalSettings.StartLogTileRequests

◆ TestBingApiKey()

bool GlobalSettings.TestBingApiKey ( string  key)

Requests URL address for tiles download from Bing Maps server.

Parameters
keyAPI key to test.
Returns
True if the Url for downloading for obtained.
New API 4.9.3:
Added in version 4.9.3

Property Documentation

◆ AllowLayersWithIncompleteReprojection

bool GlobalSettings.AllowLayersWithIncompleteReprojection
getset

Allow layers with incomplete reprojection.

‍Default value is false

New API 5.1:
Added in version 5.1.0

◆ AllowLayersWithoutProjections

bool GlobalSettings.AllowLayersWithoutProjections
getset

Gets or sets a value indicating whether layers without metadata about coordinate system / projection can be added to the map.

The decision can also be made on per-layer bases by handling AxMap.LayerProjectionIsEmpty event.

‍Default value is true.

New API 4.9.3:
Added in version 4.9.3

◆ AllowProjectionMismatch

bool GlobalSettings.AllowProjectionMismatch
getset

Gets or sets a value indicating whether layers with coordinate system / projection different from those of the map can be added to the map.

In most cases it's not advisable to allow projection mismatch, since relative position of layers with different projections won't be correct. The decision can also be made on per-layer bases by handling AxMap.ProjectionMismatch event.

‍Default value is false.

New API 4.9.3:
Added in version 4.9.3

◆ ApplicationCallback

ICallback GlobalSettings.ApplicationCallback
getset

Gets or sets global callback object to report information about progress and errors taking place inside MapWinGIS.

The callback object set by this property will override all callback set for particular classes (like Shapefile.GlobalCallback, AxMap.GlobalCallback). Also it will automatically display internal GDAL error messages.

Note
It's strongly recommended to use this property rather than setting callback for each and every class.
New API 4.9.3:
Added in version 4.9.3

◆ AutoChooseOgrLoadingMode

bool GlobalSettings.AutoChooseOgrLoadingMode
getset

Gets or sets a value which indicates whether OgrLayer.DynamicLoading mode will be chosen automatically based on the number of features.

‍Default value is true

New API 4.9.3:
Added in version 4.9.3

◆ AutoChooseRenderingHintForLabels

bool GlobalSettings.AutoChooseRenderingHintForLabels
getset

When set to true rendering hint for Labels will be chosen automatically to ensure better performance and visual quality.

‍Default value is true.

See also
Labels.TextRenderingHint
New API 4.9.3:
Added in version 4.9.3

◆ BingApiKey

string GlobalSettings.BingApiKey
getset

Gets or sets API key to access Bing maps. Without API key Bing Maps provider isn't available.

New API 4.9.3:
Added in version 4.9.3

◆ CacheDbfRecords

bool GlobalSettings.CacheDbfRecords
getset

Gets or sets a value indicating whether caching DBF records is enabled.

‍Default value is true.

New API 4.9.4:
Added in version 4.9.4

◆ CacheShapeRenderingData

bool GlobalSettings.CacheShapeRenderingData
getset

Gets or sets a value indicating whether caching of rendering data for shapes is enabled.

‍Default value is false.

New API 4.9.4:
Added in version 4.9.4

◆ CallbackVerbosity

tkCallbackVerbosity GlobalSettings.CallbackVerbosity
getset

Gets or sets the callback verbosity.

‍Default value is tkCallbackVerbosity.cvAll

New API 4.9.4:
Added in version 4.9.4

◆ ClipperGcsMultiplicationFactor

double GlobalSettings.ClipperGcsMultiplicationFactor
getset

Gets or sets a value which defines the multiplication coefficient for data in decimal degrees.

‍The default value is 10000.0.

The value is used for Clipper library due to the lack of built-in scaling in it.

◆ CompressOverviews

tkTiffCompression GlobalSettings.CompressOverviews
getset

Gets or sets the value indicating which compression mode will be used to compress image overviews.

The value is read from the GDAL option COMPRESS_OVERVIEW

Bug fixed in v5.4: MWGIS-309

‍Default value is tkTiffCompression.tkmNONE.

New API 4.9.4:
Added in version 4.9.4

◆ DefaultColorSchemeForGrids

PredefinedColorScheme GlobalSettings.DefaultColorSchemeForGrids
getset

Gets or sets color scheme to be used for rendering grids.

The value will be used on passing Grid object to AxMap.AddLayer method.

‍Default value is PredefinedColorScheme.SummerMountains.

New API 4.9.1:
Added in version 4.9.1

◆ ForceHideLabels

bool GlobalSettings.ForceHideLabels
getset

When set to true, any labels added to any instance of AxMap won't be rendered.

‍Default value is false.

New API 4.9.3:
Added in version 4.9.3

◆ GdalDataPath

string GlobalSettings.GdalDataPath
getset

Gets or sets the path where data necessary for GDAL coordinate systems / projections will be searched for.

This property effectively overrides GDAL_DATA environment variable. By default it's set to gdal-data folder in the directory where MapWinGIS is installed.

New API 4.9.3:
Added in version 4.9.3

◆ GdalLastErrorMsg

string GlobalSettings.GdalLastErrorMsg
get

Extracts the last error message reported by GDAL library.

◆ GdalLastErrorNo

tkGdalError GlobalSettings.GdalLastErrorNo
get

Gets a subtype of the last error reported by GDAL library.

‍The default value is tkGdalError.GdalErrorUndefined

◆ GdalLastErrorType

tkGdalErrorType GlobalSettings.GdalLastErrorType
get

Gets a type of the last error reported by GDAL library.

‍The default value is tkGdalErrorType.GdalUndefined

◆ GdalPluginPath

string GlobalSettings.GdalPluginPath
getset

Gets or sets the path where GDAL plug-ins will be searched for.

This property effectively overrides GDAL_DRIVER_PATH environment variable. By default it's set to gdalplugins folder in the directory where MapWinGIS is installed.

New API 4.9.3:
Added in version 4.9.3

◆ GdalReprojectionErrorMsg

string GlobalSettings.GdalReprojectionErrorMsg
get

Gets last error reported by GDAL reprojection routine.

Can be used to find out the source of failure of Shapefile.Reproject and Shapefile.ReprojectInPlace functions.

◆ GdalVersion

string GlobalSettings.GdalVersion
get

Gets the version of GDAL library which current build of MapWinGIS uses.

New API 4.9.3:
Added in version 4.9.3

◆ GeometryEngine

tkGeometryEngine GlobalSettings.GeometryEngine
getset

Gets or sets initial value to be set for Shapefile.GeometryEngine property of newly created shapefiles.

‍Default value is tkGeometryEngine.engineGeos

New API 4.9.1:
Added in version 4.9.1

◆ GridFavorGreyscale

bool GlobalSettings.GridFavorGreyscale
getset

Gets or sets a value indicating whether greyscale or color scheme rendering will be used for grids by default.

‍Default value is true.

New API 4.9.4:
Added in version 4.9.4

◆ GridProxyFormat

tkGridProxyFormat GlobalSettings.GridProxyFormat
getset

Gets or sets format to be used for displaying grid datasources using image proxy.

Methods like Grid.HasImageProxy or Grid.RemoveImageProxy will only take into account the format chosen in this property.

‍The default value is tkGridProxyFormat.gpfBmpProxy

New API 4.9.0:
Added in version 4.9.0

◆ GridProxyMode

tkGridProxyMode GlobalSettings.GridProxyMode
getset

Gets or sets preferred display mode for grid datasources.

This property will be used in AxMap.AddLayer and Grid.OpenAsImage methods if Grid.PreferedDisplayMode is set to tkGridProxyMode.gpmAuto.

‍The default value is tkGridProxyMode.gpmAuto

New API 4.9.0:
Added in version 4.9.0

◆ GridUseHistogram

bool GlobalSettings.GridUseHistogram
getset

Gets or sets a value indicating whether histogram will be computed and used for grid by default.

‍Default value is true.

New API 4.9.4:
Added in version 4.9.4

◆ HotTrackingMaxShapeCount

int GlobalSettings.HotTrackingMaxShapeCount
getset

Gets or sets maximum number of shapes within view for hot tracking functionality to work.

Hot tracking is used by tkCursorMode.cmIdentify tool and interactive editing tools.

‍Default value is 200

See also
Identifier.HotTracking, ShapeEditor.HighlightVertices.
New API 4.9.3:
Added in version 4.9.3

◆ ImageDownsamplingMode

tkInterpolationMode GlobalSettings.ImageDownsamplingMode
getset

Gets or sets default value of Image.DownsamplingMode property.

Quality of the image vs performance

‍Default value is tkInterpolationMode.imBilinear.

New API 4.9.2:
Added in version 4.9.2

◆ ImageUpsamplingMode

tkInterpolationMode GlobalSettings.ImageUpsamplingMode
getset

Gets or sets default value of Image.UpsamplingMode property.

Quality of the image vs performance

‍Default value is tkInterpolationMode.imNone.

New API 4.9.2:
Added in version 4.9.2

◆ LabelsCollisionMode

tkCollisionMode GlobalSettings.LabelsCollisionMode
getset

Sets collision mode for all instances of Labels class (which represent labels for either shapefiles or images).

‍The default value is tkCollisionMode.LocalList

New API 4.9.0:
Added in version 4.9.0

◆ LabelsCompositingQuality

tkCompositingQuality GlobalSettings.LabelsCompositingQuality
getset

Gets or sets GDI+ compositing quality for label drawing which will be used for all newly added layers.

‍The default value is tkCompositingQuality.HighQuality.

◆ LabelsSmoothingMode

tkSmoothingMode GlobalSettings.LabelsSmoothingMode
getset

Gets or sets GDI+ smoothing mode for label drawing which will be used for all newly added layers.

‍The default value is tkSmoothingMode.HighQualityMode.

◆ LoadSymbologyOnAddLayer

bool GlobalSettings.LoadSymbologyOnAddLayer
getset

Gets or sets a value indicating whether layer symbology from .mwsymb XML file should be automatically applied on adding layer to the map.

‍Default value is true.

New API 4.9.2:
Added in version 4.9.2

◆ LogTileErrorsOnly

bool GlobalSettings.LogTileErrorsOnly
getset

Gets or sets a value indicating whether only errors will be logged to the for TMS/WMS requests.

‍Default value is true.

New API 4.9.4:
Added in version 4.9.4

◆ MaxDirectGridSizeMb

double GlobalSettings.MaxDirectGridSizeMb
getset

Gets or sets maximum allowable size in MB for a grid datasource to be opened without proxy creation.

For grids with size exceeding the value of this property, proxy image will be created when GridProxyMode is set to tkGridProxyMode.gpmAuto. For tkGridProxyMode.gpmNoProxy Grid.CanDisplayWithoutProxy will return false and Grid.OpenAsImage will fail. Grids of smaller size will be rendered directly for all the modes but tkGridProxyMode.gpmUseProxy if datasources format allows it (see Grid.CanDisplayWithoutProxy).
Direct rendering of grid datasources is computationally expensive process therefore for large datasources rendering may become too slow.

‍Default value is 20.0 MB. Zero or negative values set no limitation.

New API 4.9.1:
Added in version 4.9.1

◆ MaxReprojectionShapeCount

int GlobalSettings.MaxReprojectionShapeCount
getset

Gets or sets a value which limits the maximum number of shapes within a vector layer to run on-the-fly reprojection.

This property is taken into account when projection mismatch occurs on adding a new layer to the map.

‍Default value is 50 000.

New API 4.9.3:
Added in version 4.9.3

◆ MaxUniqueValuesCountForGridScheme

int GlobalSettings.MaxUniqueValuesCountForGridScheme
getset

Gets or sets the maximum allowable number of unique values in grid color scheme.

Affects Grid.GeneratedColorScheme when generation method is set to tkGridSchemeGeneration.gsgUniqueValues or tkGridSchemeGeneration.gsgUniqueValuesOrGradient.

‍Default value is 100

New API 4.9.1:
Added in version 4.9.1

◆ MinAreaToPerimeterRatio

double GlobalSettings.MinAreaToPerimeterRatio
getset

Gets or sets a value which is used to weed out long narrow "splintered" polygons generated by geoprocessing routines.

Polygons with area to perimeter ratio less than this values won't be passed to the output.

‍The default value is 0.0001.

◆ MinOverviewWidth

int GlobalSettings.MinOverviewWidth
getset

Gets or sets the minimum width of image for GDAL overviews to be created. For images with smaller width no GDAL overviews will be created.

‍Default value is 512

New API 4.9.2:
Added in version 4.9.2

◆ MinPolygonArea

double GlobalSettings.MinPolygonArea
getset

Gets or sets the minimal area of polygon which will be passed to the output by geoprocessing routines.

When the data is defined in decimal degrees, this value will be divided into squared conversion factor between decimal degrees and meters (roughly 110000 per degree).

‍The default value is 1.0.

◆ MouseTolerance

double GlobalSettings.MouseTolerance
getset

Gets or sets a value which determines how close to a particular object mouse cursor should be in order to select it with mouse click.

‍Default value is 20 map units.

New API 4.9.3:
Added in version 4.9.3

◆ OgrInterpretYNStringAsBoolean

bool GlobalSettings.OgrInterpretYNStringAsBoolean
getset

Gets or sets a value which indicates whether to interpret single-character Ogr strings as Logical/Boolean values, as long as the character contained in the string is one of valid DBF logical characters (e.g. Y, N, T, F).

Applies to conversion of OGR Shapefile layers to MapWinGIS Shapefiles (via GetBuffer), since OGR Shapefiles do not support Logical fields. Instead, DBF Logical fields are read as single- character strings.

‍Default value is true.

New API 4.9.5:
Added in version 4.9.5

◆ OgrLayerForceUpdateMode

bool GlobalSettings.OgrLayerForceUpdateMode
getset

When set to true the opening of any OGR layer will be first made with forUpdate parameter. If this first attempt fails, the layer will be opened without update flag.

‍Default value is false.

See also
OgrLayer.SupportsEditing
New API 4.9.3:
Added in version 4.9.3

◆ OgrLayerMaxFeatureCount

int GlobalSettings.OgrLayerMaxFeatureCount
getset

Gets or sets the maximum number of features that can be loaded into memory for a single OGR layer.

‍Default value is 50 000

See also
OgrLayer.MaxFeatureCount
New API 4.9.3:
Added in version 4.9.3

◆ OgrShareConnection

bool GlobalSettings.OgrShareConnection
getset

Share connection between layers (may be unstable). For large read-only layers it will increase performance.

‍Default value is false

New API 4.9.4:
Added in version 4.9.4

◆ OgrStringEncoding

tkOgrEncoding GlobalSettings.OgrStringEncoding
getset

Gets or sets string encoding used to communicate with OGR drivers.

‍Default value is tkOgrEncoding.oseUtf8.

New API 4.9.3:
Added in version 4.9.3

◆ OverrideLocalCallback

bool GlobalSettings.OverrideLocalCallback
getset

Gets or sets a value indicating whether instances of ICallback assigned to particular classes will be overriden by global callback assined to GlobalSettings.ApplicationCallback property.

‍Default value is true.

New API 4.9.4:
Added in version 4.9.4

◆ PixelOffsetMode

tkPixelOffsetMode GlobalSettings.PixelOffsetMode
getset

Gets or sets pixel offset mode to be used during the rendering of vector layers.

‍Default value is tkPixelOffsetMode.pomDefault.

New API 4.9.3:
Added in version 4.9.3

◆ ProjPath

string GlobalSettings.ProjPath
getset

Gets or sets the path where the PROJ resource files (proj.db) will be searched for (starting with PROJ 6).

This property effectively overrides PROJ_LIB environment variable. By default it's set to proj7\share folder in the directory where MapWinGIS is installed.

New API 5.4:
Added in version 5.4

◆ RandomColorSchemeForGrids

bool GlobalSettings.RandomColorSchemeForGrids
getset

Gets or sets a value indicating whether color scheme set in GlobalsSettings.DefaultColorSchemeForGrids or a radom one should be used on opening grids.

The value will be used on passing Grid object to AxMap.AddLayer method.

‍Defautl value is true.

New API 4.9.1:
Added in version 4.9.1

◆ RasterOverviewCreation

tkRasterOverviewCreation GlobalSettings.RasterOverviewCreation
getset

Gets or sets a value indicating whether automatic creation of GDAL overviews will be performed for large datasets.

Currently applied to grid datasets only (both direct and proxy rendering). No automatic overview creation for RGB image is implemented so far.

‍Default value is tkRasterOverviewCreation.rocAuto.

New API 4.9.2:
Added in version 4.9.2

◆ RasterOverviewResampling

tkGDALResamplingMethod GlobalSettings.RasterOverviewResampling
getset

Gets or sets resampling method for creation of GDAL overviews.

‍Default value is tkGDALResamplingMethod.grmNearest.

New API 4.9.2:
Added in version 4.9.2

◆ ReprojectLayersOnAdding

bool GlobalSettings.ReprojectLayersOnAdding
getset

Gets or sets a value which determines whether automatic on-the-fly reprojection of the vector layer will be performed on adding a new layer to the map with different projection.

The decision can also be made on per-layer bases by handling AxMap.ProjectionMismatch event.

‍Default value is false.

See also
MaxReprojectionShapeCount
New API 4.9.3:
Added in version 4.9.3

◆ SaveGridColorSchemeToFile

bool GlobalSettings.SaveGridColorSchemeToFile
getset

Gets or sets a value indicating whether color scheme for grid will be saved to .mwleg to be reused on the next opening.

This value affects only grid datasources rendered by Image class directly. Color scheme for proxy images will be written on disk despite this values. Without them those proxies become meaningless.

‍Default value is true.

New API 4.9.1:
Added in version 4.9.1

◆ ShapefileFastMode

bool GlobalSettings.ShapefileFastMode
getset

Gets or sets the value which indicates whether all the new instances of Shapefile class will be initialized with the fast mode turned on.

‍The default value is false.

See also
Shapefile.FastMode

◆ ShapefileFastUnion

bool GlobalSettings.ShapefileFastUnion
getset

Gets or sets a value which affects the speed of Shapefile.Union operation.

‍The default value is true.

◆ ShapeInputValidationMode

tkShapeValidationMode GlobalSettings.ShapeInputValidationMode
getset

Sets validation mode for input of geoprocessing operations.

This setting affects only Shapefile objects, while it doesn't affect single shapes passed as parameters. Check results of validation in Shapefile.LastInputValidation.

‍Default value is tkShapeValidationMode.NoValidation.

New API 4.9.1:
Added in version 4.9.1

◆ ShapeOutputValidationMode

tkShapeValidationMode GlobalSettings.ShapeOutputValidationMode
getset

Sets validation mode for output of geoprocessing operations.

This setting affects only methods where Shapefile objects are returned as output, single shapes returned as output are not affected. Check results of validation in Shapefile.LastOutputValidation.

‍Default value is tkShapeValidationMode.NoValidation.

New API 4.9.1:
Added in version 4.9.1

◆ TiffCompression

tkTiffCompression GlobalSettings.TiffCompression
getset

Gets or sets compression mode to be used for TIFF proxies created for grid rendering.

‍Default value: tkTiffCompression.tkmLZW.

New API 4.9.2:
Added in version 4.9.2

◆ TileLogFilename

string GlobalSettings.TileLogFilename
get

Gets the filename of the file to log TMS/WMS requests to.

New API 4.9.4:
Added in version 4.9.4

◆ TileLogIsOpened

bool GlobalSettings.TileLogIsOpened
get

Gets a value indicating whether tile log is opened.

◆ TilesMinZoomOnProjectionMismatch

int GlobalSettings.TilesMinZoomOnProjectionMismatch
getset

Gets or sets minimum available zoom level for tiles when map projection and server projection don't match.

This value will be used for any provider which uses Spherical Mercator projection while map projection isn't set to Spherical Mercator or WGS84.

Smaller zoom levels (1-5) typically have severe distortions caused by coordinate transformation which makes them unusable. Tiles won't be displayed at all for these levels and they will not be included into the zoom bar.

‍Default value is 6.

New API 4.9.2:
Added in version 4.9.2

◆ TilesThreadPoolSize

int GlobalSettings.TilesThreadPoolSize
getset

Gets or sets the number of threads to be used for downloading tiles from remote server.

Increasing the number of threads doesn't necessarily lead to better performance as servers may limit the number of simultaneous connections from the same IP address.

‍Default value is 5.

New API 4.9.2:
Added in version 4.9.2

◆ WmsDiskCaching

bool GlobalSettings.WmsDiskCaching
getset

Gets or sets a value indicating whether WMS data will cached to the disk by default.

‍Default value is true.

New API 4.9.4:
Added in version 4.9.4

◆ ZoomToFirstLayer

bool GlobalSettings.ZoomToFirstLayer
getset

Gets or sets a value indicating whether a map will zoom automatically to the first layer added with AxMap.AddLayer.

‍Default value is true

New API 4.9.1:
Added in version 4.9.1