Area(bpy_struct)

base class — bpy_struct

class bpy.types.Area(bpy_struct)

Area in a subdivided screen, containing an editor

height

Area height

Type:int in [0, 32767], default 0, (readonly)
regions

Regions this area is subdivided in

Type:bpy_prop_collection of Region, (readonly)
show_menus

Show menus in the header

Type:boolean, default False
spaces

Spaces contained in this area, the first being the active space (NOTE: Useful for example to restore a previously used 3D view space in a certain area to get the old view orientation)

Type:AreaSpaces bpy_prop_collection of Space, (readonly)
type

Current editor type for this area

  • EMPTY Empty.
  • VIEW_3D 3D Viewport, Manipulate objects in a 3D environment.
  • IMAGE_EDITOR UV/Image Editor, View and edit images and UV Maps.
  • NODE_EDITOR Node Editor, Editor for node-based shading and compositing tools.
  • SEQUENCE_EDITOR Video Sequencer, Video editing tools.
  • CLIP_EDITOR Movie Clip Editor, Motion tracking tools.
  • DOPESHEET_EDITOR Dope Sheet, Adjust timing of keyframes.
  • GRAPH_EDITOR Graph Editor, Edit drivers and keyframe interpolation.
  • NLA_EDITOR Nonlinear Animation, Combine and layer Actions.
  • TEXT_EDITOR Text Editor, Edit scripts and in-file documentation.
  • CONSOLE Python Console, Interactive programmatic console for advanced editing and script development.
  • INFO Info, Main menu bar and list of error messages (drag down to expand and display).
  • TOPBAR Top Bar, Global bar at the top of the screen for global per-window settings.
  • STATUSBAR Status Bar, Global bar at the bottom of the screen for general status information.
  • OUTLINER Outliner, Overview of scene graph and all available data-blocks.
  • PROPERTIES Properties, Edit properties of active object and related data-blocks.
  • FILE_BROWSER File Browser, Browse for files and assets.
  • PREFERENCES Preferences, Edit persistent configuration settings.
Type:enum in [‘EMPTY’, ‘VIEW_3D’, ‘IMAGE_EDITOR’, ‘NODE_EDITOR’, ‘SEQUENCE_EDITOR’, ‘CLIP_EDITOR’, ‘DOPESHEET_EDITOR’, ‘GRAPH_EDITOR’, ‘NLA_EDITOR’, ‘TEXT_EDITOR’, ‘CONSOLE’, ‘INFO’, ‘TOPBAR’, ‘STATUSBAR’, ‘OUTLINER’, ‘PROPERTIES’, ‘FILE_BROWSER’, ‘PREFERENCES’], default ‘VIEW_3D’
ui_type

Current editor type for this area

Type:enum in [‘DEFAULT’], default ‘DEFAULT’
width

Area width

Type:int in [0, 32767], default 0, (readonly)
x

The window relative vertical location of the area

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

The window relative horizontal location of the area

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

tag_redraw

header_text_set(text)

Set the header status text

Parameters:text (string) – Text, New string for the header, None clears the text
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

Inherited Functions

References