Skip to main content

SetAreaFeatureDrawStyle

Updated
globalmapper.SetAreaFeatureDrawStyle(GM_LayerHandle_t32 aLayer, uint32 aAreaIndex, GM_AreaStyle_t aAreaStyle) → GM_Error_t32

Sets the style and font to use for drawing the given area object. Pass None for the area style to reset the drawing style to the default style for the classification of the area.

Typically, when modifying the drawing style of an area you will want to call GetAreaFeature to get the current drawing style, then copy the mAreaStyle member of the GM_AreaFeature_t and just change what you need, then pass your copy in to this function.

Parameters:

  • aLayer (GM_LayerHandle_t32) – Layer the area is in

  • aAreaIndex (uint32) – Index of area in layer

  • aAreaStyle (GM_AreaStyle_t) – New style to use for area

Returns:

Error Code

Return type:

GM_Error_t32

Example

The following is an example of SetAreaFeatureDrawStyle.

import os
import globalmapper as gm

import_dir = "Z:/GM-20069/single_function_sample_data/"
# Close all layers that may be open
layers_are_open = gm.GetLoadedLayerList()
if layers_are_open:
    arr_ptr, arr_size = layers_are_open
    initial_layers = gm.GM_LayerHandle_array_frompointer(arr_ptr)
    for i in range(arr_size):
        gm.CloseLayer(initial_layers[i])

err_LoadLayerList, array_pointer, array_size_param = gm.LoadLayerList(
    os.path.join(import_dir, "area.shp"),
    gm.GM_LoadFlags_HideAllPrompts,
)

arr_ptr, arr_size = gm.GetLoadedLayerList()
layers_array = gm.GM_LayerHandle_array_frompointer(arr_ptr)
layers_list = gm.carray_to_list(layers_array, arr_size)

### START SAMPLE
area_feature = gm.GetAreaFeature(layers_list[0], 0)
area_feature.mAreaStyle.mBorderPenColor = gm.toRGB(252, 3, 211)
area_feature.mAreaStyle.mBorderPenWidth = 10
err_SetAreaFeatureDrawStyle = gm.SetAreaFeatureDrawStyle(
    layers_list[0], 0, area_feature.mAreaStyle
)
gm.FreeAreaFeature(area_feature)

### END SAMPLE

# Resets the changes made in this sample
err_SetAreaFeatureDrawStyle1 = gm.SetAreaFeatureDrawStyle(layers_list[0], 0, None)

assert (
    gm.GM_Error_None == err_SetAreaFeatureDrawStyle
), f"SetAreaFeatureDrawStyle: Expected {gm.GM_Error_None}, got {err_SetAreaFeatureDrawStyle}"

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

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