Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface LayoutApi

Provides full and comprehensive run-time access to the Layout function and associated Layout State.

Includes functions to retrieve, create, save, set and clone Layouts.

Hierarchy

  • LayoutApi

Index

Methods

cloneAndSetLayout

  • cloneAndSetLayout(layoutToClone: Layout, layoutName: string): void
  • Clones the given Layout by creating a new one with the same properties but with a new name (using the one provided), and then loads it into the Grid

    Parameters

    • layoutToClone: Layout

      the Layout to clone

    • layoutName: string

      the name to use the new Layout

    Returns void

cloneLayout

  • cloneLayout(layoutToClone: Layout, layoutName: string): void
  • Clones the given Layout by creating a new one with the same properties but with a new name (using the one provided)

    Parameters

    • layoutToClone: Layout

      the Layout to clone

    • layoutName: string

      the name to use the new Layout

    Returns void

createAndSetLayout

  • Creates the given Layout and then loads it into the Grid

    Parameters

    • layoutToCreate: Layout

      the Layout to create (the Api will create the identiifer automatically)

    Returns Layout

createLayout

  • Creates the a new Layout in the state

    Parameters

    • layoutToCreate: Layout

      the Layout to create (the Api will create the identiifer automatically)

    Returns Layout | undefined

doesLayoutExist

  • doesLayoutExist(layout: Layout): boolean
  • Checks whether this Layout exists in the Adaptable State (by comparing the Uuid property value)

    Parameters

    • layout: Layout

      the Layout to check

    Returns boolean

fireLayoutUpdatedEvent

  • fireLayoutUpdatedEvent(layout: Layout): void

getAllLayout

getCurrentLayout

getCurrentLayoutName

  • getCurrentLayoutName(): string

getCurrentVisibleColumnIds

  • getCurrentVisibleColumnIds(): string[]
  • Retrieves an array of visible column ids in the current layout.

    Returns string[]

getCurrentVisibleColumnIdsMap

  • getCurrentVisibleColumnIdsMap(): {}
  • Retrieves a map with visible columns in the current layout. The col ids are the keys, and the values are true

    Returns {}

    • [key: string]: boolean

getLayoutByName

  • getLayoutByName(layoutName: string): Layout | null

getLayoutState

saveCurrentLayout

  • saveCurrentLayout(): void
  • Saves the current Layout - using the column order, visibility and grid sort info currently being displayed in the grid

    Returns void

saveLayout

  • saveLayout(layoutToSave: Layout): void
  • Saves the given Layout into Adaptable State

    Parameters

    • layoutToSave: Layout

      the Layout to save (the Layout needs already to exist)

    Returns void

setLayout

  • setLayout(layoutName: string): void
  • Sets (i.e. selects) the Layout

    Parameters

    • layoutName: string

      the Layout to set (has to be the name an existing Layout)

    Returns void

shouldAutoSaveLayout

  • shouldAutoSaveLayout(layout?: Layout): boolean

showLayoutPopup

  • showLayoutPopup(): void

Generated using TypeDoc