igniteui-webcomponents-grids 7.0.0 → 7.1.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -0,0 +1,19 @@
1
+
2
+
3
+
4
+
5
+
6
+ /**
7
+ * This enumeration is used to configure the default value separator
8
+ * as well as the default file extension used when performing CSV exporting.
9
+ */
10
+
11
+ export declare enum CsvFileTypes
12
+ {
13
+ CSV,
14
+ TSV,
15
+ TAB
16
+ }
17
+
18
+
19
+
@@ -2,6 +2,7 @@
2
2
  import { IgcBaseEventArgs } from './igc-base-event-args';
3
3
  import { IgcRowExportingEventArgs } from './igc-row-exporting-event-args';
4
4
  import { IgcColumnExportingEventArgs } from './igc-column-exporting-event-args';
5
+ import { IgcGridBaseDirective } from './igc-grid-base-directive';
5
6
  import { IgcExporterOptionsBase } from './igc-exporter-options-base';
6
7
  import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from './common';
7
8
 
@@ -24,7 +25,7 @@ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from
24
25
  *
25
26
  * @memberof IgxBaseExporter
26
27
  */
27
- public export(grid: any, options: IgcExporterOptionsBase): void;
28
+ public export(grid: IgcGridBaseDirective, options: IgcExporterOptionsBase): void;
28
29
 
29
30
 
30
31
 
