๐ŸŒฟ LeaferJS

็ฎ€ไฝ“ไธญๆ–‡

English ้ข„่ฎก2.0็‰ˆๆœฌๅฏๅŠจ็ฟป่ฏ‘

็ฎ€ไฝ“ไธญๆ–‡

English ้ข„่ฎก2.0็‰ˆๆœฌๅฏๅŠจ็ฟป่ฏ‘

Appearance

leaferjs โ€‹

Table of contents โ€‹

References โ€‹

Enumerations โ€‹

Classes โ€‹

Interfaces โ€‹

Type Aliases โ€‹

Variables โ€‹

Functions โ€‹

References โ€‹

getMatrixData โ€‹

Renames and re-exports __type

Type Aliases โ€‹

IInnerEditorMode โ€‹

ฦฌ IInnerEditorMode: "focus" | "both"

Defined in โ€‹

src/in/packages/interface/src/editor/IEditor.ts:62

IScrollBarTheme โ€‹

ฦฌ IScrollBarTheme: "light" | "dark" | IBoxInputData

Defined in โ€‹

src/in/packages/interface/src/scroll/IScrollBar.ts:9

ITransition โ€‹

ฦฌ ITransition: IAnimateOptions | IAnimateEasingName | number | boolean

Defined in โ€‹

src/leafer/packages/interface/src/animate/ITransition.ts:3

IAnimateEasing โ€‹

ฦฌ IAnimateEasing: IAnimateEasingName | ICubicBezierEasing | IStepsEasing | IObject

Defined in โ€‹

src/leafer/packages/interface/src/animate/ITransition.ts:37

IAnimateEasingName โ€‹

ฦฌ IAnimateEasingName: "linear" | "ease" | "ease-in" | "ease-out" | "ease-in-out" | "sine-in" | "sine-out" | "sine-in-out" | "quad-in" | "quad-out" | "quad-in-out" | "cubic-in" | "cubic-out" | "cubic-in-out" | "quart-in" | "quart-out" | "quart-in-out" | "quint-in" | "quint-out" | "quint-in-out" | "expo-in" | "expo-out" | "expo-in-out" | "circ-in" | "circ-out" | "circ-in-out" | "back-in" | "back-out" | "back-in-out" | "elastic-in" | "elastic-out" | "elastic-in-out" | "bounce-in" | "bounce-out" | "bounce-in-out"

Defined in โ€‹

src/leafer/packages/interface/src/animate/ITransition.ts:54

IAnimateEnding โ€‹

ฦฌ IAnimateEnding: "auto" | "from" | "to"

Defined in โ€‹

src/leafer/packages/interface/src/animate/ITransition.ts:70

ILeaferType โ€‹

ฦฌ ILeaferType: "draw" | "block" | "viewport" | "editor" | "design" | "board" | "document" | "app" | "website" | "game" | "player" | "chart" | "custom"

Defined in โ€‹

src/leafer/packages/interface/src/app/ILeafer.ts:21

IZoomType โ€‹

ฦฌ IZoomType: "in" | "out" | "fit" | "fit-width" | "fit-height" | number | ILeaf | ILeaf[] | IBoundsData

Defined in โ€‹

src/leafer/packages/interface/src/app/ILeafer.ts:98

IWindingRule โ€‹

ฦฌ IWindingRule: "evenodd" | "nonzero"

Defined in โ€‹

src/leafer/packages/interface/src/canvas/ICanvas.ts:3

ICanvasPattern โ€‹

ฦฌ ICanvasPattern: CanvasPattern

Defined in โ€‹

src/leafer/packages/interface/src/canvas/ICanvas.ts:114

ICanvasContext2DSettings โ€‹

ฦฌ ICanvasContext2DSettings: ICanvasRenderingContext2DSettings

Defined in โ€‹

src/leafer/packages/interface/src/canvas/ICanvas.ts:135

IHitCanvasConfig โ€‹

ฦฌ IHitCanvasConfig: ILeaferCanvasConfig

Defined in โ€‹

src/leafer/packages/interface/src/canvas/ILeaferCanvas.ts:24

ILeaferCanvasView โ€‹

ฦฌ ILeaferCanvasView: any

Defined in โ€‹

src/leafer/packages/interface/src/canvas/ILeaferCanvas.ts:148

IBlob โ€‹

ฦฌ IBlob: any

Defined in โ€‹

src/leafer/packages/interface/src/canvas/ILeaferCanvas.ts:229

ICanvasType โ€‹

ฦฌ ICanvasType: "skia" | "napi" | "canvas" | "miniapp"

Defined in โ€‹

src/leafer/packages/interface/src/canvas/ISkiaCanvas.ts:3

INumber โ€‹

ฦฌ INumber: number

Defined in โ€‹

src/leafer/packages/interface/src/data/IData.ts:4

IBoolean โ€‹

ฦฌ IBoolean: boolean

Defined in โ€‹

src/leafer/packages/interface/src/data/IData.ts:5

IString โ€‹

ฦฌ IString: string

Defined in โ€‹

src/leafer/packages/interface/src/data/IData.ts:6

IValue โ€‹

ฦฌ IValue: INumber | IBoolean | IString | IObject

Defined in โ€‹

src/leafer/packages/interface/src/data/IData.ts:7

ITimer โ€‹

ฦฌ ITimer: any

Defined in โ€‹

src/leafer/packages/interface/src/data/IData.ts:8

IPathString โ€‹

ฦฌ IPathString: string

Defined in โ€‹

src/leafer/packages/interface/src/data/IData.ts:10

IFourNumber โ€‹

ฦฌ IFourNumber: number | number[]

Defined in โ€‹

src/leafer/packages/interface/src/data/IData.ts:12

ILeafListItemCallback โ€‹

ฦฌ ILeafListItemCallback: (item: ILeaf, index?: number) => void

Type declaration โ€‹

โ–ธ (item, index?): void

Parameters โ€‹
NameType
itemILeaf
index?number
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/interface/src/data/IList.ts:12

ISide โ€‹

ฦฌ ISide: "width" | "height"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:34

IAxis โ€‹

ฦฌ IAxis: "x" | "y"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:36

IAxisReverse โ€‹

ฦฌ IAxisReverse: "x-reverse" | "y-reverse"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:38

IFlowType โ€‹

ฦฌ IFlowType: boolean | IAxis | IAxisReverse

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:40

IFlowBoxType โ€‹

ฦฌ IFlowBoxType: "box" | "stroke"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:42

IGap โ€‹

ฦฌ IGap: INumber | "auto" | "fit"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:44

IAxisAlign โ€‹

ฦฌ IAxisAlign: "from" | "center" | "to"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:48

IFlowWrap โ€‹

ฦฌ IFlowWrap: boolean | "reverse"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:52

IAutoSize โ€‹

ฦฌ IAutoSize: IBoolean | INumber | IPercentData

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:54

IConstraintType โ€‹

ฦฌ IConstraintType: "from" | "center" | "to" | "from-to" | "scale"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:75

IScaleFixed โ€‹

ฦฌ IScaleFixed: boolean | "zoom-in"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:77

IHitType โ€‹

ฦฌ IHitType: "path" | "pixel" | "all" | "none"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:79

IMaskType โ€‹

ฦฌ IMaskType: "path" | "pixel" | "grayscale" | "clipping" | "clipping-path"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:85

IEraserType โ€‹

ฦฌ IEraserType: "path" | "pixel"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:92

IBlendMode โ€‹

ฦฌ IBlendMode: "pass-through" | "normal" | "multiply" | "screen" | "overlay" | "darken" | "lighten" | "color-dodge" | "color-burn" | "hard-light" | "soft-light" | "difference" | "exclusion" | "hue" | "saturation" | "color" | "luminosity" | "source-over" | "source-in" | "source-out" | "source-atop" | "destination-over" | "destination-in" | "destination-out" | "destination-atop" | "xor" | "copy"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:96

IEditSize โ€‹

ฦฌ IEditSize: "size" | "font-size" | "scale"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:125

IDirection โ€‹

ฦฌ IDirection: "top-left" | "top" | "top-right" | "right" | "bottom-right" | "bottom" | "bottom-left" | "left" | "center"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:133

IDirection4 โ€‹

ฦฌ IDirection4: "top" | "right" | "bottom" | "left"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:144

IAlign โ€‹

ฦฌ IAlign: IDirection

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:150

IBaseLineAlign โ€‹

ฦฌ IBaseLineAlign: "baseline-left" | "baseline-center" | "baseline-right"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:152

IFlowAlign โ€‹

ฦฌ IFlowAlign: IAlign | IBaseLineAlign

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:157

IAround โ€‹

ฦฌ IAround: IAlign | IUnitPointData

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:162

ICursorType โ€‹

ฦฌ ICursorType: IImageCursor | "" | "auto" | "default" | "none" | "context-menu" | "help" | "pointer" | "progress" | "wait" | "cell" | "crosshair" | "text" | "vertical-text" | "alias" | "copy" | "move" | "no-drop" | "not-allowed" | "grab" | "grabbing" | "e-resize" | "n-resize" | "ne-resize" | "nw-resize" | "s-resize" | "se-resize" | "sw-resize" | "w-resize" | "ew-resize" | "ns-resize" | "nesw-resize" | "nwse-resize" | "col-resize" | "row-resize" | "all-scroll" | "zoom-in" | "zoom-out"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:166

IStateStyleType โ€‹

ฦฌ IStateStyleType: "hoverStyle" | "pressStyle" | "focusStyle" | "selectedStyle" | "disabledStyle"

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:206

ILeafAttrDescriptor โ€‹

ฦฌ ILeafAttrDescriptor: IObject & ThisType<ILeaf>

Defined in โ€‹

src/leafer/packages/interface/src/display/ILeaf.ts:711

IBranchRenderModule โ€‹

ฦฌ IBranchRenderModule: IBranchRender & ThisType<IBranch>

Defined in โ€‹

src/leafer/packages/interface/src/display/module/IBranchRender.ts:6

ILeafBoundsModule โ€‹

ฦฌ ILeafBoundsModule: ILeafBounds & ThisType<ILeaf>

Defined in โ€‹

src/leafer/packages/interface/src/display/module/ILeafBounds.ts:3

ILeafDataProxyModule โ€‹

