@genesislcap/g2plot-chart 14.214.2 → 14.214.4

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 (64) hide show
  1. package/dist/custom-elements.json +23 -9
  2. package/dist/dts/chart-components.d.ts +4 -0
  3. package/dist/dts/chart-components.d.ts.map +1 -1
  4. package/dist/dts/chart-datasource/chart-datasource.d.ts +14 -0
  5. package/dist/dts/chart-datasource/chart-datasource.d.ts.map +1 -1
  6. package/dist/dts/chart.d.ts +11 -0
  7. package/dist/dts/chart.d.ts.map +1 -1
  8. package/dist/dts/chart.types.d.ts +8 -0
  9. package/dist/dts/chart.types.d.ts.map +1 -1
  10. package/dist/dts/settings/colors.d.ts +4 -0
  11. package/dist/dts/settings/colors.d.ts.map +1 -1
  12. package/dist/dts/settings/shapes.d.ts +4 -0
  13. package/dist/dts/settings/shapes.d.ts.map +1 -1
  14. package/dist/dts/tsdoc-metadata.json +11 -0
  15. package/dist/esm/chart-components.js +4 -0
  16. package/dist/esm/chart-datasource/chart-datasource.js +14 -0
  17. package/dist/esm/chart.js +11 -1
  18. package/dist/esm/settings/colors.js +4 -0
  19. package/dist/esm/settings/shapes.js +4 -0
  20. package/dist/g2plot-chart.api.json +1600 -0
  21. package/dist/g2plot-chart.d.ts +964 -0
  22. package/docs/.gitattributes +2 -0
  23. package/docs/api/g2plot-chart.chartdatasource.disconnectedcallback.md +15 -0
  24. package/docs/api/g2plot-chart.chartdatasource.fetchgenesisdata.md +22 -0
  25. package/docs/api/g2plot-chart.chartdatasource.md +22 -0
  26. package/docs/api/g2plot-chart.chartdatasourceerrorevent.md +15 -0
  27. package/docs/api/g2plot-chart.chartdatasourceerroreventdetail.md +15 -0
  28. package/docs/api/g2plot-chart.chartdatasourceeventnames.md +15 -0
  29. package/docs/api/g2plot-chart.charterrorevent.md +15 -0
  30. package/docs/api/g2plot-chart.charterroritem.detail.md +11 -0
  31. package/docs/api/g2plot-chart.charterroritem.md +21 -0
  32. package/docs/api/g2plot-chart.charterroritem.type.md +11 -0
  33. package/docs/api/g2plot-chart.charterrornames.md +16 -0
  34. package/docs/api/g2plot-chart.charterrortypes.md +15 -0
  35. package/docs/api/g2plot-chart.chartmodels.md +13 -0
  36. package/docs/api/g2plot-chart.chartsgradients.md +24 -0
  37. package/docs/api/g2plot-chart.charttypes.md +13 -0
  38. package/docs/api/g2plot-chart.defaultchartconfig.md +13 -0
  39. package/docs/api/g2plot-chart.defaultchartfields.md +18 -0
  40. package/docs/api/g2plot-chart.defaultserieschartfield.md +18 -0
  41. package/docs/api/g2plot-chart.foundationchartshadowoptions.md +13 -0
  42. package/docs/api/g2plot-chart.g2plotchart._constructor_.md +13 -0
  43. package/docs/api/g2plot-chart.g2plotchart.chart.md +11 -0
  44. package/docs/api/g2plot-chart.g2plotchart.chartcontainer.md +11 -0
  45. package/docs/api/g2plot-chart.g2plotchart.config.md +11 -0
  46. package/docs/api/g2plot-chart.g2plotchart.configchanged.md +15 -0
  47. package/docs/api/g2plot-chart.g2plotchart.connectedcallback.md +15 -0
  48. package/docs/api/g2plot-chart.g2plotchart.data.md +11 -0
  49. package/docs/api/g2plot-chart.g2plotchart.datachanged.md +23 -0
  50. package/docs/api/g2plot-chart.g2plotchart.deepclone.md +15 -0
  51. package/docs/api/g2plot-chart.g2plotchart.disconnectedcallback.md +15 -0
  52. package/docs/api/g2plot-chart.g2plotchart.erroritems.md +11 -0
  53. package/docs/api/g2plot-chart.g2plotchart.eventhandler.md +11 -0
  54. package/docs/api/g2plot-chart.g2plotchart.md +28 -0
  55. package/docs/api/g2plot-chart.g2plotchart.renderchart.md +15 -0
  56. package/docs/api/g2plot-chart.g2plotchart.type.md +11 -0
  57. package/docs/api/g2plot-chart.g2plotchartscomponents.md +26 -0
  58. package/docs/api/g2plot-chart.g2plotcharttemplate.md +13 -0
  59. package/docs/api/g2plot-chart.md +46 -0
  60. package/docs/api/g2plot-chart.registerrapidshape.md +13 -0
  61. package/docs/api/index.md +12 -0
  62. package/docs/api-report.md +190 -0
  63. package/package.json +14 -14
  64. package/tsdoc.json +4 -0
