@visactor/vseed 0.0.1 → 0.0.2

package/dist/builder/builder/build.d.ts

@@ -0,0 +1,3 @@
+import type { ISpec } from '@visactor/vchart';
+import type { Builder } from './builder';
+export declare const build: (builder: Builder) => ISpec;

package/dist/builder/builder/buildAdvanced.d.ts

@@ -0,0 +1,3 @@
+import type { AdvancedVSeed } from '../../types';
+import type { Builder } from './builder';
+export declare const buildAdvanced: (builder: Builder) => AdvancedVSeed | null;

package/dist/builder/builder/buildSpec.d.ts

@@ -0,0 +1,4 @@
+import type { ISpec } from '@visactor/vchart';
+import type { Builder } from './builder';
+import type { AdvancedVSeed } from '../../types';
+export declare const buildSpec: (builder: Builder, advancedVSeed: AdvancedVSeed) => ISpec;

package/dist/builder/builder/builder.d.ts

@@ -0,0 +1,216 @@
+import type { AdvancedPipeline, AdvancedVSeed, ChartType, SpecPipeline, VSeed, VSeedBuilder } from '../../types';
+export declare class Builder implements VSeedBuilder {
+    private _vseed;
+    private _advancedVSeed;
+    static _advancedPipelineMap: Partial<Record<ChartType, AdvancedPipeline>>;
+    static _specPipelineMap: Partial<Record<ChartType, SpecPipeline>>;
+    static from: (vseed: VSeed) => Builder;
+    constructor(vseed: VSeed);
+    build: () => import("@visactor/vchart").ISpec;
+    buildSpec: (advanced: AdvancedVSeed) => import("@visactor/vchart").ISpec;
+    buildAdvanced: () => {
+        chartType: "table" | "pivotTable" | "line" | "column" | "columnPercent" | "columnParallel" | "bar" | "barPercent" | "barParallel" | "area" | "areaPercent" | "rose" | "pie" | "donut" | "dualAxis";
+        dataset: Record<string | number, any>[];
+        datasetReshapeInfo: {
+            foldInfo: {
+                foldMap: Record<string, string | undefined>;
+                measureId: string;
+                measureName: string;
+                measureValue: string;
+            };
+            unfoldInfo: {
+                colorItems: string[];
+                groupName: string;
+            };
+        };
+        encoding: {
+            x?: string[] | undefined;
+            y?: string[] | undefined;
+            color?: string[] | undefined;
+            group?: string[] | undefined;
+            angle?: string[] | undefined;
+            radius?: string[] | undefined;
+            tooltip?: string[] | undefined;
+        }[];
+        dimensions?: {
+            id: string;
+            location: "dimension" | "rowDimension" | "columnDimension";
+            alias?: string | undefined;
+            visible?: boolean | undefined;
+        }[] | undefined;
+        measures?: ({
+            id: string;
+            alias?: string | undefined;
+            visible?: boolean | undefined;
+            autoFormat?: boolean | undefined;
+            format?: {
+                type: "number" | "percent" | "permille";
+                ratio: number;
+                symbol: string;
+                thousandSeparator: boolean;
+                decimalPlaces: number;
+                round: "round" | "floor" | "ceil";
+                prefix: string;
+                suffix: string;
+            } | undefined;
+        } | {
+            id: string;
+            alias?: string | undefined;
+            visible?: boolean | undefined;
+            children?: ({
+                id: string;
+                alias?: string | undefined;
+                visible?: boolean | undefined;
+                autoFormat?: boolean | undefined;
+                format?: {
+                    type: "number" | "percent" | "permille";
+                    ratio: number;
+                    symbol: string;
+                    thousandSeparator: boolean;
+                    decimalPlaces: number;
+                    round: "round" | "floor" | "ceil";
+                    prefix: string;
+                    suffix: string;
+                } | undefined;
+            } | /*elided*/ any)[] | undefined;
+        })[] | undefined;
+    } | null;
+    getAdvancedPipeline: (chartType: ChartType) => AdvancedPipeline;
+    getSpecPipeline: (chartType: ChartType) => SpecPipeline;
+    get vseed(): VSeed;
+    set vseed(value: VSeed);
+    get advancedVSeed(): {
+        chartType: "table" | "pivotTable" | "line" | "column" | "columnPercent" | "columnParallel" | "bar" | "barPercent" | "barParallel" | "area" | "areaPercent" | "rose" | "pie" | "donut" | "dualAxis";
+        dataset: Record<string | number, any>[];
+        datasetReshapeInfo: {
+            foldInfo: {
+                foldMap: Record<string, string | undefined>;
+                measureId: string;
+                measureName: string;
+                measureValue: string;
+            };
+            unfoldInfo: {
+                colorItems: string[];
+                groupName: string;
+            };
+        };
+        encoding: {
+            x?: string[] | undefined;
+            y?: string[] | undefined;
+            color?: string[] | undefined;
+            group?: string[] | undefined;
+            angle?: string[] | undefined;
+            radius?: string[] | undefined;
+            tooltip?: string[] | undefined;
+        }[];
+        dimensions?: {
+            id: string;
+            location: "dimension" | "rowDimension" | "columnDimension";
+            alias?: string | undefined;
+            visible?: boolean | undefined;
+        }[] | undefined;
+        measures?: ({
+            id: string;
+            alias?: string | undefined;
+            visible?: boolean | undefined;
+            autoFormat?: boolean | undefined;
+            format?: {
+                type: "number" | "percent" | "permille";
+                ratio: number;
+                symbol: string;
+                thousandSeparator: boolean;
+                decimalPlaces: number;
+                round: "round" | "floor" | "ceil";
+                prefix: string;
+                suffix: string;
+            } | undefined;
+        } | {
+            id: string;
+            alias?: string | undefined;
+            visible?: boolean | undefined;
+            children?: ({
+                id: string;
+                alias?: string | undefined;
+                visible?: boolean | undefined;
+                autoFormat?: boolean | undefined;
+                format?: {
+                    type: "number" | "percent" | "permille";
+                    ratio: number;
+                    symbol: string;
+                    thousandSeparator: boolean;
+                    decimalPlaces: number;
+                    round: "round" | "floor" | "ceil";
+                    prefix: string;
+                    suffix: string;
+                } | undefined;
+            } | /*elided*/ any)[] | undefined;
+        })[] | undefined;
+    } | null;
+    set advancedVSeed(value: {
+        chartType: "table" | "pivotTable" | "line" | "column" | "columnPercent" | "columnParallel" | "bar" | "barPercent" | "barParallel" | "area" | "areaPercent" | "rose" | "pie" | "donut" | "dualAxis";
+        dataset: Record<string | number, any>[];
+        datasetReshapeInfo: {
+            foldInfo: {
+                foldMap: Record<string, string | undefined>;
+                measureId: string;
+                measureName: string;
+                measureValue: string;
+            };
+            unfoldInfo: {
+                colorItems: string[];
+                groupName: string;
+            };
+        };
+        encoding: {
+            x?: string[] | undefined;
+            y?: string[] | undefined;
+            color?: string[] | undefined;
+            group?: string[] | undefined;
+            angle?: string[] | undefined;
+            radius?: string[] | undefined;
+            tooltip?: string[] | undefined;
+        }[];
+        dimensions?: {
+            id: string;
+            location: "dimension" | "rowDimension" | "columnDimension";
+            alias?: string | undefined;
+            visible?: boolean | undefined;
+        }[] | undefined;
+        measures?: ({
+            id: string;
+            alias?: string | undefined;
+            visible?: boolean | undefined;
+            autoFormat?: boolean | undefined;
+            format?: {
+                type: "number" | "percent" | "permille";
+                ratio: number;
+                symbol: string;
+                thousandSeparator: boolean;
+                decimalPlaces: number;
+                round: "round" | "floor" | "ceil";
+                prefix: string;
+                suffix: string;
+            } | undefined;
+        } | {
+            id: string;
+            alias?: string | undefined;
+            visible?: boolean | undefined;
+            children?: ({
+                id: string;
+                alias?: string | undefined;
+                visible?: boolean | undefined;
+                autoFormat?: boolean | undefined;
+                format?: {
+                    type: "number" | "percent" | "permille";
+                    ratio: number;
+                    symbol: string;
+                    thousandSeparator: boolean;
+                    decimalPlaces: number;
+                    round: "round" | "floor" | "ceil";
+                    prefix: string;
+                    suffix: string;
+                } | undefined;
+            } | /*elided*/ any)[] | undefined;
+        })[] | undefined;
+    } | null);
+}

