globalmapper.SetLayerUserText

globalmapper.SetLayerUserText(GM_LayerHandle_t32 aLayer, str aUserText) → GM_Error_t32[source]

Sets a text string to associate with the layer. This value can be retrieved by calling GetLayerInfo. This text string will persist through a save to a workspace with SaveWorkspace so if you reload that workspace the same text string will be available. This is useful if you want to tie some text to the layer that persists through a save.

Parameters:

  • aLayer (GM_LayerHandle_t32) – layer to set user text for

  • aUserText (str) – text string to set as text for layer

Returns:

Error Code

Return type:

GM_Error_t32