@genesislcap/g2plot-chart 14.408.0 → 14.409.0

package/README.md

@@ -1,31 +1,25 @@
-# Genesis G2Plot Chart
+# @genesislcap/g2plot-chart
 
-This package contains the g2plot-chart component which wraps antv/g2plot charts. It also includes a chart-datasource component that will fetch data from a Genesis server (or any other server that implements the Genesis protocol).
+Documentation for this package is published on the Genesis docs site:
 
+**Docs: [Charts](https://docs.genesis.global/docs/develop/client-capabilities/charts/)**
 
 ## Installation
 
-To enable this module in your application, follow the steps below.
-
-1. Add `@genesislcap/g2plot-chart` as a dependency in your `package.json` file. Whenever you change the dependencies of your project, ensure you run the `$ npm run bootstrap` command again. You can find more information in the [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) page.
+Add the package to your `package.json` dependencies. After changing dependencies, run `npm run bootstrap` (or your project's equivalent). See [package.json basics](https://learn.genesis.global/secure/web/basics/package-json-basics/) for more information.
 
 ```json
 {
-  ...
   "dependencies": {
-    ...
     "@genesislcap/g2plot-chart": "latest"
-    ...
-  },
-  ...
+  }
 }
 ```
 
-## [API Docs](./docs/api/index.md)
-
 ## License
 
 Note: this project provides front-end dependencies and uses licensed components listed in the next section; thus, licenses for those components are required during development. Contact [Genesis Global](https://genesis.global/contact-us/) for more details.
 
 ### Licensed components
-Genesis low-code platform
+
+Genesis low-code platform

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@genesislcap/g2plot-chart",
   "description": "Genesis G2plot Chart",
-  "version": "14.408.0",
+  "version": "14.409.0",
   "sideEffects": false,
   "license": "SEE LICENSE IN license.txt",
   "main": "dist/esm/index.js",
@@ -53,21 +53,21 @@
     }
   },
   "devDependencies": {
-    "@genesislcap/foundation-testing": "14.408.0",
-    "@genesislcap/genx": "14.408.0",
-    "@genesislcap/rollup-builder": "14.408.0",
-    "@genesislcap/ts-builder": "14.408.0",
-    "@genesislcap/uvu-playwright-builder": "14.408.0",
-    "@genesislcap/vite-builder": "14.408.0",
-    "@genesislcap/webpack-builder": "14.408.0"
+    "@genesislcap/foundation-testing": "14.409.0",
+    "@genesislcap/genx": "14.409.0",
+    "@genesislcap/rollup-builder": "14.409.0",
+    "@genesislcap/ts-builder": "14.409.0",
+    "@genesislcap/uvu-playwright-builder": "14.409.0",
+    "@genesislcap/vite-builder": "14.409.0",
+    "@genesislcap/webpack-builder": "14.409.0"
   },
   "dependencies": {
     "@antv/g2plot": "^2.4.32",
-    "@genesislcap/foundation-comms": "14.408.0",
-    "@genesislcap/foundation-logger": "14.408.0",
-    "@genesislcap/foundation-ui": "14.408.0",
-    "@genesislcap/foundation-utils": "14.408.0",
-    "@genesislcap/foundation-zero": "14.408.0",
+    "@genesislcap/foundation-comms": "14.409.0",
+    "@genesislcap/foundation-logger": "14.409.0",
+    "@genesislcap/foundation-ui": "14.409.0",
+    "@genesislcap/foundation-utils": "14.409.0",
+    "@genesislcap/foundation-zero": "14.409.0",
     "@microsoft/fast-element": "1.14.0",
     "@microsoft/fast-foundation": "2.50.0"
   },
@@ -80,5 +80,5 @@
     "access": "public"
   },
   "customElements": "dist/custom-elements.json",
-  "gitHead": "26b08831fd001b4ee95c8a0d3364a18c0ec4005b"
+  "gitHead": "cbe0459d170f27c35a7de18cec415947aedf4da5"
 }

package/docs/api/g2plot-chart.chartconfig.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartConfig](./g2plot-chart.chartconfig.md)
-
-## ChartConfig type
-
-G2Plot Chart Config
-
-**Signature:**
-
-```typescript
-export type ChartConfig = LineOptions | AreaOptions | BarOptions | ColumnOptions | PieOptions | DualAxesOptions | RoseOptions | ScatterOptions | StockOptions | MixOptions;
-```

package/docs/api/g2plot-chart.chartdatasource.chartfields.md

@@ -1,15 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [chartFields](./g2plot-chart.chartdatasource.chartfields.md)
-
-## ChartDatasource.chartFields property
-
-Default value is 'groupBy value'. Can be customized but order matters.
-
-\[Mandatory\] First is always the xField/colorField \[Mandatory\] Second is always the yField/angleField \[Optional\] Third is always the seriesField
-
-**Signature:**
-
-```typescript
-chartFields: string;
-```

