@genesislcap/g2plot-chart 14.408.0 → 14.409.0

package/docs/api/g2plot-chart.chartdatasource.serverfields.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; [serverFields](./g2plot-chart.chartdatasource.serverfields.md)
-
-## ChartDatasource.serverFields property
-
-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)
-
-**Signature:**
-
-```typescript
-serverFields: string;
-```

package/docs/api/g2plot-chart.chartdatasource.showformattedtime.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; [showFormattedTime](./g2plot-chart.chartdatasource.showformattedtime.md)
-
-## ChartDatasource.showFormattedTime property
-
-Only works if \[withTimestampFormatting\] is true.
-
-Disabled by default, will ignore the TIME portion in the Chart labels. Only affects \[DATETIME\] fields.
-
-**Signature:**
-
-```typescript
-showFormattedTime: boolean;
-```

package/docs/api/g2plot-chart.chartdatasource.withtimestampformatting.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; [withTimestampFormatting](./g2plot-chart.chartdatasource.withtimestampformatting.md)
-
-## ChartDatasource.withTimestampFormatting property
-
-Enabled by default, will format UNIX timestamp fields to readable \[DATE\|DATETIME\] values.
-
-**Signature:**
-
-```typescript
-withTimestampFormatting: boolean;
-```

package/docs/api/g2plot-chart.chartdatasourceerrorevent.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; [ChartDatasourceErrorEvent](./g2plot-chart.chartdatasourceerrorevent.md)
-
-## ChartDatasourceErrorEvent type
-
-The error event Chart Datasource.
-
-**Signature:**
-
-```typescript
-export type ChartDatasourceErrorEvent = CustomEvent<ChartDatasourceErrorEventDetail>;
-```
-**References:** [ChartDatasourceErrorEventDetail](./g2plot-chart.chartdatasourceerroreventdetail.md)
-

package/docs/api/g2plot-chart.chartdatasourceerroreventdetail.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; [ChartDatasourceErrorEventDetail](./g2plot-chart.chartdatasourceerroreventdetail.md)
-
-## ChartDatasourceErrorEventDetail type
-
-The event detail for the Chart Datasource `error` event.
-
-**Signature:**
-
-```typescript
-export type ChartDatasourceErrorEventDetail = {
-    message: string;
-};
-```

package/docs/api/g2plot-chart.chartdatasourceeventnames.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; [chartDatasourceEventNames](./g2plot-chart.chartdatasourceeventnames.md)
-
-## chartDatasourceEventNames variable
-
-The Chart Datasource event names.
-
-**Signature:**
-
-```typescript
-chartDatasourceEventNames: {
-    error: string;
-}
-```

package/docs/api/g2plot-chart.charterrorevent.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; [ChartErrorEvent](./g2plot-chart.charterrorevent.md)
-
-## ChartErrorEvent type
-
-Chart possible error events
-
-**Signature:**
-
-```typescript
-export type ChartErrorEvent = ChartDatasourceErrorEvent | CustomEvent<ChartErrorItem<any>>;
-```
-**References:** [ChartDatasourceErrorEvent](./g2plot-chart.chartdatasourceerrorevent.md)<!-- -->, [ChartErrorItem](./g2plot-chart.charterroritem.md)
-

package/docs/api/g2plot-chart.charterroritem.detail.md

@@ -1,11 +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; [ChartErrorItem](./g2plot-chart.charterroritem.md) &gt; [detail](./g2plot-chart.charterroritem.detail.md)
-
-## ChartErrorItem.detail property
-
-**Signature:**
-
-```typescript
-detail: ChartErrorItemDetailType;
-```

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

