@leafer-ui/display 1.0.0-beta.9 → 1.0.0-rc.10

package/types/index.d.ts

@@ -0,0 +1,368 @@
+import { IString, INumber, IBoolean, IMaskType, IAround, IHitType, ICursorType, IPointData, IPathCommandData, IPathString, ILeaferCanvas, IPathDrawer, IExportFileType, IPickOptions, IPickResult, IRenderer, IWatcher, ILayouter, ISelector, IInteraction, ICanvasManager, IHitCanvasManager, ILeaferConfig, IAutoBounds, IEventListenerId, ITimer, IControl, ILeaferType, IScreenSizeData, IBoundsData, IResizeEvent, ILeaf, IValue, IRenderOptions, ILeaferImage, ICanvasContext2D, IWindingRule } from '@leafer/interface';
+import { Leaf } from '@leafer/core';
+import { IUI, IUIData, IUIInputData, ILeafer, IGroup, IBlendMode, IEditSize, IFill, IStroke, IStrokeAlign, IStrokeWidthString, IStrokeCap, IStrokeJoin, IDashPatternString, IArrowType, ICornerRadiusString, IShadowEffect, IShadowString, IBlurEffect, IGrayscaleEffect, IFindUIMethod, IExportOptions, IExportResult, IGroupData, IGroupInputData, ILeaferData, IApp, IEditorBase, IFunction, ILeaferInputData, IBox, IBoxData, IOverflow, IBoxInputData, IFrame, IFrameData, IFrameInputData, IRect, IRectData, IRectInputData, IEllipse, IEllipseData, IEllipseInputData, IPolygon, IPolygonData, IPolygonInputData, IStar, IStarData, IStarInputData, ILine, ILineData, ILineInputData, IImage, IImageData, IImageInputData, ICanvas, ICanvasData, ICanvasInputData, IText, ITextData, IHitType as IHitType$1, IFontWeight, ITextCase, ITextDecoration, IUnitData, ITextAlign, IVerticalAlign, ITextWrap, ITextDrawData, ITextInputData, IPath, IPathData, IPathString as IPathString$1, IPathInputData, IPen, IPenData, IPathCommandData as IPathCommandData$1, IPenInputData } from '@leafer-ui/interface';
+
+declare class UI extends Leaf implements IUI {
+    __: IUIData;
+    proxyData: IUIInputData;
+    __proxyData?: IUIInputData;
+    get app(): ILeafer;
+    leafer?: ILeafer;
+    parent?: IGroup;
+    isFrame?: boolean;
+    children?: IUI[];
+    id: IString;
+    name: IString;
+    className: IString;
+    blendMode: IBlendMode;
+    opacity: INumber;
+    visible: IBoolean;
+    locked: IBoolean;
+    zIndex: INumber;
+    mask: IBoolean;
+    maskType: IMaskType;
+    eraser: IBoolean;
+    x: INumber;
+    y: INumber;
+    width: INumber;
+    height: INumber;
+    scaleX: INumber;
+    scaleY: INumber;
+    rotation: INumber;
+    skewX: INumber;
+    skewY: INumber;
+    around: IAround;
+    draggable: IBoolean;
+    editable: IBoolean;
+    editSize?: IEditSize;
+    hittable: IBoolean;
+    hitFill: IHitType;
+    hitStroke: IHitType;
+    hitBox: IBoolean;
+    hitChildren: IBoolean;
+    hitSelf: IBoolean;
+    hitRadius: INumber;
+    cursor: ICursorType | ICursorType[];
+    fill: IFill;
+    stroke: IStroke;
+    strokeAlign: IStrokeAlign;
+    strokeWidth: INumber | INumber[] | IStrokeWidthString;
+    strokeWidthFixed: IBoolean;
+    strokeCap: IStrokeCap;
+    strokeJoin: IStrokeJoin;
+    dashPattern: INumber[] | IDashPatternString;
+    dashOffset: INumber;
+    miterLimit: INumber;
+    lazy: IBoolean;
+    startArrow: IArrowType;
+    endArrow: IArrowType;
+    cornerRadius: number | number[] | ICornerRadiusString;
+    cornerSmoothing: INumber;
+    shadow: IShadowEffect | IShadowEffect[] | IShadowString;
+    innerShadow: IShadowEffect | IShadowEffect[] | IShadowString;
+    blur: INumber | IBlurEffect;
+    backgroundBlur: INumber | IBlurEffect;
+    grayscale: INumber | IGrayscaleEffect;
+    set scale(value: INumber | IPointData);
+    get scale(): INumber | IPointData;
+    constructor(data?: IUIInputData);
+    reset(_data?: IUIInputData): void;
+    set(data: IUIInputData): void;
+    get(): IUIInputData;
+    createProxyData(): IUIInputData;
+    find(_condition: number | string | IFindUIMethod, _options?: any): IUI[];
+    findOne(_condition: number | string | IFindUIMethod, _options?: any): IUI;
+    getPath(curve?: boolean, pathForRender?: boolean): IPathCommandData;
+    getPathString(curve?: boolean, pathForRender?: boolean): IPathString;
+    __onUpdateSize(): void;
+    __updateRenderPath(): void;
+    __drawRenderPath(canvas: ILeaferCanvas): void;
+    __drawPath(canvas: ILeaferCanvas): void;
+    __drawPathByData(_drawer: IPathDrawer, _data: IPathCommandData): void;
+    __drawPathByBox(drawer: IPathDrawer): void;
+    export(filename: IExportFileType | string, options?: IExportOptions | number | boolean): Promise<IExportResult>;
+    clone(): IUI;
+    static one(data: IUIInputData, x?: number, y?: number, width?: number, height?: number): IUI;
+    destroy(): void;
+}
+
+declare class Group extends UI implements IGroup {
+    get __tag(): string;
+    __: IGroupData;
+    children: IUI[];
+    constructor(data?: IGroupInputData);
+    __setBranch(): void;
+    set(data: IUIInputData): void;
+    toJSON(): IUIInputData;
+    pick(_hitPoint: IPointData, _options?: IPickOptions): IPickResult;
+    addAt(child: IUI, index: number): void;
+    addAfter(child: IUI, after: IUI): void;
+    addBefore(child: UI, before: IUI): void;
+    add(_child: IUI, _index?: number): void;
+    addMany(..._children: IUI[]): void;
+    remove(_child?: IUI, _destroy?: boolean): void;
+    removeAll(_destroy?: boolean): void;
+    clear(): void;
+}
+
+declare class Leafer extends Group implements ILeafer {
+    get __tag(): string;
+    __: ILeaferData;
+    pixelRatio: number;
+    get isApp(): boolean;
+    get app(): ILeafer;
+    parent?: IApp;
+    running: boolean;
+    created: boolean;
+    ready: boolean;
+    viewReady: boolean;
+    viewCompleted: boolean;
+    get imageReady(): boolean;
+    get layoutLocked(): boolean;
+    transforming: boolean;
+    view: unknown;
+    canvas: ILeaferCanvas;
+    renderer: IRenderer;
+    watcher: IWatcher;
+    layouter: ILayouter;
+    selector?: ISelector;
+    interaction?: IInteraction;
+    canvasManager: ICanvasManager;
+    hitCanvasManager?: IHitCanvasManager;
+    editor: IEditorBase;
+    zoomLayer: IGroup;
+    userConfig: ILeaferConfig;
+    config: ILeaferConfig;
+    autoLayout?: IAutoBounds;
+    get cursorPoint(): IPointData;
+    leafs: number;
+    __eventIds: IEventListenerId[];
+    protected __startTimer: ITimer;
+    protected __controllers: IControl[];
+    protected __readyWait: IFunction[];
+    protected __viewReadyWait: IFunction[];
+    protected __viewCompletedWait: IFunction[];
+    __nextRenderWait: IFunction[];
+    constructor(userConfig?: ILeaferConfig, data?: ILeaferInputData);
+    init(userConfig?: ILeaferConfig, parentApp?: IApp): void;
+    onInit(): void;
+    initType(_type: ILeaferType): void;
+    set(data: IUIInputData): void;
+    start(): void;
+    stop(): void;
+    unlockLayout(): void;
+    lockLayout(): void;
+    resize(size: IScreenSizeData): void;
+    forceFullRender(): void;
+    forceRender(bounds?: IBoundsData): void;
+    updateCursor(cursor?: ICursorType): void;
+    protected __doResize(size: IScreenSizeData): void;
+    protected __onResize(event: IResizeEvent): void;
+    protected __setApp(): void;
+    protected __bindApp(app: IApp): void;
+    __setLeafer(leafer: ILeafer): void;
+    setZoomLayer(zoomLayer: ILeaf): void;
+    protected __checkAutoLayout(config: ILeaferConfig): void;
+    __setAttr(attrName: string, newValue: IValue): void;
+    __getAttr(attrName: string): IValue;
+    protected __changeCanvasSize(attrName: string, newValue: number): void;
+    protected __changeFill(newValue: string): void;
+    protected __onCreated(): void;
+    protected __onReady(): void;
+    protected __onViewReady(): void;
+    protected __onNextRender(): void;
+    protected __checkViewCompleted(emit?: boolean): void;
+    protected __onWatchData(): void;
+    waitReady(item: IFunction): void;
+    waitViewReady(item: IFunction): void;
+    waitViewCompleted(item: IFunction): void;
+    nextRender(item: IFunction, off?: 'off'): void;
+    protected __checkUpdateLayout(): void;
+    protected emitLeafer(type: string): void;
+    protected __listenEvents(): void;
+    protected __removeListenEvents(): void;
+    destroy(): void;
+}
+
+declare class Box extends Group implements IBox {
+    get __tag(): string;
+    __: IBoxData;
+    overflow: IOverflow;
+    constructor(data?: IBoxInputData);
+    __updateStrokeSpread(): number;
+    __updateRectRenderSpread(): number;
+    __updateRenderSpread(): number;
+    __updateRectBoxBounds(): void;
+    __updateBoxBounds(): void;
+    __updateStrokeBounds(): void;
+    __updateRenderBounds(): void;
+    __updateRectRenderBounds(): void;
+    __updateRectChange(): void;
+    __updateChange(): void;
+    __drawPathByData(_drawer: IPathDrawer, _data: IPathCommandData): void;
+    __renderRect(_canvas: ILeaferCanvas, _options: IRenderOptions): void;
+    __renderGroup(_canvas: ILeaferCanvas, _options: IRenderOptions): void;
+    __render(canvas: ILeaferCanvas, options: IRenderOptions): void;
+    __drawAfterFill(canvas: ILeaferCanvas, options: IRenderOptions): void;
+}
+
+declare class Frame extends Box implements IFrame {
+    get __tag(): string;
+    __: IFrameData;
+    fill: IFill;
+    overflow: IOverflow;
+    constructor(data?: IFrameInputData);
+}
+
+declare class Rect extends UI implements IRect {
+    get __tag(): string;
+    __: IRectData;
+    constructor(data?: IRectInputData);
+    __drawPathByData(_drawer: IPathDrawer, _data: IPathCommandData): void;
+}
+
+declare class Ellipse extends UI implements IEllipse {
+    get __tag(): string;
+    __: IEllipseData;
+    innerRadius: INumber;
+    startAngle: INumber;
+    endAngle: INumber;
+    constructor(data?: IEllipseInputData);
+    __updatePath(): void;
+}
+
+declare class Polygon extends UI implements IPolygon {
+    get __tag(): string;
+    __: IPolygonData;
+    sides: INumber;
+    points: number[];
+    curve: boolean | number;
+    constructor(data?: IPolygonInputData);
+    __updatePath(): void;
+    __updateRenderPath(): void;
+    __updateBoxBounds(): void;
+}
+
+declare class Star extends UI implements IStar {
+    get __tag(): string;
+    __: IStarData;
+    corners: INumber;
+    innerRadius: INumber;
+    constructor(data?: IStarInputData);
+    __updatePath(): void;
+}
+
+declare class Line extends UI implements ILine {
+    get __tag(): string;
+    __: ILineData;
+    strokeAlign: IStrokeAlign;
+    height: INumber;
+    points: number[];
+    curve: boolean | number;
+    get toPoint(): IPointData;
+    set toPoint(value: IPointData);
+    constructor(data?: ILineInputData);
+    __updatePath(): void;
+    __updateRenderPath(): void;
+    __updateBoxBounds(): void;
+}
+
+declare class Image extends Rect implements IImage {
+    get __tag(): string;
+    __: IImageData;
+    url: IString;
+    get ready(): boolean;
+    image: ILeaferImage;
+    constructor(data?: IImageInputData);
+    destroy(): void;
+}
+
+declare class Canvas extends Rect implements ICanvas {
+    get __tag(): string;
+    __: ICanvasData;
+    width: INumber;
+    height: INumber;
+    pixelRatio: INumber;
+    smooth: boolean;
+    hitFill: IHitType;
+    canvas: ILeaferCanvas;
+    context: ICanvasContext2D;
+    constructor(data?: ICanvasInputData);
+    draw(ui: IUI, offset?: IPointData, scale?: number | IPointData, rotation?: number): void;
+    paint(): void;
+    __drawAfterFill(canvas: ILeaferCanvas, _options: IRenderOptions): void;
+    __updateSize(): void;
+    destroy(): void;
+}
+
+declare class Text extends UI implements IText {
+    get __tag(): string;
+    __: ITextData;
+    width: INumber;
+    height: INumber;
+    padding: number | number[];
+    fill: IFill;
+    strokeAlign: IStrokeAlign;
+    hitFill: IHitType$1;
+    text: IString;
+    fontFamily: IString;
+    fontSize: INumber;
+    fontWeight: IFontWeight;
+    italic: IBoolean;
+    textCase: ITextCase;
+    textDecoration: ITextDecoration;
+    letterSpacing: INumber | IUnitData;
+    lineHeight: INumber | IUnitData;
+    paraIndent: INumber;
+    paraSpacing: INumber;
+    textAlign: ITextAlign;
+    verticalAlign: IVerticalAlign;
+    textWrap: ITextWrap;
+    textOverflow: IOverflow | string;
+    get textDrawData(): ITextDrawData;
+    constructor(data?: ITextInputData);
+    __drawHitPath(canvas: ILeaferCanvas): void;
+    __drawPathByData(drawer: IPathDrawer, _data?: IPathCommandData): void;
+    __drawRenderPath(canvas: ILeaferCanvas): void;
+    __updateTextDrawData(): void;
+    __updateBoxBounds(): void;
+    __updateRenderSpread(): number;
+    __updateRenderBounds(): void;
+}
+
+declare class Path extends UI implements IPath {
+    get __tag(): string;
+    __: IPathData;
+    path: IPathCommandData | IPathString$1;
+    windingRule: IWindingRule;
+    strokeAlign: IStrokeAlign;
+    constructor(data?: IPathInputData);
+    __updateBoxBounds(): void;
+}
+
+declare class Pen extends Group implements IPen {
+    get __tag(): string;
+    __: IPenData;
+    pathElement: IPath;
+    pathStyle: IPathInputData;
+    path: IPathCommandData$1;
+    constructor(data?: IPenInputData);
+    setStyle(data: IPathInputData): Pen;
+    beginPath(): Pen;
+    moveTo(_x: number, _y: number): Pen;
+    lineTo(_x: number, _y: number): Pen;
+    bezierCurveTo(_x1: number, _y1: number, _x2: number, _y2: number, _x: number, _y: number): Pen;
+    quadraticCurveTo(_x1: number, _y1: number, _x: number, _y: number): Pen;
+    closePath(): Pen;
+    rect(_x: number, _y: number, _width: number, _height: number): Pen;
+    roundRect(_x: number, _y: number, _width: number, _height: number, _cornerRadius: number | number[]): Pen;
+    ellipse(_x: number, _y: number, _radiusX: number, _radiusY: number, _rotation?: number, _startAngle?: number, _endAngle?: number, _anticlockwise?: boolean): Pen;
+    arc(_x: number, _y: number, _radius: number, _startAngle?: number, _endAngle?: number, _anticlockwise?: boolean): Pen;
+    arcTo(_x1: number, _y1: number, _x2: number, _y2: number, _radius: number): Pen;
+    drawEllipse(_x: number, _y: number, _radiusX: number, _radiusY: number, _rotation?: number, _startAngle?: number, _endAngle?: number, _anticlockwise?: boolean): Pen;
+    drawArc(_x: number, _y: number, _radius: number, _startAngle?: number, _endAngle?: number, _anticlockwise?: boolean): Pen;
+    drawPoints(_points: number[], _curve?: boolean | number, _close?: boolean): Pen;
+    paint(): void;
+}
+
+export { Box, Canvas, Ellipse, Frame, Group, Image, Leafer, Line, Path, Pen, Polygon, Rect, Star, Text, UI };