@@ -6,26 +6,36 @@ import { SortingDirection } from '../../data-operations/sorting-expression.inter
66
77export type PivotAggregation = ( members : any [ ] , data : any [ ] ) => any ;
88
9+ /**
10+ * Configuration of the pivot grid.
11+ */
912export interface IPivotConfiguration {
13+ /** A strategy to transform the rows. */
1014 rowStrategy ?: IPivotDimensionStrategy | null ;
15+ /** A strategy to transform the columns. */
1116 columnStrategy ?: IPivotDimensionStrategy | null ;
17+ /** A list of the rows. */
1218 rows : IPivotDimension [ ] | null ;
19+ /** A list of the columns. */
1320 columns : IPivotDimension [ ] | null ;
21+ /** A list of the values. */
1422 values : IPivotValue [ ] | null ;
15- // dimensions to be displayed in the filter area.
23+ /** Dimensions to be displayed in the filter area. */
1624 filters ?: IPivotDimension [ ] | null ;
1725}
1826
1927export interface IPivotDimension {
20- // allow defining a hierarchy when multiple sub groups need to be extracted from single member.
28+ /** Allows defining a hierarchy when multiple sub groups need to be extracted from single member. */
2129 childLevel ?: IPivotDimension ;
22- // field name which to use to extract value
30+ /** Field name to use in order to extract value. */
2331 memberName : string ;
24- // function that extract the value
32+ /** Function that extracts the value */
2533 memberFunction ?: ( data : any ) => any ;
26- // Enables/Disables a particular dimension from pivot structure.
34+ /** Enables/Disables a particular dimension from pivot structure. */
2735 enabled : boolean ;
28- // A predefined or defined via the `igxPivotSelector` filter expression tree for the current dimension to be applied in the filter pipe.
36+ /**
37+ * A predefined or defined via the `igxPivotSelector` filter expression tree for the current dimension to be applied in the filter pipe.
38+ * */
2939 filter ?: FilteringExpressionsTree | null ;
3040 sortDirection ?: SortingDirection ;
3141 dataType ?: GridColumnDataType ;
0 commit comments