SpaceProperties(Space)

base classes — bpy_struct, Space

class bpy.types.SpaceProperties.SpaceProperties(Space)

Properties space data

context
  • TOOL Tool, Active Tool and Workspace settings.

  • SCENE Scene, Scene Properties.

  • RENDER Render, Render Properties.

  • OUTPUT Output, Output Properties.

  • VIEW_LAYER View Layer, View Layer Properties.

  • WORLD World, World Properties.

  • OBJECT Object, Object Properties.

  • CONSTRAINT Constraints, Object Constraint Properties.

  • MODIFIER Modifiers, Modifier Properties.

  • DATA Data, Object Data Properties.

  • BONE Bone, Bone Properties.

  • BONE_CONSTRAINT Bone Constraints, Bone Constraint Properties.

  • MATERIAL Material, Material Properties.

  • TEXTURE Texture, Texture Properties.

  • PARTICLES Particles, Particle Properties.

  • PHYSICS Physics, Physics Properties.

  • SHADERFX Effects, Visual Effects Properties.

Type

enum in [‘TOOL’, ‘SCENE’, ‘RENDER’, ‘OUTPUT’, ‘VIEW_LAYER’, ‘WORLD’, ‘OBJECT’, ‘CONSTRAINT’, ‘MODIFIER’, ‘DATA’, ‘BONE’, ‘BONE_CONSTRAINT’, ‘MATERIAL’, ‘TEXTURE’, ‘PARTICLES’, ‘PHYSICS’, ‘SHADERFX’], default ‘RENDER’

pin_id
Type

ID

use_pin_id

Use the pinned context

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

  • bpy_struct.id_data

  • Space.type

  • Space.show_locked_time

  • Space.show_region_header

Inherited Functions

  • bpy_struct.as_pointer

  • bpy_struct.driver_add

  • bpy_struct.driver_remove

  • bpy_struct.get

  • bpy_struct.is_property_hidden

  • bpy_struct.is_property_overridable_library

  • bpy_struct.is_property_readonly

  • bpy_struct.is_property_set

  • bpy_struct.items

  • bpy_struct.keyframe_delete

  • bpy_struct.keyframe_insert

  • bpy_struct.keys

  • bpy_struct.path_from_id

  • bpy_struct.path_resolve

  • bpy_struct.pop

  • bpy_struct.property_overridable_library_set

  • bpy_struct.property_unset

  • bpy_struct.type_recast

  • bpy_struct.values

  • Space.bl_rna_get_subclass

  • Space.bl_rna_get_subclass_py

  • Space.draw_handler_add

  • Space.draw_handler_remove