@univerjs-pro/engine-chart 0.25.1 → 1.0.0-alpha.1

package/lib/types/wordcloud-chart/core/text/sprite.d.ts

@@ -0,0 +1,17 @@
+import type { IWordCloudTextSprite } from '../../types';
+export interface ICreateTightTextSpriteOptions {
+    readonly pixels: Uint8Array;
+    readonly width: number;
+    readonly height: number;
+    readonly alphaBBox?: {
+        readonly x: number;
+        readonly y: number;
+        readonly width: number;
+        readonly height: number;
+    };
+    readonly anchorX?: number;
+    readonly anchorY?: number;
+    readonly dpr?: number;
+    readonly textMetrics?: IWordCloudTextSprite['textMetrics'];
+}
+export declare function createTightTextSprite(options: ICreateTightTextSpriteOptions): IWordCloudTextSprite;

package/lib/types/wordcloud-chart/core/text/types.d.ts

@@ -0,0 +1 @@
+export type * from '../types/layout';

package/lib/types/wordcloud-chart/core/types/layout.d.ts

@@ -0,0 +1,81 @@
+import type { IWordCloudBounds, IWordCloudClipMask, IWordCloudEncodedWord, IWordCloudLayoutMask, IWordCloudMaskGrid, IWordCloudTextMeasurer } from '../../types';
+import type { ICollisionFootprint, WordCloudCollisionShape } from '../collision/engine';
+import type { IPlacementSearchPolicy } from '../layout/search-plan';
+export interface IWordCloudLayoutGrid {
+    readonly width: number;
+    readonly height: number;
+    readonly cellSize: number;
+    readonly cols: number;
+    readonly rows: number;
+    readonly data: Uint8Array;
+}
+export interface IWordCloudLayoutRuntime {
+    readonly measurer: IWordCloudTextMeasurer;
+    readonly mask?: IWordCloudLayoutMask;
+    readonly maskGrid?: IWordCloudMaskGrid;
+}
+export interface IWordCloudLayoutConfig {
+    readonly width: number;
+    readonly height: number;
+    readonly cellSize: number;
+    readonly minFontSize: number;
+    readonly padding: number;
+    readonly maxCandidateChecks: number;
+    readonly failureCacheLimit: number;
+    readonly ringCount: number;
+    readonly candidateStep: number;
+    readonly drawOutOfBound: boolean;
+    readonly seed: string;
+    readonly seedHash: number;
+    readonly collisionShape: WordCloudCollisionShape;
+    readonly shapeSampleSize?: number;
+    readonly shapeInsideRatio?: number;
+    readonly shapePaddingRatio?: number;
+    readonly placementSearchPolicy?: IPlacementSearchPolicy;
+    readonly wordShrink?: {
+        readonly initialRatio: number;
+        readonly fontSizeLimitMin: number;
+    };
+}
+export interface IPreparedWordCloudWord {
+    readonly source: IWordCloudEncodedWord;
+    readonly rank: number;
+    readonly baseFontSize: number;
+}
+export interface IBoxFootprint {
+    readonly key: string;
+    readonly staticKey?: string;
+    readonly width: number;
+    readonly height: number;
+    readonly rawWidth: number;
+    readonly rawHeight: number;
+    readonly angle: number;
+    readonly halfWidth: number;
+    readonly halfHeight: number;
+    readonly aabbHalfWidth: number;
+    readonly aabbHalfHeight: number;
+    readonly axisX: readonly [number, number];
+    readonly axisY: readonly [number, number];
+    readonly rel: Int32Array;
+    readonly minDc: number;
+    readonly maxDc: number;
+    readonly minDr: number;
+    readonly maxDr: number;
+    readonly corners: ReadonlyArray<readonly [number, number]>;
+    readonly shapeSamplePoints: ReadonlyArray<readonly [number, number]>;
+}
+export interface IWordCloudPlacement {
+    readonly word: IWordCloudEncodedWord;
+    readonly phase: 1 | 2;
+    readonly rank: number;
+    readonly x: number;
+    readonly y: number;
+    readonly rawWidth: number;
+    readonly rawHeight: number;
+    readonly bounds: IWordCloudBounds;
+    readonly clipBounds?: IWordCloudBounds;
+    readonly clipMask?: IWordCloudClipMask;
+    readonly footprint: ICollisionFootprint;
+    readonly fontSize: number;
+    readonly rotate: number;
+}

