Highcharts Dashboards
    Preparing search index...

    Interface ResizedCell

    interface ResizedCell {
        container: HTMLElement;
        id: string;
        isHighlighted?: boolean;
        isVisible?: boolean;
        mountedComponent?: Component;
        nestedLayout?: Layout;
        options: Options;
        removeBindedEventFn?: Function;
        resizer?: Snap;
        row: Row;
        type?: GUIElementType;
        changeVisibility(setVisible?: boolean): void;
        destroy(): void;
        getElementContainer(options: GetElementContainerOptions): HTMLElement;
        getOverlappingLevels(
            align: "left" | "right" | "bottom" | "top",
            levelMaxGap: number,
            offset?: number,
        ): number[];
        getParentCell(level: number): Cell | undefined;
        getType(): GUIElementType | undefined;
        hide(): void;
        setActiveState(): void;
        setHighlight(remove?: boolean): void;
        setSize(width?: string | number, height?: string | number): void;
        show(): void;
    }
    Index

    Properties

    container id isHighlighted? isVisible? mountedComponent? nestedLayout? options removeBindedEventFn? resizer? row type?

    Methods

    changeVisibility destroy getElementContainer getOverlappingLevels getParentCell getType hide setActiveState setHighlight setSize show

    Properties

    container: HTMLElement

    HTML container of a GUIElement.

    id: string

    Cell id.

    isHighlighted?: boolean

    Cell highlight flag.

    isVisible?: boolean

    The visibility flag.

    mountedComponent?: Component

    Component mounted in the cell.

    nestedLayout?: Layout

    Layout nested in the cell.

    options: Options

    The cell options.

    removeBindedEventFn?: Function

    The function to remove bindedGUIElement event on GUIElement container.

    resizer?: Snap
    row: Row

    Reference to the row instance.

    type?: GUIElementType = Globals.guiElementType.cell

    The type of GUI element.

    Methods

    • Parameters

      • setVisible: boolean = true

      Returns void

    • Destroy the element, its container, event hooks and mounted component.

      Returns void

    • Create or get existing HTML element as a GUIElement container.

      Parameters

      • options: GetElementContainerOptions

        Options.

      Returns HTMLElement

      The HTML element for the element container.

    • Parameters

      • align: "left" | "right" | "bottom" | "top"
      • levelMaxGap: number
      • Optionaloffset: number

      Returns number[]

    • Parameters

      • level: number

      Returns Cell | undefined

    • Return the GUIElement instance type.

      Returns GUIElementType | undefined

      The GUIElement instance type

    • Returns void

    • Sets the active state of the cell and resets the state of other cells.

      Returns void

    • Parameters

      • Optionalremove: boolean

      Returns void

    • Set cell size.

      Parameters

      • Optionalwidth: string | number

        % value or 'auto' or px

      • Optionalheight: string | number

        value in px

      Returns void

    • Returns void

    Settings

    On This Page

    Properties
    Methods