genesys-spark-chart-components 4.12.1-beta.1

package/dist/types/components.d.ts

@@ -0,0 +1,480 @@
+/* eslint-disable */
+/* tslint:disable */
+/**
+ * This is an autogenerated file created by the Stencil compiler.
+ * It contains typing information for all components that exist in this project.
+ */
+import { HTMLStencilElement, JSXBase } from "./stencil-public-runtime";
+import { EmbedOptions, VisualizationSpec } from "vega-embed";
+export { EmbedOptions, VisualizationSpec } from "vega-embed";
+export namespace Components {
+    interface GuxChartColumnBeta {
+        /**
+          * Data to be rendered in the chart. Data field names must match the values you set in xFieldName and yFieldName
+         */
+        "chartData": Record<string, any>;
+        /**
+          * List specifying the order of optional chart layers. For correct chart layering, each chartData entry must also include a "series" field with a value indicating which layer the entry belongs to, e.g 'series': 'group1'
+         */
+        "chartLayers": string[];
+        "embedOptions": EmbedOptions;
+        "includeLegend": boolean;
+        "legendPosition": | 'left'
+    | 'right'
+    | 'top'
+    | 'bottom'
+    | 'top-left'
+    | 'top-right'
+    | 'bottom-left'
+    | 'bottom-right'
+    | 'none';
+        /**
+          * Title to display above the optional legend
+         */
+        "legendTitle": string;
+        /**
+          * Title to display along the x-axis
+         */
+        "xAxisTitle": string;
+        /**
+          * Name for the data field to use to populate the chart's x-axis e.g. xFieldName of "category" will map any "category" fields in chartData to the x-axis
+         */
+        "xFieldName": string;
+        /**
+          * If true, then make Axis tick label 45 degrees
+         */
+        "xTickLabelSlant": boolean;
+        /**
+          * Title to display along the y-axis
+         */
+        "yAxisTitle": string;
+        /**
+          * Name for the data field to use to populate the chart's x-axis e.g. yFieldName of "value" will map any "value" fields in chartData to the y-axis
+         */
+        "yFieldName": string;
+    }
+    interface GuxChartDonutBeta {
+        "centerSubText": string;
+        "centerText": string;
+        /**
+          * Data to be rendered in the chart. Data field names must match the values you set in xFieldName and yFieldName
+         */
+        "chartData": Record<string, any>;
+        "colorFieldName": string;
+        "embedOptions": EmbedOptions;
+        "gauge": boolean;
+        "includeLegend": boolean;
+        "innerRadius": number;
+        "labelField": string;
+        "labelRadius": number;
+        "legendFontSize": number;
+        "legendPosition": | 'left'
+    | 'right'
+    | 'top'
+    | 'bottom'
+    | 'top-left'
+    | 'top-right'
+    | 'bottom-left'
+    | 'bottom-right'
+    | 'none';
+        "legendSymbolSize": number;
+        "legendTitle": string;
+        "legendX": number;
+        "legendY": number;
+        "outerRadius": number;
+        "showTooltip": boolean;
+        "tooltipOptions": EmbedOptions;
+    }
+    interface GuxChartLineBeta {
+        /**
+          * Data to be rendered in the chart. Data field names must match the values you set in xFieldName and yFieldName
+         */
+        "chartData": Record<string, any>;
+        "colorFieldName": string;
+        "embedOptions": EmbedOptions;
+        "includeDataPointMarkers": boolean;
+        "includeLegend": boolean;
+        "interpolation": string;
+        "legendPosition": | 'left'
+    | 'right'
+    | 'top'
+    | 'bottom'
+    | 'top-left'
+    | 'top-right'
+    | 'bottom-left'
+    | 'bottom-right'
+    | 'none';
+        /**
+          * Title to display above the optional legend
+         */
+        "legendTitle": string;
+        "strokeDash": boolean;
+        /**
+          * Title to display along the x-axis
+         */
+        "xAxisTitle": string;
+        /**
+          * Name for the data field to use to populate the chart's x-axis e.g. xFieldName of "category" will map any "category" fields in chartData to the x-axis
+         */
+        "xFieldName": string;
+        /**
+          * If true, then make Axis tick label 45 degrees
+         */
+        "xTickLabelSlant": boolean;
+        /**
+          * Title to display along the y-axis
+         */
+        "yAxisTitle": string;
+        /**
+          * Name for the data field to use to populate the chart's x-axis e.g. yFieldName of "value" will map any "value" fields in chartData to the y-axis
+         */
+        "yFieldName": string;
+    }
+    interface GuxChartPieBeta {
+        /**
+          * Data to be rendered in the chart. Data field names must match the values you set in xFieldName and yFieldName
+         */
+        "chartData": Record<string, any>;
+        "colorFieldName": string;
+        "embedOptions": EmbedOptions;
+        "includeLegend": boolean;
+        "labelField": string;
+        "labelRadius": number;
+        "legendPosition": | 'left'
+    | 'right'
+    | 'top'
+    | 'bottom'
+    | 'top-left'
+    | 'top-right'
+    | 'bottom-left'
+    | 'bottom-right'
+    | 'none';
+        "legendTitle": string;
+        "outerRadius": number;
+    }
+    interface GuxChartScatterPlotBeta {
+        /**
+          * Data to be rendered in the chart. Data field names must match the values you set in xFieldName and yFieldName
+         */
+        "chartData": Record<string, any>;
+        /**
+          * Type of category to plot in the chart
+         */
+        "colorFieldName": string;
+        "embedOptions": EmbedOptions;
+        "includeLegend": boolean;
+        "legendPosition": | 'left'
+    | 'right'
+    | 'top'
+    | 'bottom'
+    | 'top-left'
+    | 'top-right'
+    | 'bottom-left'
+    | 'bottom-right'
+    | 'none';
+        /**
+          * Title to display above the optional legend
+         */
+        "legendTitle": string;
+        /**
+          * The shape of the plotting in the chart - Square, Circle and Point
+         */
+        "useShape": string;
+        /**
+          * Title to display along the x-axis
+         */
+        "xAxisTitle": string;
+        /**
+          * Name for the data field to use to populate the chart's x-axis e.g. xFieldName of "category" will map any "category" fields in chartData to the x-axis
+         */
+        "xFieldName": string;
+        /**
+          * If true, then make Axis tick label 45 degrees
+         */
+        "xTickLabelSlant": boolean;
+        /**
+          * Title to display along the y-axis
+         */
+        "yAxisTitle": string;
+        /**
+          * Name for the data field to use to populate the chart's x-axis e.g. yFieldName of "value" will map any "value" fields in chartData to the y-axis
+         */
+        "yFieldName": string;
+    }
+    interface GuxVisualizationBeta {
+        "embedOptions": EmbedOptions;
+        "visualizationSpec": VisualizationSpec;
+    }
+}
+export interface GuxVisualizationBetaCustomEvent<T> extends CustomEvent<T> {
+    detail: T;
+    target: HTMLGuxVisualizationBetaElement;
+}
+declare global {
+    interface HTMLGuxChartColumnBetaElement extends Components.GuxChartColumnBeta, HTMLStencilElement {
+    }
+    var HTMLGuxChartColumnBetaElement: {
+        prototype: HTMLGuxChartColumnBetaElement;
+        new (): HTMLGuxChartColumnBetaElement;
+    };
+    interface HTMLGuxChartDonutBetaElement extends Components.GuxChartDonutBeta, HTMLStencilElement {
+    }
+    var HTMLGuxChartDonutBetaElement: {
+        prototype: HTMLGuxChartDonutBetaElement;
+        new (): HTMLGuxChartDonutBetaElement;
+    };
+    interface HTMLGuxChartLineBetaElement extends Components.GuxChartLineBeta, HTMLStencilElement {
+    }
+    var HTMLGuxChartLineBetaElement: {
+        prototype: HTMLGuxChartLineBetaElement;
+        new (): HTMLGuxChartLineBetaElement;
+    };
+    interface HTMLGuxChartPieBetaElement extends Components.GuxChartPieBeta, HTMLStencilElement {
+    }
+    var HTMLGuxChartPieBetaElement: {
+        prototype: HTMLGuxChartPieBetaElement;
+        new (): HTMLGuxChartPieBetaElement;
+    };
+    interface HTMLGuxChartScatterPlotBetaElement extends Components.GuxChartScatterPlotBeta, HTMLStencilElement {
+    }
+    var HTMLGuxChartScatterPlotBetaElement: {
+        prototype: HTMLGuxChartScatterPlotBetaElement;
+        new (): HTMLGuxChartScatterPlotBetaElement;
+    };
+    interface HTMLGuxVisualizationBetaElement extends Components.GuxVisualizationBeta, HTMLStencilElement {
+    }
+    var HTMLGuxVisualizationBetaElement: {
+        prototype: HTMLGuxVisualizationBetaElement;
+        new (): HTMLGuxVisualizationBetaElement;
+    };
+    interface HTMLElementTagNameMap {
+        "gux-chart-column-beta": HTMLGuxChartColumnBetaElement;
+        "gux-chart-donut-beta": HTMLGuxChartDonutBetaElement;
+        "gux-chart-line-beta": HTMLGuxChartLineBetaElement;
+        "gux-chart-pie-beta": HTMLGuxChartPieBetaElement;
+        "gux-chart-scatter-plot-beta": HTMLGuxChartScatterPlotBetaElement;
+        "gux-visualization-beta": HTMLGuxVisualizationBetaElement;
+    }
+}
+declare namespace LocalJSX {
+    interface GuxChartColumnBeta {
+        /**
+          * Data to be rendered in the chart. Data field names must match the values you set in xFieldName and yFieldName
+         */
+        "chartData"?: Record<string, any>;
+        /**
+          * List specifying the order of optional chart layers. For correct chart layering, each chartData entry must also include a "series" field with a value indicating which layer the entry belongs to, e.g 'series': 'group1'
+         */
+        "chartLayers"?: string[];
+        "embedOptions"?: EmbedOptions;
+        "includeLegend"?: boolean;
+        "legendPosition"?: | 'left'
+    | 'right'
+    | 'top'
+    | 'bottom'
+    | 'top-left'
+    | 'top-right'
+    | 'bottom-left'
+    | 'bottom-right'
+    | 'none';
+        /**
+          * Title to display above the optional legend
+         */
+        "legendTitle"?: string;
+        /**
+          * Title to display along the x-axis
+         */
+        "xAxisTitle"?: string;
+        /**
+          * Name for the data field to use to populate the chart's x-axis e.g. xFieldName of "category" will map any "category" fields in chartData to the x-axis
+         */
+        "xFieldName"?: string;
+        /**
+          * If true, then make Axis tick label 45 degrees
+         */
+        "xTickLabelSlant"?: boolean;
+        /**
+          * Title to display along the y-axis
+         */
+        "yAxisTitle"?: string;
+        /**
+          * Name for the data field to use to populate the chart's x-axis e.g. yFieldName of "value" will map any "value" fields in chartData to the y-axis
+         */
+        "yFieldName"?: string;
+    }
+    interface GuxChartDonutBeta {
+        "centerSubText"?: string;
+        "centerText"?: string;
+        /**
+          * Data to be rendered in the chart. Data field names must match the values you set in xFieldName and yFieldName
+         */
+        "chartData"?: Record<string, any>;
+        "colorFieldName"?: string;
+        "embedOptions"?: EmbedOptions;
+        "gauge"?: boolean;
+        "includeLegend"?: boolean;
+        "innerRadius"?: number;
+        "labelField"?: string;
+        "labelRadius"?: number;
+        "legendFontSize"?: number;
+        "legendPosition"?: | 'left'
+    | 'right'
+    | 'top'
+    | 'bottom'
+    | 'top-left'
+    | 'top-right'
+    | 'bottom-left'
+    | 'bottom-right'
+    | 'none';
+        "legendSymbolSize"?: number;
+        "legendTitle"?: string;
+        "legendX"?: number;
+        "legendY"?: number;
+        "outerRadius"?: number;
+        "showTooltip"?: boolean;
+        "tooltipOptions"?: EmbedOptions;
+    }
+    interface GuxChartLineBeta {
+        /**
+          * Data to be rendered in the chart. Data field names must match the values you set in xFieldName and yFieldName
+         */
+        "chartData"?: Record<string, any>;
+        "colorFieldName"?: string;
+        "embedOptions"?: EmbedOptions;
+        "includeDataPointMarkers"?: boolean;
+        "includeLegend"?: boolean;
+        "interpolation"?: string;
+        "legendPosition"?: | 'left'
+    | 'right'
+    | 'top'
+    | 'bottom'
+    | 'top-left'
+    | 'top-right'
+    | 'bottom-left'
+    | 'bottom-right'
+    | 'none';
+        /**
+          * Title to display above the optional legend
+         */
+        "legendTitle"?: string;
+        "strokeDash"?: boolean;
+        /**
+          * Title to display along the x-axis
+         */
+        "xAxisTitle"?: string;
+        /**
+          * Name for the data field to use to populate the chart's x-axis e.g. xFieldName of "category" will map any "category" fields in chartData to the x-axis
+         */
+        "xFieldName"?: string;
+        /**
+          * If true, then make Axis tick label 45 degrees
+         */
+        "xTickLabelSlant"?: boolean;
+        /**
+          * Title to display along the y-axis
+         */
+        "yAxisTitle"?: string;
+        /**
+          * Name for the data field to use to populate the chart's x-axis e.g. yFieldName of "value" will map any "value" fields in chartData to the y-axis
+         */
+        "yFieldName"?: string;
+    }
+    interface GuxChartPieBeta {
+        /**
+          * Data to be rendered in the chart. Data field names must match the values you set in xFieldName and yFieldName
+         */
+        "chartData"?: Record<string, any>;
+        "colorFieldName"?: string;
+        "embedOptions"?: EmbedOptions;
+        "includeLegend"?: boolean;
+        "labelField"?: string;
+        "labelRadius"?: number;
+        "legendPosition"?: | 'left'
+    | 'right'
+    | 'top'
+    | 'bottom'
+    | 'top-left'
+    | 'top-right'
+    | 'bottom-left'
+    | 'bottom-right'
+    | 'none';
+        "legendTitle"?: string;
+        "outerRadius"?: number;
+    }
+    interface GuxChartScatterPlotBeta {
+        /**
+          * Data to be rendered in the chart. Data field names must match the values you set in xFieldName and yFieldName
+         */
+        "chartData"?: Record<string, any>;
+        /**
+          * Type of category to plot in the chart
+         */
+        "colorFieldName"?: string;
+        "embedOptions"?: EmbedOptions;
+        "includeLegend"?: boolean;
+        "legendPosition"?: | 'left'
+    | 'right'
+    | 'top'
+    | 'bottom'
+    | 'top-left'
+    | 'top-right'
+    | 'bottom-left'
+    | 'bottom-right'
+    | 'none';
+        /**
+          * Title to display above the optional legend
+         */
+        "legendTitle"?: string;
+        /**
+          * The shape of the plotting in the chart - Square, Circle and Point
+         */
+        "useShape"?: string;
+        /**
+          * Title to display along the x-axis
+         */
+        "xAxisTitle"?: string;
+        /**
+          * Name for the data field to use to populate the chart's x-axis e.g. xFieldName of "category" will map any "category" fields in chartData to the x-axis
+         */
+        "xFieldName"?: string;
+        /**
+          * If true, then make Axis tick label 45 degrees
+         */
+        "xTickLabelSlant"?: boolean;
+        /**
+          * Title to display along the y-axis
+         */
+        "yAxisTitle"?: string;
+        /**
+          * Name for the data field to use to populate the chart's x-axis e.g. yFieldName of "value" will map any "value" fields in chartData to the y-axis
+         */
+        "yFieldName"?: string;
+    }
+    interface GuxVisualizationBeta {
+        "embedOptions"?: EmbedOptions;
+        "onChartClicked"?: (event: GuxVisualizationBetaCustomEvent<any>) => void;
+        "onChartComponentReady"?: (event: GuxVisualizationBetaCustomEvent<any>) => void;
+        "visualizationSpec"?: VisualizationSpec;
+    }
+    interface IntrinsicElements {
+        "gux-chart-column-beta": GuxChartColumnBeta;
+        "gux-chart-donut-beta": GuxChartDonutBeta;
+        "gux-chart-line-beta": GuxChartLineBeta;
+        "gux-chart-pie-beta": GuxChartPieBeta;
+        "gux-chart-scatter-plot-beta": GuxChartScatterPlotBeta;
+        "gux-visualization-beta": GuxVisualizationBeta;
+    }
+}
+export { LocalJSX as JSX };
+declare module "@stencil/core" {
+    export namespace JSX {
+        interface IntrinsicElements {
+            "gux-chart-column-beta": LocalJSX.GuxChartColumnBeta & JSXBase.HTMLAttributes<HTMLGuxChartColumnBetaElement>;
+            "gux-chart-donut-beta": LocalJSX.GuxChartDonutBeta & JSXBase.HTMLAttributes<HTMLGuxChartDonutBetaElement>;
+            "gux-chart-line-beta": LocalJSX.GuxChartLineBeta & JSXBase.HTMLAttributes<HTMLGuxChartLineBetaElement>;
+            "gux-chart-pie-beta": LocalJSX.GuxChartPieBeta & JSXBase.HTMLAttributes<HTMLGuxChartPieBetaElement>;
+            "gux-chart-scatter-plot-beta": LocalJSX.GuxChartScatterPlotBeta & JSXBase.HTMLAttributes<HTMLGuxChartScatterPlotBetaElement>;
+            "gux-visualization-beta": LocalJSX.GuxVisualizationBeta & JSXBase.HTMLAttributes<HTMLGuxVisualizationBetaElement>;
+        }
+    }
+}