@@ -1,73 +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; [ChartErrorItem](./g2plot-chart.charterroritem.md)
-
-## ChartErrorItem interface
-
-Chart Error Item
-
-**Signature:**
-
-```typescript
-export interface ChartErrorItem<ChartErrorItemDetailType> 
-```
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[detail](./g2plot-chart.charterroritem.detail.md)
-
-
-</td><td>
-
-
-</td><td>
-
-ChartErrorItemDetailType
-
-
-</td><td>
-
-
-</td></tr>
-<tr><td>
-
-[type](./g2plot-chart.charterroritem.type.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[ChartErrorTypes](./g2plot-chart.charterrortypes.md)
-
-
-</td><td>
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/g2plot-chart.charterroritem.type.md

@@ -1,11 +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; [ChartErrorItem](./g2plot-chart.charterroritem.md) &gt; [type](./g2plot-chart.charterroritem.type.md)
-
-## ChartErrorItem.type property
-
-**Signature:**
-
-```typescript
-type: ChartErrorTypes;
-```

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

@@ -1,16 +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; [chartErrorNames](./g2plot-chart.charterrornames.md)
-
-## chartErrorNames variable
-
-The error names for the Chart component.
-
-**Signature:**
-
-```typescript
-chartErrorNames: {
-    readonly datasource: "datasource";
-    readonly unknown: "unknown";
-}
-```

package/docs/api/g2plot-chart.charterrortypes.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; [ChartErrorTypes](./g2plot-chart.charterrortypes.md)
-
-## ChartErrorTypes type
-
-Chart Error Types
-
-**Signature:**
-
-```typescript
-export type ChartErrorTypes = keyof typeof chartErrorNames;
-```
-**References:** [chartErrorNames](./g2plot-chart.charterrornames.md)
-

package/docs/api/g2plot-chart.chartmodels.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; [ChartModels](./g2plot-chart.chartmodels.md)
-
-## ChartModels type
-
-G2Plot Chart Models
-
-**Signature:**
-
-```typescript
-export type ChartModels = Line | Area | Bar | Column | Pie | DualAxes | Rose | Scatter | Stock | Mix;
-```

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

@@ -1,24 +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; [chartsGradients](./g2plot-chart.chartsgradients.md)
-
-## chartsGradients variable
-
-G2Plot Chart gradient colors
-
-**Signature:**
-
-```typescript
-chartsGradients: {
-    rapidBlue: string;
-    rapidGreen: string;
-    rapidRed: string;
-    rapidPortage: string;
-    rapidAlabaster: string;
-    rapidSalomie: string;
-    rapidMelon: string;
-    rapidDodgerBlue: string;
-    rapidIce: string;
-    rapidViolet: string;
-}
-```

package/docs/api/g2plot-chart.charttypes.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; [ChartTypes](./g2plot-chart.charttypes.md)
-
-## ChartTypes type
-
-G2Plot Chart Types
-
-**Signature:**
-
-```typescript
-export type ChartTypes = 'line' | 'area' | 'column' | 'bar' | 'pie' | 'donut' | 'dualaxes' | 'rose' | 'scatter' | 'stock' | 'mix';
-```

package/docs/api/g2plot-chart.defaultchartconfig.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; [defaultChartConfig](./g2plot-chart.defaultchartconfig.md)
-
-## defaultChartConfig variable
-
-The default `g2plot-chart` configuration.
-
-**Signature:**
-
-```typescript
-defaultChartConfig: {}
-```

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

@@ -1,18 +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; [defaultChartFields](./g2plot-chart.defaultchartfields.md)
-
-## defaultChartFields variable
-
-The first and second default chart fields when it's a dual axes chart.
-
-**Signature:**
-
-```typescript
-defaultChartFields = "groupBy value"
-```
-
-## Remarks
-
-This field is always used. Default value is 'groupBy value'.
-

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

@@ -1,18 +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; [defaultSeriesChartField](./g2plot-chart.defaultserieschartfield.md)
-
-## defaultSeriesChartField variable
-
-The third default chart field when it's a triple axes chart.
-
-**Signature:**
-
-```typescript
-defaultSeriesChartField = "series"
-```
-
-## Remarks
-
-This field is optional. Default value is 'series'.
-

package/docs/api/g2plot-chart.foundationchartshadowoptions.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; [foundationChartShadowOptions](./g2plot-chart.foundationchartshadowoptions.md)
-
-## foundationChartShadowOptions variable
-
-The `g2plot-chart` component shadow options.
-
-**Signature:**
-
-```typescript
-foundationChartShadowOptions: ShadowRootInit
-```

package/docs/api/g2plot-chart.g2plotchart.config.md

@@ -1,30 +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; [G2PlotChart](./g2plot-chart.g2plotchart.md) &gt; [config](./g2plot-chart.g2plotchart.config.md)
-
-## G2PlotChart.config property
-
-The configuration to use for the chart. Check [ChartConfig](./g2plot-chart.chartconfig.md) for possible options
-
-**Signature:**
-
-```typescript
-config: ChartConfig;
-```
-
-## Example
-
-Here's a simple example:
-
-```
-const chartConfig = {
-  width: 700,
-  xField: 'value',
-  yField: 'groupBy',
-  seriesField: 'series',
-  legend: {
-    position: 'top-left',
-  },
-};
-```
-

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

@@ -1,18 +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; [G2PlotChart](./g2plot-chart.g2plotchart.md) &gt; [data](./g2plot-chart.g2plotchart.data.md)
-
-## G2PlotChart.data property
-
-The data to display in the chart.
-
-**Signature:**
-
-```typescript
-data: any[];
-```
-
-## Remarks
-
-For scenarios where you want to set data manually, without relying on `<chart-datasource>`<!-- -->.
-

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

@@ -1,101 +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; [G2PlotChart](./g2plot-chart.g2plotchart.md)
-
-## G2PlotChart class
-
-The G2Plot Chart component
-
-**Signature:**
-
-```typescript
-export declare class G2PlotChart extends G2PlotChart_base 
-```
-**Extends:** G2PlotChart\_base
-
-## Remarks
-
-The constructor for this class is marked as internal. Third-party code should not call the constructor directly or create subclasses that extend the `G2PlotChart` class.
-
-## Properties
-
-<table><thead><tr><th>
-
-Property
-
-
-</th><th>
-
-Modifiers
-
-
-</th><th>
-
-Type
-
-
-</th><th>
-
-Description
-
-
-</th></tr></thead>
-<tbody><tr><td>
-
-[config](./g2plot-chart.g2plotchart.config.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[ChartConfig](./g2plot-chart.chartconfig.md)
-
-
-</td><td>
-
-The configuration to use for the chart. Check [ChartConfig](./g2plot-chart.chartconfig.md) for possible options
-
-
-</td></tr>
-<tr><td>
-
-[data](./g2plot-chart.g2plotchart.data.md)
-
-
-</td><td>
-
-
-</td><td>
-
-any\[\]
-
-
-</td><td>
-
-The data to display in the chart.
-
-
-</td></tr>
-<tr><td>
-
-[type](./g2plot-chart.g2plotchart.type.md)
-
-
-</td><td>
-
-
-</td><td>
-
-[ChartTypes](./g2plot-chart.charttypes.md)
-
-
-</td><td>
-
-The type to use for the chart. If not set, the default bar type will be used.
-
-
-</td></tr>
-</tbody></table>
-

package/docs/api/g2plot-chart.g2plotchart.type.md

@@ -1,18 +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; [G2PlotChart](./g2plot-chart.g2plotchart.md) &gt; [type](./g2plot-chart.g2plotchart.type.md)
-
-## G2PlotChart.type property
-
-The type to use for the chart. If not set, the default bar type will be used.
-
-**Signature:**
-
-```typescript
-type: ChartTypes;
-```
-
-## Remarks
-
-Can be one of the following: line, area, column, bar, pie, donut, dualaxes, rose, scatter, stock, mix.
-

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

@@ -1,26 +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; [g2plotChartsComponents](./g2plot-chart.g2plotchartscomponents.md)
-
-## g2plotChartsComponents variable
-
-All the `g2plot-chart` components
-
-**Signature:**
-
-```typescript
-g2plotChartsComponents: {
-    g2plotChart: (overrideDefinition?: import("@microsoft/fast-foundation").OverrideFoundationElementDefinition<{
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<any, any>;
-        shadowOptions: ShadowRootInit;
-    }>) => import("@microsoft/fast-foundation").FoundationElementRegistry<{
-        baseName: string;
-        styles: import("@microsoft/fast-element").ElementStyles;
-        template: import("@microsoft/fast-element").ViewTemplate<any, any>;
-        shadowOptions: ShadowRootInit;
-    }, typeof import("./chart").G2PlotChart>;
-    register(container?: Container, ...rest: any[]): void;
-}
-```

package/docs/api/g2plot-chart.g2plotcharttemplate.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; [g2plotChartTemplate](./g2plot-chart.g2plotcharttemplate.md)
-
-## g2plotChartTemplate variable
-
-The g2lot chart template.
-
-**Signature:**
-
-```typescript
-g2plotChartTemplate: ViewTemplate
-```