AnnotationLayers(bpy_prop_collection)

base classes — bpy_prop, bpy_prop_collection

class bpy.types.AnnotationLayers(bpy_prop_collection)

Collection of annotation layers

active_index

Index of active annotation layer (in [0, inf], default 0)

Type:

int

active_note

Note/Layer to add annotation strokes to (default 'DEFAULT')

Type:

Literal[‘DEFAULT’]

new(name, *, set_active=True)

Add a new annotation layer

Parameters:
  • name (str) – Name, Name of the layer (never None)

  • set_active (bool) – Set Active, Set the newly created layer to the active layer (optional)

Returns:

The newly created layer

Return type:

AnnotationLayer

remove(layer)

Remove a annotation layer

Parameters:

layer (AnnotationLayer) – The layer to remove (never None)

classmethod bl_rna_get_subclass(id, default=None, /)
Parameters:
  • id (str) – The RNA type identifier.

  • default (bpy.types.Struct | None) – The value to return when not found.

Returns:

The RNA type or default when not found.

Return type:

bpy.types.Struct

classmethod bl_rna_get_subclass_py(id, default=None, /)
Parameters:
  • id (str) – The RNA type identifier.

  • default (type | None) – The value to return when not found.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References