Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IUserInterfaceApi

Implemented by

Index

Methods

addColorsToPalette

  • addColorsToPalette(colorPalette: string[]): void
  • Parameters

    • colorPalette: string[]

    Returns void

addStyleClassNames

  • addStyleClassNames(styleClassNames: string[]): void
  • Parameters

    • styleClassNames: string[]

    Returns void

clearColumnPermittedValues

  • clearColumnPermittedValues(column: string): void
  • If this function is called the column will revert to default behaviour which is t show current distinct values for the column in filters, searches etc

    Parameters

    • column: string

    Returns void

getAllEditLookUpColumns

getAllPermittedValues

getEditLookUpColumnForColumn

  • Parameters

    • columnId: string

    Returns EditLookUpColumn

getPermittedValuesForColumn

  • Parameters

    • columnId: string

    Returns PermittedColumnValues

getUserInterfaceState

  • Gets all the User Interface state from the Store

    Returns UserInterfaceState

isEditLookUpColumn

  • isEditLookUpColumn(columnId: string): boolean
  • Parameters

    • columnId: string

    Returns boolean

setColorPalette

  • setColorPalette(colorPalette: string[]): void
  • Sets the Color Palette - when creating functions that use the Style Object (e.g. Conditional Style, Format Column).

    Parameters

    • colorPalette: string[]

    Returns void

setColumnPermittedValues

  • setColumnPermittedValues(column: string, permittedValues: string[]): void
  • This replaces any existing permitted values for the column. It is ​​not​​ an additive function.

    Parameters

    • column: string
    • permittedValues: string[]

    Returns void

Generated using TypeDoc