SpaceDopeSheetEditor(Space)

base classes — bpy_struct, Space

class bpy.types.SpaceDopeSheetEditor(Space)

Dope Sheet space data

cache_cloth

Show the active object’s cloth point cache (default False)

Type:

bool

cache_dynamicpaint

Show the active object’s Dynamic Paint cache (default False)

Type:

bool

cache_particles

Show the active object’s particle point cache (default False)

Type:

bool

cache_rigidbody

Show the active object’s Rigid Body cache (default False)

Type:

bool

cache_simulation_nodes

Show the active object’s simulation nodes cache and bake data (default False)

Type:

bool

cache_smoke

Show the active object’s smoke cache (default False)

Type:

bool

cache_softbody

Show the active object’s softbody point cache (default False)

Type:

bool

dopesheet

Settings for filtering animation data (readonly)

Type:

DopeSheet

mode

Editing context being displayed (default 'ACTION')

  • DOPESHEET Dope Sheet – Edit all keyframes in scene.

  • ACTION Action Editor – Edit keyframes in active object’s Object-level action.

  • SHAPEKEY Shape Key Editor – Edit keyframes in active object’s Shape Keys action.

  • GPENCIL Grease Pencil – Edit timings for all Grease Pencil sketches in file.

  • MASK Mask – Edit timings for Mask Editor splines.

  • CACHEFILE Cache File – Edit timings for Cache File data-blocks.

  • TIMELINE Timeline – Simple timeline view with playback controls in the header, without channel list, side-panel, or footer.

Type:

Literal[‘DOPESHEET’, ‘ACTION’, ‘SHAPEKEY’, ‘GPENCIL’, ‘MASK’, ‘CACHEFILE’, ‘TIMELINE’]

overlays

Settings for display of overlays (readonly, never None)

Type:

SpaceDopeSheetOverlay

show_cache

Show the status of cached frames in the timeline (default False)

Type:

bool

show_extremes

Mark keyframes where the key value flow changes direction, based on comparison with adjacent keys (default False)

Type:

bool

show_interpolation

Display keyframe handle types and non-Bézier interpolation modes (default False)

Type:

bool

show_markers

If any exists, show markers in a separate row at the bottom of the editor (default False)

Type:

bool

show_pose_markers

Show markers belonging to the active action instead of Scene markers (Action and Shape Key Editors only) (default False)

Type:

bool

show_region_channels

(default False)

Type:

bool

(default False)

Type:

bool

show_region_hud

(default False)

Type:

bool

show_region_ui

(default False)

Type:

bool

show_seconds

Show timing as a timecode instead of frames (default False)

Type:

bool

show_sliders

Show sliders beside F-Curve channels (default False)

Type:

bool

ui_mode

Editing context being displayed (default 'ACTION')

  • DOPESHEET Dope Sheet – Edit all keyframes in scene.

  • ACTION Action Editor – Edit keyframes in active object’s Object-level action.

  • SHAPEKEY Shape Key Editor – Edit keyframes in active object’s Shape Keys action.

  • GPENCIL Grease Pencil – Edit timings for all Grease Pencil sketches in file.

  • MASK Mask – Edit timings for Mask Editor splines.

  • CACHEFILE Cache File – Edit timings for Cache File data-blocks.

Type:

Literal[‘DOPESHEET’, ‘ACTION’, ‘SHAPEKEY’, ‘GPENCIL’, ‘MASK’, ‘CACHEFILE’]

use_auto_merge_keyframes

Automatically merge nearby keyframes (default True)

Type:

bool

use_marker_sync

Sync Markers with keyframe edits (default False)

Type:

bool

use_realtime_update

When transforming keyframes, changes to the animation data are flushed to other views (default True)

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

classmethod draw_handler_add(callback, args, region_type, draw_type)

Add a new draw handler to this space type. It will be called every time the specified region in the space type will be drawn. Note: All arguments are positional only for now.

Parameters:

  • callback (Callable[..., Any]) – A function that will be called when the region is drawn. It gets the specified arguments as input, it’s return value is ignored.

  • args (tuple[Any, ...]) – Arguments that will be passed to the callback.

  • region_type (str) – The region type the callback draws in; usually WINDOW. (bpy.types.Region.type)

  • draw_type (str) – Usually POST_PIXEL for 2D drawing and POST_VIEW for 3D drawing. In some cases PRE_VIEW can be used. BACKDROP can be used for backdrops in the node editor.

Returns:

Handler that can be removed later on.

Return type:

object

classmethod draw_handler_remove(handler, region_type)

Remove a draw handler that was added previously.

Parameters:

  • handler (object) – The draw handler that should be removed.

  • region_type (str) – Region type the callback was added to.

Inherited Properties

Inherited Functions