package/lib/types/wordcloud-chart/core/types/option.d.ts

@@ -0,0 +1 @@
+export type { IResolvedWordCloudSpec, IWordCloudChartSpec, IWordCloudDataSource, IWordCloudEChartsMaskSource, IWordCloudEChartsSeriesOption, IWordCloudEncoding, IWordCloudFieldMapping, IWordCloudProtocolSpec, IWordCloudSeriesOption, IWordCloudSpecBase, } from '../../types';

package/lib/types/wordcloud-chart/core/types/shape.d.ts

@@ -0,0 +1 @@
+export type { IWordCloudLayoutMask, IWordCloudMaskGrid, IWordCloudMaskShapeSpec, IWordCloudSegmentationRegion, IWordCloudSegmentationResult, WordCloudShape, } from '../../types';

package/lib/types/wordcloud-chart/core/types/word.d.ts

@@ -0,0 +1 @@
+export type { INormalizedWordCloudDatum, IWordCloudEncodedWord, IWordCloudPlacedWord, IWordCloudTextMarkAttrs, IWordCloudTextMarkSpec, } from '../../types';

package/lib/types/wordcloud-chart/defaults.d.ts

@@ -0,0 +1,70 @@
+import type { IResolvedWordCloudSpec, IWordCloudSpecBase } from './types';
+export declare const DEFAULT_WORD_CLOUD_CHART_SPEC: {
+    type: "wordcloud";
+    data: {
+        id: string;
+        values: never[];
+    };
+    fields: {
+        id: string;
+        text: string;
+        value: string;
+        group: string;
+        color: string;
+    };
+    transforms: never[];
+    encoding: {
+        fontSize: {
+            scale: "sqrt";
+            range: [number, number];
+        };
+        rotate: {
+            angles: number[];
+            seed: string;
+        };
+    };
+    layout: {
+        width: number;
+        height: number;
+        mode: "default";
+        maskShape: {
+            type: "builtin";
+            shape: "rect";
+        };
+        seed: string;
+        drawOutOfBound: false;
+        shrinkToFit: false;
+        minFontSize: number;
+        maxAttempts: number;
+        spiralStep: number;
+        gridSize: number;
+        shapeSampleSize: null;
+        shapeInsideRatio: null;
+        shapePaddingRatio: number;
+        textLayoutTimes: number;
+        importantWordCount: number;
+        fontSizeShrinkFactor: number;
+        stepFactor: number;
+        globalShrinkLimit: number;
+        fontSizeEnlargeFactor: number;
+        fillingTimes: number;
+        fillingStep: number;
+        fillingInitialOpacity: number;
+        fillingDeltaOpacity: number;
+        fillingDeltaFontSizeFactor: number;
+        fillingRatio: number;
+        minFillFontSize: number;
+        minInitFontSize: number;
+    };
+    mark: {
+        fontFamily: string;
+        fontStyle: "normal";
+        fontWeight: string;
+        padding: number;
+        opacity: number;
+    };
+    tooltip: {
+        fields: never[];
+    };
+};
+export declare function resolveWordCloudSpec(spec: IWordCloudSpecBase): IResolvedWordCloudSpec;

package/lib/types/wordcloud-chart/echarts.d.ts

@@ -0,0 +1,2 @@
+export { WORD_CLOUD_DEFAULT_OPTION, WORD_CLOUD_SERIES_TYPE } from './adapters/echarts/echarts-options';
+export { registerWordCloudChart } from './adapters/echarts/install';