@@ -0,0 +1,18 @@
1
+
2
+ import { IgcBaseEventArgs } from './igc-base-event-args';
3
+
4
+
5
+
6
+
7
+ /* csSuppress */
8
+
9
+ export declare class IgcCsvExportEndedEventArgs extends IgcBaseEventArgs
10
+ {
11
+
12
+
13
+ public csvData?: string;
14
+
15
+ }
16
+
17
+
18
+
@@ -0,0 +1,47 @@
1
+
2
+ import { IgcExporterOptionsBase } from './igc-exporter-options-base';
3
+ import { CsvFileTypes } from './csv-file-types';
4
+
5
+
6
+
7
+
8
+ /* csSuppress */
9
+ /**
10
+ * Objects of this class are used to configure the CSV exporting process.
11
+ */
12
+
13
+ export declare class IgcCsvExporterOptions extends IgcExporterOptionsBase
14
+ {
15
+
16
+
17
+
18
+ /**
19
+ * Gets the value delimiter which will be used for the exporting operation.
20
+ * ```typescript
21
+ * let delimiter = this.exportOptions.valueDelimiter;
22
+ * ```
23
+ *
24
+ * @memberof IgxCsvExporterOptions
25
+ */
26
+ public set valueDelimiter(value: any);
27
+ public get valueDelimiter(): any;
28
+
29
+
30
+
31
+ /**
32
+ * Gets the CSV export format.
33
+ * ```typescript
34
+ * let filetype = this.exportOptions.fileType;
35
+ * ```
36
+ *
37
+ * @memberof IgxCsvExporterOptions
38
+ */
39
+ public set fileType(value: any);
40
+ public get fileType(): any;
41
+
42
+ constructor(fileName: string, fileType: CsvFileTypes);
43
+
44
+ }
45
+
46
+
47
+
@@ -0,0 +1,55 @@
1
+
2
+ import { IgcBaseExporter } from './igc-base-exporter';
3
+ import { IgcCsvExportEndedEventArgs } from './igc-csv-export-ended-event-args';
4
+ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from './common';
5
+ import { IgcBaseExporterEventMap } from './igc-base-exporter';
6
+
7
+
8
+
9
+
10
+ /* csSuppress */
11
+ /**
12
+ * **Ignite UI for Angular CSV Exporter Service** -
13
+ * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter-csv)
14
+ *
15
+ * The Ignite UI for Angular CSV Exporter service can export data in a Character Separated Values format from
16
+ * both raw data (array) or from an `IgxGrid`.
17
+ *
18
+ * Example:
19
+ * ```typescript
20
+ * public localData = [
21
+ * { Name: "Eric Ridley", Age: "26" },
22
+ * { Name: "Alanis Brook", Age: "22" },
23
+ * { Name: "Jonathan Morris", Age: "23" }
24
+ * ];
25
+ *
26
+ * constructor(private csvExportService: IgxCsvExporterService) {
27
+ * }
28
+ *
29
+ * const opt: IgxCsvExporterOptions = new IgxCsvExporterOptions("FileName", CsvFileTypes.CSV);
30
+ * this.csvExportService.exportData(this.localData, opt);
31
+ * ```
32
+ */
33
+
34
+ export declare class IgcCsvExporterService extends EventEmitterMixin<IgcCsvExporterServiceEventMap, AbstractConstructor<IgcBaseExporter>>(IgcBaseExporter)
35
+
36
+ {
37
+
38
+ }
39
+
40
+ export declare interface IgcCsvExporterServiceEventMap extends IgcBaseExporterEventMap {
41
+
42
+ /**
43
+ * This event is emitted when the export process finishes.
44
+ * ```typescript
45
+ * this.exporterService.exportEnded.subscribe((args: ICsvExportEndedEventArgs) => {
46
+ * // put event handler code here
47
+ * });
48
+ * ```
49
+ *
50
+ * @memberof IgxCsvExporterService
51
+ */
52
+ exportEnded: CustomEvent<IgcCsvExportEndedEventArgs>;
53
+
54
+ }
55
+
@@ -0,0 +1,19 @@
1
+
2
+ import { IgcBaseEventArgs } from './igc-base-event-args';
3
+ import { IgcObject } from './igc-object';
4
+
5
+
6
+
7
+
8
+ /* csSuppress */
9
+
10
+ export declare class IgcExcelExportEndedEventArgs extends IgcBaseEventArgs
11
+ {
12
+
13
+
14
+ public xlsx?: IgcObject;
15
+
16
+ }
17
+
18
+
19
+
@@ -0,0 +1,87 @@
1
+
2
+ import { IgcExporterOptionsBase } from './igc-exporter-options-base';
3
+
4
+
5
+
6
+
7
+ /* csSuppress */
8
+ /**
9
+ * Objects of this class are used to configure the Excel exporting process.
10
+ */
11
+
12
+ export declare class IgcExcelExporterOptions extends IgcExporterOptionsBase
13
+ {
14
+
15
+
16
+ /**
17
+ * Specifies if column pinning should be ignored. If ignoreColumnsOrder is set to true,
18
+ * this option will always be considered as set to true.
19
+ * ```typescript
20
+ * let ignorePinning = this.exportOptions.ignorePinning;
21
+ * this.exportOptions.ignorePinning = true;
22
+ * ```
23
+ *
24
+ * @memberof IgxExcelExporterOptions
25
+ */
26
+ public set ignorePinning(value: boolean);
27
+ public get ignorePinning(): boolean;
28
+
29
+
30
+
31
+ /**
32
+ * Specifies whether the exported data should be formatted as Excel table. (True by default)
33
+ * ```typescript
34
+ * let exportAsTable = this.exportOptions.exportAsTable;
35
+ * this.exportOptions.exportAsTable = false;
36
+ * ```
37
+ *
38
+ * @memberof IgxExcelExporterOptions
39
+ */
40
+ public set exportAsTable(value: boolean);
41
+ public get exportAsTable(): boolean;
42
+
43
+
44
+
45
+ /**
46
+ * Gets the width of the columns in the exported excel file.
47
+ * ```typescript
48
+ * let width = this.exportOptions.columnWidth;
49
+ * ```
50
+ *
51
+ * @memberof IgxExcelExporterOptions
52
+ */
53
+ public set columnWidth(value: number);
54
+ public get columnWidth(): number;
55
+
56
+
57
+
58
+ /**
59
+ * Gets the height of the rows in the exported excel file.
60
+ * ```typescript
61
+ * let height = this.exportOptions.rowHeight;
62
+ * ```
63
+ *
64
+ * @memberof IgxExcelExporterOptions
65
+ */
66
+ public set rowHeight(value: number);
67
+ public get rowHeight(): number;
68
+
69
+
70
+
71
+ /**
72
+ * Gets the name of the worksheet in the exported excel file.
73
+ * ```typescript
74
+ * let worksheetName = this.exportOptions.worksheetName;
75
+ * ```
76
+ *
77
+ * @memberof IgxExcelExporterOptions
78
+ */
79
+ public set worksheetName(value: string);
80
+ public get worksheetName(): string;
81
+
82
+ constructor(fileName: string);
83
+
84
+ }
85
+
86
+
87
+
@@ -0,0 +1,54 @@
1
+
2
+ import { IgcBaseExporter } from './igc-base-exporter';
3
+ import { IgcExcelExportEndedEventArgs } from './igc-excel-export-ended-event-args';
4
+ import { EventEmitterMixin, LitElement, Constructor, AbstractConstructor } from './common';
5
+ import { IgcBaseExporterEventMap } from './igc-base-exporter';
6
+
7
+
8
+
9
+
10
+ /* csSuppress */
11
+ /**
12
+ * **Ignite UI for Angular Excel Exporter Service** -
13
+ * [Documentation](https://www.infragistics.com/products/ignite-ui-angular/angular/components/exporter_excel.html)
14
+ *
15
+ * The Ignite UI for Angular Excel Exporter service can export data in Microsoft® Excel® format from both raw data
16
+ * (array) or from an `IgxGrid`.
17
+ *
18
+ * Example:
19
+ * ```typescript
20
+ * public localData = [
21
+ * { Name: "Eric Ridley", Age: "26" },
22
+ * { Name: "Alanis Brook", Age: "22" },
23
+ * { Name: "Jonathan Morris", Age: "23" }
24
+ * ];
25
+ *
26
+ * constructor(private excelExportService: IgxExcelExporterService) {
27
+ * }
28
+ *
29
+ * this.excelExportService.exportData(this.localData, new IgxExcelExporterOptions("FileName"));
30
+ * ```
31
+ */
32
+
33
+ export declare class IgcExcelExporterService extends EventEmitterMixin<IgcExcelExporterServiceEventMap, AbstractConstructor<IgcBaseExporter>>(IgcBaseExporter)
34
+
35
+ {
36
+
37
+ }
38
+
39
+ export declare interface IgcExcelExporterServiceEventMap extends IgcBaseExporterEventMap {
40
+
41
+ /**
42
+ * This event is emitted when the export process finishes.
43
+ * ```typescript
44
+ * this.exporterService.exportEnded.subscribe((args: IExcelExportEndedEventArgs) => {
45
+ * // put event handler code here
46
+ * });
47
+ * ```
48
+ *
49
+ * @memberof IgxExcelExporterService
50
+ */
51
+ exportEnded: CustomEvent<IgcExcelExportEndedEventArgs>;
52
+
53
+ }
54
+
@@ -63,7 +63,8 @@ import { IgcSortingOptions } from './igc-sorting-options';
63
63
  import { IgcRowDirective } from './igc-row-directive';
