Options
All
  • Public
  • Public/Protected
  • All
Menu

Functions relating to the AdapTable Dashboard.

Hierarchy

  • DashboardApi

Index

Methods

addCustomButton

addCustomToolbarButtons

  • addCustomToolbarButtons(customToolbarName: string, buttons: ToolbarButton[]): void
  • Adds the Toolbar Buttons to the current collection in the Custom Toolbar

    Parameters

    • customToolbarName: string

      the name of the Custom Toolbar

    • buttons: ToolbarButton[]

      the ToolbarButtons to add

    Returns void

clearCustomToolbarButtons

  • clearCustomToolbarButtons(customToolbarName: string): void
  • Clears all the Toolbar Buttons from the Custom Toolbar

    Parameters

    • customToolbarName: string

      the name of the Custom Toolbar

    Returns void

collapseDashboard

  • collapseDashboard(): void
  • Collapses the Dashboard so only the Dashboard Header is visible - and not the contents of any Toolbars

    Returns void

deleteCustomButton

dockDashboard

  • dockDashboard(): void
  • Docks the Dashboard so that it 'snaps back' into its customary position above the grid.

    Returns void

expandDashboard

  • expandDashboard(): void

fireToolbarVisibilityChangedEvent

  • fireToolbarVisibilityChangedEvent(tab: DashboardTab, toolbar: string): void
  • Fires the Toolbar Visibility Changed Event for the given Tab and Toolbar

    Parameters

    • tab: DashboardTab

      The Tab which is visible

    • toolbar: string

      The Toolbar which is visible

    Returns void

floatDashboard

  • floatDashboard(): void
  • Floats the Dashboard so only the Dashboard Header is visible (in reduced size) - and it can be dragged to a new location

    Returns void

getActiveTab

getActiveTabIndex

  • getActiveTabIndex(): number | undefined

getCurrentToolbars

getCustomButtonByName

  • getCustomButtonByName(customButtonName: string): ToolbarButton | undefined
  • Retrieves the first Custom Button in Dashboard State with the given name

    Parameters

    • customButtonName: string

      the name of the Custom Button to retrieve

    Returns ToolbarButton | undefined

getCustomButtons

getCustomToolbarByName

  • getCustomToolbarByName(customToolbarName: string): CustomToolbar

getCustomToolbarContentsDiv

  • getCustomToolbarContentsDiv(customToolbarName: string): HTMLElement | null
  • Returns the 'div' element for the given Custom Toolbar

    Parameters

    • customToolbarName: string

      the name of the Custom Toolbar

    Returns HTMLElement | null

getCustomToolbars

getDashboardState

getTabByName

isToolbarVisible

setActiveTab

  • setActiveTab(tabIndex: number): void
  • Sets the Active Tab in the Dashboard Header

    Parameters

    • tabIndex: number

      the tab index to set

    Returns void

setCustomToolbarButtons

  • setCustomToolbarButtons(customToolbarName: string, buttons: ToolbarButton[]): void
  • Replaces the Toolbar Buttons in the Custom toolbar with the new set

    Parameters

    • customToolbarName: string

      the name of the Custom Toolbar

    • buttons: ToolbarButton[]

      the ToolbarButtons to add

    Returns void

setHomeToolbarTitle

  • setHomeToolbarTitle(title: string): void
  • Sets the title of the Dashboard Header

    Note: This is the bit which can be double-clicked to put the Dashboard into floating mode

    If no value is set this property, the Dashboard will display the value of the AdaptableId property in AdaptableOptions

    Parameters

    • title: string

    Returns void

setVisibleButtons

showDashboardPopup

  • showDashboardPopup(): void

updateCustomButton

Generated using TypeDoc