@leafer/interface 1.0.0-rc.8 → 1.0.0

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@leafer/interface",
-  "version": "1.0.0-rc.8",
+  "version": "1.0.0",
   "description": "@leafer/interface",
   "author": "Chao (Leafer) Wan",
   "license": "MIT",

package/src/app/ILeafer.ts

@@ -1,15 +1,15 @@
-import { ILeaf } from '../display/ILeaf'
+import { ILeaf, ICursorType } from '../display/ILeaf'
 import { IRenderer, IRendererConfig } from '../renderer/IRenderer'
 import { IHitCanvas, ILeaferCanvas, ILeaferCanvasConfig, IHitCanvasConfig } from '../canvas/ILeaferCanvas'
 import { ILayouter, ILayouterConfig } from '../layouter/ILayouter'
 import { ISelector, ISelectorConfig } from '../selector/ISelector'
 import { IInteraction, IInteractionCanvas, IInteractionConfig } from '../interaction/IInteraction'
 import { IWatcher, IWatcherConfig } from '../watcher/IWatcher'
-import { IAutoBounds, IPointData, IScreenSizeData } from '../math/IMath'
+import { IAutoBounds, IBoundsData, IPointData, IScreenSizeData, IBounds, IClientPointData } from '../math/IMath'
 import { ICanvasManager } from '../canvas/ICanvasManager'
 import { IHitCanvasManager } from '../canvas/IHitCanvasManager'
 import { IEventListenerId } from '../event/IEventer'
-import { IObject } from '../data/IData'
+import { IFourNumber, IObject } from '../data/IData'
 import { IZoomView } from '../display/IView'
 import { IAppBase } from './IApp'
 import { ILeaferImage, ILeaferImageConfig } from '../image/ILeaferImage'
@@ -17,11 +17,12 @@ import { IControl } from '../control/IControl'
 import { IFunction } from '../function/IFunction'
 
 