package/dist/types/i18n/fetchResources.d.ts

@@ -0,0 +1,11 @@
+export interface ILocalizedComponentResources {
+  [resourceKey: string]: string;
+}
+export interface ILocalizedResources {
+  [componentName: string]: ILocalizedComponentResources;
+}
+export interface IResourceCache {
+  [locale: string]: ILocalizedResources;
+}
+export declare const determineFetchUrl: (locale?: string) => string;
+export declare const fetchResources: (componentName: string, locale: string) => Promise<ILocalizedComponentResources>;

package/dist/types/i18n/index.d.ts

@@ -0,0 +1,9 @@
+import { ILocalizedComponentResources } from './fetchResources';
+type I18nValueContext = {
+  [key: string]: string | number;
+};
+export type GetI18nValue = (resourceKey: string, context?: I18nValueContext) => string;
+export declare function buildI18nForComponent(component: HTMLElement, defaultResources: ILocalizedComponentResources, parentComponent?: string): Promise<GetI18nValue>;
+export declare function getComponentI18nResources(component: HTMLElement, defaultResources: ILocalizedComponentResources, locale: string, parentComponent?: string): Promise<ILocalizedComponentResources>;
+export declare function getDesiredLocale(element: HTMLElement): string;
+export {};

package/dist/types/index.d.ts

@@ -0,0 +1,3 @@
+
+  export * from './components';
+  export * from './stencil-wrapper';