@apia/charts 1.0.2 → 2.0.0

package/dist/index.d.ts

@@ -1,250 +1,6 @@
-import * as _apia_util from '@apia/util';
-import * as React$1 from 'react';
-import React__default from 'react';
-
-type TApiaChartCoordinate = {
-    /**
-     * Value shown in the X axis.
-     * In the case of pie charts, it defines the name of each slice.
-     */
-    key: string;
-    /**
-     * Value shown in the Y axis, or to determine the size and value of slices of
-     * a pie chart.
-     */
-    value: string;
-    /**
-     * Optional value shown only on the slices of pie charts
-     */
-    percentage?: string;
-    color?: string;
-};
-type TApiaChartColumn = {
-    /**
-     * Specific color of a column, does not work on pie charts
-     */
-    color: string;
-    /**
-     * Values of each element
-     */
-    sets: TApiaChartCoordinate | TApiaChartCoordinate[];
-    /**
-     * Name of each column.
-     *
-     * On bars and line based charts, the legend will show this value.
-     *
-     * On the pie and waterfall charts, a chart will be created for each column.
-     */
-    name: string;
-};
-type TApiaChartDefinition = {
-    chartType?: 'barH2D' | 'barV2D' | 'linear' | 'waterfall' | 'pie2D';
-    axisXTitle?: string;
-    axisYTitle?: string;
-    hideSelector?: boolean;
-    /**
-     * The colors of the waterfall chart are defined by the bars with positive
-     * values and the bars with negative values. So in order to mantain cohesion
-     * in the color schema of the chart, this prop establishes the required colors
-     * for the chart
-     */
-    waterfallColors?: {
-        positive: string;
-        negative: string;
-        total: string;
-        stepConnector: string;
-    };
-    /**
-     * Name of the schema of colors shown in the chart. Pie charts must always include a schema
-     */
-    colorSchema?: string;
-    /**
-     * Main data to be parsed and shown in the chart.
-     * Depending on the ```chartType``` and the amount of ```column``` objects,
-     * the data can be considered differently.
-     *
-     * Examples:
-     * ```
-     * const columnsWithSingleColumnObject = columns: {
-     *   column: {
-     *     color: 'red',
-     *     coordinate: [
-     *       { xValue: '1', yValue: '1' },
-     *       ...,
-     *     ],
-     *     name: 'col1',
-     *   }
-     * };
-     * ```
-     * ```
-     * const columnsWithMultipleColumnObject = columns: {
-     *   column: [
-     *     {
-     *      color: 'red',
-     *      coordinate: [
-     *        { xValue: '1', yValue: '1' },
-     *        ...,
-     *      ],
-     *      name: 'col1',
-     *    },
-     *    ...,
-     *  ]
-     * };
-     *```
-     *
-     *
-     * ***Horizontal and Vertical bars***:
-     *
-     * ```1 column object```:
-     *
-     * Each ```coordinate``` is considered an individual separate 'column bar',
-     * and the ```colorSchema``` is separated between each ```coordinate``` made
-     * 'column bar'.
-     *
-     *
-     * ```Multiple column objects```:
-     *
-     * Each ```column``` object should have the same amount of coordinates and
-     * the coordinates in the same index of the array should have the same
-     * ```xValue```
-     *
-     * Each ```coordinate``` is considered an individual separate 'column bar',
-     * but the coordinates of each column are re-accommodated based on their
-     * ```xValue``` in order to make groups of columns with the same value on the
-     * X axis.
-     *
-     * In this case there will be 6 groups of columns (based on the length of the
-     * coordinate array), each group containing 3 'column bars' (based on the
-     * amount of column objects) and the ```colorSchema``` will be distributed
-     * inside each group, meaning each column having one single color.
-     *
-     *
-     * ***Linear***:
-     *
-     * ```N column objects```:
-  
-     *
-     * Each ```column``` object is considered a line path, the coordinates being
-     * the nodes of said line.
-     *
-     * ***Pie charts***:
-     *
-     * ```N column objects```:
-     *
-     * Each ```column``` object is considered a unique Pie chart, the coordinates
-     * being the slices of said pie.
-     *
-     * ***Waterfall***:
-     *
-     * ```N column objects```:
-     *
-     * Each ```column``` object is considered a unique Waterfall chart, the coordinates
-     * being bars with the ```yValue``` determining if it goes up or down. Only this
-     * type of chart admits negative values on its coordinates.
-     *
-     */
-    dataSets: {
-        data: TApiaChartColumn | TApiaChartColumn[];
-    };
-    margin?: {
-        top: number;
-        left: number;
-        bottom: number;
-        right: number;
-    } | number;
-    pnl_id?: string;
-    showAxisXTitle?: boolean;
-    showAxisYTitle?: boolean;
-    showGrid?: boolean;
-    showLegend?: boolean;
-    showValues?: boolean;
-    /**
-     * Specific for waterfall charts to show the total sum of the values of the
-     * chart at the end while each column shows its value. Otherwise the values
-     * shown on each bar will represent the current sum of values
-     */
-    showTotal?: boolean;
-    title: string;
-    ratio: {
-        height: number;
-        width: number;
-        maxWidth: number;
-    };
-};
-type TChartMargin = {
-    top: number;
-    bottom: number;
-    left: number;
-    right: number;
-};
-type TChartRendererProps = {
-    chart: TApiaChartDefinition;
-    margin?: number | TChartMargin;
-    disableEvents?: boolean;
-    className?: string;
-    chartId: string;
-    parentRef?: React.MutableRefObject<HTMLElement>;
-    outerClassName?: string;
-    allowZoom?: boolean;
-};
-
-declare const ChartRenderer: React__default.FC<{
-    currentChart: TApiaChartDefinition;
-    chartConfig?: Partial<Omit<TApiaChartDefinition, "columns">> | undefined;
-    chartProps?: Partial<TChartRendererProps> | undefined;
-    allowScaleChange?: boolean | undefined;
-    chartId: string;
-    allowZoom?: boolean | undefined;
-} & React__default.RefAttributes<HTMLElement> & {
-    id: _apia_util.TId;
-}>;
-
-declare const EmptyGrid: ({ width }: {
-    width?: number | undefined;
-}) => React$1.JSX.Element;
-
-type TWidgetZone = {
-    minimum: number;
-    maximum: number;
-    transparency: number;
-    color: string;
-};
-type TWidgetData = {
-    border: boolean;
-    backgroundColor: string;
-    currentValue: number;
-    forceProp?: Record<string, unknown>;
-    height: number;
-    maxValue: number;
-    minValue: number;
-    noValueColor: string;
-    pointerColor: string;
-    ringAnchor: number;
-    scaleFontSize: string | number;
-    valueColor: string;
-    valueDecimals: number;
-    valueFontSize: string | number;
-    valueType: string | number;
-    viewBtnDshAssociated: boolean;
-    viewBtnHistory: boolean;
-    viewBtnInfo: boolean;
-    viewBtnComments: boolean;
-    viewBtnUpdate: boolean;
-    viewBtnOpenCbe: boolean;
-    viewBtnOpenQry: boolean;
-    viewBtnOpenOtherQry: boolean;
-    viewBtnOpenOtherQbe: boolean;
-    viewWidName: boolean;
-    widKpiType: string | number;
-    width: number;
-    zones: {
-        Zone: TWidgetZone | TWidgetZone[];
-    };
-};
-
-declare const WidgetContainer: ({ data, id, }: {
-    data: TWidgetData;
-    id: string;
-}) => React$1.JSX.Element;
-
-export { ChartRenderer, EmptyGrid, TApiaChartColumn, TApiaChartDefinition, TWidgetData, WidgetContainer };
+export { ChartRenderer } from './charts/ChartRenderer.js';
+export { TApiaChartColumn, TApiaChartDefinition } from './charts/types.js';
+export { EmptyGrid } from './charts/util/EmptyGrid.js';
+export { TWidgetData } from './widgets/types.js';
+export { WidgetContainer } from './widgets/WidgetContainer.js';
+//# sourceMappingURL=index.d.ts.map