Class RevColumnsManager<BCS, SF>

ReadonlyclientId

getSettingsForNewColumnEventer

ReadonlygridSettings

ReadonlyinternalParent

ReadonlyschemaServer

activeColumnCount

• get activeColumnCount(): number

  Returns number

activeColumns

• get activeColumns(): readonly RevColumn<BCS, SF>[]

  Returns readonly RevColumn<BCS, SF>[]

fieldColumnCount

• get fieldColumnCount(): number

  Returns number

fieldColumns

• get fieldColumns(): readonly RevColumn<BCS, SF>[]

  Returns readonly RevColumn<BCS, SF>[]

autoSizeActiveColumnWidths

• autoSizeActiveColumnWidths(widenOnly: boolean): void

  Parameters

  • widenOnly: boolean

  Returns void

calculateFixedColumnsWidth

• calculateFixedColumnsWidth(): number

  Returns number

  The total width of all the fixed columns.

getFixedColumnCount

• getFixedColumnCount(): number

  Returns number

  The number of fixed columns.

getSchema

• getSchema(): readonly SF[]

  Returns readonly SF[]

hideActiveColumn

• hideActiveColumn(activeColumnIndex: number, ui: boolean): void

  Parameters

  • activeColumnIndex: number
  • ui: boolean

  Returns void

hideColumns

• hideColumns(
      indexesAreActive: boolean,
      columnIndexOrIndices: undefined | number | number[],
      ui: boolean,
  ): void

  Parameters

  • indexesAreActive: boolean
  • columnIndexOrIndices: undefined | number | number[]
  • ui: boolean

  Returns void

isColumnFixed

• isColumnFixed(activeColumnIndex: number): boolean

  Parameters

  • activeColumnIndex: number

  Returns boolean

moveActiveColumn

• moveActiveColumn(fromIndex: number, toIndex: number, ui: boolean): void

  Parameters

  • fromIndex: number
  • toIndex: number
  • ui: boolean

  Returns void

setActiveColumns

• setActiveColumns(columnArray: readonly RevColumn<BCS, SF>[]): void

  Parameters

  • columnArray: readonly RevColumn<BCS, SF>[]

  Returns void

setActiveColumnsAndWidthsByFieldName

• setActiveColumnsAndWidthsByFieldName(
      fieldNameAndWidths: FieldNameAndAutoSizableWidth[],
      ui: boolean,
  ): void

  Parameters

  • fieldNameAndWidths: FieldNameAndAutoSizableWidth[]
  • ui: boolean

  Returns void

setActiveColumnsAutoWidthSizing

• setActiveColumnsAutoWidthSizing(value: boolean): void

  Parameters

  • value: boolean

  Returns void

showHideColumns

• showHideColumns(
      indexesAreActive: boolean,
      columnIndexOrIndices: undefined | number | number[],
      insertIndex: undefined | number,
      allowDuplicateColumns: boolean,
      ui: boolean,
  ): void

  Parameters

  • indexesAreActive: boolean

    If true, then column indices specify active column indices. Otherwise field column indices
  • columnIndexOrIndices: undefined | number | number[]

    A column index or array of indices. If undefined then all of the columns as per isActiveColumnIndexes
  • insertIndex: undefined | number

    Set to undefined to add new active columns at end of list. Set to -1 to hide specified columns
  • allowDuplicateColumns: boolean

    If true, then if an existing column is already visible, it will not be removed and duplicates of that column will be present
  • ui: boolean

    Whether this was instigated by a UI action

  Returns void

swapActiveColumns

• swapActiveColumns(source: number, target: number): void

  swap source and target columns

  Parameters

  • source: number

    column index
  • target: number

    column index

  Returns void