ฦฌ ILeafDataProxyModule: ILeafDataProxy & ThisType<ILeaf>

Defined in โ€‹

src/leafer/packages/interface/src/display/module/ILeafDataProxy.ts:4

ILeafEventerModule โ€‹

ฦฌ ILeafEventerModule: ILeafEventer & ThisType<ILeaf>

Defined in โ€‹

src/leafer/packages/interface/src/display/module/ILeafEventer.ts:7

ILeafHitModule โ€‹

ฦฌ ILeafHitModule: ILeafHit & ThisType<ILeaf>

Defined in โ€‹

src/leafer/packages/interface/src/display/module/ILeafHit.ts:5

ILeafMatrixModule โ€‹

ฦฌ ILeafMatrixModule: ILeafMatrix & ThisType<ILeaf>

Defined in โ€‹

src/leafer/packages/interface/src/display/module/ILeafMatrix.ts:3

ILeafRenderModule โ€‹

ฦฌ ILeafRenderModule: ILeafRender & ThisType<ILeaf>

Defined in โ€‹

src/leafer/packages/interface/src/display/module/ILeafRender.ts:5

IEventListener โ€‹

ฦฌ IEventListener: IFunction

Defined in โ€‹

src/leafer/packages/interface/src/event/IEventer.ts:8

IEventOption โ€‹

ฦฌ IEventOption: IEventListenerOptions | boolean | "once"

Defined in โ€‹

src/leafer/packages/interface/src/event/IEventer.ts:15

IEventParams โ€‹

ฦฌ IEventParams: any[]

Defined in โ€‹

src/leafer/packages/interface/src/event/IEventer.ts:29

InnerId โ€‹

ฦฌ InnerId: number

Defined in โ€‹

src/leafer/packages/interface/src/event/IEventer.ts:38

PointerType โ€‹

ฦฌ PointerType: "mouse" | "pen" | "touch"

Defined in โ€‹

src/leafer/packages/interface/src/event/IUIEvent.ts:52

IShortcutKeys โ€‹

ฦฌ IShortcutKeys: IShortcutStringKeys | IShortcutArrayKeys

Defined in โ€‹

src/leafer/packages/interface/src/event/IUIEvent.ts:102

IShortcutKeyCodes โ€‹

ฦฌ IShortcutKeyCodes: IKeyCodes | "A" | "B" | "C" | "D" | "E" | "F" | "G" | "H" | "I" | "J" | "K" | "L" | "M" | "N" | "O" | "P" | "Q" | "R" | "S" | "T" | "U" | "V" | "W" | "X" | "Y" | "Z" | "0" | "1" | "2" | "3" | "4" | "5" | "6" | "7" | "8" | "9" | "!" | "@" | "#" | "$" | "%" | "^" | "&" | "*" | "(" | ")" | "Esc" | "Caps" | "Shift" | "Ctrl" | "Alt" | "Meta" | "โŒ˜" | "Win" | "โ†‘" | "โ†“" | "โ†" | "โ†’" | "Scroll" | "Num" | "-" | "_" | "=" | "+" | "[" | "{" | "]" | "}" | "\\" | "|" | ";" | ":" | "'" | "\"" | "," | "<" | "." | ">" | "/" | "?" | "`" | "~"

Defined in โ€‹

src/leafer/packages/interface/src/event/IUIEvent.ts:108

IKeyCodes โ€‹

ฦฌ IKeyCodes: "KeyA" | "KeyB" | "KeyC" | "KeyD" | "KeyE" | "KeyF" | "KeyG" | "KeyH" | "KeyI" | "KeyJ" | "KeyK" | "KeyL" | "KeyM" | "KeyN" | "KeyO" | "KeyP" | "KeyQ" | "KeyR" | "KeyS" | "KeyT" | "KeyU" | "KeyV" | "KeyW" | "KeyX" | "KeyY" | "KeyZ" | "Digit0" | "Digit1" | "Digit2" | "Digit3" | "Digit4" | "Digit5" | "Digit6" | "Digit7" | "Digit8" | "Digit9" | "F1" | "F2" | "F3" | "F4" | "F5" | "F6" | "F7" | "F8" | "F9" | "F10" | "F11" | "F12" | "F13" | "F14" | "F15" | "F16" | "F17" | "F18" | "F19" | "F20" | "F21" | "F22" | "F23" | "F24" | "Escape" | "Tab" | "CapsLock" | "ShiftLeft" | "ShiftRight" | "ControlLeft" | "ControlRight" | "AltLeft" | "AltRight" | "MetaLeft" | "MetaRight" | "Enter" | "Space" | "Backspace" | "Insert" | "Delete" | "Home" | "End" | "PageUp" | "PageDown" | "ArrowUp" | "ArrowDown" | "ArrowLeft" | "ArrowRight" | "PrintScreen" | "Pause" | "ScrollLock" | "NumLock" | "ContextMenu" | "Minus" | "Equal" | "BracketLeft" | "BracketRight" | "Backslash" | "IntlBackslash" | "Semicolon" | "Quote" | "Comma" | "Period" | "Slash" | "Backquote" | "Numpad0" | "Numpad1" | "Numpad2" | "Numpad3" | "Numpad4" | "Numpad5" | "Numpad6" | "Numpad7" | "Numpad8" | "Numpad9" | "NumpadMultiply" | "NumpadAdd" | "NumpadSubtract" | "NumpadDecimal" | "NumpadDivide" | "NumpadEnter" | "NumpadComma" | "NumpadParenLeft" | "NumpadParenRight" | "NumpadEqual" | "BrowserBack" | "BrowserForward" | "BrowserRefresh" | "BrowserStop" | "BrowserSearch" | "BrowserFavorites" | "BrowserHome" | "LaunchMail" | "LaunchMediaPlayer" | "LaunchCalculator" | "MediaPlayPause" | "MediaStop" | "MediaTrackNext" | "MediaTrackPrevious" | "MediaVolumeMute" | "MediaVolumeUp" | "MediaVolumeDown" | "AudioVolumeMute" | "AudioVolumeUp" | "AudioVolumeDown" | "Select" | "LaunchApp1" | "LaunchApp2" | "Help" | "Sleep" | "WakeUp" | "Lang1" | "Lang2" | "Power" | "Fn" | "Eject" | "Convert" | "NonConvert" | "KanaMode" | "Unidentified"

Defined in โ€‹

src/leafer/packages/interface/src/event/IUIEvent.ts:193

IExportImageType โ€‹

ฦฌ IExportImageType: "jpg" | "png" | "webp" | "bmp"

Defined in โ€‹

src/leafer/packages/interface/src/file/IFileType.ts:1

IExportFileType โ€‹

ฦฌ IExportFileType: IExportImageType | "svg" | "pdf" | "json"

Defined in โ€‹

src/leafer/packages/interface/src/file/IFileType.ts:2

ILocationType โ€‹

ฦฌ ILocationType: "world" | "page" | "local" | "inner"

Defined in โ€‹

src/leafer/packages/interface/src/layout/ILeafLayout.ts:4

IBoundsType โ€‹

ฦฌ IBoundsType: "content" | "box" | "stroke" | "render"

Defined in โ€‹

src/leafer/packages/interface/src/layout/ILeafLayout.ts:5

ILayoutAttr โ€‹

ฦฌ ILayoutAttr: "x" | "y" | "scaleX" | "scaleY" | "rotation" | "skewX" | "skewY"

Defined in โ€‹

src/leafer/packages/interface/src/math/IMath.ts:188

MCommandData โ€‹

ฦฌ MCommandData: [Command, x, y]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:15

HCommandData โ€‹

ฦฌ HCommandData: [Command, x]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:16

VCommandData โ€‹

ฦฌ VCommandData: [Command, y]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:17

LCommandData โ€‹

ฦฌ LCommandData: MCommandData

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:18

CCommandData โ€‹

ฦฌ CCommandData: [Command, x1, y1, x2, y2, x, y]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:20

SCommandData โ€‹

ฦฌ SCommandData: [Command, x2, y2, x, y]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:21

QCommandData โ€‹

ฦฌ QCommandData: [Command, x1, y1, x, y]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:23

TCommandData โ€‹

ฦฌ TCommandData: [Command, x, y]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:24

ZCommandData โ€‹

ฦฌ ZCommandData: [Command]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:26

ACommandData โ€‹

ฦฌ ACommandData: [Command, radiusX, radiusY, xAxisRotation, largeArcFlag, sweepFlag, x, y]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:28

RectCommandData โ€‹

ฦฌ RectCommandData: [Command, x, y, width, height]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:41

RoundRectCommandData โ€‹

ฦฌ RoundRectCommandData: [Command, x, y, width, height, cornerRadius]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:42

EllipseCommandData โ€‹

ฦฌ EllipseCommandData: [Command, x, y, radiusX, radiusY, rotation, startAngle, endAngle, anticlockwise]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:43

ArcCommandData โ€‹

ฦฌ ArcCommandData: [Command, x, y, radius, startAngle, endAngle, anticlockwise]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:44

ArcToCommandData โ€‹

ฦฌ ArcToCommandData: [Command, x1, y1, x2, y2, radius]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:45

CanvasPathCommand โ€‹

ฦฌ CanvasPathCommand: 1 | 2 | 5 | 7 | 11

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:48

IPathCommandData โ€‹

ฦฌ IPathCommandData: number[]

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:50

IPathCommandObject โ€‹

ฦฌ IPathCommandObject: MoveToCommandObject | LineToCommandObject | BezierCurveToCommandObject | QuadraticCurveToCommandObject | ClosePathCommandObject

Defined in โ€‹

src/leafer/packages/interface/src/path/IPathCommand.ts:87

IAnswer โ€‹

ฦฌ IAnswer: 0 | 1 | 2 | 3

Defined in โ€‹

src/leafer/packages/interface/src/selector/ISelector.ts:32

IAnimation โ€‹

ฦฌ IAnimation: IStyleAnimation | IKeyframesAnimation

Defined in โ€‹

src/ui/packages/interface/src/IAnimation.ts:6

IAnimateType โ€‹

ฦฌ IAnimateType: "all" | "animation" | "transition" | "animate"

Defined in โ€‹

src/ui/packages/interface/src/IAnimation.ts:8

IKeyframe โ€‹

ฦฌ IKeyframe: IUIInputData | IAnimateKeyframe