package/docs/api/g2plot-chart.chartdatasource.criteria.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [criteria](./g2plot-chart.chartdatasource.criteria.md)
-
-## ChartDatasource.criteria property
-
-Clients can send a Groovy expression to perform filters on the query server, these remain active for the life of the subscription.
-
-**Signature:**
-
-```typescript
-criteria: string;
-```

package/docs/api/g2plot-chart.chartdatasource.data.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [data](./g2plot-chart.chartdatasource.data.md)
-
-## ChartDatasource.data property
-
-Optional attribute that can be used to pass the data that will be used in the component.
-
-**Signature:**
-
-```typescript
-data: any[];
-```

package/docs/api/g2plot-chart.chartdatasource.isgroup.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [isGroup](./g2plot-chart.chartdatasource.isgroup.md)
-
-## ChartDatasource.isGroup property
-
-If true, will enable grouped chart plotting numeric values for levels of two categorical variables instead of one.
-
-**Signature:**
-
-```typescript
-isGroup: boolean;
-```

package/docs/api/g2plot-chart.chartdatasource.issnapshot.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [isSnapshot](./g2plot-chart.chartdatasource.issnapshot.md)
-
-## ChartDatasource.isSnapshot property
-
-Request a snapshot from the server.
-
-**Signature:**
-
-```typescript
-isSnapshot: boolean;
-```

package/docs/api/g2plot-chart.chartdatasource.isstack.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [isStack](./g2plot-chart.chartdatasource.isstack.md)
-
-## ChartDatasource.isStack property
-
-If true, will enable stacked chart to effectively portray comparisons of total values across several categories.
-
-**Signature:**
-
-```typescript
-isStack: boolean;
-```

package/docs/api/g2plot-chart.chartdatasource.maxrows.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [maxRows](./g2plot-chart.chartdatasource.maxrows.md)
-
-## ChartDatasource.maxRows property
-
-Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE\_ROWS messages. This will not affect the number of rows displayed.
-
-**Signature:**
-
-```typescript
-maxRows: number;
-```

package/docs/api/g2plot-chart.chartdatasource.maxview.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [maxView](./g2plot-chart.chartdatasource.maxview.md)
-
-## ChartDatasource.maxView property
-
-Maximum number of rows to track as part of a client "view".
-
-**Signature:**
-
-```typescript
-maxView: number;
-```

package/docs/api/g2plot-chart.chartdatasource.md

