Ignite UI for Angular

All
  • Public
  • Public/Protected
  • All

Class IgxColumnSummaryDescription

Represents a summary that is applied to a datasource. Changes to this object are not observed or expected after it is initially assigned to a collection.

Hierarchy

Hierarchy

  • IgxColumnSummaryDescription

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Static ngAcceptInputType_displayFormatSpecifiers

ngAcceptInputType_displayFormatSpecifiers: string | any[]

Static ngAcceptInputType_maxFractionDigits

ngAcceptInputType_maxFractionDigits: string | number

Static ngAcceptInputType_operand

ngAcceptInputType_operand: string | DataSourceSummaryOperand

Static ngAcceptInputType_valueFormatSpecifiers

ngAcceptInputType_valueFormatSpecifiers: string | any[]

Accessors

calculatorDisplayName

  • get calculatorDisplayName(): string

  • Gets or sets the name to use when displaying the calculator name.

    Returns string

  • set calculatorDisplayName(v: string): void

  • Parameters

    • v: string

    Returns void

displayFormat

  • get displayFormat(): string

  • Gets or sets the display format for the summary when in list display mode.

    Returns string

  • set displayFormat(v: string): void

  • Parameters

    • v: string

    Returns void

displayFormatSpecifiers

  • get displayFormatSpecifiers(): any[]

  • Gets or sets the format specifiers to use with the DisplayFormat string.

    Returns any[]

  • set displayFormatSpecifiers(v: any[]): void

  • Parameters

    • v: any[]

    Returns void

displayName

  • get displayName(): string

  • Gets or sets the display name for the summary.

    Returns string

  • set displayName(v: string): void

  • Parameters

    • v: string

    Returns void

field

  • get field(): string

  • Returns string

  • set field(v: string): void

  • Parameters

    • v: string

    Returns void

formatOverride

  • get formatOverride(): any

  • Gets or sets an INTL.DateTimeFormat or INTL.NumericFormat to use to format the value.

    Returns any

  • set formatOverride(v: any): void

  • Parameters

    • v: any

    Returns void

formatText

  • get formatText(): EventEmitter<{
        args: IgxFormatSummaryTextEventArgs;
        sender: any;
    }>

  • Called when the value is being formatted.

    Returns EventEmitter<{
        args: IgxFormatSummaryTextEventArgs;
        sender: any;
    }>

maxFractionDigits

  • get maxFractionDigits(): number

  • Gets or sets the maximum fraction digits. If a format is specificied this value is ignored.

    Returns number

  • set maxFractionDigits(v: number): void

  • Parameters

    • v: number

    Returns void

operand

provideCalculator

  • get provideCalculator(): EventEmitter<{
        args: IgxProvideCalculatorEventArgs;
        sender: any;
    }>

  • Called when the summary calculator is required.

    Returns EventEmitter<{
        args: IgxProvideCalculatorEventArgs;
        sender: any;
    }>

valueFormat

  • get valueFormat(): string

  • Gets or sets the format string for the summary value.

    Returns string

  • set valueFormat(v: string): void

  • Parameters

    • v: string

    Returns void

valueFormatSpecifiers

  • get valueFormatSpecifiers(): any[]

  • Gets or sets the format specifiers to use with the ValueFormat string.

    Returns any[]

  • set valueFormatSpecifiers(v: any[]): void

  • Parameters

    • v: any[]

    Returns void

Methods

equals

  • Parameters

    • other: any

    Returns boolean

findByName

  • Parameters

    • name: string

    Returns any