Skip to main content

RemoveCustomBrushStyle

Updated
globalmapper.RemoveCustomBrushStyle(str aBrushName) → GM_Error_t32

Removes a custom brush style that was previously added with the AddCustomBrushStyle function.

Parameters:

aBrushName (str) – Text name to use when referring to the brush style

Returns:

Error Code

Return type:

GM_Error_t32

Example

The following is an example of RemoveCustomBrushStyle.

import os
import globalmapper as gm

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

err_AddCustomBrushStyle, brush_style = gm.AddCustomBrushStyle(
    import_dir + "checkered_fill.jpg", "Checkered Fill"
)

### START SAMPLE
err_RemoveCustomBrushStyle = gm.RemoveCustomBrushStyle("Checkered Fill")

### END SAMPLE

assert (
    gm.GM_Error_None == err_AddCustomBrushStyle
), f"AddCustomBrushStyle: Expected {gm.GM_Error_None}, got {err_AddCustomBrushStyle}"
assert (
    gm.GM_Error_None == err_RemoveCustomBrushStyle
), f"RemoveCustomBrushStyle: Expected {gm.GM_Error_None}, got {err_RemoveCustomBrushStyle}"

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

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