64
64
  import { IgcHeadSelectorTemplateContext } from './igc-head-selector-template-context';
65
65
  import { IgcRowSelectorTemplateContext } from './igc-row-selector-template-context';
66
- import { GridSelectionMode } from './grid-selection-mode';
66
+ import { TransactionService } from './transaction-service';
67
+ import { GridSelectionMode } from './grid-selection-mode';
67
68
  import { GridCellMergeMode } from './grid-cell-merge-mode';
68
69
  import { IgcSearchInfo } from './igc-search-info';
69
70
  import { IgcForOfState } from './igc-for-of-state';
@@ -941,6 +942,14 @@ public set selectedRows(value: any[]);
941
942
  public set batchEditing(value: boolean);
942
943
  public get batchEditing(): boolean;
943
944
 
945
+
946
+
947
+ /* csSuppress */
948
+ /**
949
+ * Get transactions service for the grid.
950
+ */
951
+ public get transactions(): TransactionService;
952
+
944
953
 
945
954
 
946
955
  /**
@@ -1056,6 +1065,9 @@ public set selectedRows(value: any[]);
1056
1065
  *
1057
1066
  * @remarks
1058
1067
  * If set, returns the outlet defined outside the grid. Otherwise returns the grid's internal outlet directive.
1068
+ *
1069
+ * @deprecated Overlays now use the HTML Popover API and no longer move to the document body by default, so using outlet is also no longer needed.
1070
+ * body by default, so using outlet is also no longer needed.
1059
1071
  */
