API
API 文档 通过 TypeDoc 自动生成，用于帮助用户了解内部数据结构，可定位到源代码学习。
The API documentation is automatically generated by TypeDoc to help users understand internal data structures and locate source code for learning.
Note
The API documentation contains some properties and methods that are not publicly exposed. Please use them with caution.
The Guide Documentation covers the main API features, with detailed comments and full accessibility.
Table of contents
Classes
- Animate
- AnimateEvent
- AnimateList
- Arrow
- ArrowData
- EllipseBox
- ImageBox
- PathBox
- PolygonBox
- StarBox
- EllipseBoxData
- ImageBoxData
- PathBoxData
- PolygonBoxData
- StarBoxData
- Editor
- EditBox
- EditPoint
- EditSelect
- SelectArea
- Stroker
- EditorEvent
- EditorGroupEvent
- EditorMoveEvent
- EditorRotateEvent
- EditorScaleEvent
- EditorSkewEvent
- InnerEditorEvent
- EditTool
- InnerEditor
- LineEditTool
- TransformTool
- Finder
- Flow
- HTMLText
- HTMLTextData
- Robot
- RobotData
- ScrollBar
- Scroller
- TextEditor
- Transformer
- LeaferCanvas
- CanvasManager
- LeaferCanvasBase
- Debug
- LeafData
- LeafLayout
- Branch
- Leaf
- BoundsEvent
- ChildEvent
- Event
- Eventer
- ImageEvent
- LayoutEvent
- LeaferEvent
- PropertyEvent
- RenderEvent
- ResizeEvent
- WatchEvent
- LeaferFilm
- LeaferImage
- LeaferVideo
- LeafLevelList
- LeafList
- AutoBounds
- Bounds
- Matrix
- Point
- Layouter
- Renderer
- Picker
- Selector
- Watcher
- PathCreator
- TaskItem
- TaskProcessor
- App
- BoxData
- CanvasData
- EllipseData
- FrameData
- GroupData
- ImageData
- LeaferData
- LineData
- PathData
- PenData
- PolygonData
- RectData
- StarData
- TextData
- UIData
- Box
- Canvas
- Ellipse
- Frame
- Group
- Image
- Leafer
- Line
- Path
- Pen
- Polygon
- Rect
- Star
- Text
- UI
- DragEvent
- DropEvent
- KeyEvent
- MoveEvent
- PointerEvent
- RotateEvent
- SwipeEvent
- TouchEvent
- UIEvent
- ZoomEvent
- HitCanvasManager
- Interaction
- Cursor
- Dragger
- InteractionBase
Interfaces
- IEditBox
- IEditSelect
- IEditor
- IEditTool
- IInnerEditor
- IEditorEvent
- IInnerEditorEvent
- IEditorGroupEvent
- IEditorMoveEvent
- IEditorScaleEvent
- IEditorRotateEvent
- IEditorSkewEvent
- ISelectArea
- ISimulateElement
- IStroker
- IFlowWrapDrawData
- IFlowDrawData
- IGapBoundsData
- IFlowAlignToAxisAlignMap
- IFlowParseData
- IHTMLTextData
- IHTMLTextInputData
- IScrollBarConfig
- IScrollBar
- IAnimateOptions
- IAnimateEasingFunction
- ICustomEasingFunction
- ICubicBezierEasing
- IStepsEasing
- IAnimateEvents
- IAnimateEventFunction
- IAppBase
- ILeaferConfig
- ILeaferAttrData
- IZoomOptions
- ILeaferBase
- ILeaferTypeCreator
- ILeaferTypeFunction
- ILeaferTypeList
- ICreator
- IUICreator
- IPath2D
- ICanvasContext2D
- ITextMetrics
- ICanvasManager
- IHitCanvasManager
- ILeaferCanvasConfig
- ICanvasStrokeOptions
- ICanvasCacheOptions
- ICanvasAttr
- ILeaferCanvas
- IHitCanvas
- IWindingRuleData
- IBlobFunction
- ISkiaCanvas
- ISkiaCanvasExportConfig
- ISkiaNAPICanvas
- IControl
- IObject
- IBooleanMap
- INumberMap
- IStringMap
- IFunctionMap
- IPointDataMap
- IDataTypeHandle
- IDataProcessor
- ILeafDataOptions
- ILeafData
- ILeafMap
- ILeafArrayMap
- ILeafList
- ILeafLevelList
- IBranch
- IPointGap
- IFlowAxisAlign
- IRangeSize
- IInterlace
- IUnitData
- IPercentData
- IConstraint
- IImageCursor
- IFilter
- ILeafAttrData
- ILeafInputData
- ILeafComputedData
- IArrowPathData
- ILeaf
- ILeafAttrDescriptorFn
- ICachedLeaf
- ILeafComplexCachedData
- IZoomView
- IBranchRender
- ILeafBounds
- ILeafDataProxy
- ILeafEventer
- ILeafHit
- ILeafMatrix
- ILeafRender
- IEvent
- IEventTarget
- ILeaferEvent
- IRenderEvent
- IAnimateEvent
- IChildEvent
- IBoundsEvent
- IResizeEvent
- IResizeEventListener
- IUpdateEvent
- IPropertyEvent
- ILayoutEvent
- IWatchEvent
- IMultiTouchData
- IKeepTouchData
- IEventListenerOptions
- IEventListenerItem
- IEventListenerMap
- IEventParamsMap
- IEventListenerId
- IEventer
- IProgressData
- IProgressFunction
- IUIEvent
- IPointerEvent
- ITouchEvent
- IDragEvent
- IDropEvent
- IRotateEvent
- IZoomEvent
- IMoveEvent
- IWheelEvent
- ISwipeEvent
- IKeyEvent
- IShortcutKeysCheck
- IImageEvent
- IExportOptions
- IJSONOptions
- IExportResult
- IExportResultFunction
- IExportOnCanvasFunction
- IResource
- IFunction
- INumberFunction
- IStringFunction
- IObjectFunction
- IValueFunction
- IPointDataFunction
- IAttrDecorator
- IImageManager
- ILeaferFilmConfig
- ILeaferFilm
- IFilmDecoder
- IFilmFrame
- IFilmOptions
- IFilmPlayOptions
- ILeaferImageConfig
- IImageLOD
- IImageTileLOD
- ILeaferImageOnLoaded
- ILeaferImageOnError
- ILeaferImageCacheCanvas
- ILeaferImagePatternPaint
- ILeaferImageSliceData
- ILeaferImageSlice
- ILeaferImageLevel
- ILeaferImage
- ILeaferImageMap
- ILeaferVideoConfig
- ILeaferVideo
- ICursorTypeMap
- ICursorRotate
- ICursorRotateMap
- IInteraction
- IInteractionCanvas
- IInteractionConfig
- IZoomConfig
- IMoveConfig
- IWheelConfig
- IPointerConfig
- ITouchConfig
- IMultiTouchConfig
- ISingleGestureConfig
- ICursorConfig
- ITransformer
- ILeafLayout
- ILayoutChangedData
- ILayoutBlockData
- IPartLayoutConfig
- ILayouterConfig
- ILayouter
- IPointData
- IOptionPointData
- IUnitPointData
- IFromToData
- IRotationPointData
- IScrollPointData
- IClientPointData
- IPoint
- IRadiusPointData
- ISizeData
- IOptionSizeData
- ISize
- IScreenSizeData
- IBoundsData
- IOffsetBoundsData
- IBoundsDataWithOptionRotation
- IBoundsDataFn
- IBounds
- ITwoPointBoundsData
- IAutoBoxData
- IAutoBoundsData
- IAutoBounds
- IMatrixData
- IScaleData
- IScaleRotationData
- ISkewData
- ILayoutData
- ILayoutBoundsData
- IMatrix
- IMatrixWithBoundsData
- IMatrixWithScaleData
- IMatrixWithOptionScaleData
- IMatrixWithOptionHalfData
- IMatrixWithBoundsScaleData
- IMatrixWithLayoutData
- MoveToCommandObject
- LineToCommandObject
- BezierCurveToCommandObject
- QuadraticCurveToCommandObject
- IPathCommandNodeBase
- MoveToCommandNode
- LineToCommandNode
- BezierCurveToCommandNode
- ClosePathCommandNode
- IPathNodeBase
- IMotionPathData
- IPathDrawer
- IPathCreator
- IPlatform
- IMiniappSelect
- IMiniappSizeView
- IMiniapp
- IPlugin
- IRenderOptions
- IRendererConfig
- IRenderer
- IPickResult
- IPickOptions
- IPickBottom
- ISelectorConfig
- IFindCondition
- IFindMethod
- ISelectorProxy
- ISelector
- IPicker
- IFinder
- ITaskProcessorConfig
- ITaskProcessor
- ITaskItem
- ITaskOptions
- IWatchEventData
- IWatcherConfig
- IWatcher
- IStyleAnimation
- IKeyframesAnimation
- IAnimateKeyframe
- IComputedKeyframe
- IAnimate
- IAnimateList
- ICachedShape
- IStrokeAttrData
- IStrokeInputData
- IStrokeStyle
- IStrokeComputedData
- IStrokeComputedStyle
- ITextStyleAttrData
- ITextStyleInputData
- ITextStyleComputedData
- IEffectAttrData
- IEffectInputData
- IEffectComputedData
- IScrollConfig
- IScroller
- ILine
- ILineData
- ILineInputData
- IArrow
- IArrowData
- IArrowInputData
- ILinker
- ILinkerPointData
- ILinkerPointOptions
- ILinkerComputedPointData
- ILinkerData
- ILinkerInputData
- IFlow
- IFlowData
- IFlowInputData
- IRect
- IRectData
- IRectInputData
- IEllipse
- IEllipseData
- IEllipseInputData
- IPolygon
- IPolygonData
- IPolygonInputData
- IStar
- IStarData
- IStarInputData
- IPath
- IPathData
- IPathInputData
- IPen
- IPenData
- IPenInputData
- IText
- IBackgroundBoxStyle
- ITextData
- ITextInputData
- ITextRowData
- ITextWordData
- ITextCharData
- ITextDrawData
- IImage
- IImageData
- IImageInputData
- ICanvas
- ICanvasData
- ICanvasInputData
- IFilm
- IFilmData
- IFilmInputData
- IVideo
- IVideoData
- IVideoInputData
- IRobot
- IRobotActions
- IRobotAnimation
- IRobotKeyframe
- IRobotComputedKeyframe
- IRobotData
- IRobotInputData
- ILeaferData
- ILeaferInputData
- IAppData
- IAppInputData
- IFrame
- IFrameData
- IFrameInputData
- IBox
- IBoxData
- IBoxInputData
- IEllipseBox
- IEllipseBoxData
- IEllipseBoxInputData
- IPolygonBox
- IPolygonBoxData
- IPolygonBoxInputData
- IStarBox
- IStarBoxData
- IStarBoxInputData
- IPathBox
- IPathBoxData
- IPathBoxInputData
- IImageBox
- IImageBoxData
- IImageBoxInputData
- IGroup
- IGroupData
- IGroupInputData
- IUI
- IStateStyle
- IStates
- IFindUIMethod
- IUIData
- IUIBaseInputData
- IUIInputData
- IUIJSONData
- IApp
- IAppConfig
- IAppForEachFunction
- ILeafer
- IEditorBase
- ITransformTool
- IEditorConfig
- IEditorSelectData
- IEditorEditOuterData
- IEditorMoveData
- IEditorScaleData
- IEditorRotationData
- IEditorSkewData
- IEditorBeforeSelect
- IEditorBeforeEditOuter
- IEditorBeforeEditInner
- IEditorBeforeMove
- IEditorBeforeScale
- IEditorBeforeRotate
- IEditorBeforeSkew
- IEditorOnCopy
- IEditPointInputData
- IEditPoint
- IEditBoxBase
- IEditorDragStartData
- IEditorConfigFunction
- IEditToolFunction
- IColorConvertModule
- IEffectModule
- IExportModule
- IFilterModule
- IFilterProcessor
- IFilterFunction
- IPaintModule
- IPaintImageModule
- IPaintGradientModule
- IPathArrowModule
- IStateModule
- ITextConvertModule
- ITransitionModule
- ITransitionMap
- ITransitionFunction
- ILeafPaint
- ILeafPaintPatternData
- ILeafStrokePaint
- ILeafShadowEffect
- IPaintBase
- ISolidPaint
- IStrokeSolidPaint
- IRGB
- IRGBA
- IGradientPaint
- IStrokeGradientPaint
- IColorStop
- IImagePaint
- IStrokeImagePaint
- IImageFilter
- IArrowTypeData
- IPathDataArrowMap
- IPathDataArrow
- IPathDataArrowOffset
- ITextDecorationData
- IVectorPath
- IShadowEffect
- IBlurEffect
- IGrayscaleEffect
- IEffect
Type Aliases
- IInnerEditorMode
- IScrollBarTheme
- ITransition
- IAnimateEasing
- IAnimateEasingName
- IAnimateEnding
- ILeaferType
- ILeaferMode
- IZoomType
- IWindingRule
- ICanvasPattern
- ICanvasContext2DSettings
- IHitCanvasConfig
- ILeaferCanvasView
- ICanvasSizeAttr
- IBlob
- ICanvasType
- INumber
- IBoolean
- IString
- IValue
- ITimer
- IPathString
- IFourNumber
- ILeafListItemCallback
- ISide
- IAxis
- IAxisReverse
- IFlowType
- IFlowBoxType
- IGap
- IAxisAlign
- IFlowWrap
- IAutoSize
- IConstraintType
- IScaleFixed
- IHitType
- IMaskType
- IEraserType
- IBlendMode
- IEditSize
- IDragBoundsType
- IDirection
- IDirection4
- IAlign
- IBaseLineAlign
- IFlowAlign
- IAround
- ICursorType
- IStateStyleType
- ILeafAttrDescriptor
- IBranchRenderModule
- ILeafBoundsModule
- ILeafDataProxyModule
- ILeafEventerModule
- ILeafHitModule
- ILeafMatrixModule
- ILeafRenderModule
- IGestureType
- IEventListener
- IEventOption
- IEventParams
- InnerId
- PointerType
- IShortcutKeys
- IShortcutKeyCodes
- IKeyCodes
- IExportImageType
- IExportFileType
- IFilmFileType
- IVideoFileType
- IMultimediaType
- IResponseType
- ILocationType
- IBoundsType
- ILayoutAttr
- MCommandData
- HCommandData
- VCommandData
- LCommandData
- CCommandData
- SCommandData
- QCommandData
- TCommandData
- ZCommandData
- ACommandData
- RectCommandData
- RoundRectCommandData
- EllipseCommandData
- ArcCommandData
- ArcToCommandData
- CanvasPathCommand
- IPathCommandData
- IPathCommandObject
- IPathCommandNode
- PathNodeHandleName
- IImageCrossOrigin
- IAnswer
- IAnimation
- IAnimateType
- IKeyframe
- IKeyframeId
- IScrollTheme
- ILinkerPointType
- IRobotActionName
- IStateName
- IUITag
- IEditorEditInnerData
- IEditPointType
- IUIBoundsModule
- IUIHitModule
- IUIRenderModule
- IRectRenderModule
- IImageRenderModule
- ITextRenderModule
- IGroupRenderModule
- IFrameRenderModule
- ILeafPaintColor
- ILeafFill
- IPercent
- IColorString
- ICornerRadiusString
- IStrokeWidthString
- IDashPatternString
- IPaintString
- IShadowString
- IPaint
- IStrokePaint
- IFill
- IStroke
- IPaintAttr
- IPaintType
- IGradientType
- IColor
- IImageFilterType
- IImageFilters
- IImagePaintMode
- IRepeat
- IStrokeAlign
- IStrokeCap
- IStrokeJoin
- IArrowType
- IArrowStyle
- ITextAlign
- IVerticalAlign
- ITextCase
- IFontWeight
- IFontWeightNumer
- IFontWeightString
- ITextDecoration
- ITextDecorationType
- ITextWrap
- IWritingMode
- IOverflow
- ITextOverflow
Variables
- AnimateEasing
- PathArrowModule
- PathMatrixHelper
- EditDataHelper
- EditSelectHelper
- EditorHelper
- EditToolCreator
- HighBezierHelper
- HighCurveHelper
- PathScaler
- LeaferTypeCreator
- MultiTouchHelper
- WheelEventHelper
- canvasSizeAttrs
- version
- Plugin
- Run
- DataHelper
- emptyData
- BranchRender
- LeafBounds
- LeafDataProxy
- LeafEventer
- LeafMatrix
- LeafRender
- BranchHelper
- LeafBoundsHelper
- LeafHelper
- WaitHelper
- leaferTransformAttrMap
- extraPropertyEventMap
- FileHelper
- Resource
- ImageManager
- AlignHelper
- AroundHelper
- tempBounds
- BoundsHelper
- FourNumberHelper
- IncrementId
- MathHelper
- OneRadian
- PI2
- PI_2
- tempMatrix
- MatrixHelper
- tempPoint
- PointHelper
- StringNumberMap
- TwoPointBoundsHelper
- UnitConvertHelper
- BezierHelper
- EllipseHelper
- PathBounds
- PathCommandDataHelper
- PathCommandMap
- NeedConvertToCanvasCommandMap
- PathNumberCommandMap
- PathNumberCommandLengthMap
- PathCommandNodeHelper
- PathConvert
- PathCorner
- PathDrawer
- PathHelper
- RectHelper
- pen
- Platform
- Creator
- EventCreator
- UICreator
- UIBounds
- RectRender
- UIRender
- MyImage
- DragBoundsHelper
- MyDragEvent
- Keyboard
- PointerButton
- MyPointerEvent
- MyTouchEvent
- TextConvert
- ColorConvert
- UnitConvert
- PathArrow
- Paint
- PaintImage
- PaintGradient
- Effect
- Filter
- Export
- State
- Transition
- InteractionHelper
Functions
- arrowType
- registerEditTool
- registerInnerEditor
- motionPathType
- scaleResize
- scaleResizeFontSize
- scaleResizePath
- scaleResizePoints
- scaleResizeGroup
- stateType
- stateStyleType
- addViewport
- addViewportConfig
- canvasPatch
- useCanvas
- registerUI
- registerUIEvent
- decorateLeafAttr
- attr
- defineLeafAttr
- dataType
- positionType
- scrollType
- autoLayoutType
- scaleType
- rotationType
- boundsType
- naturalBoundsType
- doBoundsType
- pathInputType
- pathType
- affectStrokeBoundsType
- doStrokeType
- strokeType
- affectRenderBoundsType
- surfaceType
- dimType
- opacityType
- visibleType
- sortType
- maskType
- eraserType
- hitType
- cursorType
- dataProcessor
- layoutProcessor
- defineDataProcessor
- defineKey
- getDescriptor
- createDescriptor
- rewrite
- rewriteAble
- useModule
- isUndefined
- isNull
- isString
- isFinite
- isNumber
- tryToNumber
- isArray
- isObject
- isData
- isEmptyData
- getPointData
- getBoundsData
- path
- effectType
- resizeType
- zoomLayerType
- createAttr