Defined in โ€‹

src/ui/packages/interface/src/IAnimation.ts:19

IKeyframeId โ€‹

ฦฌ IKeyframeId: number

Defined in โ€‹

src/ui/packages/interface/src/IAnimation.ts:21

IRobotActionName โ€‹

ฦฌ IRobotActionName: string

Defined in โ€‹

src/ui/packages/interface/src/IUI.ts:118

IStateName โ€‹

ฦฌ IStateName: string

Defined in โ€‹

src/ui/packages/interface/src/IUI.ts:444

IUITag โ€‹

ฦฌ IUITag: "App" | "Leafer" | "Rect" | "Ellipse" | "Polygon" | "Star" | "Line" | "Path" | "Pen" | "Text" | "Image" | "Canvas" | "Group" | "Frame" | "Box" | "Arrow" | "Robot" | "GIF" | "Video"

Defined in โ€‹

src/ui/packages/interface/src/IUI.ts:528

IEditPointType โ€‹

ฦฌ IEditPointType: "resize" | "rotate" | "skew" | "resize-rotate" | "button"

Defined in โ€‹

src/ui/packages/interface/src/editor/IEditor.ts:219

IUIBoundsModule โ€‹

ฦฌ IUIBoundsModule: IUIBounds & ThisType<IUI>

Defined in โ€‹

src/ui/packages/interface/src/module/IUIBounds.ts:5

IUIHitModule โ€‹

ฦฌ IUIHitModule: ILeafHit & ThisType<IUI>

Defined in โ€‹

src/ui/packages/interface/src/module/IUIHit.ts:5

IUIRenderModule โ€‹

ฦฌ IUIRenderModule: IUIRender & ThisType<IUI>

Defined in โ€‹

src/ui/packages/interface/src/module/IUIRender.ts:5

IRectRenderModule โ€‹

ฦฌ IRectRenderModule: IRectRender & ThisType<IRect>

Defined in โ€‹

src/ui/packages/interface/src/module/IUIRender.ts:12

IImageRenderModule โ€‹

ฦฌ IImageRenderModule: IImageRender & ThisType<IImage>

Defined in โ€‹

src/ui/packages/interface/src/module/IUIRender.ts:18

ITextRenderModule โ€‹

ฦฌ ITextRenderModule: ITextRender & ThisType<IText>

Defined in โ€‹

src/ui/packages/interface/src/module/IUIRender.ts:24

IGroupRenderModule โ€‹

ฦฌ IGroupRenderModule: IGroupRender & ThisType<IGroup>

Defined in โ€‹

src/ui/packages/interface/src/module/IUIRender.ts:30

IFrameRenderModule โ€‹

ฦฌ IFrameRenderModule: IFrameRender & ThisType<IFrame>

Defined in โ€‹

src/ui/packages/interface/src/module/IUIRender.ts:36

ILeafPaintColor โ€‹

ฦฌ ILeafPaintColor: IColorString | CanvasGradient | CanvasPattern

Defined in โ€‹

src/ui/packages/interface/src/type/IComputedType.ts:8

ILeafFill โ€‹

ฦฌ ILeafFill: ILeafPaint

Defined in โ€‹

src/ui/packages/interface/src/type/IComputedType.ts:41

IPercent โ€‹

ฦฌ IPercent: string

Defined in โ€‹

src/ui/packages/interface/src/type/IStringType.ts:1

IColorString โ€‹

ฦฌ IColorString: string

Defined in โ€‹

src/ui/packages/interface/src/type/IStringType.ts:2

ICornerRadiusString โ€‹

ฦฌ ICornerRadiusString: string

Defined in โ€‹

src/ui/packages/interface/src/type/IStringType.ts:4

IStrokeWidthString โ€‹

ฦฌ IStrokeWidthString: string

Defined in โ€‹

src/ui/packages/interface/src/type/IStringType.ts:5

IDashPatternString โ€‹

ฦฌ IDashPatternString: string

Defined in โ€‹

src/ui/packages/interface/src/type/IStringType.ts:6

IPaintString โ€‹

ฦฌ IPaintString: ISolidPaintString | IGradientPaintString | IImagePaintString

Defined in โ€‹

src/ui/packages/interface/src/type/IStringType.ts:8

IShadowString โ€‹

ฦฌ IShadowString: string

Defined in โ€‹

src/ui/packages/interface/src/type/IStringType.ts:13

IPaint โ€‹

ฦฌ IPaint: ISolidPaint | IGradientPaint | IImagePaint

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:5

IStrokePaint โ€‹

ฦฌ IStrokePaint: IStrokeSolidPaint | IStrokeGradientPaint | IStrokeImagePaint

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:7

IFill โ€‹

ฦฌ IFill: IPaint | IPaint[] | IPaintString

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:9

IStroke โ€‹

ฦฌ IStroke: IStrokePaint | IStrokePaint[] | IPaintString

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:11

IPaintAttr โ€‹

ฦฌ IPaintAttr: "fill" | "stroke"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:13

IPaintType โ€‹

ฦฌ IPaintType: "image" | "solid" | IGradientType

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:25

IGradientType โ€‹

ฦฌ IGradientType: "linear" | "radial" | "angular"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:30

IColor โ€‹

ฦฌ IColor: IColorString | IRGB | IRGBA

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:43

IImagePaintMode โ€‹

ฦฌ IImagePaintMode: "normal" | "cover" | "fit" | "stretch" | "clip" | "repeat"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:114

IRepeat โ€‹

ฦฌ IRepeat: boolean | "x" | "y" | IPointData

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:115

IStrokeAlign โ€‹

ฦฌ IStrokeAlign: "inside" | "outside" | "center"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:118

IStrokeCap โ€‹

ฦฌ IStrokeCap: "none" | "round" | "square"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:119

IStrokeJoin โ€‹

ฦฌ IStrokeJoin: "bevel" | "round" | "miter"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:120

IArrowType โ€‹

ฦฌ IArrowType: IPathDataArrow | "none" | "angle" | "angle-side" | "arrow" | "triangle" | "triangle-flip" | "circle" | "circle-line" | "square" | "square-line" | "diamond" | "diamond-line" | "mark"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:123

ITextAlign โ€‹

ฦฌ ITextAlign: "left" | "center" | "right" | "justify" | "both"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:143

IVerticalAlign โ€‹

ฦฌ IVerticalAlign: "top" | "middle" | "bottom"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:144

ITextCase โ€‹

ฦฌ ITextCase: "upper" | "lower" | "title" | "none" | "small-caps"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:145

IFontWeight โ€‹

ฦฌ IFontWeight: IFontWeightNumer | IFontWeightString

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:146

IFontWeightNumer โ€‹

ฦฌ IFontWeightNumer: 100 | 200 | 300 | 400 | 500 | 600 | 700 | 800 | 900

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:147

IFontWeightString โ€‹

ฦฌ IFontWeightString: "thin" | "extra-light" | "light" | "normal" | "medium" | "semi-bold" | "bold" | "extra-bold" | "black"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:148

ITextDecoration โ€‹

ฦฌ ITextDecoration: ITextDecorationType | ITextDecorationData

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:159

ITextDecorationType โ€‹

ฦฌ ITextDecorationType: "none" | "under" | "delete" | "under-delete"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:160

ITextWrap โ€‹

ฦฌ ITextWrap: "normal" | "none" | "break"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:166

IWritingMode โ€‹

ฦฌ IWritingMode: IAxis | IAxisReverse

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:167

IOverflow โ€‹

ฦฌ IOverflow: "show" | "hide" | "scroll"

Defined in โ€‹

src/ui/packages/interface/src/type/IType.ts:202

Variables โ€‹

AnimateEasing โ€‹

โ€ข Const AnimateEasing: Object

Type declaration โ€‹

NameType
get(easing: IAnimateEasing) => any
register(name: string, value: ICustomEasingFunction) => void
listIObject

Defined in โ€‹

src/in/packages/animate/src/AnimateEasing.ts:68

PathArrowModule โ€‹

โ€ข Const PathArrowModule: IPathArrowModule

Defined in โ€‹

src/in/packages/arrow/src/PathArrowModule.ts:14

PathMatrixHelper โ€‹

โ€ข Const PathMatrixHelper: Object

Type declaration โ€‹

NameType
layout(data: IPathCommandData, x: number, y: number, scaleX?: number, scaleY?: number, rotation?: number, origin?: IPointData) => void
rotate(data: IPathCommandData, rotation?: number, center?: IPointData) => void

Defined in โ€‹

src/in/packages/arrow/src/PathMatrixHelper.ts:9

EditDataHelper โ€‹

โ€ข Const EditDataHelper: Object

Type declaration โ€‹

NameType
getScaleData(target: IUI, startBounds: ILayoutBoundsData, direction: Direction9, totalMove: IPointData, lockRatio: boolean | "corner", around: IAround, flipable: boolean, scaleMode: boolean) => IEditorScaleEvent
getRotateData(target: IUI, direction: Direction9, current: IPointData, last: IPointData, around: IAround) => IEditorRotateEvent
getSkewData(bounds: IBoundsData, direction: Direction9, move: IPointData, around: IAround) => IEditorSkewEvent
getAround(around: IAround, altKey: boolean) => IAround
getRotateDirection(direction: number, rotation: number, totalDirection: number) => number
getFlipDirection(direction: Direction9, flipedX: boolean, flipedY: boolean) => Direction9

Defined in โ€‹

src/in/packages/editor/src/helper/EditDataHelper.ts:11

EditSelectHelper โ€‹

โ€ข Const EditSelectHelper: Object

Type declaration โ€‹

NameType
findOne(path: ILeafList) => IUI
findByBounds(branch: IUI, bounds: IBounds) => IUI[]

Defined in โ€‹

src/in/packages/editor/src/helper/EditSelectHelper.ts:4

EditorHelper โ€‹

โ€ข Const EditorHelper: Object

Type declaration โ€‹

NameType
group(list: IUI[], element?: IUI, userGroup?: IGroupInputData | IGroup) => IGroup
ungroup(list: IUI[]) => IUI[]
toTop(list: IUI[]) => void
toBottom(list: IUI[]) => void

Defined in โ€‹

src/in/packages/editor/src/helper/EditorHelper.ts:8

EditToolCreator โ€‹

โ€ข Const EditToolCreator: Object