package/lib/types/wordcloud-chart/index.d.ts

@@ -0,0 +1,11 @@
+export { layoutWordCloudChart, resolveLayoutOptions } from './canvas';
+export * from './core/layout/font-scale';
+export { createBuiltinMaskGrid, createMaskGridFromShape, createTextMaskGrid, normalizeMaskGrid, segmentMaskGrid } from './core/shape/built-in-shapes';
+export { encodeWordCloudWords } from './core/text/formatter';
+export { normalizeWordCloudData } from './core/text/normalize';
+export { DEFAULT_WORD_CLOUD_CHART_SPEC, resolveWordCloudSpec } from './defaults';
+export { registerWordCloudChart, WORD_CLOUD_DEFAULT_OPTION, WORD_CLOUD_SERIES_TYPE } from './echarts';
+export type { INormalizedWordCloudDatum, IResolvedWordCloudSpec, IWordCloudBounds, IWordCloudChartSpec, IWordCloudDataSource, IWordCloudEChartsMaskSource, IWordCloudEChartsSeriesDataItem, IWordCloudEChartsSeriesOption, IWordCloudEncodedWord, IWordCloudEncoding, IWordCloudFieldMapping, IWordCloudLayoutMask, IWordCloudLayoutOptions, IWordCloudLayoutResult, IWordCloudMaskGrid, IWordCloudMaskShapeSpec, IWordCloudPlacedWord, IWordCloudProtocolSpec, IWordCloudSegmentationRegion, IWordCloudSegmentationResult, IWordCloudSeriesDataItem, IWordCloudSeriesOption, IWordCloudSpecBase, IWordCloudTextMarkAttrs, IWordCloudTextMarkSpec, IWordCloudTextMeasurer, IWordCloudTextSprite, WordCloudFontSizeRange, WordCloudShape, } from './types';
+export { DEFAULT_WORD_CLOUD_SHAPE, normalizeWordCloudShape, SUPPORTED_WORD_CLOUD_SHAPES } from './types';
+export { DEFAULT_WORD_CLOUD_RENDER_CONFIG, resolveWordCloudRenderConfig, } from './word-cloud-render-config';
+export type { IResolvedWordCloudRenderConfig, IWordCloudRenderConfig, } from './word-cloud-render-config';

package/lib/types/wordcloud-chart/types.d.ts

