# Header(bpy_struct)

base class — `bpy_struct`

class `bpy.types.``Header`(bpy_struct)

  Editor header containing UI elements

  `bl_idname`

    If this is set, the header gets a custom ID, otherwise it takes the name of the class used to define the panel; for example, if the class name is “OBJECT_HT_hello”, and bl_idname is not set by the script, then bl_idname = “OBJECT_HT_hello”

    Type: | string, default “”, (never None)

  `bl_region_type`

    The region where the header is going to be used in (defaults to header region)

    Type: | enum in [‘WINDOW’, ‘HEADER’, ‘CHANNELS’, ‘TEMPORARY’, ‘UI’, ‘TOOLS’, ‘TOOL_PROPS’, ‘PREVIEW’, ‘HUD’, ‘NAVIGATION_BAR’, ‘EXECUTE’, ‘FOOTER’, ‘TOOL_HEADER’], default ‘HEADER’

  `bl_space_type`

    The space where the header is going to be used in

    - `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, Log of operations, warnings and error messages.
    - `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 ‘EMPTY’

  `layout`

    Structure of the header in the UI

    Type: | `UILayout`, (readonly)

  `draw`(context)

    Draw UI elements into the header UI layout

  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`