Type declaration โ€‹

NameType
listIObject
register(EditTool: IObject) => void
get(tag: string, editor: IEditor) => IEditTool

Defined in โ€‹

src/in/packages/editor/src/tool/EditToolCreator.ts:17

HighBezierHelper โ€‹

โ€ข Const HighBezierHelper: Object

Type declaration โ€‹

NameType
getDistance(fromX: number, fromY: number, x1: number, y1: number, x2: number, y2: number, toX: number, toY: number, t: number) => number
getRotation(t: number, fromX: number, fromY: number, x1: number, y1: number, x2: number, y2: number, toX: number, toY: number) => number
getT(distance: number, totalDistance: number, fromX: number, fromY: number, x1: number, y1: number, x2: number, y2: number, toX: number, toY: number, precision: number) => number
cut(data: IPathCommandData, t: number, fromX: number, fromY: number, x1: number, y1: number, x2: number, y2: number, toX: number, toY: number) => void

Defined in โ€‹

src/in/packages/motion-path/src/HighBezierHelper.ts:12

HighCurveHelper โ€‹

โ€ข Const HighCurveHelper: Object

Type declaration โ€‹

NameType
transform(data: IPathCommandData, matrix: IMatrixData) => void
transformPoints(data: IPathCommandData, matrix: IMatrixData, start: number, pointCount: number) => void
getMotionPathData(data: IPathCommandData) => IMotionPathData
getDistancePoint(distanceData: IMotionPathData, motionDistance: number | IUnitData, motionPrecision?: number) => IRotationPointData
getDistancePath(distanceData: IMotionPathData, motionDistance: number | IUnitData, motionPrecision?: number) => IPathCommandData

Defined in โ€‹

src/in/packages/motion-path/src/HighCurveHelper.ts:10

PathScaler โ€‹

โ€ข Const PathScaler: Object

Type declaration โ€‹

NameType
scale(data: IPathCommandData, scaleX: number, scaleY: number) => void
scalePoints(data: IPathCommandData, scaleX: number, scaleY: number, start?: number, pointCount?: number) => void

Defined in โ€‹

src/in/packages/resize/src/PathScaler.ts:8

LeaferTypeCreator โ€‹

โ€ข Const LeaferTypeCreator: Object

Type declaration โ€‹

NameType
listILeaferTypeList
register(name: string, fn: ILeaferTypeFunction) => void
run(name: string, leafer: ILeaferBase) => void

Defined in โ€‹

src/in/packages/viewport/src/LeaferTypeCreator.ts:13

MultiTouchHelper โ€‹

โ€ข Const MultiTouchHelper: Object

Type declaration โ€‹

NameType
getData(list: IKeepTouchData[]) => IMultiTouchData

Defined in โ€‹

src/in/packages/viewport/src/interaction/MultiTouchHelper.ts:6

WheelEventHelper โ€‹

โ€ข Const WheelEventHelper: Object

Type declaration โ€‹

NameType
getMove(event: IWheelEvent, config: IWheelConfig) => IPointData
getScale(event: IWheelEvent, config: IWheelConfig) => number

Defined in โ€‹

src/in/packages/viewport/src/interaction/WheelEventHelper.ts:6

canvasSizeAttrs โ€‹

โ€ข Const canvasSizeAttrs: string[]

Defined in โ€‹

src/leafer/packages/canvas/canvas/src/LeaferCanvasBase.ts:12

version โ€‹

โ€ข Const version: "1.9.0"

Defined in โ€‹

src/leafer/packages/core/src/index.ts:23

Plugin โ€‹

โ€ข Const Plugin: Object

Type declaration โ€‹

NameType
listIBooleanMap
add(name: string, ...needPlugins: string[]) => void
has(name: string, tip?: boolean) => boolean
need(name: string) => any

Defined in โ€‹

src/leafer/packages/debug/src/Plugin.ts:6

Run โ€‹

โ€ข Const Run: Object

Type declaration โ€‹

NameType
currentIdnumber
currentNamestring
idMapids
nameMapnames
nameToIdMapids
start(name: string, microsecond?: boolean) => number
end(id: number, microsecond?: boolean) => void
endOfName(name: string, microsecond?: boolean) => void

Defined in โ€‹

src/leafer/packages/debug/src/Run.ts:17

DataHelper โ€‹

โ€ข Const DataHelper: Object

Type declaration โ€‹

NameType
default<T>(t: T, defaultData: IObject) => T
assign(t: IObject, merge: IObject, exclude?: IObject) => void
copyAttrs(t: IObject, from: IObject, include: string[]) => IObject
clone(data: unknown) => IObject
toMap(list: string[]) => IBooleanMap
stintSet<T, K>(data: T, attrName: K, value: T[K]) => void

Defined in โ€‹

src/leafer/packages/display-module/data/src/DataHelper.ts:4

emptyData โ€‹

โ€ข Const emptyData: IObject = {}

Defined in โ€‹

src/leafer/packages/display-module/data/src/data.ts:10

BranchRender โ€‹

โ€ข Const BranchRender: IBranchRenderModule

Defined in โ€‹

src/leafer/packages/display-module/display-module/src/BranchRender.ts:7

LeafBounds โ€‹

โ€ข Const LeafBounds: ILeafBoundsModule

Defined in โ€‹

src/leafer/packages/display-module/display-module/src/LeafBounds.ts:13

LeafDataProxy โ€‹

โ€ข Const LeafDataProxy: ILeafDataProxyModule

Defined in โ€‹

src/leafer/packages/display-module/display-module/src/LeafDataProxy.ts:9

LeafEventer โ€‹

โ€ข Const LeafEventer: ILeafEventerModule

Defined in โ€‹

src/leafer/packages/display-module/display-module/src/LeafEventer.ts:6

LeafMatrix โ€‹

โ€ข Const LeafMatrix: ILeafMatrixModule

Defined in โ€‹

src/leafer/packages/display-module/display-module/src/LeafMatrix.ts:8

LeafRender โ€‹

โ€ข Const LeafRender: ILeafRenderModule

Defined in โ€‹

src/leafer/packages/display-module/display-module/src/LeafRender.ts:6

BranchHelper โ€‹

โ€ข Const BranchHelper: Object

Type declaration โ€‹

NameType
sort(a: ILeaf, b: ILeaf) => number
pushAllChildBranch(branch: ILeaf, leafList: ILeafList | ILeafLevelList) => void
pushAllParent(leaf: ILeaf, leafList: ILeafList | ILeafLevelList) => void
pushAllBranchStack(branch: ILeaf, pushList: ILeaf[]) => void
updateBounds(branch: ILeaf, exclude?: ILeaf) => void
updateBoundsByBranchStack(branchStack: ILeaf[], exclude?: ILeaf) => void

Defined in โ€‹

src/leafer/packages/display-module/helper/src/BranchHelper.ts:7

LeafBoundsHelper โ€‹

โ€ข Const LeafBoundsHelper: Object

Type declaration โ€‹

NameType
worldBounds(target: ILeaf) => IBoundsData
localBoxBounds(target: ILeaf) => IBoundsData
localStrokeBounds(target: ILeaf) => IBoundsData
localRenderBounds(target: ILeaf) => IBoundsData
maskLocalBoxBounds(target: ILeaf, index: number) => IBoundsData
maskLocalStrokeBounds(target: ILeaf, index: number) => IBoundsData
maskLocalRenderBounds(target: ILeaf, index: number) => IBoundsData
excludeRenderBounds(child: ILeaf, options: IRenderOptions) => boolean

Defined in โ€‹

src/leafer/packages/display-module/helper/src/LeafBoundsHelper.ts:4

LeafHelper โ€‹

โ€ข Const LeafHelper: Object

Type declaration โ€‹

NameType
updateAllMatrix(leaf: ILeaf, checkAutoLayout?: boolean, waitAutoLayout?: boolean) => void
updateMatrix(leaf: ILeaf, checkAutoLayout?: boolean, waitAutoLayout?: boolean) => void
updateBounds(leaf: ILeaf) => void
updateAllWorldOpacity(leaf: ILeaf) => void
updateChange(leaf: ILeaf) => void
updateAllChange(leaf: ILeaf) => void
worldHittable(t: ILeaf) => boolean
draggable(t: ILeaf) => boolean
copyCanvasByWorld(leaf: ILeaf, currentCanvas: ILeaferCanvas, fromCanvas: ILeaferCanvas, fromWorld?: IBoundsData, blendMode?: string, onlyResetTransform?: boolean) => void
moveWorld(t: ILeaf, x: number | IPointData, y: number, isInnerPoint?: boolean, transition?: ITransition) => void
moveLocal(t: ILeaf, x: number | IPointData, y: number, transition?: ITransition) => void
zoomOfWorld(t: ILeaf, origin: IPointData, scaleX: number, scaleY?: ITransition, resize?: boolean, transition?: ITransition) => void
zoomOfLocal(t: ILeaf, origin: IPointData, scaleX: number, scaleY: ITransition, resize?: boolean, transition?: ITransition) => void
rotateOfWorld(t: ILeaf, origin: IPointData, angle: number, transition?: ITransition) => void
rotateOfLocal(t: ILeaf, origin: IPointData, angle: number, transition?: ITransition) => void
skewOfWorld(t: ILeaf, origin: IPointData, skewX: number, skewY?: number, resize?: boolean, transition?: ITransition) => void
skewOfLocal(t: ILeaf, origin: IPointData, skewX: number, skewY: number, resize?: boolean, transition?: ITransition) => void
transformWorld(t: ILeaf, transform: IMatrixData, resize?: boolean, transition?: ITransition) => void
transform(t: ILeaf, transform: IMatrixData, resize?: boolean, transition?: ITransition) => void
setTransform(t: ILeaf, transform: IMatrixData, resize?: boolean, transition?: ITransition) => void
getFlipTransform(t: ILeaf, axis: IAxis) => IMatrixData
getLocalOrigin(t: ILeaf, origin: IPointData | IDirection) => IPointData
getInnerOrigin(t: ILeaf, origin: IPointData | IDirection) => IPointData
getRelativeWorld(t: ILeaf, relative: ILeaf, temp?: boolean) => IMatrixData
drop(t: ILeaf, parent: ILeaf, index?: number, resize?: boolean) => void
hasParent(p: ILeaf, parent: ILeaf) => boolean | void
animateMove(t: ILeaf, move: IPointData, speed: number) => void

