base class — bpy_struct

class bpy.types.Area(bpy_struct)

Area in a subdivided screen, containing an editor


Area height

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

Regions this area is subdivided in

Type:bpy_prop_collection of Region, (readonly)

Show menus in the header

Type:boolean, default False

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)

Current editor type for this area

  • EMPTY Empty.
  • VIEW_3D 3D View, 3D viewport.
  • 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.
  • TIMELINE Timeline, Timeline and playback controls.
  • GRAPH_EDITOR Graph Editor, Edit drivers and keyframe interpolation.
  • DOPESHEET_EDITOR Dope Sheet, Adjust timing of keyframes.
  • NLA_EDITOR NLA Editor, Combine and layer Actions.
  • TEXT_EDITOR Text Editor, Edit scripts and in-file documentation.
  • LOGIC_EDITOR Logic Editor, Game logic editing.
  • 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).
  • 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.
  • USER_PREFERENCES User Preferences, Edit persistent configuration settings.

Area width

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

The window relative vertical location of the area

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

The window relative horizontal location of the area

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



Set the header text

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