1060
1072
  public set outlet(value: IgcOverlayOutletDirective);
1061
1073
  public get outlet(): IgcOverlayOutletDirective;
@@ -2564,6 +2576,13 @@ expansionStatesChange: CustomEvent<Map<any, boolean>>;
2564
2576
  */
2565
2577
  selectedRowsChange: CustomEvent<any[]>;
2566
2578
 
2579
+ /* blazorInclude */
2580
+ /** @hidden @internal */
2581
+ /**
2582
+ * Emitted when content children are resolved and collections in grid are updated.
2583
+ */
2584
+ childrenResolved: CustomEvent<void>;
2585
+
2567
2586
  /**
2568
2587
  * Emitted when the expanded state of a row gets changed.
2569
2588
  *
@@ -14,7 +14,6 @@ import { IgcActionStripComponent } from './igc-action-strip-component';
14
14
  import { IgcGridEditingActionsComponent } from './igc-grid-editing-actions-component';
15
15
  import { IgcGridPinningActionsComponent } from './igc-grid-pinning-actions-component';
16
16
  import { IgcRowIslandComponent } from './igc-row-island-component';
17
- import { IgcFilteringExpressionsTree } from './igc-filtering-expressions-tree';
18
17
  import { IgcGridResourceStrings } from './igc-grid-resource-strings';
19
18
  import { IgcCellType } from './igc-cell-type';
20
19
  import { IgcRowType } from './igc-row-type';
@@ -70,12 +69,6 @@ import { IgcHierarchicalGridBaseDirectiveEventMap } from './igc-hierarchical-gri
70
69
 
71
70
 
72
71
 
73
- /* blazorCSSuppress */
74
- public set advancedFilteringExpressionsTree(value: IgcFilteringExpressionsTree);
75
- public get advancedFilteringExpressionsTree(): IgcFilteringExpressionsTree;
76
-
77
-
78
-
79
72
  /**
80
73
  * Gets/Sets the value of the `id` attribute.
81
74
  *
@@ -67,7 +67,8 @@ import { IgcSortingOptions } from './igc-sorting-options';
67
67
  import { IgcRowDirective } from './igc-row-directive';
68
68
  import { IgcHeadSelectorTemplateContext } from './igc-head-selector-template-context';
69
69
  import { IgcRowSelectorTemplateContext } from './igc-row-selector-template-context';
70
- import { GridSelectionMode } from './grid-selection-mode';
70
+ import { TransactionService } from './transaction-service';
71
+ import { GridSelectionMode } from './grid-selection-mode';
71
72
  import { GridCellMergeMode } from './grid-cell-merge-mode';
72
73
  import { IgcGridRowComponent } from './igc-grid-row-component';
73
74
  import { DropPosition } from './drop-position';
@@ -1016,6 +1017,14 @@ public set selectedRows(value: any[]);
1016
1017
  public set sortingExpressions(value: IgcSortingExpression[]);
1017
1018
  public get sortingExpressions(): IgcSortingExpression[];
1018
1019
 
1020
+
1021
+
1022
+ /* csSuppress */
1023
+ /**
1024
+ * Get transactions service for the grid.
1025
+ */
1026
+ public get transactions(): TransactionService;
1027
+
1019
1028
 
1020
1029
 
1021
1030
  /**
@@ -2537,6 +2546,13 @@ expansionStatesChange: CustomEvent<Map<any, boolean>>;
2537
2546
  */
