igniteui-webcomponents-grids
Version:
Ignite UI Web Components grid components.
53 lines (52 loc) • 2.12 kB
TypeScript
import { IgcFormatGroupTextEventArgs } from "./igc-format-group-text-event-args";
import { IgcColumnSortDescription } from "./igc-column-sort-description";
import { ColumnGroupDescription as ColumnGroupDescription_internal } from "./ColumnGroupDescription";
/**
* 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.
*/
export declare class IgcColumnGroupDescription extends IgcColumnSortDescription {
protected createImplementation(): ColumnGroupDescription_internal;
/**
* @hidden
*/
get i(): ColumnGroupDescription_internal;
constructor();
/**
* Gets or sets the format string for the group value.
*/
get valueFormat(): string;
set valueFormat(v: string);
/**
* Gets or sets the format specifiers to use with the ValueFormat string.
*/
get valueFormatSpecifiers(): any[];
set valueFormatSpecifiers(v: any[]);
/**
* Gets or sets the display format for the group text in the group header.
*/
get displayFormat(): string;
set displayFormat(v: string);
/**
* Gets or sets the format specifiers to use with the DisplayFormat string.
*/
get displayFormatSpecifiers(): any[];
set displayFormatSpecifiers(v: any[]);
/**
* Gets or sets an INTL.DateTimeFormat or INTL.NumericFormat to use to format the value.
*/
get formatOverride(): any;
set formatOverride(v: any);
/**
* Gets or sets the display text for the group name.
*/
get displayName(): string;
set displayName(v: string);
findByName(name: string): any;
private _formatText;
private _formatText_wrapped;
/**
* Called when the value is being formatted.
*/
get formatText(): (s: IgcColumnGroupDescription, e: IgcFormatGroupTextEventArgs) => void;
set formatText(ev: (s: IgcColumnGroupDescription, e: IgcFormatGroupTextEventArgs) => void);
}