AnnotationLayer(bpy_struct)

base class — bpy_struct

class bpy.types.AnnotationLayer(bpy_struct)

Collection of related sketches

active_frame

Frame currently being displayed for this layer (readonly)

Type:

AnnotationFrame

annotation_hide

Set annotation Visibility (default False)

Type:

bool

annotation_onion_after_color

Base color for ghosts after the active frame (array of 3 items, in [0, 1], default (0.25, 0.1, 1.0))

Type:

mathutils.Color

annotation_onion_after_range

Maximum number of frames to show after current frame (in [-1, 120], default 0)

Type:

int

annotation_onion_before_color

Base color for ghosts before the active frame (array of 3 items, in [0, 1], default (0.302, 0.851, 0.302))

Type:

mathutils.Color

annotation_onion_before_range

Maximum number of frames to show before current frame (in [-1, 120], default 0)

Type:

int

annotation_onion_use_custom_color

Use custom colors for onion skinning instead of the theme (default False)

Type:

bool

annotation_opacity

Annotation Layer Opacity (in [0, 1], default 0.0)

Type:

float

color

Color for all strokes in this layer (array of 3 items, in [0, 1], default (0.0, 0.0, 0.0))

Type:

mathutils.Color

frames

Sketches for this layer on different frames (default None, readonly)

Type:

AnnotationFrames[AnnotationFrame]

info

Layer name (default “”, never None)

Type:

str

is_ruler

This is a special ruler layer (default False, readonly)

Type:

bool

lock

Protect layer from further editing and/or frame changes (default False)

Type:

bool

lock_frame

Lock current frame displayed by layer (default False)

Type:

bool

select

Layer is selected for editing in the Dope Sheet (default False)

Type:

bool

show_in_front

Make the layer display in front of objects (default True)

Type:

bool

thickness

Thickness of annotation strokes (in [1, 10], default 0)

Type:

int

use_annotation_onion_skinning

Display annotation onion skins before and after the current frame (default False)

Type:

bool

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