@j2inn/fin5-ui-utils 8.1.1-beta.6 → 8.1.1

package/dist/react/components/charts/line-bar/Chart.d.ts

@@ -1,166 +1,166 @@
-import * as am5 from '@amcharts/amcharts5';
-import { ITimeInterval } from '@amcharts/amcharts5/.internal/core/util/Time';
-import * as am5xy from '@amcharts/amcharts5/xy';
-import React from 'react';
-export declare type StackedColumnChartInterfaceColors = {
-    [Property in keyof am5.IInterfaceColorsSettings]: string;
-};
-export interface StackedColumnChartColorPalette {
-    interfaceColors?: Partial<StackedColumnChartInterfaceColors>;
-    series?: string[];
-}
-export declare enum UnitPlacement {
-    none = "none",
-    top = "top",
-    axis = "axis"
-}
-export declare enum AxisPlacement {
-    left = "left",
-    right = "right"
-}
-export declare enum LegendPlacement {
-    top = "top",
-    bottom = "bottom",
-    left = "left",
-    right = "right",
-    hidden = "hidden"
-}
-interface BaseChartSeriesProps {
-    seriesName: string;
-    dis?: string;
-    unit?: string;
-    axisPlacement?: AxisPlacement;
-    hideAxis?: boolean;
-}
-export interface BarChartSeriesData extends BaseChartSeriesProps {
-    stroke?: am5.Color;
-    data: LineChartSeriesPoint[];
-}
-export interface LineChartSeriesPoint {
-    ts: number;
-    value: number | undefined | null;
-}
-export interface LineChartSeriesData extends BaseChartSeriesProps {
-    strokeSettings?: {
-        stroke?: am5.Color;
-        strokeDasharray?: number[];
-        strokeWidth?: number;
-    };
-    data: LineChartSeriesPoint[];
-}
-export interface ChartAxisRangeData {
-    startValue?: number;
-    endValue?: number;
-    foreground?: am5.Color;
-    color?: am5.Color;
-    opacity?: number;
-    text?: string;
-    html?: string;
-    tooltip?: string;
-    showText?: boolean;
-    placeBelow?: boolean;
-}
-export interface ChartProps {
-    /**
-     * Data used to populate the chart with columns
-     */
-    barSeriesData?: BarChartSeriesData[];
-    /**
-     * Data used to populate the chart with stacked columns
-     */
-    stackedBarSeriesData?: BarChartSeriesData[];
-    /**
-     * Data used to populate the chart with line series
-     */
-    lineSeriesData?: LineChartSeriesData[];
-    rangesData?: ChartAxisRangeData[];
-    /**
-     * The name of the prop in the data that contains the timestamp
-     */
-    dateField: string;
-    /**
-     * True to activate the cursor
-     */
-    cursor?: boolean;
-    /**
-     * The time interval for the Date Axis @see https://www.amcharts.com/docs/v5/charts/xy-chart/axes/date-axis/#data-granularity
-     */
-    baseInterval: ITimeInterval;
-    /**
-     * Color palette for the chart slices and interface colors @see https://www.amcharts.com/docs/v5/concepts/colors-gradients-and-patterns/#Interface_colors
-     */
-    colorPalette?: Partial<StackedColumnChartColorPalette>;
-    /**
-     * Number formatting options @see https://www.amcharts.com/docs/v5/tutorials/formatting-date-time-and-numbers-using-intl-object/#Formatting_numbers
-     */
-    numberFormat?: Intl.NumberFormatOptions;
-    /**
-     * amcharts5 theme classes to be used by the chart @see https://www.amcharts.com/docs/v5/concepts/themes/
-     */
-    chartThemes?: typeof am5.Theme[];
-    /**
-     * Settings for chart customization @see https://www.amcharts.com/docs/v5/reference/xychart/#Settings
-     */
-    chartSettings?: am5xy.IXYChartSettings;
-    /**
-     * Settings for legend customization @see https://www.amcharts.com/docs/v5/reference/legend/#Settings
-     */
-    legendSettings?: am5.ILegendSettings;
-    /**
-     * Settings for legend labels customization @see https://www.amcharts.com/docs/v5/concepts/legend/#labels
-     */
-    legendLabelsSettings?: am5.ILabelSettings;
-    /**
-     * Settings for legend markers customization @see https://www.amcharts.com/docs/v5/concepts/legend/#labels
-     */
-    legendMarkersSettings?: am5.ILabelSettings & {
-        rounded?: boolean;
-    };
-    /**
-     * Settings for date axis @see https://www.amcharts.com/docs/v5/reference/dateaxis/#Settings
-     */
-    dateAxisSettings?: Omit<am5xy.IDateAxisSettings<am5xy.AxisRenderer>, 'baseInterval' | 'renderer'>;
-    /**
-     * Settings for date axis renderer @see https://www.amcharts.com/docs/v5/reference/iaxisrendererxsettings/
-     */
-    dateAxisRendererSettings?: am5xy.IAxisRendererXSettings;
-    /**
-     * Settings for category axis @see https://www.amcharts.com/docs/v5/reference/valueaxis/#Settings
-     */
-    valueAxisSettings?: Omit<am5xy.IValueAxisSettings<am5xy.AxisRenderer>, 'renderer'>;
-    /**
-     * Settings for chart series customization @see https://www.amcharts.com/docs/v5/reference/grid/#Settings
-     */
-    gridSettings?: Partial<am5xy.IGridSettings>;
-    /**
-     * Settings for chart column series customization @see https://www.amcharts.com/docs/v5/reference/columnseries/#Settings
-     */
-    barSeriesSettings?: am5xy.IColumnSeriesSettings;
-    /**
-     * Settings for chart line series customization @see https://www.amcharts.com/docs/v5/reference/lineseries/#Settings
-     */
-    lineSeriesSettings?: Partial<am5xy.ILineSeriesSettings>;
-    /**
-     * Settings for series column customization @see https://www.amcharts.com/docs/v5/reference/roundedrectangle/#Settings
-     */
-    columnSettings?: Partial<am5.IRoundedRectangleSettings>;
-    /**
-     * Settings for tooltips label customization @see https://www.amcharts.com/docs/v5/reference/ilabelsettings/
-     */
-    tooltipSettings?: Partial<am5.ILabelSettings>;
-    unitPlacement?: UnitPlacement;
-    legendPlacement?: LegendPlacement;
-    translateLabel?: (name: string) => string;
-    /**
-     * Optional DOM id for the chart container, if not specified it will be automatically generated.
-     * It can also be an HTMLElement, in that case the element will be used as a parent.
-     */
-    DOMtargetId?: string | HTMLElement;
-}
-/**
- * Customizable stacked column and line chart component based on amcharts5
- *
- * This component wraps some of the chart configuration trying to make it more react-friendly
- */
-export declare const Chart: React.FC<ChartProps>;
-export {};
+import * as am5 from '@amcharts/amcharts5';
+import { ITimeInterval } from '@amcharts/amcharts5/.internal/core/util/Time';
+import * as am5xy from '@amcharts/amcharts5/xy';
+import React from 'react';
+export declare type StackedColumnChartInterfaceColors = {
+    [Property in keyof am5.IInterfaceColorsSettings]: string;
+};
+export interface StackedColumnChartColorPalette {
+    interfaceColors?: Partial<StackedColumnChartInterfaceColors>;
+    series?: string[];
+}
+export declare enum UnitPlacement {
+    none = "none",
+    top = "top",
+    axis = "axis"
+}
+export declare enum AxisPlacement {
+    left = "left",
+    right = "right"
+}
+export declare enum LegendPlacement {
+    top = "top",
+    bottom = "bottom",
+    left = "left",
+    right = "right",
+    hidden = "hidden"
+}
+interface BaseChartSeriesProps {
+    seriesName: string;
+    dis?: string;
+    unit?: string;
+    axisPlacement?: AxisPlacement;
+    hideAxis?: boolean;
+}
+export interface BarChartSeriesData extends BaseChartSeriesProps {
+    stroke?: am5.Color;
+    data: LineChartSeriesPoint[];
+}
+export interface LineChartSeriesPoint {
+    ts: number;
+    value: number | undefined | null;
+}
+export interface LineChartSeriesData extends BaseChartSeriesProps {
+    strokeSettings?: {
+        stroke?: am5.Color;
+        strokeDasharray?: number[];
+        strokeWidth?: number;
+    };
+    data: LineChartSeriesPoint[];
+}
+export interface ChartAxisRangeData {
+    startValue?: number;
+    endValue?: number;
+    foreground?: am5.Color;
+    color?: am5.Color;
+    opacity?: number;
+    text?: string;
+    html?: string;
+    tooltip?: string;
+    showText?: boolean;
+    placeBelow?: boolean;
+}
+export interface ChartProps {
+    /**
+     * Data used to populate the chart with columns
+     */
+    barSeriesData?: BarChartSeriesData[];
+    /**
+     * Data used to populate the chart with stacked columns
+     */
+    stackedBarSeriesData?: BarChartSeriesData[];
+    /**
+     * Data used to populate the chart with line series
+     */
+    lineSeriesData?: LineChartSeriesData[];
+    rangesData?: ChartAxisRangeData[];
+    /**
+     * The name of the prop in the data that contains the timestamp
+     */
+    dateField: string;
+    /**
+     * True to activate the cursor
+     */
+    cursor?: boolean;
+    /**
+     * The time interval for the Date Axis @see https://www.amcharts.com/docs/v5/charts/xy-chart/axes/date-axis/#data-granularity
+     */
+    baseInterval: ITimeInterval;
+    /**
+     * Color palette for the chart slices and interface colors @see https://www.amcharts.com/docs/v5/concepts/colors-gradients-and-patterns/#Interface_colors
+     */
+    colorPalette?: Partial<StackedColumnChartColorPalette>;
+    /**
+     * Number formatting options @see https://www.amcharts.com/docs/v5/tutorials/formatting-date-time-and-numbers-using-intl-object/#Formatting_numbers
+     */
+    numberFormat?: Intl.NumberFormatOptions;
+    /**
+     * amcharts5 theme classes to be used by the chart @see https://www.amcharts.com/docs/v5/concepts/themes/
+     */
+    chartThemes?: typeof am5.Theme[];
+    /**
+     * Settings for chart customization @see https://www.amcharts.com/docs/v5/reference/xychart/#Settings
+     */
+    chartSettings?: am5xy.IXYChartSettings;
+    /**
+     * Settings for legend customization @see https://www.amcharts.com/docs/v5/reference/legend/#Settings
+     */
+    legendSettings?: am5.ILegendSettings;
+    /**
+     * Settings for legend labels customization @see https://www.amcharts.com/docs/v5/concepts/legend/#labels
+     */
+    legendLabelsSettings?: am5.ILabelSettings;
+    /**
+     * Settings for legend markers customization @see https://www.amcharts.com/docs/v5/concepts/legend/#labels
+     */
+    legendMarkersSettings?: am5.ILabelSettings & {
+        rounded?: boolean;
+    };
+    /**
+     * Settings for date axis @see https://www.amcharts.com/docs/v5/reference/dateaxis/#Settings
+     */
+    dateAxisSettings?: Omit<am5xy.IDateAxisSettings<am5xy.AxisRenderer>, 'baseInterval' | 'renderer'>;
+    /**
+     * Settings for date axis renderer @see https://www.amcharts.com/docs/v5/reference/iaxisrendererxsettings/
+     */
+    dateAxisRendererSettings?: am5xy.IAxisRendererXSettings;
+    /**
+     * Settings for category axis @see https://www.amcharts.com/docs/v5/reference/valueaxis/#Settings
+     */
+    valueAxisSettings?: Omit<am5xy.IValueAxisSettings<am5xy.AxisRenderer>, 'renderer'>;
+    /**
+     * Settings for chart series customization @see https://www.amcharts.com/docs/v5/reference/grid/#Settings
+     */
+    gridSettings?: Partial<am5xy.IGridSettings>;
+    /**
+     * Settings for chart column series customization @see https://www.amcharts.com/docs/v5/reference/columnseries/#Settings
+     */
+    barSeriesSettings?: am5xy.IColumnSeriesSettings;
+    /**
+     * Settings for chart line series customization @see https://www.amcharts.com/docs/v5/reference/lineseries/#Settings
+     */
+    lineSeriesSettings?: Partial<am5xy.ILineSeriesSettings>;
+    /**
+     * Settings for series column customization @see https://www.amcharts.com/docs/v5/reference/roundedrectangle/#Settings
+     */
+    columnSettings?: Partial<am5.IRoundedRectangleSettings>;
+    /**
+     * Settings for tooltips label customization @see https://www.amcharts.com/docs/v5/reference/ilabelsettings/
+     */
+    tooltipSettings?: Partial<am5.ILabelSettings>;
+    unitPlacement?: UnitPlacement;
+    legendPlacement?: LegendPlacement;
+    translateLabel?: (name: string) => string;
+    /**
+     * Optional DOM id for the chart container, if not specified it will be automatically generated.
+     * It can also be an HTMLElement, in that case the element will be used as a parent.
+     */
+    DOMtargetId?: string | HTMLElement;
+}
+/**
+ * Customizable stacked column and line chart component based on amcharts5
+ *
+ * This component wraps some of the chart configuration trying to make it more react-friendly
+ */
+export declare const Chart: React.FC<ChartProps>;
+export {};