GreasePencilv3LayerGroup(bpy_struct)

base class — bpy_struct

class bpy.types.GreasePencilv3LayerGroup(bpy_struct)

Collection of Grease Pencil layers

active

Active Grease Pencil layer group

Type

GreasePencilLayerGroup

new(name, *, parent_group=None)

Add a new Grease Pencil layer group

Parameters

  • name (string, (never None)) – Name, Name of the layer group

  • parent_group (GreasePencilLayerGroup, (optional)) – The parent layer group the new group will be created in (use None for the main stack)

Returns

The newly created layer group

Return type

GreasePencilLayerGroup

remove(layer_group, *, keep_children=False)

Remove a new Grease Pencil layer group

Parameters

  • layer_group (GreasePencilLayerGroup, (never None)) – The layer group to remove

  • keep_children (boolean, (optional)) – Keep the children nodes of the group and only delete the group itself

move(layer_group, type)

Move a layer group in the parent layer group or main stack

Parameters

  • layer_group (GreasePencilLayerGroup, (never None)) – The layer group to move

  • type (enum in ['DOWN', 'UP']) – Direction of movement

move_top(layer_group)

Move a layer group to the top of the parent layer group or main stack

Parameters

layer_group (GreasePencilLayerGroup, (never None)) – The layer group to move

move_bottom(layer_group)

Move a layer group to the bottom of the parent layer group or main stack

Parameters

layer_group (GreasePencilLayerGroup, (never None)) – The layer group to move

move_to_layer_group(layer_group, parent_group)

Move a layer group into a parent layer group

Parameters
classmethod bl_rna_get_subclass(id, default=None, /)
Parameters

id (str) – The RNA type identifier.

Returns

The RNA type or default when not found.

Return type

bpy.types.Struct subclass

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters

id (str) – The RNA type identifier.

Returns

The class or default when not found.

Return type

type

Inherited Properties

Inherited Functions

References