Defined in โ€‹

src/leafer/packages/display-module/helper/src/LeafHelper.ts:10

WaitHelper โ€‹

โ€ข Const WaitHelper: Object

Type declaration โ€‹

NameType
run(wait: IFunction[]) => void

Defined in โ€‹

src/leafer/packages/display-module/helper/src/WaitHelper.ts:3

leaferTransformAttrMap โ€‹

โ€ข Const leaferTransformAttrMap: IStringMap

Defined in โ€‹

src/leafer/packages/event/src/LeaferEvent.ts:34

FileHelper โ€‹

โ€ข Const FileHelper: Object

Type declaration โ€‹

NameType
alphaPixelTypesIExportFileType[]
upperCaseTypeMapIStringMap
mineType(type: string) => string
fileType(filename: string) => string
isOpaqueImage(filename: string) => boolean
getExportOptions(options?: number | boolean | IExportOptions) => IExportOptions

Defined in โ€‹

src/leafer/packages/file/src/FileHelper.ts:3

Resource โ€‹

โ€ข Const Resource: IResource

Defined in โ€‹

src/leafer/packages/file/src/Resource.ts:11

ImageManager โ€‹

โ€ข Const ImageManager: IImageManager

Defined in โ€‹

src/leafer/packages/image/image/src/ImageManager.ts:7

AlignHelper โ€‹

โ€ข Const AlignHelper: Object

Type declaration โ€‹

NameType
toPoint(align: IDirection, content: IBoundsData, box: IBoundsData, to: IPointData, onlyBoxSize?: boolean, onlyContentSize?: boolean) => void

Defined in โ€‹

src/leafer/packages/math/src/AlignHelper.ts:6

AroundHelper โ€‹

โ€ข Const AroundHelper: Object

Type declaration โ€‹

NameType
directionDataIUnitPointData[]
tempPointIPointData
get(around: IAround) => IUnitPointData
toPoint(around: IAround, box: IBoundsData, to: IPointData, onlyBoxSize?: boolean, content?: IBoundsData, onlyContentSize?: boolean) => void
getPoint(around: IAround, box: IBoundsData, to?: IPointData) => IPointData

Defined in โ€‹

src/leafer/packages/math/src/AroundHelper.ts:20

tempBounds โ€‹

โ€ข Const tempBounds: Bounds

Defined in โ€‹

src/leafer/packages/math/src/Bounds.ts:185

BoundsHelper โ€‹

โ€ข Const BoundsHelper: Object

Type declaration โ€‹

NameType
tempBoundsIBoundsData
set(t: IBoundsData, x: number, y: number, width: number, height: number) => void
copy(t: IBoundsData, bounds: IBoundsData) => void
copyAndSpread(t: IBoundsData, bounds: IBoundsData, spread: IFourNumber, isShrink?: boolean, side?: ISide) => void
minX(t: IBoundsData) => number
minY(t: IBoundsData) => number
maxX(t: IBoundsData) => number
maxY(t: IBoundsData) => number
move(t: IBoundsData, x: number, y: number) => void
getByMove(t: IBoundsData, x: number, y: number) => IBoundsData
toOffsetOutBounds(t: IBoundsData, to?: IOffsetBoundsData, parent?: IBoundsData) => void
scale(t: IBoundsData, scaleX: number, scaleY: number, onlySize?: boolean) => void
scaleOf(t: IBoundsData, origin: IPointData, scaleX: number, scaleY: number) => void
tempToOuterOf(t: IBoundsData, matrix: IMatrixData) => IBoundsData
getOuterOf(t: IBoundsData, matrix: IMatrixData) => IBoundsData
toOuterOf(t: IBoundsData, matrix: IMatrixData, to?: IBoundsData) => void
toInnerOf(t: IBoundsData, matrix: IMatrixData, to?: IBoundsData) => void
getFitMatrix(t: IBoundsData, put: IBoundsData, baseScale: number) => IMatrix
getFitScale(t: ISizeData, put: ISizeData, isCoverMode?: boolean) => number
put(t: ISizeData, put: ISizeData, align: IDirection, putScale: number | "fit" | "cover", changeSize: boolean, to?: IPointData) => void
getSpread(t: IBoundsData, spread: IFourNumber, side?: ISide) => IBoundsData
spread(t: IBoundsData, spread: IFourNumber, side?: ISide) => void
shrink(t: IBoundsData, shrink: IFourNumber, side?: ISide) => void
ceil(t: IBoundsData) => void
unsign(t: IBoundsData) => void
float(t: IBoundsData, maxLength?: number) => void
add(t: IBoundsData, bounds: IBoundsData, isPoint?: boolean) => void
addList(t: IBoundsData, list: IBoundsData[]) => void
setList(t: IBoundsData, list: IBoundsData[], addMode: boolean) => void
addListWithFn(t: IBoundsData, list: IObject[], boundsDataFn: IBoundsDataFn) => void
setListWithFn(t: IBoundsData, list: IObject[], boundsDataFn: IBoundsDataFn, addMode: boolean) => void
setPoints(t: IBoundsData, points: IPointData[]) => void
setPoint(t: IBoundsData, point: IPointData) => void
addPoint(t: IBoundsData, point: IPointData) => void
getPoints(t: IBoundsData) => IPointData[]
hitRadiusPoint(t: IBoundsData, point: IRadiusPointData, pointMatrix?: IMatrixWithScaleData) => boolean
hitPoint(t: IBoundsData, point: IPointData, pointMatrix?: IMatrixData) => boolean
hit(t: IBoundsData, other: IBoundsData, otherMatrix?: IMatrixData) => boolean
includes(t: IBoundsData, other: IBoundsData, otherMatrix?: IMatrixData) => boolean
getIntersectData(t: IBoundsData, other: IBoundsData, otherMatrix?: IMatrixData) => IBoundsData
intersect(t: IBoundsData, other: IBoundsData, otherMatrix?: IMatrixData) => void
isSame(t: IBoundsData, bounds: IBoundsData) => boolean
isEmpty(t: IBoundsData) => boolean
reset(t: IBoundsData) => void

Defined in โ€‹

src/leafer/packages/math/src/BoundsHelper.ts:22

IncrementId โ€‹

โ€ข Const IncrementId: Object

Type declaration โ€‹

NameType
RUNTIMEstring
LEAFstring
TASKstring
CNAVASstring
IMAGEstring
typesINumberMap
create(typeName: string) => number

Defined in โ€‹

src/leafer/packages/math/src/IncrementId.ts:4

MathHelper โ€‹

โ€ข Const MathHelper: Object

Type declaration โ€‹

NameType
within(value: number, min: number | IRangeSize, max?: number) => number
fourNumber(num: number | number[], maxValue?: number) => number[]
formatRotation(rotation: number, unsign?: boolean) => number
getGapRotation(addRotation: number, gap: number, oldRotation: number) => number
float(num: number, maxLength?: number) => number
getScaleData(scale: number | IPointData, size: number | IOptionSizeData, originSize: ISizeData, scaleData?: IScaleData) => IScaleData
assignScale(scaleData: IScaleData, scale: number | IPointData) => void
randInt(num: number) => number
randColor(opacity?: number) => string

Defined in โ€‹

src/leafer/packages/math/src/MathHelper.ts:6

OneRadian โ€‹

โ€ข Const OneRadian: number

Defined in โ€‹

src/leafer/packages/math/src/MathHelper.ts:96

PI2 โ€‹

โ€ข Const PI2: number

Defined in โ€‹

src/leafer/packages/math/src/MathHelper.ts:97

PI_2 โ€‹

โ€ข Const PI_2: number

Defined in โ€‹

src/leafer/packages/math/src/MathHelper.ts:98

tempMatrix โ€‹

โ€ข Const tempMatrix: Matrix

Defined in โ€‹

src/leafer/packages/math/src/Matrix.ts:170

MatrixHelper โ€‹

โ€ข Const MatrixHelper: Object

Type declaration โ€‹

NameType
defaultMatrixIMatrixData
defaultWorldIMatrixWithLayoutData
tempMatrixIMatrixData
set(t: IMatrixData, a: number, b: number, c: number, d: number, e: number, f: number) => void
get() => IMatrixData
getWorld() => IMatrixWithLayoutData
copy(t: IMatrixData, matrix: IMatrixData) => void
translate(t: IMatrixData, x: number, y: number) => void
translateInner(t: IMatrixData, x: number, y: number, hasOrigin?: boolean) => void
scale(t: IMatrixData, scaleX: number, scaleY: number) => void
scaleOfOuter(t: IMatrixData, origin: IPointData, scaleX: number, scaleY?: number) => void
scaleOfInner(t: IMatrixData, origin: IPointData, scaleX: number, scaleY: number) => void
rotate(t: IMatrixData, rotation: number) => void
rotateOfOuter(t: IMatrixData, origin: IPointData, rotation: number) => void
rotateOfInner(t: IMatrixData, origin: IPointData, rotation: number) => void
skew(t: IMatrixData, skewX: number, skewY?: number) => void
skewOfOuter(t: IMatrixData, origin: IPointData, skewX: number, skewY?: number) => void
skewOfInner(t: IMatrixData, origin: IPointData, skewX: number, skewY: number) => void
multiply(t: IMatrixData, child: IMatrixData) => void
multiplyParent(t: IMatrixWithOptionScaleData, parent: IMatrixWithOptionScaleData, to?: IMatrixWithOptionScaleData, abcdChanged?: number | boolean, childScaleData?: IScaleData, scrollData?: IScrollPointData) => void
divide(t: IMatrixData, child: IMatrixData) => void
divideParent(t: IMatrixData, parent: IMatrixData) => void
tempInvert(t: IMatrixData) => IMatrixData
invert(t: IMatrixData) => void
toOuterPoint(t: IMatrixData, inner: IPointData, to?: IPointData, distance?: boolean) => void
toInnerPoint(t: IMatrixData, outer: IPointData, to?: IPointData, distance?: boolean) => void
setLayout(t: IMatrixData, layout: ILayoutData, origin?: IPointData, around?: IPointData, bcChanged?: number | boolean) => void
getLayout(t: IMatrixData, origin?: IPointData, around?: IPointData, firstSkewY?: boolean) => ILayoutData
withScale(t: IMatrixData, scaleX?: number, scaleY: number) => IMatrixWithScaleData
reset(t: IMatrixData) => void

