GreasePencilLayers(bpy_struct)

base class — bpy_struct

class bpy.types.GreasePencilLayers(bpy_struct)

Collection of grease pencil layers

active

Active grease pencil layer

Type:GPencilLayer
active_index

Index of active grease pencil layer

Type:int in [0, inf], default 0
active_note

Note/Layer to add annotation strokes to

Type:enum in [‘DEFAULT’], default ‘DEFAULT’
new(name, set_active=True)

Add a new grease pencil layer

Parameters:
  • name (string, (never None)) – Name, Name of the layer
  • set_active (boolean, (optional)) – Set Active, Set the newly created layer to the active layer
Returns:

The newly created layer

Return type:

GPencilLayer

remove(layer)

Remove a grease pencil layer

Parameters:layer (GPencilLayer, (never None)) – The layer to remove
move(layer, type)

Move a grease pencil layer in the layer stack

Parameters:
  • layer (GPencilLayer, (never None)) – The layer to move
  • type (enum in ['UP', 'DOWN']) – Direction of movement
classmethod bl_rna_get_subclass(id, default=None)
Parameters:id (string) – 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 (string) – The RNA type identifier.
Returns:The class or default when not found.
Return type:type

Inherited Properties

Inherited Functions

References