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

Type:

int in [-inf, inf], default 0

asset_library_reference

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

  • 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:

enum in [‘ALL’, ‘LOCAL’, ‘ESSENTIALS’, ‘CUSTOM’], default ‘ALL’

object_mode

Switch to this object mode when activating the workspace

Type:

enum in Workspace Object Mode Items, default ‘OBJECT’

owner_ids
Type:

wmOwnerIDs bpy_prop_collection of wmOwnerID, (readonly)

screens

Screen layouts of a workspace

Type:

bpy_prop_collection of Screen, (readonly)

tools
Type:

wmTools bpy_prop_collection of WorkSpaceTool, (readonly)

use_filter_by_owner

Filter the UI by tags

Type:

boolean, default False

use_pin_scene

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

Type:

boolean, default False

classmethod status_text_set_internal(text)

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

Parameters:

text (string) – 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.

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 (str) – The RNA type identifier.

Returns:

The class or default when not found.

Return type:

type

Inherited Properties

Inherited Functions

References