Class ProgressBarCellRenderer<T>

Works with AreaModelObjectArray only

Type Parameters

  • T

Hierarchy

  • ProgressBarCellRenderer

Implements

Constructors

  • Type Parameters

    • T

    Parameters

    • property: string
    • maxValue: number = 100
    • labelVisible: boolean = false
    • ariaLabel: ((percent, value) => string) = ...

      Text for screen readers (the bar is an image). Default: "75 %".

      Since

      1.1.91

        • (percent, value): string
        • Text for screen readers (the bar is an image). Default: "75 %".

          Parameters

          • percent: number
          • value: number

          Returns string

          Since

          1.1.91

    Returns ProgressBarCellRenderer<T>

Properties

ariaLabel: ((percent, value) => string) = ...

Type declaration

    • (percent, value): string
    • Text for screen readers (the bar is an image). Default: "75 %".

      Parameters

      • percent: number
      • value: number

      Returns string

      Since

      1.1.91

labelVisible: boolean = false
maxValue: number = 100
property: string

Methods

  • Fills the (empty) cell element.

    Parameters

    • cellDiv: HTMLDivElement

      the cell element, already positioned and sized

    • rowIndex: number

      row in the area (as displayed)

    • columnIndex: number

      column index (west + center + east)

    • areaIdent: AreaIdent

      "header", "body" or "footer"

    • areaModel: AreaModelObjectArray<T>

      the model of this area (e.g. for getRowByIndex(rowIndex))

    • _cellValue: any

      the value of the cell (areaModel.getValueAt(rowIndex, columnIndex))

    • domService: DomServiceIf

      create and change elements through it (works with Angular's Renderer2, too)

    Returns undefined | Function

    optionally a cleanup function, called before the cell is drawn again