@@ -12,7 +12,9 @@
12
12
  "type": {
13
13
  "text": "object"
14
14
  },
15
- "default": "{\n g2plotChart,\n register(container?: Container, ...rest: any[]) {\n if (!container) {\n // preserve backward compatibility with code that loops through\n // the values of this object and calls them as funcs with no args\n return;\n }\n for (const key in this) {\n if (key === 'register') {\n continue;\n }\n this[key]().register(container, ...rest);\n }\n },\n}"
15
+ "default": "{\n g2plotChart,\n register(container?: Container, ...rest: any[]) {\n if (!container) {\n // preserve backward compatibility with code that loops through\n // the values of this object and calls them as funcs with no args\n return;\n }\n for (const key in this) {\n if (key === 'register') {\n continue;\n }\n this[key]().register(container, ...rest);\n }\n },\n}",
16
+ "description": "All the `g2plot-chart` components",
17
+ "privacy": "public"
16
18
  }
17
19
  ],
18
20
  "exports": [
@@ -121,7 +123,7 @@
121
123
  "declarations": [
122
124
  {
123
125
  "kind": "class",
124
- "description": "",
126
+ "description": "The G2Plot Chart component",
125
127
  "name": "G2PlotChart",
126
128
  "members": [
127
129
  {
@@ -510,7 +512,9 @@
510
512
  "type": {
511
513
  "text": "ShadowRootInit"
512
514
  },
513
- "default": "undefined"
515
+ "default": "undefined",
516
+ "description": "The `g2plot-chart` component shadow options.",
517
+ "privacy": "public"
514
518
  },
515
519
  {
516
520
  "kind": "variable",
@@ -518,7 +522,9 @@
518
522
  "type": {
519
523
  "text": "object"
520
524
  },
521
- "default": "{}"
525
+ "default": "{}",
526
+ "description": "The default `g2plot-chart` configuration.",
527
+ "privacy": "public"
522
528
  },
523
529
  {
524
530
  "kind": "variable",
@@ -647,7 +653,9 @@
647
653
  "type": {
648
654
  "text": "string"
649
655
  },
650
- "default": "'groupBy value'"
656
+ "default": "'groupBy value'",
657
+ "description": "The first and second default chart fields when it's a dual axes chart.",
658
+ "privacy": "public"
651
659
  },
652
660
  {
653
661
  "kind": "variable",
@@ -655,11 +663,13 @@
655
663
  "type": {
656
664
  "text": "string"
657
665
  },
658
- "default": "'series'"
666
+ "default": "'series'",
667
+ "description": "The third default chart field when it's a triple axes chart.",
668
+ "privacy": "public"
659
669
  },
660
670
  {
661
671
  "kind": "class",
662
- "description": "",
672
+ "description": "The Genesis Datasource for the `g2plot-chart` component.",
663
673
  "name": "ChartDatasource",
664
674
  "members": [
665
675
  {
@@ -2502,7 +2512,9 @@
2502
2512
  "type": {
2503
2513
  "text": "object"
2504
2514
  },
2505
- "default": "{\n rapidBlue: `l(270) 0:${PrimaryRapidColorHEX.purple} 1:${PrimaryRapidColorHEX.blue}`,\n rapidGreen: `l(270) 0:${RapidColorHEX.green} 1:${RapidColorHEX.lightGreen}`,\n rapidRed: `l(300) 0:${RapidColorHEX.red} 1:${RapidColorHEX.lightRed}`,\n rapidPortage: `l(270) 0:${RapidColorHEX.portage} 1:${RapidColorHEX.lightPortage}`,\n rapidAlabaster: `l(270) 0:${RapidColorHEX.white} 1:${RapidColorHEX.silver}`,\n rapidSalomie: `l(270) 0:${RapidColorHEX.salomie} 1:${RapidColorHEX.lightSalomie}`,\n rapidMelon: `l(270) 0:${RapidColorHEX.melon} 1:${RapidColorHEX.lightMelon}`,\n rapidDodgerBlue: `l(270) 0:${RapidColorHEX.dodgerBlue} 1:${RapidColorHEX.lightDodgerBlue}`,\n rapidIce: `l(170) 0:${RapidColorHEX.ice} 1:${RapidColorHEX.lightIce}`,\n rapidViolet: `l(270) 0:${RapidColorHEX.violet} 1:${RapidColorHEX.lightViolet}`,\n}"
2515
+ "default": "{\n rapidBlue: `l(270) 0:${PrimaryRapidColorHEX.purple} 1:${PrimaryRapidColorHEX.blue}`,\n rapidGreen: `l(270) 0:${RapidColorHEX.green} 1:${RapidColorHEX.lightGreen}`,\n rapidRed: `l(300) 0:${RapidColorHEX.red} 1:${RapidColorHEX.lightRed}`,\n rapidPortage: `l(270) 0:${RapidColorHEX.portage} 1:${RapidColorHEX.lightPortage}`,\n rapidAlabaster: `l(270) 0:${RapidColorHEX.white} 1:${RapidColorHEX.silver}`,\n rapidSalomie: `l(270) 0:${RapidColorHEX.salomie} 1:${RapidColorHEX.lightSalomie}`,\n rapidMelon: `l(270) 0:${RapidColorHEX.melon} 1:${RapidColorHEX.lightMelon}`,\n rapidDodgerBlue: `l(270) 0:${RapidColorHEX.dodgerBlue} 1:${RapidColorHEX.lightDodgerBlue}`,\n rapidIce: `l(170) 0:${RapidColorHEX.ice} 1:${RapidColorHEX.lightIce}`,\n rapidViolet: `l(270) 0:${RapidColorHEX.violet} 1:${RapidColorHEX.lightViolet}`,\n}",
2516
+ "description": "G2Plot Chart gradient colors",
2517
+ "privacy": "public"
2506
2518
  }
2507
2519
  ],
2508
2520
  "exports": [
@@ -2545,7 +2557,9 @@
2545
2557
  "declarations": [
2546
2558
  {
2547
2559
  "kind": "function",
2548
- "name": "registerRapidShape"
2560
+ "name": "registerRapidShape",
2561
+ "description": "Register the Rapid Design System G2Plot shape",
2562
+ "privacy": "public"
2549
2563
  }
2550
2564
  ],
2551
2565
  "exports": [
@@ -1,4 +1,8 @@
1
1
  import type { Container } from '@microsoft/fast-foundation';
2
+ /**
3
+ * All the `g2plot-chart` components
4
+ * @public
5
+ */
2
6
  export declare const g2plotChartsComponents: {
3
7
  g2plotChart: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
4
8
  baseName: string;
@@ -1 +1 @@
1
- {"version":3,"file":"chart-components.d.ts","sourceRoot":"","sources":["../../src/chart-components.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAG5D,eAAO,MAAM,sBAAsB;;;;;;;;;;;;yBAEZ,SAAS,WAAW,GAAG,EAAE;CAa/C,CAAC"}
1
+ {"version":3,"file":"chart-components.d.ts","sourceRoot":"","sources":["../../src/chart-components.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,SAAS,EAAE,MAAM,4BAA4B,CAAC;AAG5D;;;GAGG;AACH,eAAO,MAAM,sBAAsB;;;;;;;;;;;;yBAEZ,SAAS,WAAW,GAAG,EAAE;CAa/C,CAAC"}
@@ -1,6 +1,16 @@
1
1
  import { BaseDatasource } from '@genesislcap/foundation-ui';
2
2
  import type { BaseDatasourceErrorHandlingOptions } from '@genesislcap/foundation-ui';
3
+ /**
4
+ * The first and second default chart fields when it's a dual axes chart.
5
+ * @remarks This field is always used. Default value is 'groupBy value'.
6
+ * @public
7
+ */
3
8
  export declare const defaultChartFields = "groupBy value";
9
+ /**
10
+ * The third default chart field when it's a triple axes chart.
11
+ * @remarks This field is optional. Default value is 'series'.
12
+ * @public
13
+ */
4
14
  export declare const defaultSeriesChartField = "series";
5
15
  declare class ConcreteDatasource extends BaseDatasource {
6
16
  private chart;
@@ -382,6 +392,10 @@ declare const ChartDatasource_base: (new (...args: any[]) => {
382
392
  blur(): void;
383
393
  focus(options?: FocusOptions): void;
384
394
  }) & typeof ConcreteDatasource;
395
+ /**
396
+ * The Genesis Datasource for the `g2plot-chart` component.
397
+ * @public
398
+ */
385
399
  export declare class ChartDatasource extends ChartDatasource_base {
386
400
  disconnectedCallback(): void;
387
401
  fetchGenesisData(withFullInit?: boolean): Promise<void>;
@@ -1 +1 @@
1
- {"version":3,"file":"chart-datasource.d.ts","sourceRoot":"","sources":["../../../src/chart-datasource/chart-datasource.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,4BAA4B,CAAC;AAUrF,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAClD,eAAO,MAAM,uBAAuB,WAAW,CAAC;AAQhD,cAAM,kBAAmB,SAAQ,cAAc;IAC7C,OAAO,CAAC,KAAK,CAAc;IAE3B;;;;;;;;OAQG;IACkC,WAAW,EAAE,MAAM,CAAsB;IAC9E,OAAO,CAAC,qBAAqB,CAAW;IACxC,OAAO,CAAC,yBAAyB,CAA6B;IAC9D,OAAO,CAAC,gBAAgB,CAAS;IAEjC;;;;;;;;OAQG;IACmC,YAAY,EAAE,MAAM,CAAC;IAC3D,OAAO,CAAC,qBAAqB,CAAW;IAEU,OAAO,UAAS;IAChB,OAAO,UAAS;IAElE;;;OAGG;IACwB,OAAO,UAAQ;IAE1C;;;;;;OAMG;IAC0D,iBAAiB,UAAS;IAEjF,iBAAiB;IAwCvB,WAAW,CAAC,MAAM,EAAE,kCAAkC,GAAG,IAAI;IAc7D,SAAS;IAMT,iBAAiB,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE;IAuCtC,mBAAmB,CAAC,YAAY,EAAE,GAAG,EAAE;IAQvC,mBAAmB,CAAC,WAAW,EAAE,GAAG,EAAE;IAQtC,mBAAmB,CAAC,WAAW,EAAE,GAAG,EAAE;IAatC,OAAO,CAAC,kBAAkB;IAiC1B,OAAO,CAAC,gCAAgC;IAiBxC,IAAI,sBAAsB,IAAI,MAAM,CAEnC;IAED,IAAI,oBAAoB,IAAI,OAAO,CAElC;IAED,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IAED,OAAO,CAAC,uBAAuB;CAOhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAED,qBAGa,eAAgB,SAAQ,oBAAkC;IAC5D,oBAAoB,IAAI,IAAI;IAKrB,gBAAgB,CAAC,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAIxE"}
1
+ {"version":3,"file":"chart-datasource.d.ts","sourceRoot":"","sources":["../../../src/chart-datasource/chart-datasource.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,cAAc,EAAE,MAAM,4BAA4B,CAAC;AAC5D,OAAO,KAAK,EAAE,kCAAkC,EAAE,MAAM,4BAA4B,CAAC;AAUrF;;;;GAIG;AACH,eAAO,MAAM,kBAAkB,kBAAkB,CAAC;AAElD;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,WAAW,CAAC;AAQhD,cAAM,kBAAmB,SAAQ,cAAc;IAC7C,OAAO,CAAC,KAAK,CAAc;IAE3B;;;;;;;;OAQG;IACkC,WAAW,EAAE,MAAM,CAAsB;IAC9E,OAAO,CAAC,qBAAqB,CAAW;IACxC,OAAO,CAAC,yBAAyB,CAA6B;IAC9D,OAAO,CAAC,gBAAgB,CAAS;IAEjC;;;;;;;;OAQG;IACmC,YAAY,EAAE,MAAM,CAAC;IAC3D,OAAO,CAAC,qBAAqB,CAAW;IAEU,OAAO,UAAS;IAChB,OAAO,UAAS;IAElE;;;OAGG;IACwB,OAAO,UAAQ;IAE1C;;;;;;OAMG;IAC0D,iBAAiB,UAAS;IAEjF,iBAAiB;IAwCvB,WAAW,CAAC,MAAM,EAAE,kCAAkC,GAAG,IAAI;IAc7D,SAAS;IAMT,iBAAiB,CAAC,YAAY,CAAC,EAAE,GAAG,EAAE;IAuCtC,mBAAmB,CAAC,YAAY,EAAE,GAAG,EAAE;IAQvC,mBAAmB,CAAC,WAAW,EAAE,GAAG,EAAE;IAQtC,mBAAmB,CAAC,WAAW,EAAE,GAAG,EAAE;IAatC,OAAO,CAAC,kBAAkB;IAiC1B,OAAO,CAAC,gCAAgC;IAiBxC,IAAI,sBAAsB,IAAI,MAAM,CAEnC;IAED,IAAI,oBAAoB,IAAI,OAAO,CAElC;IAED,IAAI,mBAAmB,IAAI,OAAO,CAEjC;IAED,OAAO,CAAC,uBAAuB;CAOhC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAED;;;GAGG;AACH,qBAGa,eAAgB,SAAQ,oBAAkC;IAC5D,oBAAoB,IAAI,IAAI;IAKrB,gBAAgB,CAAC,YAAY,CAAC,EAAE,OAAO,GAAG,OAAO,CAAC,IAAI,CAAC;CAIxE"}
@@ -326,7 +326,9 @@ declare const G2PlotChart_base: (new (...args: any[]) => {
326
326
  focus(options?: FocusOptions): void;
327
327
  }) & typeof FoundationElement;
328
328
  /**
329
+ * The G2Plot Chart component
329
330
  * @tagname %%prefix%%-g2plot-chart
331
+ * @public
330
332
  */
331
333
  export declare class G2PlotChart extends G2PlotChart_base {
332
334
  chart: ChartModels;
@@ -368,7 +370,16 @@ export declare class G2PlotChart extends G2PlotChart_base {
368
370
  private cacheHiddenLegendItemsCallback;
369
371
  private initalizeConfiguration;
370
372
  }
373
+ /**
374
+ * The `g2plot-chart` component shadow options.
375
+ * @public
376
+ * @privateRemarks explicitly declaring for extensibility
377
+ */
371
378
  export declare const foundationChartShadowOptions: ShadowRootInit;
379
+ /**
380
+ * The default `g2plot-chart` configuration.
381
+ * @public
382
+ */
372
383
  export declare const defaultChartConfig: {};
373
384
  /**
374
385
  * The G2plot Chart
@@ -1 +1 @@
1
- {"version":3,"file":"chart.d.ts","sourceRoot":"","sources":["../../src/chart.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAK/D,OAAO,EACL,WAAW,EACX,UAAU,EAGV,eAAe,EACf,cAAc,EACf,MAAM,eAAe,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkBvB;;GAEG;AACH,qBAAa,WAAY,SAAQ,gBAAiC;IACzD,KAAK,EAAE,WAAW,CAAC;IACnB,cAAc,EAAE,WAAW,CAAC;IAC7B,IAAI,EAAE,UAAU,CAAS;IACnB,MAAM,MAAC;IACnB,aAAa;IAUD,IAAI,EAAE,GAAG,EAAE,CAAM;IACjB,UAAU,EAAE,cAAc,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAM;IAEzE,OAAO,CAAC,cAAc,CAAkC;IACxD,OAAO,CAAC,YAAY,CAAC,CAAqB;IAC1C,OAAO,CAAC,mBAAmB,CAA4B;IAEvD,WAAW,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE;;IAmB5C,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,YAAY;IAUX,SAAS,IAAI,IAAI;IAU1B,WAAW;IAKX,iBAAiB;IAsBjB,oBAAoB,IAAI,IAAI;IAkB5B,YAAY,mBAEV;IAEF,OAAO,CAAC,cAAc,CAapB;IAEF,OAAO,CAAC,qBAAqB,CAO3B;IAEF;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,8BAA8B;IA0BtC,OAAO,CAAC,sBAAsB,CAW5B;CACH;AAGD,eAAO,MAAM,4BAA4B,EAAE,cAA0B,CAAC;AAEtE,eAAO,MAAM,kBAAkB,IAAK,CAAC;AAErC;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;sBAMtB,CAAC"}
1
+ {"version":3,"file":"chart.d.ts","sourceRoot":"","sources":["../../src/chart.ts"],"names":[],"mappings":"AAcA,OAAO,EAAE,iBAAiB,EAAE,MAAM,4BAA4B,CAAC;AAK/D,OAAO,EACL,WAAW,EACX,UAAU,EAGV,eAAe,EACf,cAAc,EACf,MAAM,eAAe,CAAC;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;;AAkBvB;;;;GAIG;AACH,qBAAa,WAAY,SAAQ,gBAAiC;IACzD,KAAK,EAAE,WAAW,CAAC;IACnB,cAAc,EAAE,WAAW,CAAC;IAC7B,IAAI,EAAE,UAAU,CAAS;IACnB,MAAM,MAAC;IACnB,aAAa;IAUD,IAAI,EAAE,GAAG,EAAE,CAAM;IACjB,UAAU,EAAE,cAAc,CAAC,eAAe,CAAC,QAAQ,CAAC,CAAC,EAAE,CAAM;IAEzE,OAAO,CAAC,cAAc,CAAkC;IACxD,OAAO,CAAC,YAAY,CAAC,CAAqB;IAC1C,OAAO,CAAC,mBAAmB,CAA4B;IAEvD,WAAW,CAAC,QAAQ,EAAE,GAAG,EAAE,EAAE,QAAQ,EAAE,GAAG,EAAE;;IAmB5C,OAAO,CAAC,mBAAmB;IAI3B,OAAO,CAAC,YAAY;IAUX,SAAS,IAAI,IAAI;IAU1B,WAAW;IAKX,iBAAiB;IAsBjB,oBAAoB,IAAI,IAAI;IAkB5B,YAAY,mBAEV;IAEF,OAAO,CAAC,cAAc,CAapB;IAEF,OAAO,CAAC,qBAAqB,CAO3B;IAEF;;;;;;;;;;;;;;OAcG;IACH,OAAO,CAAC,8BAA8B;IA0BtC,OAAO,CAAC,sBAAsB,CAW5B;CACH;AAED;;;;GAIG;AACH,eAAO,MAAM,4BAA4B,EAAE,cAA0B,CAAC;AAEtE;;;GAGG;AACH,eAAO,MAAM,kBAAkB,IAAK,CAAC;AAErC;;;;;;GAMG;AACH,eAAO,MAAM,WAAW;;;;;;;;;;sBAMtB,CAAC"}
@@ -1,7 +1,15 @@
1
1
  import { Line, Area, Bar, Column, Pie, DualAxes, Rose, Scatter, Stock, Mix } from '@antv/g2plot';
2
2
  import { ChartDatasourceErrorEvent } from './chart-datasource/chart-datasource.types';
3
3
  import { chartErrorNames } from './chart.definitions';
4
+ /**
5
+ * G2Plot Chart Models
6
+ * @public
7
+ */
4
8
  export type ChartModels = Line | Area | Bar | Column | Pie | DualAxes | Rose | Scatter | Stock | Mix;
9
+ /**
10
+ * G2Plot Chart Types
11
+ * @public
12
+ */
5
13
  export type ChartTypes = 'line' | 'area' | 'column' | 'bar' | 'pie' | 'donut' | 'dualaxes' | 'rose' | 'scatter' | 'stock' | 'mix';
6
14
  /**
7
15
  * Chart Event Listeners
@@ -1 +1 @@
1
- {"version":3,"file":"chart.types.d.ts","sourceRoot":"","sources":["../../src/chart.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACjG,OAAO,EAAE,yBAAyB,EAAE,MAAM,2CAA2C,CAAC;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD,MAAM,MAAM,WAAW,GACnB,IAAI,GACJ,IAAI,GACJ,GAAG,GACH,MAAM,GACN,GAAG,GACH,QAAQ,GACR,IAAI,GACJ,OAAO,GACP,KAAK,GACL,GAAG,CAAC;AACR,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,MAAM,GACN,QAAQ,GACR,KAAK,GACL,KAAK,GACL,OAAO,GACP,UAAU,GACV,MAAM,GACN,SAAS,GACT,OAAO,GACP,KAAK,CAAC;AAEV;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;CAAE,EAAE,CAAC;AAErF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,eAAe,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,wBAAwB;IACtD,MAAM,EAAE,wBAAwB,CAAC;IACjC,IAAI,EAAE,eAAe,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,yBAAyB,GAAG,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC"}
1
+ {"version":3,"file":"chart.types.d.ts","sourceRoot":"","sources":["../../src/chart.types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,IAAI,EAAE,IAAI,EAAE,GAAG,EAAE,MAAM,EAAE,GAAG,EAAE,QAAQ,EAAE,IAAI,EAAE,OAAO,EAAE,KAAK,EAAE,GAAG,EAAE,MAAM,cAAc,CAAC;AACjG,OAAO,EAAE,yBAAyB,EAAE,MAAM,2CAA2C,CAAC;AACtF,OAAO,EAAE,eAAe,EAAE,MAAM,qBAAqB,CAAC;AAEtD;;;GAGG;AACH,MAAM,MAAM,WAAW,GACnB,IAAI,GACJ,IAAI,GACJ,GAAG,GACH,MAAM,GACN,GAAG,GACH,QAAQ,GACR,IAAI,GACJ,OAAO,GACP,KAAK,GACL,GAAG,CAAC;AAER;;;GAGG;AACH,MAAM,MAAM,UAAU,GAClB,MAAM,GACN,MAAM,GACN,QAAQ,GACR,KAAK,GACL,KAAK,GACL,OAAO,GACP,UAAU,GACV,MAAM,GACN,SAAS,GACT,OAAO,GACP,KAAK,CAAC;AAEV;;;GAGG;AACH,MAAM,MAAM,oBAAoB,GAAG;IAAE,GAAG,EAAE,MAAM,CAAC;IAAC,MAAM,EAAE,CAAC,KAAK,EAAE,KAAK,KAAK,IAAI,CAAA;CAAE,EAAE,CAAC;AAErF;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,MAAM,OAAO,eAAe,CAAC;AAE3D;;;GAGG;AACH,MAAM,WAAW,cAAc,CAAC,wBAAwB;IACtD,MAAM,EAAE,wBAAwB,CAAC;IACjC,IAAI,EAAE,eAAe,CAAC;CACvB;AAED;;;GAGG;AACH,MAAM,MAAM,eAAe,GAAG,yBAAyB,GAAG,WAAW,CAAC,cAAc,CAAC,GAAG,CAAC,CAAC,CAAC"}
@@ -1,3 +1,7 @@
1
+ /**
2
+ * G2Plot Chart gradient colors
3
+ * @public
4
+ */
1
5
  export declare const chartsGradients: {
2
6
  rapidBlue: string;
3
7
  rapidGreen: string;
@@ -1 +1 @@
1
- {"version":3,"file":"colors.d.ts","sourceRoot":"","sources":["../../../src/settings/colors.ts"],"names":[],"mappings":"AAEA,eAAO,MAAM,eAAe;;;;;;;;;;;CAW3B,CAAC"}
1
+ {"version":3,"file":"colors.d.ts","sourceRoot":"","sources":["../../../src/settings/colors.ts"],"names":[],"mappings":"AAEA;;;GAGG;AACH,eAAO,MAAM,eAAe;;;;;;;;;;;CAW3B,CAAC"}
@@ -1,2 +1,6 @@
1
+ /**
2
+ * Register the Rapid Design System G2Plot shape
3
+ * @public
4
+ */
1
5
  export declare const registerRapidShape: () => void;
2
6
  //# sourceMappingURL=shapes.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"shapes.d.ts","sourceRoot":"","sources":["../../../src/settings/shapes.ts"],"names":[],"mappings":"AAIA,eAAO,MAAM,kBAAkB,YAsB9B,CAAC"}
1
+ {"version":3,"file":"shapes.d.ts","sourceRoot":"","sources":["../../../src/settings/shapes.ts"],"names":[],"mappings":"AAIA;;;GAGG;AACH,eAAO,MAAM,kBAAkB,YAsB9B,CAAC"}
@@ -0,0 +1,11 @@
1
+ // This file is read by tools that parse documentation comments conforming to the TSDoc standard.
2
+ // It should be published with your NPM package. It should not be tracked by Git.
3
+ {
4
+ "tsdocVersion": "0.12",
5
+ "toolPackages": [
6
+ {
7
+ "packageName": "@microsoft/api-extractor",
8
+ "packageVersion": "7.34.9"
9
+ }
10
+ ]
11
+ }
@@ -1,4 +1,8 @@
1
1
  import { g2plotChart } from './chart';
2
+ /**
3
+ * All the `g2plot-chart` components
4
+ * @public
5
+ */
2
6
  export const g2plotChartsComponents = {
3
7
  g2plotChart,
4
8
  register(container, ...rest) {
@@ -6,7 +6,17 @@ import { attr, customElement } from '@microsoft/fast-element';
6
6
  import { chartDatasourceEventNames } from './chart-datasource.config';
7
7
  import { extractFields, getFormattedDateGroupBy, getReduced } from './chart-datasource.utils';
8
8
  const logger = createLogger('chart-datasource');
9
+ /**
10
+ * The first and second default chart fields when it's a dual axes chart.
11
+ * @remarks This field is always used. Default value is 'groupBy value'.
12
+ * @public
13
+ */
9
14
  export const defaultChartFields = 'groupBy value';
15
+ /**
16
+ * The third default chart field when it's a triple axes chart.
17
+ * @remarks This field is optional. Default value is 'series'.
18
+ * @public
19
+ */
10
20
  export const defaultSeriesChartField = 'series';
11
21
  const defaultConfigFieldsCount = 2;
12
22
  const maxConfigFieldsCount = 3;
@@ -209,6 +219,10 @@ __decorate([
209
219
  __decorate([
210
220
  attr({ mode: 'boolean', attribute: 'show-formatted-time' })
211
221
  ], ConcreteDatasource.prototype, "showFormattedTime", void 0);
222
+ /**
223
+ * The Genesis Datasource for the `g2plot-chart` component.
224
+ * @public
225
+ */
212
226
  let ChartDatasource = class ChartDatasource extends LifecycleMixin(ConcreteDatasource) {
213
227
  disconnectedCallback() {
214
228
  if (!this.shouldRunDisconnect)
package/dist/esm/chart.js CHANGED
@@ -10,7 +10,9 @@ import { LineChart, AreaChart, BarChart, ColumnChart, DonutChart, PieChart, Dual
10
10
  import { registerRapidShape } from './settings';
11
11
  ChartDatasource;
12
12
  /**
13
+ * The G2Plot Chart component
13
14
  * @tagname %%prefix%%-g2plot-chart
15
+ * @public
14
16
  */
15
17
  export class G2PlotChart extends LifecycleMixin(FoundationElement) {
16
18
  configChanged() {
@@ -172,8 +174,16 @@ __decorate([
172
174
  __decorate([
173
175
  observable
174
176
  ], G2PlotChart.prototype, "errorItems", void 0);
175
- // explicitly declaring for extensibility
177
+ /**
178
+ * The `g2plot-chart` component shadow options.
179
+ * @public
180
+ * @privateRemarks explicitly declaring for extensibility
181
+ */
176
182
  export const foundationChartShadowOptions = undefined;
183
+ /**
184
+ * The default `g2plot-chart` configuration.
185
+ * @public
186
+ */
177
187
  export const defaultChartConfig = {};
178
188
  /**
179
189
  * The G2plot Chart
@@ -1,4 +1,8 @@
1
1
  import { RapidColorHEX, PrimaryRapidColorHEX } from '@genesislcap/foundation-zero';
2
+ /**
3
+ * G2Plot Chart gradient colors
4
+ * @public
5
+ */
2
6
  export const chartsGradients = {
3
7
  rapidBlue: `l(270) 0:${PrimaryRapidColorHEX.purple} 1:${PrimaryRapidColorHEX.blue}`,
4
8
  rapidGreen: `l(270) 0:${RapidColorHEX.green} 1:${RapidColorHEX.lightGreen}`,
@@ -1,5 +1,9 @@
1
1
  import { G2 } from '@antv/g2plot';
2
2
  const sliceNumber = 0.01;
3
+ /**
4
+ * Register the Rapid Design System G2Plot shape
5
+ * @public
6
+ */
3
7
  export const registerRapidShape = () => {
4
8
  G2.registerShape('interval', 'rapid-shape', {
5
9
  draw(cfg, container) {