Defined in โ€‹

src/leafer/packages/math/src/MatrixHelper.ts:15

tempPoint โ€‹

โ€ข Const tempPoint: Point

Defined in โ€‹

src/leafer/packages/math/src/Point.ts:100

PointHelper โ€‹

โ€ข Const PointHelper: Object

Type declaration โ€‹

NameType
defaultPointIPointData
tempPointIPointData
tempRadiusPointIRadiusPointData
set(t: IPointData, x: number, y: number) => void
setRadius(t: IRadiusPointData, x: number, y?: number) => void
copy(t: IPointData, point: IPointData) => void
copyFrom(t: IPointData, x: number, y: number) => void
round(t: IPointData, halfPixel?: boolean) => void
move(t: IPointData, x: number | IPointData, y?: number) => void
scale(t: IPointData, scaleX: number, scaleY: number) => void
scaleOf(t: IPointData, origin: IPointData, scaleX: number, scaleY: number) => void
rotate(t: IPointData, rotation: number, origin?: IPointData) => void
tempToInnerOf(t: IPointData, matrix: IMatrixData) => IPointData
tempToOuterOf(t: IPointData, matrix: IMatrixData) => IPointData
tempToInnerRadiusPointOf(t: IRadiusPointData, matrix: IMatrixWithScaleData) => IRadiusPointData
toInnerRadiusPointOf(t: IRadiusPointData, matrix: IMatrixWithScaleData, to?: IRadiusPointData) => void
toInnerOf(t: IPointData, matrix: IMatrixData, to?: IPointData) => void
toOuterOf(t: IPointData, matrix: IMatrixData, to?: IPointData) => void
getCenter(t: IPointData, to: IPointData) => IPointData
getCenterX(x1: number, x2: number) => number
getCenterY(y1: number, y2: number) => number
getDistance(t: IPointData, point: IPointData) => number
getDistanceFrom(x1: number, y1: number, x2: number, y2: number) => number
getMinDistanceFrom(x1: number, y1: number, x2: number, y2: number, x3: number, y3: number) => number
getAngle(t: IPointData, to: IPointData) => number
getRotation(t: IPointData, origin: IPointData, to: IPointData, toOrigin?: IPointData) => number
getRadianFrom(fromX: number, fromY: number, originX: number, originY: number, toX: number, toY: number, toOriginX?: number, toOriginY?: number) => number
getAtan2(t: IPointData, to: IPointData) => number
getDistancePoint(t: IPointData, to: IPointData, distance: number, changeTo: boolean) => IPointData
toNumberPoints(originPoints: number[] | IPointData[]) => number[]
reset(t: IPointData) => void

Defined in โ€‹

src/leafer/packages/math/src/PointHelper.ts:12

StringNumberMap โ€‹

โ€ข Const StringNumberMap: INumberMap

Defined in โ€‹

src/leafer/packages/math/src/StringNumber.ts:4

TwoPointBoundsHelper โ€‹

โ€ข Const TwoPointBoundsHelper: Object

Type declaration โ€‹

NameType
tempPointBoundsITwoPointBoundsData
setPoint(t: ITwoPointBoundsData, minX: number, minY: number) => void
addPoint(t: ITwoPointBoundsData, x: number, y: number) => void
addBounds(t: ITwoPointBoundsData, x: number, y: number, width: number, height: number) => void
copy(t: ITwoPointBoundsData, pb: ITwoPointBoundsData) => void
addPointBounds(t: ITwoPointBoundsData, pb: ITwoPointBoundsData) => void
toBounds(t: ITwoPointBoundsData, setBounds: IBoundsData) => void

Defined in โ€‹

src/leafer/packages/math/src/TwoPointBoundsHelper.ts:3

BezierHelper โ€‹

โ€ข Const BezierHelper: Object

Type declaration โ€‹

NameType
points(data: IPathCommandData, originPoints: number[] | IPointData[], curve?: number | boolean, close?: boolean) => void
rect(data: IPathCommandData, x: number, y: number, width: number, height: number) => void
roundRect(data: IPathCommandData, x: number, y: number, width: number, height: number, radius: number | number[]) => void
arcTo(data: void | IPathCommandData, fromX: number, fromY: number, x1: number, y1: number, toX: number, toY: number, radius: number, setPointBounds?: ITwoPointBoundsData, setEndPoint?: IPointData, setStartPoint?: IPointData) => void
arc(data: void | IPathCommandData, x: number, y: number, radius: number, startAngle: number, endAngle: number, anticlockwise?: boolean, setPointBounds?: ITwoPointBoundsData, setEndPoint?: IPointData, setStartPoint?: IPointData) => void
ellipse(data: void | IPathCommandData, cx: number, cy: number, radiusX: number, radiusY: number, rotation: number, startAngle: number, endAngle: number, anticlockwise?: boolean, setPointBounds?: ITwoPointBoundsData, setEndPoint?: IPointData, setStartPoint?: IPointData) => void
quadraticCurveTo(data: IPathCommandData, fromX: number, fromY: number, x1: number, y1: number, toX: number, toY: number) => void
toTwoPointBoundsByQuadraticCurve(fromX: number, fromY: number, x1: number, y1: number, toX: number, toY: number, pointBounds: ITwoPointBoundsData, addMode?: boolean) => void
toTwoPointBounds(fromX: number, fromY: number, x1: number, y1: number, x2: number, y2: number, toX: number, toY: number, pointBounds: ITwoPointBoundsData, addMode?: boolean) => void
getPointAndSet(t: number, fromX: number, fromY: number, x1: number, y1: number, x2: number, y2: number, toX: number, toY: number, setPoint: IPointData) => void
getPoint(t: number, fromX: number, fromY: number, x1: number, y1: number, x2: number, y2: number, toX: number, toY: number) => IPointData
getDerivative(t: number, fromV: number, v1: number, v2: number, toV: number) => number

Defined in โ€‹

src/leafer/packages/path/src/BezierHelper.ts:15

EllipseHelper โ€‹

โ€ข Const EllipseHelper: Object

Type declaration โ€‹

NameType
ellipticalArc(data: IPathCommandData, fromX: number, fromY: number, radiusX: number, radiusY: number, rotation: number, largeFlag: number, sweepFlag: number, toX: number, toY: number, curveMode?: boolean) => void

Defined in โ€‹

src/leafer/packages/path/src/EllipseHelper.ts:12

PathBounds โ€‹

โ€ข Const PathBounds: Object

Type declaration โ€‹

NameType
toBounds(data: IPathCommandData, setBounds: IBoundsData) => void
toTwoPointBounds(data: IPathCommandData, setPointBounds: ITwoPointBoundsData) => void

Defined in โ€‹

src/leafer/packages/path/src/PathBounds.ts:19

PathCommandDataHelper โ€‹

โ€ข Const PathCommandDataHelper: Object

Type declaration โ€‹

NameType
beginPath(data: IPathCommandData) => void
moveTo(data: IPathCommandData, x: number, y: number) => void
lineTo(data: IPathCommandData, x: number, y: number) => void
bezierCurveTo(data: IPathCommandData, x1: number, y1: number, x2: number, y2: number, x: number, y: number) => void
quadraticCurveTo(data: IPathCommandData, x1: number, y1: number, x: number, y: number) => void
closePath(data: IPathCommandData) => void
rect(data: IPathCommandData, x: number, y: number, width: number, height: number) => void
roundRect(data: IPathCommandData, x: number, y: number, width: number, height: number, cornerRadius: number | number[]) => void
ellipse(data: IPathCommandData, x: number, y: number, radiusX: number, radiusY: number, rotation?: number, startAngle?: number, endAngle?: number, anticlockwise?: boolean) => void
arc(data: IPathCommandData, x: number, y: number, radius: number, startAngle?: number, endAngle?: number, anticlockwise?: boolean) => void
arcTo(data: IPathCommandData, x1: number, y1: number, x2: number, y2: number, radius: number, lastX?: number, lastY?: number) => void
drawEllipse(data: IPathCommandData, x: number, y: number, radiusX: number, radiusY: number, rotation?: number, startAngle?: number, endAngle?: number, anticlockwise?: boolean) => void
drawArc(data: IPathCommandData, x: number, y: number, radius: number, startAngle?: number, endAngle?: number, anticlockwise?: boolean) => void
drawPoints(data: IPathCommandData, points: number[] | IPointData[], curve?: number | boolean, close?: boolean) => void

Defined in โ€‹

src/leafer/packages/path/src/PathCommandDataHelper.ts:14

PathCommandMap โ€‹

โ€ข Const PathCommandMap: INumberMap

Defined in โ€‹

src/leafer/packages/path/src/PathCommandMap.ts:16

NeedConvertToCanvasCommandMap โ€‹

โ€ข Const NeedConvertToCanvasCommandMap: INumberMap

Defined in โ€‹

src/leafer/packages/path/src/PathCommandMap.ts:83

PathNumberCommandMap โ€‹

โ€ข Const PathNumberCommandMap: IStringMap = {}

Defined in โ€‹

src/leafer/packages/path/src/PathCommandMap.ts:116

PathNumberCommandLengthMap โ€‹

โ€ข Const PathNumberCommandLengthMap: INumberMap = {}

Defined in โ€‹

src/leafer/packages/path/src/PathCommandMap.ts:122

PathConvert โ€‹

โ€ข Const PathConvert: Object

Type declaration โ€‹

NameType
currentICurrentCommand
stringify(data: IPathCommandData, floatLength?: number) => string
parse(pathString: string, curveMode?: boolean) => IPathCommandData
toCanvasData(old: IPathCommandData, curveMode?: boolean) => IPathCommandData
objectToCanvasData(list: IPathCommandObject[]) => IPathCommandData
copyData(data: IPathCommandData, old: IPathCommandData, index: number, count: number) => void
pushData(data: IPathCommandData, strNum: string | number) => void

Defined in โ€‹

src/leafer/packages/path/src/PathConvert.ts:25

PathCorner โ€‹

โ€ข Const PathCorner: Object

Type declaration โ€‹

NameType
smooth(data: IPathCommandData, cornerRadius: number, _cornerSmoothing?: number) => IPathCommandData

