Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GridApi

Hierarchy

Implements

Index

Constructors

constructor

  • new GridApi(blotter: IAdaptableBlotter): GridApi
  • Constructor for all the api classes which simply takes and assigns an instance of the Adaptable Blotter

    Parameters

    • blotter: IAdaptableBlotter

      the core IAdaptableBlotter object

    Returns GridApi

Methods

checkItemExists

  • checkItemExists(item: any, name: string, type: string): boolean
  • Base api Helper method to ensure that the Adaptable Blotter Object being used in the function is not null or undefined

    If it does not exist then we log an error and the api method should stop

    Parameters

    • item: any

      the AdaptableBlotterObject being checked

    • name: string

      the name of the object if it has one (e.g. if its a search)

    • type: string

      the actual type of the object being checked

    Returns boolean

dispatchAction

  • dispatchAction(action: Action): void
  • Base api Helper method that dispatches a Redux Action to the Store

    Parameters

    • action: Action

      the Redux Action to be dispatched

    Returns void

getBlotterState

  • getBlotterState(): AdaptableBlotterState
  • Returns the entire State from the Store

    This is a simple getState() call

    Returns AdaptableBlotterState

getColumnSorts

getColumns

  • getColumns(): IColumn[]

getDateColumns

  • getDateColumns(): IColumn[]

getGridState

getNumericColumns

  • getNumericColumns(): IColumn[]

getSelectedCellInfo

  • getSelectedCellInfo(): SelectedCellInfo

getSelectedRowInfo

  • getSelectedRowInfo(): SelectedRowInfo

getVisibleColumns

  • getVisibleColumns(): IColumn[]

setGlue42Off

  • setGlue42Off(): void

setGlue42On

  • setGlue42On(): void

setGridCell

  • setGridCell(gridCell: GridCell): void
  • Parameters

    • gridCell: GridCell

    Returns void

setGridCellBatch

  • setGridCellBatch(gridCells: GridCell[]): void
  • Parameters

    • gridCells: GridCell[]

    Returns void

setGridData

  • setGridData(dataSource: any): void
  • Parameters

    • dataSource: any

    Returns void

setValue

  • setValue(id: any, columnId: string, newValue: any): void
  • Parameters

    • id: any
    • columnId: string
    • newValue: any

    Returns void

Generated using TypeDoc