Options
All
  • Public
  • Public/Protected
  • All
Menu

Provides full and comprehensive run-time access to the Format Column function and associated state.

Format Columns are columns which are given a style that is always applied (unlike Conditional Styles where the style is dependent on a rule being met).

Hierarchy

  • IFormatColumnApi

Implemented by

Index

Methods

addFormatColumn

  • addFormatColumn(column: string, style: IStyle): void
  • Adds a new Format Column

    Parameters

    • column: string

      The column to apply the Style to

    • style: IStyle

      The Style to apply - (see Style Object for more details)

    Returns void

deleteAllFormatColumn

  • deleteAllFormatColumn(): void
  • Deletes all Format Columns in the State

    Returns void

deleteFormatColumn

  • Deletes an existing Format Column

    Parameters

    Returns void

getAllFormatColumn

  • Gets all Format Columns in the State

    Returns FormatColumn[]

getFormatColumnState

  • Retrieves the Format Column State

    Returns FormatColumnState

updateFormatColumn

  • updateFormatColumn(column: string, style: IStyle): void
  • Updates an existing Format Column

    Parameters

    • column: string

      The colunn to update the style for.

    • style: IStyle

      The Style to update - (see Style Object for more details)

    Returns void

Generated using TypeDoc