@@ -0,0 +1,339 @@
+export type WordCloudColorMode = 'fixed' | 'identity' | 'palette';
+export type WordCloudLayoutMode = 'default' | 'fast' | 'grid' | 'ensureMapping' | 'ensureMappingEnlarge';
+export type WordCloudScaleType = 'linear' | 'sqrt' | 'log';
+export declare const SUPPORTED_WORD_CLOUD_SHAPES: readonly ["cloud", "rect", "circle", "cardioid", "heart", "diamond", "triangle-forward", "triangle", "pentagon", "star"];
+export type WordCloudShape = typeof SUPPORTED_WORD_CLOUD_SHAPES[number];
+export declare const DEFAULT_WORD_CLOUD_SHAPE: WordCloudShape;
+export type WordCloudFontSizeRange = [number, number] | 'auto';
+export declare function normalizeWordCloudShape(shape: unknown): WordCloudShape;
+export interface IWordCloudProtocolSpec {
+    data: IWordCloudDataSource;
+    fields?: Partial<IWordCloudFieldMapping>;
+    transforms?: IWordCloudDataTransform[];
+    encoding?: IWordCloudEncoding;
+    layout?: Partial<IWordCloudLayoutOptions>;
+    mark?: IWordCloudTextMarkSpec;
+    tooltip?: IWordCloudTooltipSpec;
+}
+export interface IWordCloudChartSpec extends IWordCloudProtocolSpec {
+    type: 'wordcloud';
+}
+export interface IWordCloudEChartsSeriesDataItem extends Record<string, unknown> {
+    name?: string;
+    value?: unknown;
+}
+export type IWordCloudEChartsMaskSource = {
+    type: 'shape';
+    value: WordCloudShape | string;
+} | {
+    type: 'image';
+    value: string;
+};
+export interface IWordCloudEChartsSeriesOption {
+    type: 'wordCloud';
+    data?: IWordCloudEChartsSeriesDataItem[];
+    left?: number | string;
+    top?: number | string;
+    right?: number | string;
+    bottom?: number | string;
+    width?: number | string;
+    height?: number | string;
+    colorBy?: 'series' | 'data';
+    gridSize?: number;
+    padding?: number;
+    maskSource?: IWordCloudEChartsMaskSource;
+    drawOutOfBound?: boolean;
+    keepAspect?: boolean;
+    fontSizeRange?: WordCloudFontSizeRange;
+    collisionShape?: 'box' | 'glyph';
+    rotations?: number[];
+    randomSeed?: number;
+    textStyle?: Record<string, unknown>;
+    formatter?: string | ((params: Record<string, unknown>) => unknown);
+    zoomToFit?: {
+        shrink?: boolean;
+        enlarge?: boolean;
+        fontSizeLimitMin?: number;
+        fontSizeLimitMax?: number;
+        minShrinkRatio?: number;
+    };
+}
+export type IWordCloudSpecBase = IWordCloudProtocolSpec;
+export type IWordCloudSeriesDataItem = IWordCloudEChartsSeriesDataItem;
+export type IWordCloudSeriesOption = IWordCloudEChartsSeriesOption;
+export interface IWordCloudDataSource {
+    id?: string;
+    values: Array<Record<string, unknown>>;
+}
+export interface IWordCloudFieldMapping {
+    text: string;
+    value: string;
+    id?: string;
+    group?: string;
+    color?: string;
+    tooltip?: string[];
+}
+export type IWordCloudDataTransform = {
+    type: 'filterInvalid';
+} | {
+    type: 'limit';
+    count: number;
+};
+export interface IWordCloudEncoding {
+    fontSize?: {
+        field?: string;
+        scale?: WordCloudScaleType;
+        range?: WordCloudFontSizeRange;
+    };
+    color?: {
+        field?: string;
+        mode?: WordCloudColorMode;
+        palette?: string[];
+        fixed?: string;
+    };
+    rotate?: {
+        angles?: number[];
+        ratio?: number;
+        seed?: string | number;
+    };
+}
+export interface IWordCloudTextMarkSpec {
+    fontFamily?: string;
+    fontStyle?: 'normal' | 'italic' | 'oblique';
+    fontWeight?: string | number;
+    padding?: number;
+    opacity?: number;
+    fill?: string;
+    emphasis?: Partial<IWordCloudTextMarkSpec>;
+}
+export interface IWordCloudTooltipSpec {
+    fields?: string[];
+}
+export interface IResolvedWordCloudSpec extends Omit<IWordCloudProtocolSpec, 'fields' | 'transforms' | 'encoding' | 'layout' | 'mark' | 'tooltip'> {
+    fields: IWordCloudFieldMapping;
+    transforms: IWordCloudDataTransform[];
+    encoding: IWordCloudEncoding;
+    layout: IWordCloudLayoutOptions;
+    mark: IWordCloudTextMarkSpec;
+    tooltip: IWordCloudTooltipSpec;
+}
+export interface INormalizedWordCloudDatum {
+    key: string;
+    datumIndex: number;
+    text: string;
+    value: number;
+    raw: Record<string, unknown>;
+    group?: string;
+    colorValue?: unknown;
+    tooltipValues?: Record<string, unknown>;
+}
+export interface IWordCloudTextMarkAttrs {
+    fontSize: number;
+    fill?: string;
+    rotate: number;
+    opacity: number;
+    fontFamily: string;
+    fontStyle: 'normal' | 'italic' | 'oblique';
+    fontWeight: string | number;
+    padding: number;
+}
+export interface IWordCloudEncodedWord {
+    key: string;
+    datumIndex: number;
+    text: string;
+    value: number;
+    raw: Record<string, unknown>;
+    mark: IWordCloudTextMarkAttrs;
+    rotationAngles?: number[];
+}
+export interface IWordCloudLayoutOptions {
+    width: number;
+    height: number;
+    mode: WordCloudLayoutMode;
+    seed: string | number;
+    drawOutOfBound: boolean;
+    shrinkToFit: boolean;
+    minFontSize: number;
+    maxAttempts: number;
+    spiralStep: number;
+    gridSize: number;
+    maskShape: IWordCloudMaskShapeSpec;
+    shapeSampleSize?: number | null;
+    shapeInsideRatio?: number | null;
+    shapePaddingRatio?: number | null;
+    textLayoutTimes: number;
+    importantWordCount: number;
+    fontSizeShrinkFactor: number;
+    stepFactor: number;
+    globalShrinkLimit: number;
+    fontSizeEnlargeFactor: number;
+    fillingTimes: number;
+    fillingStep: number;
+    fillingXStep?: number;
+    fillingYStep?: number;
+    fillingInitialFontSize?: number;
+    fillingDeltaFontSize?: number;
+    fillingInitialOpacity: number;
+    fillingDeltaOpacity: number;
+    fillingDeltaFontSizeFactor: number;
+    fillingRatio: number;
+    minFillFontSize: number;
+    minInitFontSize: number;
+    wordShrink?: {
+        initialRatio: number;
+        fontSizeLimitMin: number;
+    };
+}
+export interface IWordCloudMeasureResult {
+    width: number;
+    height: number;
+    actualBoundingBoxAscent?: number;
+    actualBoundingBoxDescent?: number;
+    actualBoundingBoxLeft?: number;
+    actualBoundingBoxRight?: number;
+}
+export interface IWordCloudTextSprite {
+    width: number;
+    height: number;
+    pixels: Uint8Array;
+    occupied?: Int32Array;
+    spans?: IWordCloudTextSpriteSpan[];
+    anchorX?: number;
+    anchorY?: number;
+    offsetX?: number;
+    offsetY?: number;
+    alphaBBox?: {
+        x: number;
+        y: number;
+        width: number;
+        height: number;
+    };
+    alphaPixelCount?: number;
+    dpr?: number;
+    textMetrics?: {
+        width: number;
+        actualBoundingBoxAscent?: number;
+        actualBoundingBoxDescent?: number;
+        actualBoundingBoxLeft?: number;
+        actualBoundingBoxRight?: number;
+    };
+}
+export interface IWordCloudTextSpriteSpan {
+    y: number;
+    x1: number;
+    x2: number;
+}
+export interface IWordCloudTextMeasurer {
+    measureText(word: IWordCloudEncodedWord): IWordCloudMeasureResult;
+    rasterizeText?: (word: IWordCloudEncodedWord) => IWordCloudTextSprite;
+}
+export interface IWordCloudLayoutMask {
+    isVisible(bounds: IWordCloudBounds): boolean;
+}
+export type IWordCloudMaskShapeSpec = {
+    type: 'builtin';
+    shape: WordCloudShape;
+} | {
+    type: 'text';
+    text: string;
+    hollow?: boolean;
+    backgroundColor?: string;
+    fill?: string;
+    fontFamily?: string;
+    fontWeight?: string | number;
+    fontStyle?: 'normal' | 'italic' | 'oblique';
+    fontVariant?: string;
+} | {
+    type: 'image';
+    file: File | Blob;
+    removeWhiteBorder?: boolean;
+    threshold?: number;
+    invert?: boolean;
+} | {
+    type: 'grid';
+    grid: IWordCloudMaskGrid;
+};
+export interface IWordCloudMaskGrid {
+    width: number;
+    height: number;
+    data: Uint8Array;
+    sourceHash?: string;
+    sourceType?: string;
+}
+export interface IWordCloudSegmentationRegion {
+    label: number;
+    area: number;
+    center: [number, number];
+    maxPoint: [number, number, number, number];
+    maxR: number;
+    ratio: number;
+    boundary: Array<[number, number]>;
+}
+export interface IWordCloudSegmentationResult {
+    labels: Int32Array;
+    regions: IWordCloudSegmentationRegion[];
+    shapeBounds: {
+        x1: number;
+        y1: number;
+        x2: number;
+        y2: number;
+        width: number;
+        height: number;
+    };
+    shapeCenter: [number, number];
+    shapeArea: number;
+    shapeMaxR: number;
+    shapeRatio: number;
+}
+export interface IWordCloudBounds {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+}
+export interface IWordCloudClipSpan {
+    y: number;
+    x1: number;
+    x2: number;
+}
+export interface IWordCloudClipMask extends IWordCloudBounds {
+    spans: IWordCloudClipSpan[];
+    spanHeight?: number;
+}
+export interface IWordCloudPlacedWord extends IWordCloudEncodedWord {
+    x: number;
+    y: number;
+    width: number;
+    height: number;
+    bounds: IWordCloudBounds;
+    clipBounds?: IWordCloudBounds;
+    clipMask?: IWordCloudClipMask;
+    visible: boolean;
+    isFillingWord?: boolean;
+}
+export interface IWordCloudLayoutStats {
+    dataCount: number;
+    placedCount: number;
+    droppedCount: number;
+    durationMs: number;
+    maxFontSize: number;
+    minPlacedFontSize: number;
+    finalFontSizeScale: number;
+    angleHistogram: Record<string, number>;
+    rejectByBounds: number;
+    rejectByCollision: number;
+    rejectByShape: number;
+    rejectByMaxAttempts: number;
+    avgTryCount: number;
+    maxTryCount: number;
+    occupiedRatio: number;
+    layoutWidth: number;
+    layoutHeight: number;
+}
+export interface IWordCloudLayoutResult {
+    width: number;
+    height: number;
+    words: IWordCloudPlacedWord[];
+    fillingWords: IWordCloudPlacedWord[];
+    stats?: IWordCloudLayoutStats;
+}

