@genesislcap/g2plot-chart 14.408.0 → 14.409.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.
Files changed (46) hide show
  1. package/README.md +7 -13
  2. package/package.json +14 -14
  3. package/docs/api/g2plot-chart.chartconfig.md +0 -13
  4. package/docs/api/g2plot-chart.chartdatasource.chartfields.md +0 -15
  5. package/docs/api/g2plot-chart.chartdatasource.criteria.md +0 -13
  6. package/docs/api/g2plot-chart.chartdatasource.data.md +0 -13
  7. package/docs/api/g2plot-chart.chartdatasource.isgroup.md +0 -13
  8. package/docs/api/g2plot-chart.chartdatasource.issnapshot.md +0 -13
  9. package/docs/api/g2plot-chart.chartdatasource.isstack.md +0 -13
  10. package/docs/api/g2plot-chart.chartdatasource.maxrows.md +0 -13
  11. package/docs/api/g2plot-chart.chartdatasource.maxview.md +0 -13
  12. package/docs/api/g2plot-chart.chartdatasource.md +0 -369
  13. package/docs/api/g2plot-chart.chartdatasource.orderby.md +0 -13
  14. package/docs/api/g2plot-chart.chartdatasource.reduced.md +0 -13
  15. package/docs/api/g2plot-chart.chartdatasource.request.md +0 -13
  16. package/docs/api/g2plot-chart.chartdatasource.resourcename.md +0 -13
  17. package/docs/api/g2plot-chart.chartdatasource.reverse.md +0 -13
  18. package/docs/api/g2plot-chart.chartdatasource.rowid.md +0 -13
  19. package/docs/api/g2plot-chart.chartdatasource.serverfields.md +0 -15
  20. package/docs/api/g2plot-chart.chartdatasource.showformattedtime.md +0 -15
  21. package/docs/api/g2plot-chart.chartdatasource.withtimestampformatting.md +0 -13
  22. package/docs/api/g2plot-chart.chartdatasourceerrorevent.md +0 -15
  23. package/docs/api/g2plot-chart.chartdatasourceerroreventdetail.md +0 -15
  24. package/docs/api/g2plot-chart.chartdatasourceeventnames.md +0 -15
  25. package/docs/api/g2plot-chart.charterrorevent.md +0 -15
  26. package/docs/api/g2plot-chart.charterroritem.detail.md +0 -11
  27. package/docs/api/g2plot-chart.charterroritem.md +0 -73
  28. package/docs/api/g2plot-chart.charterroritem.type.md +0 -11
  29. package/docs/api/g2plot-chart.charterrornames.md +0 -16
  30. package/docs/api/g2plot-chart.charterrortypes.md +0 -15
  31. package/docs/api/g2plot-chart.chartmodels.md +0 -13
  32. package/docs/api/g2plot-chart.chartsgradients.md +0 -24
  33. package/docs/api/g2plot-chart.charttypes.md +0 -13
  34. package/docs/api/g2plot-chart.defaultchartconfig.md +0 -13
  35. package/docs/api/g2plot-chart.defaultchartfields.md +0 -18
  36. package/docs/api/g2plot-chart.defaultserieschartfield.md +0 -18
  37. package/docs/api/g2plot-chart.foundationchartshadowoptions.md +0 -13
  38. package/docs/api/g2plot-chart.g2plotchart.config.md +0 -30
  39. package/docs/api/g2plot-chart.g2plotchart.data.md +0 -18
  40. package/docs/api/g2plot-chart.g2plotchart.md +0 -101
  41. package/docs/api/g2plot-chart.g2plotchart.type.md +0 -18
  42. package/docs/api/g2plot-chart.g2plotchartscomponents.md +0 -26
  43. package/docs/api/g2plot-chart.g2plotcharttemplate.md +0 -13
  44. package/docs/api/g2plot-chart.md +0 -275
  45. package/docs/api/index.md +0 -30
  46. package/docs/api-report.md.api.md +0 -229
