Ignite UI for Web Components

All
  • Public
  • Public/Protected
  • All

Class IgcColumnGroupDescription

Represents an element in the current grouping applied to a data source or provider. Changes to this object are not observed or expected after it is initially assigned to a collection.

Hierarchy

Hierarchy (view full)

Constructors

Accessors

Methods

Constructors

constructor

Accessors

displayFormat

  • get displayFormat(): string

  • Gets or sets the display format for the group text in the group header.

    Returns string

  • set displayFormat(v): 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): void

  • Parameters

    • v: any[]

    Returns void

displayName

  • get displayName(): string

  • Gets or sets the display text for the group name.

    Returns string

  • set displayName(v): void

  • Parameters

    • v: string

    Returns void

field

  • get field(): string

  • Gets or sets the property being sorted.

    Returns string

  • set field(v): 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): void

  • Parameters

    • v: any

    Returns void

formatText

  • get formatText(): ((s, e) => void)

  • Called when the value is being formatted.

    Returns ((s, e) => void)

  • set formatText(ev): void

  • Parameters

    Returns void

sortDirection

  • get sortDirection(): ListSortDirection

  • Gets or sets the direction to sort based on the property.

    Returns ListSortDirection

  • set sortDirection(v): void

  • Parameters

    • v: ListSortDirection

    Returns void

valueFormat

  • get valueFormat(): string

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

    Returns string

  • set valueFormat(v): 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): void

  • Parameters

    • v: any[]

    Returns void

Methods

equals

  • equals(other): boolean

  • Returns if the SortDescription is equal to another.

    Parameters

    • other: any
      • The SortDescription to compare to.

    Returns boolean

findByName

  • findByName(name): any

  • Parameters

    • name: string

    Returns any