package/dist/builder/builder/index.d.ts

@@ -0,0 +1 @@
+export { Builder } from './builder';

package/dist/builder/index.d.ts

@@ -0,0 +1,2 @@
+export * from './builder';
+export * from './register';

package/dist/builder/register/index.d.ts

@@ -0,0 +1 @@
+export { registerColumn, registerAll, registerBar } from './register';

package/dist/builder/register/register.d.ts

@@ -0,0 +1,3 @@
+export declare const registerAll: () => void;
+export declare const registerColumn: () => void;
+export declare const registerBar: () => void;

package/dist/dataReshape/constant.d.ts

@@ -0,0 +1,5 @@
+export declare const FoldMeasureName = "__MeaName__";
+export declare const FoldMeasureValue = "__MeaValue__";
+export declare const FoldMeasureId = "__MeaId__";
+export declare const FoldDimensionGroup = "__DimGroup__";
+export declare const Separator = "-";

package/dist/dataReshape/dataReshapeFor1D1M.d.ts

@@ -0,0 +1,13 @@
+import type { Dataset, Dimension, FoldInfo, Measure, UnfoldInfo } from '../types';
+/**
+ * 数据重塑为1个维度1个指标
+ * @param dataset
+ * @param dimensions
+ * @param measures
+ * @returns
+ */
+export declare const dataReshapeFor1D1M: (dataset: Dataset, dimensions: Dimension[], measures: Measure[]) => {
+    dataset: Dataset;
+    foldInfo: FoldInfo;
+    unfoldInfo: UnfoldInfo;
+};

