@@ -6,26 +6,36 @@ import { SortingDirection } from '../../data-operations/sorting-expression.inter
6
6
7
7
export type PivotAggregation = ( members : any [ ] , data : any [ ] ) => any ;
8
8
9
+ /**
10
+ * Configuration of the pivot grid.
11
+ */
9
12
export interface IPivotConfiguration {
13
+ /** A strategy to transform the rows. */
10
14
rowStrategy ?: IPivotDimensionStrategy | null ;
15
+ /** A strategy to transform the columns. */
11
16
columnStrategy ?: IPivotDimensionStrategy | null ;
17
+ /** A list of the rows. */
12
18
rows : IPivotDimension [ ] | null ;
19
+ /** A list of the columns. */
13
20
columns : IPivotDimension [ ] | null ;
21
+ /** A list of the values. */
14
22
values : IPivotValue [ ] | null ;
15
- // dimensions to be displayed in the filter area.
23
+ /** Dimensions to be displayed in the filter area. */
16
24
filters ?: IPivotDimension [ ] | null ;
17
25
}
18
26
19
27
export 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. */
21
29
childLevel ?: IPivotDimension ;
22
- // field name which to use to extract value
30
+ /** Field name to use in order to extract value. */
23
31
memberName : string ;
24
- // function that extract the value
32
+ /** Function that extracts the value */
25
33
memberFunction ?: ( data : any ) => any ;
26
- // Enables/Disables a particular dimension from pivot structure.
34
+ /** Enables/Disables a particular dimension from pivot structure. */
27
35
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
+ * */
29
39
filter ?: FilteringExpressionsTree | null ;
30
40
sortDirection ?: SortingDirection ;
31
41
dataType ?: GridColumnDataType ;
0 commit comments