Interface FormatterFacade

A facade to access the formatters from client code. The idea is that for a column the resolveFormattingInfo method is used to lookup a matching formatter for the column values. This formatting infos can be used during column rendering to trigger the formatters.

interface FormatterFacade {
    format(values: any[], options: FormattingInfo): string;
    hasFormatter(formatterId: string): boolean;
    resolveFormattingInfo(fields: FieldData[], context: {
        dataSourceId: string;
        isDomainValueField(fieldName: string): boolean;
        resolveDefaultOptions?(fieldName: string): undefined | FormatterOptions;
    }): undefined | FormattingInfo;
}

Methods

format hasFormatter resolveFormattingInfo

Methods

format

  • format(values, options): string

  • Formats values using the resolved formatter infos.

    Parameters

    • values: any[]

      values to format

    • options: FormattingInfo

      infos resolved by the resolveFormattingInfo method.

    Returns string

hasFormatter

  • hasFormatter(formatterId): boolean

  • Allows Testing for the existence of a given formatter id.

    Parameters

    • formatterId: string

    Returns boolean

resolveFormattingInfo

  • resolveFormattingInfo(fields, context): undefined | FormattingInfo

  • Resolve a formatting infos for a column, which may be a combination of multiple fields.

    Parameters

    • fields: FieldData[]
    • context: {
          dataSourceId: string;
          isDomainValueField(fieldName: string): boolean;
          resolveDefaultOptions?(fieldName: string): undefined | FormatterOptions;
      }
      • dataSourceId: string
      • isDomainValueField:function
        • isDomainValueField(fieldName): boolean

        • Parameters

          • fieldName: string

          Returns boolean

      • resolveDefaultOptions?:function
        • resolveDefaultOptions(fieldName): undefined | FormatterOptions

        • Parameters

          • fieldName: string

          Returns undefined | FormatterOptions

    Returns undefined | FormattingInfo

    FormattingInfo or undefined. Undefined has the effect that the fields are not displayed.

Settings

Member Visibility

On This Page

Methods