Space(bpy_struct)

base class — bpy_struct

subclasses — SpaceClipEditor, SpaceConsole, SpaceDopeSheetEditor, SpaceFileBrowser, SpaceGraphEditor, SpaceImageEditor, SpaceInfo, SpaceLogicEditor, SpaceNLA, SpaceNodeEditor, SpaceOutliner, SpacePreferences, SpaceProperties, SpaceSequenceEditor, SpaceSpreadsheet, SpaceTextEditor, SpaceView3D

class bpy.types.Space(bpy_struct)

Space data for a screen area

show_locked_time

Synchronize the visible timeline range with other time-based editors

Type

boolean, default False

show_region_header
Type

boolean, default False

type

Space data type

  • EMPTY Empty.

  • VIEW_3D 3D Viewport – Manipulate objects in a 3D environment.

  • IMAGE_EDITOR UV/Image Editor – View and edit images and UV Maps.

  • NODE_EDITOR Node Editor – Editor for node-based shading and compositing tools.

  • SEQUENCE_EDITOR Video Sequencer – Video editing tools.

  • CLIP_EDITOR Movie Clip Editor – Motion tracking tools.

  • DOPESHEET_EDITOR Dope Sheet – Adjust timing of keyframes.

  • GRAPH_EDITOR Graph Editor – Edit drivers and keyframe interpolation.

  • NLA_EDITOR Nonlinear Animation – Combine and layer Actions.

  • TEXT_EDITOR Text Editor – Edit scripts and in-file documentation.

  • LOGIC_EDITOR Logic Bricks Editor – Logic Bricks Editor tools.

  • CONSOLE Python Console – Interactive programmatic console for advanced editing and script development.

  • INFO Info – Log of operations, warnings and error messages.

  • TOPBAR Top Bar – Global bar at the top of the screen for global per-window settings.

  • STATUSBAR Status Bar – Global bar at the bottom of the screen for general status information.

  • OUTLINER Outliner – Overview of scene graph and all available data-blocks.

  • PROPERTIES Properties – Edit properties of active object and related data-blocks.

  • FILE_BROWSER File Browser – Browse for files and assets.

  • SPREADSHEET Spreadsheet – Explore geometry data in a table.

  • PREFERENCES Preferences – Edit persistent configuration settings.

Type

enum in [‘EMPTY’, ‘VIEW_3D’, ‘IMAGE_EDITOR’, ‘NODE_EDITOR’, ‘SEQUENCE_EDITOR’, ‘CLIP_EDITOR’, ‘DOPESHEET_EDITOR’, ‘GRAPH_EDITOR’, ‘NLA_EDITOR’, ‘TEXT_EDITOR’, ‘LOGIC_EDITOR’, ‘CONSOLE’, ‘INFO’, ‘TOPBAR’, ‘STATUSBAR’, ‘OUTLINER’, ‘PROPERTIES’, ‘FILE_BROWSER’, ‘SPREADSHEET’, ‘PREFERENCES’], default ‘EMPTY’, (readonly)

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

References