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.

Constructors

Accessors

  • get calculatorDisplayName(): string
  • Gets or sets the name to use when displaying the calculator name.

    Returns string

  • set calculatorDisplayName(v): void
  • Parameters

    • v: string

    Returns void

  • get displayFormat(): string
  • Gets or sets the display format for the summary when in list display mode.

    Returns string

  • set displayFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get displayFormatSpecifiers(): any[]
  • Gets or sets the format specifiers to use with the DisplayFormat string.

    Returns any[]

  • set displayFormatSpecifiers(v): void
  • Parameters

    • v: any[]

    Returns void

  • get displayName(): string
  • Gets or sets the display name for the summary.

    Returns string

  • set displayName(v): void
  • Parameters

    • v: string

    Returns void

  • get field(): string
  • Returns string

  • set field(v): void
  • Parameters

    • v: string

    Returns void

  • get formatOverride(): any
  • Gets or sets an INTL.DateTimeFormat or INTL.NumericFormat to use to format the value.

    Returns any

  • set formatOverride(v): void
  • Parameters

    • v: any

    Returns void

  • get maxFractionDigits(): number
  • Gets or sets the maximum fraction digits. If a format is specificied this value is ignored.

    Returns number

  • set maxFractionDigits(v): void
  • Parameters

    • v: number

    Returns void

  • get operand(): DataSourceSummaryOperand
  • Returns DataSourceSummaryOperand

  • set operand(v): void
  • Parameters

    • v: DataSourceSummaryOperand

    Returns void

  • get provideCalculator(): ((s, e) => void)
  • Called when the summary calculator is required.

    Returns ((s, e) => void)

  • set provideCalculator(ev): void
  • Parameters

    Returns void

  • get valueFormat(): string
  • Gets or sets the format string for the summary value.

    Returns string

  • set valueFormat(v): void
  • Parameters

    • v: string

    Returns void

  • get valueFormatSpecifiers(): any[]
  • Gets or sets the format specifiers to use with the ValueFormat string.

    Returns any[]

  • set valueFormatSpecifiers(v): void
  • Parameters

    • v: any[]

    Returns void

Methods

  • Parameters

    • other: any

    Returns boolean

  • Parameters

    • name: string

    Returns any