Defined in โ€‹

src/leafer/packages/path/src/PathCorner.ts:12

PathDrawer โ€‹

โ€ข Const PathDrawer: Object

Type declaration โ€‹

NameType
drawPathByData(drawer: IPathDrawer, data: IPathCommandData) => void

Defined in โ€‹

src/leafer/packages/path/src/PathDrawer.ts:11

PathHelper โ€‹

โ€ข Const PathHelper: Object

Type declaration โ€‹

NameType
creatorIPathCreator
parse(_pathString: string, _curveMode?: boolean) => IPathCommandData
convertToCanvasData(_old: IPathCommandData, _curveMode?: boolean) => IPathCommandData

Defined in โ€‹

src/leafer/packages/path/src/PathHelper.ts:3

RectHelper โ€‹

โ€ข Const RectHelper: Object

Type declaration โ€‹

NameType
drawRoundRect(drawer: IPathDrawer, x: number, y: number, width: number, height: number, cornerRadius: number | number[]) => void

Defined in โ€‹

src/leafer/packages/path/src/RectHelper.ts:4

pen โ€‹

โ€ข Const pen: PathCreator

Defined in โ€‹

src/leafer/packages/path/src/index.ts:23

Platform โ€‹

โ€ข Const Platform: IPlatform

Defined in โ€‹

src/leafer/packages/platform/platform/src/Platform.ts:4

Creator โ€‹

โ€ข Const Creator: ICreator

Defined in โ€‹

src/leafer/packages/platform/platform/src/creator/Creator.ts:5

EventCreator โ€‹

โ€ข Const EventCreator: Object

Type declaration โ€‹

NameType
nameListIObject
register(Event: IObject) => void
changeName(oldName: string, newName: string) => void
has(type: string) => boolean
get(type: string, ...params: unknown[]) => IEvent

Defined in โ€‹

src/leafer/packages/platform/platform/src/creator/EventCreator.ts:8

UICreator โ€‹

โ€ข Const UICreator: Object

Type declaration โ€‹

NameType
listIObject
register(UI: IObject) => void
get(tag: string, data?: IObject, x?: number, y?: number, width?: number, height?: number) => ILeaf

Defined in โ€‹

src/leafer/packages/platform/platform/src/creator/UICreator.ts:8

UIBounds โ€‹

โ€ข Const UIBounds: IUIBoundsModule

Defined in โ€‹

src/ui/packages/display-module/bounds/src/UIBounds.ts:6

RectRender โ€‹

โ€ข Const RectRender: IRectRenderModule

Defined in โ€‹

src/ui/packages/display-module/render/src/RectRender.ts:6

UIRender โ€‹

โ€ข Const UIRender: IUIRenderModule

Defined in โ€‹

src/ui/packages/display-module/render/src/UIRender.ts:9

MyImage โ€‹

โ€ข Const MyImage: typeof Image = Image

Defined in โ€‹

src/ui/packages/display/src/Image.ts:31

MyDragEvent โ€‹

โ€ข Const MyDragEvent: typeof DragEvent = DragEvent

Defined in โ€‹

src/ui/packages/event/src/DragEvent.ts:118

Keyboard โ€‹

โ€ข Const Keyboard: Object

Type declaration โ€‹

NameType
isHoldSpaceKey() => boolean
isHold(code: IShortcutKeyCodes) => boolean
isHoldKeys(shortcutKeys: IShortcutKeysCheck | IShortcutKeys, e?: IUIEvent) => boolean
setDownCode(code: string) => void
setUpCode(code: string) => void

Defined in โ€‹

src/ui/packages/event/src/Keyboard.ts:6

PointerButton โ€‹

โ€ข Const PointerButton: Object

Type declaration โ€‹

NameType
LEFTnumber
RIGHTnumber
MIDDLEnumber
defaultLeft(event: IUIEvent) => void
left(event: IUIEvent) => boolean
right(event: IUIEvent) => boolean
middle(event: IUIEvent) => boolean

Defined in โ€‹

src/ui/packages/event/src/PointerButton.ts:4

MyPointerEvent โ€‹

โ€ข Const MyPointerEvent: typeof PointerEvent = PointerEvent

Defined in โ€‹

src/ui/packages/event/src/PointerEvent.ts:50

TextConvert โ€‹

โ€ข Const TextConvert: ITextConvertModule

Defined in โ€‹

src/ui/packages/external/src/index.ts:7

ColorConvert โ€‹

โ€ข Const ColorConvert: IColorConvertModule

Defined in โ€‹

src/ui/packages/external/src/index.ts:9

UnitConvert โ€‹

โ€ข Const UnitConvert: Object

Type declaration โ€‹

NameType
number(value: number | IUnitData, percentRefer?: number) => number

Defined in โ€‹

src/ui/packages/external/src/index.ts:13

PathArrow โ€‹

โ€ข Const PathArrow: IPathArrowModule

Defined in โ€‹

src/ui/packages/external/src/index.ts:20

Paint โ€‹

โ€ข Const Paint: IPaintModule

Defined in โ€‹

src/ui/packages/external/src/index.ts:23

PaintImage โ€‹

โ€ข Const PaintImage: IPaintImageModule

Defined in โ€‹

src/ui/packages/external/src/index.ts:25

PaintGradient โ€‹

โ€ข Const PaintGradient: IPaintGradientModule

Defined in โ€‹

src/ui/packages/external/src/index.ts:27

Effect โ€‹

โ€ข Const Effect: IEffectModule

Defined in โ€‹

src/ui/packages/external/src/index.ts:29

Filter โ€‹

โ€ข Const Filter: IFilterModule

Defined in โ€‹

src/ui/packages/external/src/index.ts:31

Export โ€‹

โ€ข Const Export: IExportModule

Defined in โ€‹

src/ui/packages/external/src/index.ts:35

State โ€‹

โ€ข Const State: IStateModule

Defined in โ€‹

src/ui/packages/external/src/index.ts:37

Transition โ€‹

โ€ข Const Transition: ITransitionModule

Defined in โ€‹

src/ui/packages/external/src/index.ts:42

InteractionHelper โ€‹

โ€ข Const InteractionHelper: Object

Type declaration โ€‹

NameType
getDragEventData(startPoint: IPointData, lastPoint: IPointData, event: IPointerEvent) => IDragEvent
getDropEventData(event: IPointerEvent, list: ILeafList, data: IObject) => IDropEvent
getSwipeDirection(angle: number) => string
getSwipeEventData(startPoint: IPointData, lastDragData: IDragEvent, event: IPointerEvent) => ISwipeEvent
getBase(e: IObject) => IUIEvent
pathHasEventType(path: ILeafList, type: string) => boolean
filterPathByEventType(path: ILeafList, type: string) => ILeafList
pathCanDrag(path: ILeafList) => boolean
pathHasOutside(path: ILeafList) => boolean

Defined in โ€‹

src/ui/packages/interaction/interaction/src/InteractionHelper.ts:7

Functions โ€‹

arrowType โ€‹

โ–ธ arrowType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/in/packages/arrow/src/decorator.ts:4

registerEditTool โ€‹

โ–ธ registerEditTool(): (target: IObject) => void

Returns โ€‹

fn

โ–ธ (target): void

Parameters โ€‹
NameType
targetIObject
Returns โ€‹

void

Defined in โ€‹

src/in/packages/editor/src/tool/EditToolCreator.ts:9

registerInnerEditor โ€‹

โ–ธ registerInnerEditor(): (target: IObject) => void

Returns โ€‹

fn

โ–ธ (target): void

Parameters โ€‹
NameType
targetIObject
Returns โ€‹

void

Defined in โ€‹

src/in/packages/editor/src/tool/EditToolCreator.ts:15

motionPathType โ€‹

โ–ธ motionPathType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/in/packages/motion-path/src/decorator.ts:4

scaleResize โ€‹

โ–ธ scaleResize(leaf, scaleX, scaleY): void

Parameters โ€‹

NameType
leafILeaf
scaleXnumber
scaleYnumber

Returns โ€‹

void

Defined in โ€‹

src/in/packages/resize/src/scaler.ts:10

scaleResizeFontSize โ€‹

โ–ธ scaleResizeFontSize(leaf, scaleX, scaleY, direction?): void

Parameters โ€‹

NameType
leafIText
scaleXnumber
scaleYnumber
direction?Direction9

Returns โ€‹

void

Defined in โ€‹

src/in/packages/resize/src/scaler.ts:20

scaleResizePath โ€‹

โ–ธ scaleResizePath(leaf, scaleX, scaleY): void

Parameters โ€‹

NameType
leafILeaf
scaleXnumber
scaleYnumber

Returns โ€‹

void

Defined in โ€‹

src/in/packages/resize/src/scaler.ts:58

scaleResizePoints โ€‹

โ–ธ scaleResizePoints(leaf, scaleX, scaleY): void

Parameters โ€‹

NameType
leafILine | IPolygon
scaleXnumber
scaleYnumber

Returns โ€‹

void

Defined in โ€‹

src/in/packages/resize/src/scaler.ts:63

scaleResizeGroup โ€‹

โ–ธ scaleResizeGroup(group, scaleX, scaleY): void

Parameters โ€‹

NameType
groupIBranch
scaleXnumber
scaleYnumber

Returns โ€‹

void

Defined in โ€‹

src/in/packages/resize/src/scaler.ts:70

stateType โ€‹

