Blockbench Reference Docs
    Preparing search index...

    Class Panel

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    condition container default_configuration display_condition events form? growable handle height icon id inside_vue? menu min_height? mode_position_data name node onFold onResize optional plugin? previous_slot resizable? resize_handles? sidebar_resize_handle snap_menu tab_bar toolbars type vue? width floating_panel_z_order selected

    Accessors

    attached_index attached_to fixed_height folded open_attached_panel position_data slot

    Methods

    addListener addToolbar attachPanel customizePosition delete dispatchEvent fold getAttachedPanels getContainerPanel getHostPanel isInSidebar isVisible moveTo moveToFront on once removeListener resetCustomLayout resize selectTab setupFloatHandles update updateSlot

    Constructors

    • Parameters

      • id: string | PanelOptions
      • data: PanelOptions

      Returns Panel

    Properties

    condition: ConditionResolvable
    container: HTMLElement
    default_configuration: {
        default_position?: Partial<PanelPositionData>;
        mode_positions?: Record<string, Partial<PanelPositionData>>;
    }

    The default configuration of the panel as it was when constructed without user customization

    display_condition: ConditionResolvable
    events: Record<string, EventListener[]>
    form?: InputForm
    growable: boolean
    handle: HTMLElement
    height: number
    icon: string
    id: string
    inside_vue?: Vue
    menu: Menu
    min_height?: number
    mode_position_data: Record<string, PanelPositionData>

    Stores panel position data during the current session

    name: string
    node: HTMLElement
    onFold: () => void
    onResize: () => void
    optional: boolean
    plugin?: string
    previous_slot: PanelSlot
    resizable?: boolean
    resize_handles?: HTMLElement
    sidebar_resize_handle: HTMLElement
    snap_menu: Menu
    tab_bar: HTMLElement
    toolbars: Toolbar[]
    type: "panel"
    vue?: Vue
    width: number
    floating_panel_z_order: string[]
    selected: Panel

    Accessors

    • get attached_index(): number

      Returns number

    • set attached_index(id: number): void

      Parameters

      • id: number

      Returns void

    • get attached_to(): string

      Returns string

    • set attached_to(id: string): void

      Parameters

      • id: string

      Returns void

    • get fixed_height(): boolean

      Returns boolean

    • set fixed_height(state: boolean): void

      Parameters

      • state: boolean

      Returns void

    • get folded(): boolean

      Returns boolean

    • set folded(state: boolean): void

      Parameters

      • state: boolean

      Returns void

    • get open_attached_panel(): Panel

      Returns Panel

    • set open_attached_panel(panel: Panel): void

      Parameters

      Returns void

    • get position_data(): PanelPositionData

      Returns PanelPositionData

    • get slot(): PanelSlot

      Returns PanelSlot

    Methods

    • Parameters

      • event_name: string
      • cb: EventListener

      Returns Deletable

    • Parameters

      • toolbar: Toolbar
      • Optionalposition: number

      Returns void

    • Parameters

      • panel: Panel
      • Optionalindex: number

      Returns void

    • Parameters

      • Optionaldata: Partial<PanelPositionData>

      Returns void

    • Returns void

    • Parameters

      • event_name: PanelEvent
      • data: any

      Returns void

    • Parameters

      • Optionalstate: boolean

      Returns this

    • Returns Panel[]

    • Get the panel that acts as the container for this panel. If the panel is not attached to another panel, returns itself

      Returns Panel

    • Get the host panel if this panel is attached to another panel

      Returns Panel

    • Returns boolean

    • Returns boolean

    • Parameters

      • slot: PanelSlot
      • Optionalref_panel: Panel
      • Optionalbefore: boolean

      Returns this

    • Returns this

    • Parameters

      • event_name: string
      • cb: EventListener

      Returns Deletable

    • Parameters

      • event_name: string
      • cb: EventListener

      Returns Deletable

    • Parameters

      • event_name: string
      • cb: EventListener

      Returns void

    • Returns this

    • Parameters

      • e1: MouseEvent | TouchEvent

      Returns void

    • Parameters

      Returns this

    • Returns this

    • Parameters

      • Optionaldragging: boolean

      Returns this

    • Returns this

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Accessors
    Methods