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)

  • UNSUPPORTED Not Supported – This region does not support panel categories.

Type:

enum in ['UNSUPPORTED'], default "'UNSUPPORTED'"

alignment

Alignment of the region within the area

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

enum in ['NONE', 'TOP', 'BOTTOM', 'LEFT', 'RIGHT', 'HORIZONTAL_SPLIT', 'VERTICAL_SPLIT', 'FLOAT', 'QUAD_SPLIT'], default "'NONE'", (readonly)

data

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

Type:

AnyType, (readonly)

height

Region height

Type:

int in [0, 32767], default 0, (readonly)

type

Type of this region

Type:

enum in Region Type Items, default "'WINDOW'", (readonly)

view2d

2D view of the region

Type:

View2D, (readonly, never None)

width

Region width

Type:

int in [0, 32767], default 0, (readonly)

x

The window relative vertical location of the region

Type:

int in [-inf, inf], default 0, (readonly)

y

The window relative horizontal location of the region

Type:

int in [-inf, inf], default 0, (readonly)

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.

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