SpaceDopeSheetEditor(Space)¶

base classes — bpy_struct, Space

class bpy.types.SpaceDopeSheetEditor(Space)¶

Dope Sheet space data

action¶

Action displayed and edited in this space

Type: Action

auto_snap¶

Automatic time snapping settings for transformations

NONE No Auto-Snap.
STEP Frame Step, Snap to 1.0 frame intervals.
TIME_STEP Second Step, Snap to 1.0 second intervals.
FRAME Nearest Frame, Snap to actual frames (nla-action time).
SECOND Nearest Second, Snap to actual seconds (nla-action time).
MARKER Nearest Marker, Snap to nearest marker.

Type: enum in [‘NONE’, ‘STEP’, ‘TIME_STEP’, ‘FRAME’, ‘SECOND’, ‘MARKER’], default ‘NONE’

cache_cloth¶

Show the active object’s cloth point cache

Type: boolean, default False

cache_dynamicpaint¶

Show the active object’s Dynamic Paint cache

Type: boolean, default False

cache_particles¶

Show the active object’s particle point cache

Type: boolean, default False

cache_rigidbody¶

Show the active object’s Rigid Body cache

Type: boolean, default False

cache_smoke¶

Show the active object’s smoke cache

Type: boolean, default False

cache_softbody¶

Show the active object’s softbody point cache

Type: boolean, default False

dopesheet¶

Settings for filtering animation data

Type: DopeSheet, (readonly)

mode¶

Editing context being displayed

DOPESHEET Dope Sheet, Edit all keyframes in scene.
TIMELINE Timeline, Timeline and playback controls.
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: enum in [‘DOPESHEET’, ‘TIMELINE’, ‘ACTION’, ‘SHAPEKEY’, ‘GPENCIL’, ‘MASK’, ‘CACHEFILE’], default ‘ACTION’

show_cache¶

Show the status of cached frames in the timeline

Type: boolean, default False

show_extremes¶

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

Type: boolean, default False

show_interpolation¶

Display keyframe handle types and non-bezier interpolation modes

Type: boolean, default False

show_markers¶

If any exists, show markers in a separate row at the bottom of the editor

Type: boolean, default False

show_pose_markers¶

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

Type: boolean, default False

show_region_ui¶

Type: boolean, default False

show_seconds¶

Show timing in seconds not frames

Type: boolean, default False

show_sliders¶

Show sliders beside F-Curve channels

Type: boolean, default False

ui_mode¶

Editing context being displayed

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: enum in [‘DOPESHEET’, ‘ACTION’, ‘SHAPEKEY’, ‘GPENCIL’, ‘MASK’, ‘CACHEFILE’], default ‘ACTION’

use_auto_merge_keyframes¶

Automatically merge nearby keyframes

Type: boolean, default False

use_marker_sync¶

Sync Markers with keyframe edits

Type: boolean, default False

use_realtime_update¶

When transforming keyframes, changes to the animation data are flushed to other views

Type: boolean, default False

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

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 (function) – A function that will be called when the region is drawn. It gets the specified arguments as input.
args (tuple) – 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

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