package/dist/dataReshape/dataReshapeFor2D1M.d.ts

@@ -0,0 +1,13 @@
+import type { Dataset, Dimension, FoldInfo, Measure, UnfoldInfo } from '../types';
+/**
+ * 数据重塑为2个维度1个指标
+ * @param dataset
+ * @param dimensions
+ * @param measures
+ * @returns
+ */
+export declare const dataReshapeFor2D1M: (dataset: Dataset, dimensions: Dimension[], measures: Measure[]) => {
+    dataset: Dataset;
+    foldInfo: FoldInfo;
+    unfoldInfo: UnfoldInfo;
+};

package/dist/dataReshape/foldMeasures.d.ts

@@ -0,0 +1,31 @@
+import type { Dataset, FoldInfo, Measure, Measures } from '../types';
+/**
+ * 折叠指定的指标
+ * @description 合并指定的指标为1个, 无论多少个, 都能转换为1个, 取名为fold, 意为折叠后混合在一起.
+ */
+export declare const foldMeasures: (dataset: Dataset, measures: Measure[], measureId?: string, measureName?: string, measureValue?: string) => {
+    dataset: Dataset;
+    foldInfo: FoldInfo;
+};
+/**
+ * 折叠指定的指标组, 至多支持2层
+ * @param dataset
+ * @param measures
+ * @param measureId
+ * @param measureName
+ * @param measureValue
+ * @returns
+ */
+export declare const foldMeasureGroups: (dataset: Dataset, measures: Required<Measures>, measureId?: string, measureName?: string, measureValue?: string) => {
+    dataset: Dataset;
+    foldInfo: FoldInfo;
+} | {
+    dataset: Record<string | number, any>[];
+    datasetGroup?: undefined;
+} | {
+    datasetGroup: (never[] | {
+        dataset: Dataset;
+        foldInfo: FoldInfo;
+    })[];
+    dataset?: undefined;
+};

package/dist/dataReshape/index.d.ts

@@ -0,0 +1,4 @@
+export { unfoldDimensions } from './unfoldDimensions';
+export { foldMeasures } from './foldMeasures';
+export { dataReshapeFor2D1M } from './dataReshapeFor2D1M';
+export { dataReshapeFor1D1M } from './dataReshapeFor1D1M';

package/dist/dataReshape/unfoldDimensions.d.ts

@@ -0,0 +1,19 @@
+import type { Dataset, Datum, Dimension, Measure } from '../types';
+import type { UnfoldInfo } from '../types';
+/**
+ * TODO: 优化展开维度的性能
+ * 展开指定的维度
+ * @description 第一步: 根据指定的维度, 将多个维度展开为N个指标(取决于维值去重后的数量), 随后合并成一个维度.
+ */
+export declare const unfoldDimensions: (dataset: Dataset, dimensions: Dimension[], measures: Measure[], unfoldStartIndex?: number, foldGroupName?: string, dimensionsSeparator?: string) => {
+    dataset: Dataset;
+    unfoldInfo: UnfoldInfo;
+};
+/**
+ * 生成维度组合名称
+ * @param dimensionsToBeGrouped 待分组的维度
+ * @param datum 数据项
+ * @param dimensionsSeparator 维度分隔符
+ * @returns 维度组合名称
+ */
+export declare const generateDimGroupName: (dimensionsToBeGrouped: Dimension[], datum: Datum, dimensionsSeparator: string) => string;