โ–ธ stateType(defaultValue?, styleName?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue
styleName?string

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/in/packages/state/src/decorator.ts:4

stateStyleType โ€‹

โ–ธ stateStyleType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/in/packages/state/src/decorator.ts:14

addViewport โ€‹

โ–ธ addViewport(leafer, mergeConfig?, custom?): void

Parameters โ€‹

NameType
leaferILeaferBase
mergeConfig?ILeaferConfig
custom?boolean

Returns โ€‹

void

Defined in โ€‹

src/in/packages/viewport/src/type/viewport.ts:6

addViewportConfig โ€‹

โ–ธ addViewportConfig(leafer, mergeConfig?): void

Parameters โ€‹

NameType
leaferILeaferBase
mergeConfig?ILeaferConfig

Returns โ€‹

void

Defined in โ€‹

src/in/packages/viewport/src/type/viewport.ts:22

canvasPatch โ€‹

โ–ธ canvasPatch(drawer): void

Parameters โ€‹

NameType
drawerIPathDrawer

Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/canvas/canvas/src/patch/index.ts:5

registerUI โ€‹

โ–ธ registerUI(): (target: IObject) => void

Returns โ€‹

fn

โ–ธ (target): void

Parameters โ€‹
NameType
targetIObject
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/class.ts:4

registerUIEvent โ€‹

โ–ธ registerUIEvent(): (target: IObject) => void

Returns โ€‹

fn

โ–ธ (target): void

Parameters โ€‹
NameType
targetIObject
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/class.ts:10

decorateLeafAttr โ€‹

โ–ธ decorateLeafAttr(defaultValue?, descriptorFn?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue
descriptorFn?ILeafAttrDescriptorFn

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:10

attr โ€‹

โ–ธ attr(partDescriptor?): ILeafAttrDescriptor

Parameters โ€‹

NameType
partDescriptor?ILeafAttrDescriptor

Returns โ€‹

ILeafAttrDescriptor

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:14

defineLeafAttr โ€‹

โ–ธ defineLeafAttr(target, key, defaultValue?, partDescriptor?): void

Parameters โ€‹

NameType
targetILeaf
keystring
defaultValue?IValue
partDescriptor?ILeafAttrDescriptor

Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:19

dataType โ€‹

โ–ธ dataType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:29

positionType โ€‹

โ–ธ positionType(defaultValue?, checkFiniteNumber?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue
checkFiniteNumber?boolean

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:33

autoLayoutType โ€‹

โ–ธ autoLayoutType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:41

scaleType โ€‹

โ–ธ scaleType(defaultValue?, checkFiniteNumber?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue
checkFiniteNumber?boolean

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:53

rotationType โ€‹

โ–ธ rotationType(defaultValue?, checkFiniteNumber?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue
checkFiniteNumber?boolean

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:62

boundsType โ€‹

โ–ธ boundsType(defaultValue?, checkFiniteNumber?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue
checkFiniteNumber?boolean

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:71

naturalBoundsType โ€‹

โ–ธ naturalBoundsType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:79

doBoundsType โ€‹

โ–ธ doBoundsType(leaf): void

Parameters โ€‹

NameType
leafILeaf

Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:87

pathInputType โ€‹

โ–ธ pathInputType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:92

pathType โ€‹

โ–ธ pathType(defaultValue?, checkFiniteNumber?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue
checkFiniteNumber?boolean

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:104

affectStrokeBoundsType โ€‹

โ–ธ affectStrokeBoundsType(defaultValue?, useStroke?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue
useStroke?boolean

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:107

doStrokeType โ€‹

โ–ธ doStrokeType(leaf): void

Parameters โ€‹

NameType
leafILeaf

Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:118

strokeType โ€‹

โ–ธ strokeType(defaultValue?, useStroke?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue
useStroke?boolean

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:123

affectRenderBoundsType โ€‹

โ–ธ affectRenderBoundsType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:125

surfaceType โ€‹

โ–ธ surfaceType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:134

opacityType โ€‹

โ–ธ opacityType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:142

visibleType โ€‹

โ–ธ visibleType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:151

sortType โ€‹

โ–ธ sortType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:182

maskType โ€‹

โ–ธ maskType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:193

eraserType โ€‹

โ–ธ eraserType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:204

hitType โ€‹

โ–ธ hitType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:212

cursorType โ€‹

โ–ธ cursorType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:224

dataProcessor โ€‹

โ–ธ dataProcessor(processor): (target: IObject, _key?: string) => void

Parameters โ€‹

NameType
processorIObject

Returns โ€‹

fn

โ–ธ (target, _key?): void

Parameters โ€‹
NameType
targetIObject
_key?string
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:236

layoutProcessor โ€‹

โ–ธ layoutProcessor(processor): (target: IObject, _key?: string) => void

Parameters โ€‹

NameType
processorIObject

Returns โ€‹

fn

โ–ธ (target, _key?): void

Parameters โ€‹
NameType
targetIObject
_key?string
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:244

defineDataProcessor โ€‹

โ–ธ defineDataProcessor(target, key, defaultValue?): void

Parameters โ€‹

NameType
targetILeaf
keystring
defaultValue?IValueFunction | IValue

Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/data.ts:261

defineKey โ€‹

โ–ธ defineKey<T>(target, key, descriptor, noConfigurable?): void

Type parameters โ€‹

Name
T

Parameters โ€‹

NameType
targetT
keystring
descriptorIObject & ThisType<T>
noConfigurable?boolean

Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/object.ts:4

getDescriptor โ€‹

โ–ธ getDescriptor(object, name): PropertyDescriptor

Parameters โ€‹

NameType
objectIObject
namestring

Returns โ€‹

PropertyDescriptor

Defined in โ€‹

src/leafer/packages/decorator/src/object.ts:9

createDescriptor โ€‹

โ–ธ createDescriptor(key, defaultValue?): Object

Parameters โ€‹

NameType
keystring
defaultValue?IValue

Returns โ€‹

Object

NameType
get() => any
set(value: IValue) => void

Defined in โ€‹

src/leafer/packages/decorator/src/object.ts:13

rewrite โ€‹

โ–ธ rewrite(method): (target: IObject, key: string) => void

Parameters โ€‹

NameType
methodIFunction

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetIObject
keystring
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/rewrite.ts:18

rewriteAble โ€‹

โ–ธ rewriteAble(): (_target: IObject) => void

Returns โ€‹

fn

โ–ธ (_target): void

Parameters โ€‹
NameType
_targetIObject
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/rewrite.ts:24

useModule โ€‹

โ–ธ useModule(module, exclude?): (target: IObject) => void

Parameters โ€‹

NameType
moduleIObject
exclude?string[]

Returns โ€‹

fn

โ–ธ (target): void

Parameters โ€‹
NameType
targetIObject
Returns โ€‹

void

Defined in โ€‹

src/leafer/packages/decorator/src/rewrite.ts:45

isUndefined โ€‹

โ–ธ isUndefined(value): boolean

Parameters โ€‹

NameType
valueany

Returns โ€‹

boolean

Defined in โ€‹

src/leafer/packages/display-module/data/src/data.ts:12

isNull โ€‹

โ–ธ isNull(value): boolean

Parameters โ€‹

NameType
valueany

Returns โ€‹

boolean

Defined in โ€‹

src/leafer/packages/display-module/data/src/data.ts:16

isString โ€‹

โ–ธ isString<T>(value): value is T

Type parameters โ€‹

NameType
Textends string

Parameters โ€‹

NameType
valueany

Returns โ€‹

value is T

Defined in โ€‹

src/leafer/packages/display-module/data/src/data.ts:20

isFinite โ€‹

โ–ธ isFinite(number): boolean

Returns true if passed value is finite. Unlike the global isFinite, Number.isFinite doesn't forcibly convert the parameter to a number. Only finite values of the type number, result in true.

Parameters โ€‹

NameTypeDescription
numberunknownA numeric value.

Returns โ€‹

boolean

Defined in โ€‹

src/leafer/packages/display-module/data/src/data.ts:24

isNumber โ€‹

โ–ธ isNumber<T>(value): value is T

Type parameters โ€‹

NameType
Textends number

Parameters โ€‹

NameType
valueany

Returns โ€‹

value is T

Defined in โ€‹

src/leafer/packages/display-module/data/src/data.ts:26

tryToNumber โ€‹

โ–ธ tryToNumber(value): number

Parameters โ€‹

NameType
valueany

Returns โ€‹

number

Defined in โ€‹

src/leafer/packages/display-module/data/src/data.ts:32

isArray โ€‹

โ–ธ isArray(arg): arg is any[]

Parameters โ€‹

NameType
argany

Returns โ€‹

arg is any[]

Defined in โ€‹

src/leafer/packages/display-module/data/src/data.ts:36

isObject โ€‹

โ–ธ isObject<T>(value): value is T

Type parameters โ€‹

NameType
Textends object

Parameters โ€‹

NameType
valueany

Returns โ€‹

value is T

Defined in โ€‹

src/leafer/packages/display-module/data/src/data.ts:38

isData โ€‹

โ–ธ isData<T>(value): value is T

Type parameters โ€‹

NameType
Textends object

Parameters โ€‹

NameType
valueany

Returns โ€‹

value is T

Defined in โ€‹

src/leafer/packages/display-module/data/src/data.ts:42

isEmptyData โ€‹

โ–ธ isEmptyData(value): boolean

Parameters โ€‹

NameType
valueany

Returns โ€‹

boolean

Defined in โ€‹

src/leafer/packages/display-module/data/src/data.ts:46

getPointData โ€‹

โ–ธ getPointData(): IPointData

Returns โ€‹

IPointData

Defined in โ€‹

src/leafer/packages/math/src/MathHelper.ts:100

getBoundsData โ€‹

โ–ธ getBoundsData(): IBoundsData

Returns โ€‹

IBoundsData

Defined in โ€‹

src/leafer/packages/math/src/MathHelper.ts:101

effectType โ€‹

โ–ธ effectType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/ui/packages/decorator/src/data.ts:7

resizeType โ€‹

โ–ธ resizeType(defaultValue?): (target: ILeaf, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetILeaf
keystring
Returns โ€‹

void

Defined in โ€‹

src/ui/packages/decorator/src/data.ts:17

zoomLayerType โ€‹

โ–ธ zoomLayerType(): (target: IUI, key: string) => void

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetIUI
keystring
Returns โ€‹

void

Defined in โ€‹

src/ui/packages/decorator/src/data.ts:27

createAttr โ€‹

โ–ธ createAttr(defaultValue?): (target: IUI, key: string) => void

Parameters โ€‹

NameType
defaultValue?IValue

Returns โ€‹

fn

โ–ธ (target, key): void

Parameters โ€‹
NameType
targetIUI
keystring
Returns โ€‹

void

Defined in โ€‹

src/ui/packages/decorator/src/data.ts:41

useCanvas โ€‹

โ–ธ useCanvas(_canvasType, _power?): void

Parameters โ€‹

NameType
_canvasTypeICanvasType
_power?IObject

Returns โ€‹

void

Defined in โ€‹

src/ui/packages/platform/web/src/core.ts:21

Released under the MIT License.

Copyright ยฉ 2023-2025 Chao (Leafer) Wan