package/lib/types/wordcloud-chart/word-cloud-render-config.d.ts

@@ -0,0 +1,30 @@
+import type { WordCloudCollisionShape } from './core/collision/engine';
+import type { WordCloudFontSizeRange, WordCloudShape } from './types';
+export interface IWordCloudRenderConfig {
+    initialShape?: WordCloudShape;
+    collisionShape?: WordCloudCollisionShape;
+    fontSizeRange?: WordCloudFontSizeRange;
+    padding?: number;
+    zoomToFit?: {
+        shrink?: boolean;
+        enlarge?: boolean;
+        fontSizeLimitMin?: number;
+        fontSizeLimitMax?: number;
+        minShrinkRatio?: number;
+    };
+}
+export interface IResolvedWordCloudRenderConfig {
+    initialShape: WordCloudShape;
+    collisionShape: WordCloudCollisionShape;
+    fontSizeRange: WordCloudFontSizeRange;
+    padding: number;
+    zoomToFit: {
+        shrink: boolean;
+        enlarge: boolean;
+        fontSizeLimitMin: number;
+        fontSizeLimitMax?: number;
+        minShrinkRatio: number;
+    };
+}
+export declare const DEFAULT_WORD_CLOUD_RENDER_CONFIG: IResolvedWordCloudRenderConfig;
+export declare function resolveWordCloudRenderConfig(config?: IWordCloudRenderConfig): IResolvedWordCloudRenderConfig;