@@ -1,275 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md)
4
-
5
- ## g2plot-chart package
6
-
7
- ## Classes
8
-
9
- <table><thead><tr><th>
10
-
11
- Class
12
-
13
-
14
- </th><th>
15
-
16
- Description
17
-
18
-
19
- </th></tr></thead>
20
- <tbody><tr><td>
21
-
22
- [ChartDatasource](./g2plot-chart.chartdatasource.md)
23
-
24
-
25
- </td><td>
26
-
27
- The Genesis Datasource for the `g2plot-chart` component.
28
-
29
-
30
- </td></tr>
31
- <tr><td>
32
-
33
- [G2PlotChart](./g2plot-chart.g2plotchart.md)
34
-
35
-
36
- </td><td>
37
-
38
- The G2Plot Chart component
39
-
40
-
41
- </td></tr>
42
- </tbody></table>
43
-
44
- ## Interfaces
45
-
46
- <table><thead><tr><th>
47
-
48
- Interface
49
-
50
-
51
- </th><th>
52
-
53
- Description
54
-
55
-
56
- </th></tr></thead>
57
- <tbody><tr><td>
58
-
59
- [ChartErrorItem](./g2plot-chart.charterroritem.md)
60
-
61
-
62
- </td><td>
63
-
64
- Chart Error Item
65
-
66
-
67
- </td></tr>
68
- </tbody></table>
69
-
70
- ## Variables
71
-
72
- <table><thead><tr><th>
73
-
74
- Variable
75
-
76
-
77
- </th><th>
78
-
79
- Description
80
-
81
-
82
- </th></tr></thead>
83
- <tbody><tr><td>
84
-
85
- [chartDatasourceEventNames](./g2plot-chart.chartdatasourceeventnames.md)
86
-
87
-
88
- </td><td>
89
-
90
- The Chart Datasource event names.
91
-
92
-
93
- </td></tr>
94
- <tr><td>
95
-
96
- [chartErrorNames](./g2plot-chart.charterrornames.md)
97
-
98
-
99
- </td><td>
100
-
101
- The error names for the Chart component.
102
-
103
-
104
- </td></tr>
105
- <tr><td>
106
-
107
- [chartsGradients](./g2plot-chart.chartsgradients.md)
108
-
109
-
110
- </td><td>
111
-
112
- G2Plot Chart gradient colors
113
-
114
-
115
- </td></tr>
116
- <tr><td>
117
-
118
- [defaultChartConfig](./g2plot-chart.defaultchartconfig.md)
119
-
120
-
121
- </td><td>
122
-
123
- The default `g2plot-chart` configuration.
124
-
125
-
126
- </td></tr>
127
- <tr><td>
128
-
129
- [defaultChartFields](./g2plot-chart.defaultchartfields.md)
130
-
131
-
132
- </td><td>
133
-
134
- The first and second default chart fields when it's a dual axes chart.
135
-
136
-
137
- </td></tr>
138
- <tr><td>
139
-
140
- [defaultSeriesChartField](./g2plot-chart.defaultserieschartfield.md)
141
-
142
-
143
- </td><td>
144
-
145
- The third default chart field when it's a triple axes chart.
146
-
147
-
148
- </td></tr>
149
- <tr><td>
150
-
151
- [foundationChartShadowOptions](./g2plot-chart.foundationchartshadowoptions.md)
152
-
153
-
154
- </td><td>
155
-
156
- The `g2plot-chart` component shadow options.
157
-
158
-
159
- </td></tr>
160
- <tr><td>
161
-
162
- [g2plotChartsComponents](./g2plot-chart.g2plotchartscomponents.md)
163
-
164
-
165
- </td><td>
166
-
167
- All the `g2plot-chart` components
168
-
169
-
170
- </td></tr>
171
- <tr><td>
172
-
173
- [g2plotChartTemplate](./g2plot-chart.g2plotcharttemplate.md)
174
-
175
-
176
- </td><td>
177
-
178
- The g2lot chart template.
179
-
180
-
181
- </td></tr>
182
- </tbody></table>
183
-
184
- ## Type Aliases
185
-
186
- <table><thead><tr><th>
187
-
188
- Type Alias
189
-
190
-
191
- </th><th>
192
-
193
- Description
194
-
195
-
196
- </th></tr></thead>
197
- <tbody><tr><td>
198
-
199
- [ChartConfig](./g2plot-chart.chartconfig.md)
200
-
201
-
202
- </td><td>
203
-
204
- G2Plot Chart Config
205
-
206
-
207
- </td></tr>
208
- <tr><td>
209
-
210
- [ChartDatasourceErrorEvent](./g2plot-chart.chartdatasourceerrorevent.md)
211
-
212
-
213
- </td><td>
214
-
215
- The error event Chart Datasource.
216
-
217
-
218
- </td></tr>
219
- <tr><td>
220
-
221
- [ChartDatasourceErrorEventDetail](./g2plot-chart.chartdatasourceerroreventdetail.md)
222
-
223
-
224
- </td><td>
225
-
226
- The event detail for the Chart Datasource `error` event.
227
-
228
-
229
- </td></tr>
230
- <tr><td>
231
-
232
- [ChartErrorEvent](./g2plot-chart.charterrorevent.md)
233
-
234
-
235
- </td><td>
236
-
237
- Chart possible error events
238
-
239
-
240
- </td></tr>
241
- <tr><td>
242
-
243
- [ChartErrorTypes](./g2plot-chart.charterrortypes.md)
244
-
245
-
246
- </td><td>
247
-
248
- Chart Error Types
249
-
250
-
251
- </td></tr>
252
- <tr><td>
253
-
254
- [ChartModels](./g2plot-chart.chartmodels.md)
255
-
256
-
257
- </td><td>
258
-
259
- G2Plot Chart Models
260
-
261
-
262
- </td></tr>
263
- <tr><td>
264
-
265
- [ChartTypes](./g2plot-chart.charttypes.md)
266
-
267
-
268
- </td><td>
269
-
270
- G2Plot Chart Types
271
-
272
-
273
- </td></tr>
274
- </tbody></table>
275
-
package/docs/api/index.md DELETED
@@ -1,30 +0,0 @@
1
- <!-- Do not edit this file. It is automatically generated by API Documenter. -->
2
-
3
- [Home](./index.md)
4
-
5
- ## API Reference
6
-
7
- ## Packages
8
-
9
- <table><thead><tr><th>
10
-
11
- Package
12
-
13
-
14
- </th><th>
15
-
16
- Description
17
-
18
-
19
- </th></tr></thead>
20
- <tbody><tr><td>
21
-
22
- [@genesislcap/g2plot-chart](./g2plot-chart.md)
23
-
24
-
25
- </td><td>
26
-
27
-
28
- </td></tr>
29
- </tbody></table>
30
-
@@ -1,229 +0,0 @@
1
- ## API Report File for "@genesislcap/g2plot-chart"
2
-
3
- > Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
4
-
5
- ```ts
6
-
7
- import { Area } from '@antv/g2plot';
8
- import { AreaOptions } from '@antv/g2plot';
9
- import { Bar } from '@antv/g2plot';
10
- import { BarOptions } from '@antv/g2plot';
11
- import { BaseDatasource } from '@genesislcap/foundation-ui';
12
- import type { BaseDatasourceErrorHandlingOptions } from '@genesislcap/foundation-ui';
13
- import { Column } from '@antv/g2plot';
14
- import { ColumnOptions } from '@antv/g2plot';
15
- import type { Container } from '@microsoft/fast-foundation';
16
- import { Controller } from '@microsoft/fast-element';
17
- import { DOMContainer } from '@genesislcap/foundation-utils';
18
- import { DualAxes } from '@antv/g2plot';
19
- import { DualAxesOptions } from '@antv/g2plot';
20
- import { ElementStyles } from '@microsoft/fast-element';
21
- import { FieldMetadata } from '@genesislcap/foundation-comms';
22
- import { FoundationElement } from '@microsoft/fast-foundation';
23
- import { FoundationElementRegistry } from '@microsoft/fast-foundation';
24
- import { FoundationLayoutContainer } from '@genesislcap/foundation-utils';
25
- import { LayoutCacheContainer } from '@genesislcap/foundation-utils';
26
- import { Line } from '@antv/g2plot';
27
- import { LineOptions } from '@antv/g2plot';
28
- import { Mix } from '@antv/g2plot';
29
- import { MixOptions } from '@antv/g2plot';
30
- import { OverrideFoundationElementDefinition } from '@microsoft/fast-foundation';
31
- import { Pie } from '@antv/g2plot';
32
- import { PieOptions } from '@antv/g2plot';
33
- import { Rose } from '@antv/g2plot';
34
- import { RoseOptions } from '@antv/g2plot';
35
- import { Scatter } from '@antv/g2plot';
36
- import { ScatterOptions } from '@antv/g2plot';
37
- import { Stock } from '@antv/g2plot';
38
- import { StockOptions } from '@antv/g2plot';
39
- import { ViewTemplate } from '@microsoft/fast-element';
40
-
41
- // @public
42
- export type ChartConfig = LineOptions | AreaOptions | BarOptions | ColumnOptions | PieOptions | DualAxesOptions | RoseOptions | ScatterOptions | StockOptions | MixOptions;
43
-
44
- // Warning: (ae-forgotten-export) The symbol "ChartDatasource_base" needs to be exported by the entry point index.d.ts
45
- //
46
- // @public
47
- export class ChartDatasource extends ChartDatasource_base {
48
- chartFields: string;
49
- // @internal (undocumented)
50
- connectedCallback(): Promise<void>;
51
- criteria: string;
52
- data: any[];
53
- // @internal (undocumented)
54
- disconnectedCallback(): void;
55
- // @internal (undocumented)
56
- fetchGenesisData(withFullInit?: boolean): Promise<void>;
57
- // @internal (undocumented)
58
- handleError(params: BaseDatasourceErrorHandlingOptions): void;
59
- // @internal (undocumented)
60
- get hasValidChartFields(): boolean;
61
- // @internal (undocumented)
62
- get hasValidServerFields(): boolean;
63
- isGroup: boolean;
64
- isSnapshot: boolean;
65
- isStack: boolean;
66
- maxRows: number;
67
- maxView: number;
68
- orderBy: string;
69
- reduced: boolean;
70
- request: any;
71
- resourceName: string;
72
- reverse: boolean;
73
- rowId: string;
74
- serverFields: string;
75
- showFormattedTime: boolean;
76
- withTimestampFormatting: boolean;
77
- }
78
-
79
- // @public
80
- export type ChartDatasourceErrorEvent = CustomEvent<ChartDatasourceErrorEventDetail>;
81
-
82
- // @public
83
- export type ChartDatasourceErrorEventDetail = {
84
- message: string;
85
- };
86
-
87
- // @public
88
- export const chartDatasourceEventNames: {
89
- error: string;
90
- };
91
-
92
- // @public
93
- export type ChartErrorEvent = ChartDatasourceErrorEvent | CustomEvent<ChartErrorItem<any>>;
94
-
95
- // @public
96
- export interface ChartErrorItem<ChartErrorItemDetailType> {
97
- // (undocumented)
98
- detail: ChartErrorItemDetailType;
99
- // (undocumented)
100
- type: ChartErrorTypes;
101
- }
102
-
103
- // @public
104
- export const chartErrorNames: {
105
- readonly datasource: "datasource";
106
- readonly unknown: "unknown";
107
- };
108
-
109
- // @public
110
- export type ChartErrorTypes = keyof typeof chartErrorNames;
111
-
112
- // Warning: (ae-internal-missing-underscore) The name "chartEventNames" should be prefixed with an underscore because the declaration is marked as @internal
113
- //
114
- // @internal
115
- export const chartEventNames: {
116
- datasourceErrorClose: string;
117
- };
118
-
119
- // Warning: (ae-internal-missing-underscore) The name "ChartEventsListeners" should be prefixed with an underscore because the declaration is marked as @internal
120
- //
121
- // @internal
122
- export type ChartEventsListeners = {
123
- key: string;
124
- action: (event: Event) => void;
125
- }[];
126
-
127
- // @public
128
- export type ChartModels = Line | Area | Bar | Column | Pie | DualAxes | Rose | Scatter | Stock | Mix;
129
-
130
- // @public
131
- export const chartsGradients: {
132
- rapidBlue: string;
133
- rapidGreen: string;
134
- rapidRed: string;
135
- rapidPortage: string;
136
- rapidAlabaster: string;
137
- rapidSalomie: string;
138
- rapidMelon: string;
139
- rapidDodgerBlue: string;
140
- rapidIce: string;
141
- rapidViolet: string;
142
- };
143
-
144
- // @public
145
- export type ChartTypes = 'line' | 'area' | 'column' | 'bar' | 'pie' | 'donut' | 'dualaxes' | 'rose' | 'scatter' | 'stock' | 'mix';
146
-
147
- // @public
148
- export const defaultChartConfig: {};
149
-
150
- // @public
151
- export const defaultChartFields = "groupBy value";
152
-
153
- // @public
154
- export const defaultSeriesChartField = "series";
155
-
156
- // @public
157
- export const foundationChartShadowOptions: ShadowRootInit;
158
-
159
- // Warning: (ae-forgotten-export) The symbol "G2PlotChart_base" needs to be exported by the entry point index.d.ts
160
- //
161
- // @public
162
- export class G2PlotChart extends G2PlotChart_base {
163
- // @internal
164
- constructor();
165
- // @internal (undocumented)
166
- chartContainer: HTMLElement;
167
- config: ChartConfig;
168
- // @internal (undocumented)
169
- configChanged(): void;
170
- // @internal
171
- connectedCallback(): void;
172
- data: any[];
173
- // @internal (undocumented)
174
- dataChanged(oldValue: any[], newValue: any[]): void;
175
- // @internal
176
- deepClone(): Node;
177
- // @internal (undocumented)
178
- disconnectedCallback(): void;
179
- // @internal (undocumented)
180
- errorItems: ChartErrorItem<ChartErrorEvent['detail']>[];
181
- // @internal (undocumented)
182
- eventHandler: (e: any) => void;
183
- // @internal
184
- renderChart(): void;
185
- type: ChartTypes;
186
- }
187
-
188
- // Warning: (ae-internal-missing-underscore) The name "g2plotChart" should be prefixed with an underscore because the declaration is marked as @internal
189
- //
190
- // @internal
191
- export const g2plotChart: (overrideDefinition?: OverrideFoundationElementDefinition< {
192
- baseName: string;
193
- styles: ElementStyles;
194
- template: ViewTemplate<any, any>;
195
- shadowOptions: ShadowRootInit;
196
- }>) => FoundationElementRegistry< {
197
- baseName: string;
198
- styles: ElementStyles;
199
- template: ViewTemplate<any, any>;
200
- shadowOptions: ShadowRootInit;
201
- }, typeof G2PlotChart>;
202
-
203
- // @public
204
- export const g2plotChartsComponents: {
205
- g2plotChart: (overrideDefinition?: OverrideFoundationElementDefinition< {
206
- baseName: string;
207
- styles: ElementStyles;
208
- template: ViewTemplate<any, any>;
209
- shadowOptions: ShadowRootInit;
210
- }>) => FoundationElementRegistry< {
211
- baseName: string;
212
- styles: ElementStyles;
213
- template: ViewTemplate<any, any>;
214
- shadowOptions: ShadowRootInit;
215
- }, G2PlotChart>;
216
- register(container?: Container, ...rest: any[]): void;
217
- };
218
-
219
- // @public
220
- export const g2plotChartTemplate: ViewTemplate;
221
-
222
- // Warning: (ae-internal-missing-underscore) The name "registerRapidShape" should be prefixed with an underscore because the declaration is marked as @internal
223
- //
224
- // @internal
225
- export const registerRapidShape: () => void;
226
-
227
- // (No @packageDocumentation comment for this package)
228
-
229
- ```