GreasePencilLayers(bpy_struct)

base class — bpy_struct

class bpy.types.GreasePencilLayers.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

  • bpy_struct.id_data

Inherited Functions

  • bpy_struct.as_pointer

  • bpy_struct.driver_add

  • bpy_struct.driver_remove

  • bpy_struct.get

  • bpy_struct.is_property_hidden

  • bpy_struct.is_property_overridable_library

  • bpy_struct.is_property_readonly

  • bpy_struct.is_property_set

  • bpy_struct.items

  • bpy_struct.keyframe_delete

  • bpy_struct.keyframe_insert

  • bpy_struct.keys

  • bpy_struct.path_from_id

  • bpy_struct.path_resolve

  • bpy_struct.pop

  • bpy_struct.property_overridable_library_set

  • bpy_struct.property_unset

  • bpy_struct.type_recast

  • bpy_struct.values

References

  • GreasePencil.layers