Region(bpy_struct)

base class — bpy_struct

class bpy.types.Region.Region(bpy_struct)

Region in a subdivided screen area

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, doesn’t 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)

height

Region height

Type

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

type

Type of this region

Type

enum in [‘WINDOW’, ‘HEADER’, ‘CHANNELS’, ‘TEMPORARY’, ‘UI’, ‘TOOLS’, ‘TOOL_PROPS’, ‘PREVIEW’, ‘HUD’, ‘NAVIGATION_BAR’, ‘EXECUTE’, ‘FOOTER’, ‘TOOL_HEADER’], 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

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

Inherited Properties

  • bpy_struct.id_data

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

References

  • Area.regions

  • Context.region