@@ -1,369 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md)
-
-## ChartDatasource class
-
-The Genesis Datasource for the `g2plot-chart` component.
-
-**Signature:**
-
-```typescript
-export declare class ChartDatasource extends ChartDatasource_base 
-```
-**Extends:** ChartDatasource\_base
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[chartFields](./g2plot-chart.chartdatasource.chartfields.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Default value is 'groupBy value'. Can be customized but order matters.
-
-\[Mandatory\] First is always the xField/colorField \[Mandatory\] Second is always the yField/angleField \[Optional\] Third is always the seriesField
-
-
-</td></tr>
-<tr><td>
-
-[criteria](./g2plot-chart.chartdatasource.criteria.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Clients can send a Groovy expression to perform filters on the query server, these remain active for the life of the subscription.
-
-
-</td></tr>
-<tr><td>
-
-[data](./g2plot-chart.chartdatasource.data.md)
-
-
-</td><td>
-
-
-</td><td>
-
-any\[\]
-
-
-</td><td>
-
-Optional attribute that can be used to pass the data that will be used in the component.
-
-
-</td></tr>
-<tr><td>
-
-[isGroup](./g2plot-chart.chartdatasource.isgroup.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-If true, will enable grouped chart plotting numeric values for levels of two categorical variables instead of one.
-
-
-</td></tr>
-<tr><td>
-
-[isSnapshot](./g2plot-chart.chartdatasource.issnapshot.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Request a snapshot from the server.
-
-
-</td></tr>
-<tr><td>
-
-[isStack](./g2plot-chart.chartdatasource.isstack.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-If true, will enable stacked chart to effectively portray comparisons of total values across several categories.
-
-
-</td></tr>
-<tr><td>
-
-[maxRows](./g2plot-chart.chartdatasource.maxrows.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-Maximum number of rows to be returned as part of the initial message, and as part of any additional MORE\_ROWS messages. This will not affect the number of rows displayed.
-
-
-</td></tr>
-<tr><td>
-
-[maxView](./g2plot-chart.chartdatasource.maxview.md)
-
-
-</td><td>
-
-
-</td><td>
-
-number
-
-
-</td><td>
-
-Maximum number of rows to track as part of a client "view".
-
-
-</td></tr>
-<tr><td>
-
-[orderBy](./g2plot-chart.chartdatasource.orderby.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-This option can be used to select a Data Server index (defined in the Data Server query), which is especially useful if you want the data to be sorted in a specific way. By default, Data Server rows are returned in order of creation (from oldest database record to newest).
-
-
-</td></tr>
-<tr><td>
-
-[reduced](./g2plot-chart.chartdatasource.reduced.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Enabled by default, will not work if a custom charts-fields is used (requires \[type, value\]).
-
-
-</td></tr>
-<tr><td>
-
-[request](./g2plot-chart.chartdatasource.request.md)
-
-
-</td><td>
-
-
-</td><td>
-
-any
-
-
-</td><td>
-
-This optional parameter enables you to specify request fields, which can include wildcards.
-
-
-</td></tr>
-<tr><td>
-
-[resourceName](./g2plot-chart.chartdatasource.resourcename.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Name of the backend resource which contain the data.
-
-
-</td></tr>
-<tr><td>
-
-[reverse](./g2plot-chart.chartdatasource.reverse.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-This option changes the Data Server index iteration. For example, if you are using the default index, the query will return rows in order from the newest database records to the oldest.
-
-
-</td></tr>
-<tr><td>
-
-[rowId](./g2plot-chart.chartdatasource.rowid.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Attribute to set an unique identifier for the row.
-
-
-</td></tr>
-<tr><td>
-
-[serverFields](./g2plot-chart.chartdatasource.serverfields.md)
-
-
-</td><td>
-
-
-</td><td>
-
-string
-
-
-</td><td>
-
-Can be customized but order matters.
-
-\[Mandatory\] First will be associated to the first value in 'chartFields' (xField/colorField) \[Mandatory\] Second will be associated to the second value in 'chartFields' (yField/angleField) \[Optional\] Third will be associated to the third value in 'chartFields' (seriesField)
-
-
-</td></tr>
-<tr><td>
-
-[showFormattedTime](./g2plot-chart.chartdatasource.showformattedtime.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Only works if \[withTimestampFormatting\] is true.
-
-Disabled by default, will ignore the TIME portion in the Chart labels. Only affects \[DATETIME\] fields.
-
-
-</td></tr>
-<tr><td>
-
-[withTimestampFormatting](./g2plot-chart.chartdatasource.withtimestampformatting.md)
-
-
-</td><td>
-
-
-</td><td>
-
-boolean
-
-
-</td><td>
-
-Enabled by default, will format UNIX timestamp fields to readable \[DATE\|DATETIME\] values.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/g2plot-chart.chartdatasource.orderby.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [orderBy](./g2plot-chart.chartdatasource.orderby.md)
-
-## ChartDatasource.orderBy property
-
-This option can be used to select a Data Server index (defined in the Data Server query), which is especially useful if you want the data to be sorted in a specific way. By default, Data Server rows are returned in order of creation (from oldest database record to newest).
-
-**Signature:**
-
-```typescript
-orderBy: string;
-```

package/docs/api/g2plot-chart.chartdatasource.reduced.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [reduced](./g2plot-chart.chartdatasource.reduced.md)
-
-## ChartDatasource.reduced property
-
-Enabled by default, will not work if a custom charts-fields is used (requires \[type, value\]).
-
-**Signature:**
-
-```typescript
-reduced: boolean;
-```

package/docs/api/g2plot-chart.chartdatasource.request.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [request](./g2plot-chart.chartdatasource.request.md)
-
-## ChartDatasource.request property
-
-This optional parameter enables you to specify request fields, which can include wildcards.
-
-**Signature:**
-
-```typescript
-request: any;
-```

package/docs/api/g2plot-chart.chartdatasource.resourcename.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [resourceName](./g2plot-chart.chartdatasource.resourcename.md)
-
-## ChartDatasource.resourceName property
-
-Name of the backend resource which contain the data.
-
-**Signature:**
-
-```typescript
-resourceName: string;
-```

package/docs/api/g2plot-chart.chartdatasource.reverse.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [reverse](./g2plot-chart.chartdatasource.reverse.md)
-
-## ChartDatasource.reverse property
-
-This option changes the Data Server index iteration. For example, if you are using the default index, the query will return rows in order from the newest database records to the oldest.
-
-**Signature:**
-
-```typescript
-reverse: boolean;
-```

package/docs/api/g2plot-chart.chartdatasource.rowid.md

@@ -1,13 +0,0 @@
-<!-- Do not edit this file. It is automatically generated by API Documenter. -->
-
-[Home](./index.md) &gt; [@genesislcap/g2plot-chart](./g2plot-chart.md) &gt; [ChartDatasource](./g2plot-chart.chartdatasource.md) &gt; [rowId](./g2plot-chart.chartdatasource.rowid.md)
-
-## ChartDatasource.rowId property
-
-Attribute to set an unique identifier for the row.
-
-**Signature:**
-
-```typescript
-rowId: string;
-```