Region(bpy_struct)

base class — bpy_struct

class bpy.types.Region(bpy_struct)

Region in a subdivided screen area

active_panel_category

The current active panel category, may be Null if the region does not support this feature (NOTE: these categories are generated at runtime, so list may be empty at initialization, before any drawing took place) (default 'UNSUPPORTED')

Type:

Literal[Region Panel Category Items]

alignment

Alignment of the region within the area (default 'NONE', readonly)

  • NONE None – Don’t use any fixed alignment, fill available space.

  • TOP Top.

  • BOTTOM Bottom.

  • LEFT Left.

  • RIGHT Right.

  • HORIZONTAL_SPLIT Horizontal Split.

  • VERTICAL_SPLIT Vertical Split.

  • FLOAT Float – Region floats on screen, does not use any fixed alignment.

  • QUAD_SPLIT Quad Split – Region is split horizontally and vertically.

Type:

Literal[‘NONE’, ‘TOP’, ‘BOTTOM’, ‘LEFT’, ‘RIGHT’, ‘HORIZONTAL_SPLIT’, ‘VERTICAL_SPLIT’, ‘FLOAT’, ‘QUAD_SPLIT’]

data

Region specific data (the type depends on the region type) (readonly)

Type:

AnyType

height

Region height (in [0, 32767], default 0, readonly)

Type:

int

type

Type of this region (default 'WINDOW', readonly)

Type:

Literal[Region Type Items]

view2d

2D view of the region (readonly, never None)

Type:

View2D

width

Region width (in [0, 32767], default 0, readonly)

Type:

int

x

The window relative vertical location of the region (in [-inf, inf], default 0, readonly)

Type:

int

y

The window relative horizontal location of the region (in [-inf, inf], default 0, readonly)

Type:

int

tag_redraw()

tag_redraw

tag_refresh_ui()

tag_refresh_ui

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