WorkSpace(ID)

base classes — bpy_struct, ID

class bpy.types.WorkSpace(ID)

Workspace data-block, defining the working environment for the user

active_addon

Active Add-on in the Workspace Add-ons filter (in [-inf, inf], default 0)

Type:

int

asset_library_reference

Active asset library to show in the UI, not used by the Asset Browser (which has its own active asset library) (default 'ALL')

  • ALL All Libraries – Show assets from all of the listed asset libraries.

  • LOCAL Current File – Show the assets currently available in this Blender session.

  • ESSENTIALS Essentials – Show the basic building blocks and utilities coming with Blender.

  • CUSTOM Custom – Show assets from the asset libraries configured in the Preferences.

Type:

Literal[‘ALL’, ‘LOCAL’, ‘ESSENTIALS’, ‘CUSTOM’]

object_mode

Switch to this object mode when activating the workspace (default 'OBJECT')

Type:

Literal[Workspace Object Mode Items]

owner_ids

(default None, readonly)

Type:

wmOwnerIDs[wmOwnerID]

screens

Screen layouts of a workspace (default None, readonly)

Type:

bpy_prop_collection[Screen]

sequencer_scene
Type:

Scene

tools

(default None, readonly)

Type:

wmTools[WorkSpaceTool]

use_filter_by_owner

Filter the UI by tags (default False)

Type:

bool

use_pin_scene

Remember the last used scene for the workspace and switch to it whenever this workspace is activated again (default False)

Type:

bool

use_scene_time_sync

Set the active scene and time based on the current scene strip (default False)

Type:

bool

classmethod status_text_set_internal(text)

Set the status bar text, typically key shortcuts for modal operators

Parameters:

text (str) – Text, New string for the status bar, None clears the text

status_text_set(text)

Set the status text or None to clear, When text is a function, this will be called with the (header, context) arguments.

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