2538
2547
  selectedRowsChange: CustomEvent<any[]>;
2539
2548
 
2549
+ /* blazorInclude */
2550
+ /** @hidden @internal */
2551
+ /**
2552
+ * Emitted when content children are resolved and collections in grid are updated.
2553
+ */
2554
+ childrenResolved: CustomEvent<void>;
2555
+
2540
2556
  /**
2541
2557
  * Emitted when the expanded state of a row gets changed.
2542
2558
  *
@@ -38,6 +38,15 @@ export { IgcPivotDateDimension } from "./igc-pivot-date-dimension";
38
38
  export type { GridColumnDataType } from "./grid-column-data-type";
39
39
  export type { IgcGridResourceStrings } from "./igc-grid-resource-strings";
40
40
  export type { IgcPivotDateDimensionOptions } from "./igc-pivot-date-dimension-options";
41
+ export { IgcCsvExporterOptions } from "./igc-csv-exporter-options";
42
+ export type { IgcExporterOptionsBase } from "./igc-exporter-options-base";
43
+ export { CsvFileTypes } from "./csv-file-types";
44
+ export { type IgcCsvExporterServiceEventMap, IgcCsvExporterService } from "./igc-csv-exporter-service";
45
+ export type { IgcBaseExporterEventMap, IgcBaseExporter } from "./igc-base-exporter";
46
+ export type { IgcCsvExportEndedEventArgs } from "./igc-csv-export-ended-event-args";
47
+ export { IgcExcelExporterOptions } from "./igc-excel-exporter-options";
48
+ export { type IgcExcelExporterServiceEventMap, IgcExcelExporterService } from "./igc-excel-exporter-service";
49
+ export type { IgcExcelExportEndedEventArgs } from "./igc-excel-export-ended-event-args";
41
50
  export { IgcSummaryOperand } from "./igc-summary-operand";
42
51
  export type { IgcSummaryResult } from "./igc-summary-result";
43
52
  export { IgcNumberSummaryOperand } from "./igc-number-summary-operand";
@@ -112,9 +121,10 @@ export type { IgcPivotAggregator } from "./igc-pivot-aggregator";
112
121
  export type { IgcPivotGridRecord } from "./igc-pivot-grid-record";
113
122
  export type { IgcPivotGridColumn } from "./igc-pivot-grid-column";
114
123
  export type { IgcValidationResourceStrings } from "./igc-validation-resource-strings";
124
+ export type { IgcRowExportingEventArgs } from "./igc-row-exporting-event-args";
125
+ export type { IgcColumnExportingEventArgs } from "./igc-column-exporting-event-args";
115
126
  export type { IgcPositionStrategy } from "./igc-position-strategy";
116
127
  export type { IgcScrollStrategy } from "./igc-scroll-strategy";
117
- export type { IgcBaseExporterEventMap, IgcBaseExporter } from "./igc-base-exporter";
118
128
  export type { IgcExporterOptions } from "./igc-exporter-options";
119
129
  export type { IgcCancelableBrowserEventArgs } from "./igc-cancelable-browser-event-args";
120
130
  export type { IgcGridTemplateContext } from "./igc-grid-template-context";
@@ -196,9 +206,6 @@ export type { IgcFieldPipeArgs } from "./igc-field-pipe-args";
196
206
  export type { IgcFieldEditorOptions } from "./igc-field-editor-options";
197
207
  export type { PivotAggregationType } from "./pivot-aggregation-type";
198
208
  export type { IgcPositionSettings } from "./igc-position-settings";
199
- export type { IgcRowExportingEventArgs } from "./igc-row-exporting-event-args";
200
- export type { IgcColumnExportingEventArgs } from "./igc-column-exporting-event-args";
201
- export type { IgcExporterOptionsBase } from "./igc-exporter-options-base";
202
209
  export type { IgcCancelableEventArgs } from "./igc-cancelable-event-args";
203
210
  export type { ValidationStatus } from "./validation-status";
204
211
  export type { GridKeydownTargetType } from "./grid-keydown-target-type";