-export type ILeaferType = 'draw' | 'design' | 'board' | 'document' | 'user'
+export type ILeaferType = 'draw' | 'editor' | 'design' | 'board' | 'document' | 'app' | 'website' | 'game' | 'player' | 'chart' | 'custom'
 export interface ILeaferConfig extends IRendererConfig, ILeaferCanvasConfig, IInteractionConfig, ILayouterConfig {
     start?: boolean
     type?: ILeaferType
     realCanvas?: boolean
+    lazySpeard?: IFourNumber
 }
 
 export interface ILeaferAttrData {
@@ -33,7 +34,7 @@ export interface ILeaferAttrData {
     viewCompleted: boolean
     layoutLocked: boolean
 
-    pixelRatio: number
+    transforming: boolean
 
     view: unknown
 
@@ -50,10 +51,12 @@ export interface ILeaferAttrData {
     hitCanvasManager?: IHitCanvasManager
 
     autoLayout?: IAutoBounds
+    lazyBounds: IBounds
 
     config: ILeaferConfig
 
     readonly cursorPoint: IPointData
+    readonly clientBounds: IBoundsData
     leafs: number
 
     __eventIds: IEventListenerId[]
@@ -67,16 +70,22 @@ export interface ILeaferAttrData {
     unlockLayout(): void
     lockLayout(): void
 
-    setZoomLayer(zoomLayer: ILeaf): void
-    forceFullRender(): void
-    updateCursor(): void
+    updateCursor(cursor?: ICursorType): void
     resize(size: IScreenSizeData): void
 
-    waitReady(item: IFunction): void
-    waitViewReady(item: IFunction): void
-    waitViewCompleted(item: IFunction): void
+    waitReady(item: IFunction, bind?: IObject): void
+    waitViewReady(item: IFunction, bind?: IObject): void
+    waitViewCompleted(item: IFunction, bind?: IObject): void
+
+    zoom(zoomType: IZoomType, padding?: IFourNumber, fixedScale?: boolean): IBoundsData
+    getValidMove(moveX: number, moveY: number): IPointData
+    getValidScale(changeScale: number): number
+
+    getWorldPointByClient(clientPoint: IClientPointData, updateClient?: boolean): IPointData
 }
 
+export type IZoomType = 'in' | 'out' | 'fit' | 'fit-width' | 'fit-height' | number | ILeaf | ILeaf[] | IBoundsData
+
 export interface ILeaferBase extends IZoomView, IControl, ILeaferAttrData {
     readonly isApp: boolean
     readonly app: ILeaferBase
@@ -101,6 +110,7 @@ export interface ICreator {
     image?(options?: ILeaferImageConfig): ILeaferImage
     canvas?(options?: ILeaferCanvasConfig, manager?: ICanvasManager): ILeaferCanvas
     hitCanvas?(options?: IHitCanvasConfig, manager?: ICanvasManager): IHitCanvas
+    hitCanvasManager?(): IHitCanvasManager
 
     watcher?(target: ILeaf, options?: IWatcherConfig): IWatcher
     layouter?(target: ILeaf, options?: ILayouterConfig): ILayouter

package/src/canvas/ICanvas.ts

@@ -111,6 +111,8 @@ export interface CanvasPattern {
     setTransform(transform?: DOMMatrix2DInit): void
 }
 
+export type ICanvasPattern = CanvasPattern
+
 declare var CanvasPattern: {
     prototype: CanvasPattern
     new(): CanvasPattern
@@ -123,15 +125,18 @@ interface CanvasRect {
 }
 
 type PredefinedColorSpace = 'display-p3' | 'srgb'
-interface CanvasRenderingContext2DSettings {
+interface ICanvasRenderingContext2DSettings {
     alpha?: boolean
     colorSpace?: PredefinedColorSpace
     desynchronized?: boolean
     willReadFrequently?: boolean
 }
+
+export type ICanvasContext2DSettings = ICanvasRenderingContext2DSettings
+
 export interface ICanvasContext2D extends CanvasCompositing, CanvasDrawImage, CanvasDrawPath, CanvasFillStrokeStyles, CanvasFilters, CanvasImageData, CanvasImageSmoothing, CanvasPath, CanvasPathDrawingStyles, CanvasRect, CanvasShadowStyles, CanvasState, CanvasText, CanvasTextDrawingStyles, CanvasTransform, CanvasUserInterface {
     readonly canvas: HTMLCanvasElement
-    getContextAttributes(): CanvasRenderingContext2DSettings
+    getContextAttributes(): ICanvasRenderingContext2DSettings
 }
 
 declare var ICanvasContext2D: {

package/src/canvas/IHitCanvasManager.ts

@@ -1,9 +1,9 @@
 import { ILeaf } from '../display/ILeaf'
-import { IScreenSizeData } from '../math/IMath'
 import { ICanvasManager } from './ICanvasManager'
-import { IHitCanvas } from './ILeaferCanvas'
+import { IHitCanvas, ILeaferCanvasConfig } from './ILeaferCanvas'
 
 export interface IHitCanvasManager extends ICanvasManager {
+    maxTotal: number // 最多缓存多少张画布
     getPathType(leaf: ILeaf): IHitCanvas
-    getImageType(leaf: ILeaf, size: IScreenSizeData): IHitCanvas
+    getPixelType(leaf: ILeaf, config?: ILeaferCanvasConfig): IHitCanvas
 }

package/src/canvas/ILeaferCanvas.ts

@@ -1,11 +1,12 @@
 import { IObject } from '../data/IData'
-import { IBounds, IMatrixData, IBoundsData, IAutoBoundsData, IAutoBounds, IScreenSizeData, IMatrixWithBoundsData, IPointData } from '../math/IMath'
-import { ICanvasContext2D, IWindingRule, IPath2D, ITextMetrics, CanvasGradient, CanvasPattern } from './ICanvas'
+import { IBounds, IMatrixData, IBoundsData, IAutoBoundsData, IAutoBounds, IScreenSizeData, IMatrixWithBoundsData, IPointData, IRadiusPointData } from '../math/IMath'
+import { ICanvasContext2D, IWindingRule, IPath2D, ITextMetrics, CanvasGradient, CanvasPattern, ICanvasContext2DSettings } from './ICanvas'
 import { IResizeEventListener } from '../event/IEvent'
 import { IPathDrawer } from '../path/IPathDrawer'
 import { InnerId } from '../event/IEventer'
 import { ICanvasManager } from './ICanvasManager'
-import { ICursorType } from '../display/ILeaf'
+import { IExportFileType } from '../file/IFileType'
+import { IExportOptions } from '../file/IExport'
 
 export interface ILeaferCanvasConfig extends IAutoBoundsData {
     view?: string | IObject
@@ -14,6 +15,7 @@ export interface ILeaferCanvasConfig extends IAutoBoundsData {
     smooth?: boolean
     hittable?: boolean
     webgl?: boolean
+    contextSettings?: ICanvasContext2DSettings
 }
 
 export type IHitCanvasConfig = ILeaferCanvasConfig
@@ -29,6 +31,11 @@ export interface ICanvasStrokeOptions {
     miterLimit?: number
 }
 
+export interface ICanvasCacheOptions extends ICanvasStrokeOptions {
+    fillStyle?: string | object
+    strokeStyle?: string | object
+}
+
 export interface ICanvasAttr extends ICanvasStrokeOptions, IObject {
 
     smooth: boolean // imageSmoothingEnabled: boolean
@@ -105,6 +112,8 @@ interface ICanvasMethod {
 
     hitFill(point: IPointData, fillRule?: string): boolean
     hitStroke(point: IPointData, strokeWidth?: number): boolean
+    hitPixel(radiusPoint: IRadiusPointData, offset?: IPointData, scale?: number): boolean
+
 
     setStroke(strokeStyle: string | object, strokeWidth: number, options?: ICanvasStrokeOptions): void
     setStrokeOptions(options: ICanvasStrokeOptions): void
@@ -116,7 +125,7 @@ interface ICanvasMethod {
     setWorldBlur(blur: number): void
 
     copyWorld(canvas: ILeaferCanvas, fromBounds?: IBoundsData, toBounds?: IBoundsData, blendMode?: string): void
-    copyWorldByReset(canvas: ILeaferCanvas, from?: IBoundsData, to?: IBoundsData, blendMode?: string): void
+    copyWorldByReset(canvas: ILeaferCanvas, from?: IBoundsData, to?: IBoundsData, blendMode?: string, onlyResetTransform?: boolean): void
     copyWorldToInner(canvas: ILeaferCanvas, fromWorld: IMatrixWithBoundsData, toInnerBounds: IBoundsData, blendMode?: string): void
 
     useMask(maskCanvas: ILeaferCanvas, fromBounds?: IBoundsData, toBounds?: IBoundsData): void
@@ -130,6 +139,7 @@ interface ICanvasMethod {
     clear(): void
 }
 
+export type ILeaferCanvasView = any
 export interface ILeaferCanvas extends ICanvasAttr, ICanvasMethod, IPathDrawer {
 
     readonly innerId: InnerId
@@ -148,6 +158,9 @@ export interface ILeaferCanvas extends ICanvasAttr, ICanvasMethod, IPathDrawer {
     backgroundColor?: string
     hittable?: boolean
 
+    zIndex?: number
+    childIndex?: number
+
     bounds: IBounds
     clientBounds: IBoundsData
 
@@ -155,7 +168,7 @@ export interface ILeaferCanvas extends ICanvasAttr, ICanvasMethod, IPathDrawer {
 
     autoLayout: boolean
 
-    view: any
+    view: ILeaferCanvasView
     parentView: any
 
     unreal?: boolean
@@ -168,6 +181,7 @@ export interface ILeaferCanvas extends ICanvasAttr, ICanvasMethod, IPathDrawer {
 
     init(): void
 
+    export(filename: IExportFileType | string, options?: IExportOptions | number | boolean): string | Promise<any>
     toBlob(type?: string, quality?: number): Promise<IBlob>
     toDataURL(type?: string, quality?: number): string | Promise<string>
     saveAs(filename: string, quality?: number): Promise<boolean>
@@ -178,14 +192,12 @@ export interface ILeaferCanvas extends ICanvasAttr, ICanvasMethod, IPathDrawer {
     resize(size: IScreenSizeData): void
     updateViewSize(): void
     updateClientBounds(): void
-
-    setCursor(cursor: ICursorType | ICursorType[]): void
+    getClientBounds(update?: boolean): IBoundsData
 
     // other
     isSameSize(options: ILeaferCanvasConfig): boolean
     getSameCanvas(useSameWorldTransform?: boolean, useSameSmooth?: boolean): ILeaferCanvas
-    getBiggerCanvas(addWidth: number, addHeight: number): ILeaferCanvas
-    recycle(): void
+    recycle(clearBounds?: IBoundsData): void
 
     updateRender(): void
     unrealCanvas(): void
@@ -194,7 +206,7 @@ export interface ILeaferCanvas extends ICanvasAttr, ICanvasMethod, IPathDrawer {
 
 
 export interface IHitCanvas extends ILeaferCanvas {
-
+    hitScale?: number
 }
 
 

package/src/data/IData.ts

@@ -1,11 +1,15 @@
+import { IPointData } from '../math/IMath'
+
 export type INumber = number // number | string    will convert to number
 export type IBoolean = boolean // boolean | string  will convert to boolean
 export type IString = string //  string  | other   will convert to string
-export type IValue = INumber | IBoolean | IString | IObject  // 
+export type IValue = INumber | IBoolean | IString | IObject
 export type ITimer = any
 
 export type IPathString = string
 
+export type IFourNumber = number | number[]
+
 export interface IObject {
     [name: string]: any
 }
@@ -22,6 +26,10 @@ export interface IStringMap {
     [name: string]: string
 }
 
+export interface IPointDataMap {
+    [name: string]: IPointData
+}
+
 export interface IDataTypeHandle {
     (target: any): void
 }

package/src/data/ILeafData.ts

@@ -1,4 +1,5 @@
 import { ILeaf, ILeafComputedData } from '../display/ILeaf'
+import { IJSONOptions } from '../file/IExport'
 import { IObject } from './IData'
 
 export interface IDataProcessor {
@@ -6,16 +7,13 @@ export interface IDataProcessor {
     __input: IObject
     __middle: IObject
 
-    __single: boolean
-    __checkSingle(): void
-
     __get(name: string): any
     __getData(): IObject
 
     __setInput(name: string, value: any): void
     __getInput(name: string): any
     __removeInput(name: string): void
-    __getInputData(): IObject
+    __getInputData(names?: string[] | IObject, options?: IJSONOptions): IObject
 
     __setMiddle(name: string, value: any): void
     __getMiddle(name: string): any
@@ -29,5 +27,7 @@ export interface ILeafDataOptions {
 }
 
 export interface ILeafData extends IDataProcessor, ILeafComputedData {
-
+    __single?: boolean
+    __checkSingle(): void
+    __removeNaturalSize(): void
 }

package/src/display/IBranch.ts

@@ -1,10 +1,11 @@
+import { ILeaf } from './ILeaf'
 import { ILeaferCanvas } from '../canvas/ILeaferCanvas'
 import { IRenderOptions } from '../renderer/IRenderer'
-import { ILeaf } from './ILeaf'
 
 export interface IBranch extends ILeaf {
     children: ILeaf[]
     __renderBranch?(canvas: ILeaferCanvas, options: IRenderOptions): void
     addMany(...children: ILeaf[]): void
     removeAll(destroy?: boolean): void
+    clear(): void
 }