Skip to main content

AddCustomSymbol

Updated
globalmapper.AddCustomSymbol(string aSymbolFilename, string aSymbolName) → GM_Error_t32

Adds a new custom symbol that can be used when drawing point features (see the SetPointFeatureDrawStyle function).

Parameters:

  • aSymbolFilename (str) – Full path to symbol file (BMP or ICO)

  • aSymbolName (str) – Text name to use when referring to the symbol

Returns:

Error Code

Return type:

GM_Error_t32

Example

The following is an example of AddCustomSymbol.

import os
import globalmapper as gm

import_dir = "Z:/GM-20069/single_function_sample_data/"

### START SAMPLE
err_AddCustomSymbol = gm.AddCustomSymbol(
    import_dir + "toucan_icon.ico", "Toucan Icon"
)

### END SAMPLE

err_RemoveCustomSymbol = gm.RemoveCustomSymbol("Toucan Icon")

assert (
    gm.GM_Error_None == err_AddCustomSymbol
), f"AddCustomSymbol: Expected {gm.GM_Error_None}, got {err_AddCustomSymbol}"
assert (
    gm.GM_Error_None == err_RemoveCustomSymbol
), f"RemoveCustomSymbol: Expected {gm.GM_Error_None}, got {err_RemoveCustomSymbol}"

assert os.path.isdir(import_dir), f"Import directory doesn't exist: {import_dir}"

assert os.path.exists(
    os.path.join(import_dir, "toucan_icon.ico")
), "Sample data doesn't exist"