Class: Text

Hierarchy

• UI

  ↳ Text

Implements

• IText

Table of contents

Constructors

• constructor

Properties

• innerId
• __layout
• __world
• __local
• __nowWorld
• __cameraWorld
• __worldOpacity
• __level
• __tempNumber
• __hasAutoLayout
• __hasMask
• __hasEraser
• __hitCanvas
• __captureMap
• __bubbleMap
• __parentWait
• __leaferWait
• noBounds
• destroyed
• __
• width
• height
• resizeFontSize
• fill
• strokeAlign
• hitFill
• text
• fontFamily
• fontSize
• fontWeight
• italic
• textCase
• textDecoration
• letterSpacing
• lineHeight
• paraIndent
• paraSpacing
• textAlign
• verticalAlign
• textWrap
• textOverflow
• proxyData
• __proxyData
• leafer
• parent
• zoomLayer
• children
• id
• name
• className
• blendMode
• opacity
• visible
• selected
• disabled
• locked
• zIndex
• mask
• eraser
• x
• y
• scaleX
• scaleY
• rotation
• skewX
• skewY
• offsetX
• offsetY
• scrollX
• scrollY
• origin
• around
• lazy
• pixelRatio
• path
• windingRule
• closed
• flow
• padding
• gap
• flowAlign
• flowWrap
• itemBox
• inFlow
• autoWidth
• autoHeight
• lockRatio
• autoBox
• widthRange
• heightRange
• draggable
• dragBounds
• editable
• hittable
• hitStroke
• hitBox
• hitChildren
• hitSelf
• hitRadius
• cursor
• stroke
• strokeWidth
• strokeWidthFixed
• strokeCap
• strokeJoin
• dashPattern
• dashOffset
• miterLimit
• startArrow
• endArrow
• cornerRadius
• cornerSmoothing
• shadow
• innerShadow
• blur
• backgroundBlur
• grayscale
• normalStyle
• hoverStyle
• pressStyle
• focusStyle
• selectedStyle
• disabledStyle
• data

Accessors

• tag
• innerName
• __DataProcessor
• __LayoutProcessor
• isLeafer
• isBranch
• isBranchLeaf
• __localMatrix
• __localBoxBounds
• worldTransform
• localTransform
• boxBounds
• renderBounds
• worldBoxBounds
• worldStrokeBounds
• worldRenderBounds
• worldOpacity
• __worldFlipped
• __onlyHitMask
• __ignoreHitWorld
• __inLazyBounds
• pathInputed
• event
• __tag
• editInner
• textDrawData
• app
• isFrame
• scale
• pen
• editConfig
• editOuter

Methods

• resetCustom
• waitParent
• waitLeafer
• nextRender
• removeNextRender
• __bindLeafer
• setAttr
• getAttr
• getComputedAttr
• toJSON
• toString
• toSVG
• __SVG
• toHTML
• __setAttr
• __getAttr
• setProxyAttr
• getProxyAttr
• focus
• updateLayout
• forceUpdate
• forceRender
• __updateWorldMatrix
• __updateLocalMatrix
• __updateWorldBounds
• __updateLocalBounds
• __updateLocalBoxBounds
• __updateLocalStrokeBounds
• __updateLocalRenderBounds
• __updateContentBounds
• __updateStrokeBounds
• __updateAutoLayout
• __updateFlowLayout
• __updateNaturalSize
• __updateStrokeSpread
• __updateEraser
• __renderEraser
• __updateMask
• __renderMask
• __getNowWorld
• getTransform
• getBounds
• getLayoutBounds
• getLayoutPoints
• getWorldBounds
• worldToLocal
• localToWorld
• worldToInner
• innerToWorld
• getInnerPoint
• getInnerPointByLocal
• getLocalPoint
• getLocalPointByInner
• getWorldPoint
• getWorldPointByLocal
• getPagePoint
• getWorldPointByPage
• setTransform
• transform
• move
• moveInner
• scaleOf
• rotateOf
• skewOf
• transformWorld
• moveWorld
• scaleOfWorld
• rotateOfWorld
• skewOfWorld
• flip
• scaleResize
• __scaleResize
• resizeWidth
• resizeHeight
• __hitWorld
• __hit
• __hitFill
• __hitStroke
• __hitPixel
• __updateHitCanvas
• __render
• __drawFast
• __draw
• __clip
• __renderShape
• __updateWorldOpacity
• __updateChange
• __updatePath
• __updateSortChildren
• add
• remove
• dropTo
• on
• off
• on_
• off_
• once
• emit
• emitEvent
• hasEvent
• changeAttr
• addAttr
• __drawHitPath
• __drawPathByData
• __drawRenderPath
• __updateTextDrawData
• __updateBoxBounds
• __updateRenderSpread
• __updateRenderBounds
• reset
• set
• get
• createProxyData
• find
• findTag
• findOne
• findId
• getPath
• getPathString
• load
• __onUpdateSize
• __updateRenderPath
• __drawPath
• __drawPathByBox
• export
• clone
• one
• registerUI
• registerData
• setEditConfig
• setEditOuter
• setEditInner
• destroy

Constructors

constructor

• new Text(data?): Text

Parameters

Name	Type
data?	ITextInputData

Returns

Text

Overrides

UI.constructor

Defined in

ui/packages/display/src/Text.ts:94

Properties

innerId

• Readonly innerId: number

Implementation of

IText.innerId

Inherited from

UI.innerId

Defined in

leafer/packages/display/src/Leaf.ts:29

---

__layout

• __layout: ILeafLayout

Implementation of

IText.__layout

Inherited from

UI.__layout

Defined in

leafer/packages/display/src/Leaf.ts:43

---

__world

• __world: IMatrixWithBoundsScaleData

Implementation of

IText.__world

Inherited from

UI.__world

Defined in

leafer/packages/display/src/Leaf.ts:45

---

__local

• Optional __local: IMatrixWithBoundsData

Implementation of

IText.__local

Inherited from

UI.__local

Defined in

leafer/packages/display/src/Leaf.ts:46

---

__nowWorld

• Optional __nowWorld: IMatrixWithBoundsScaleData

Implementation of

IText.__nowWorld

Inherited from

UI.__nowWorld

Defined in

leafer/packages/display/src/Leaf.ts:48

---

__cameraWorld

• Optional __cameraWorld: IMatrixWithBoundsScaleData

Implementation of

IText.__cameraWorld

Inherited from

UI.__cameraWorld

Defined in

leafer/packages/display/src/Leaf.ts:49

---

__worldOpacity

• __worldOpacity: number

Implementation of

IText.__worldOpacity

Inherited from

UI.__worldOpacity

Defined in

leafer/packages/display/src/Leaf.ts:54

---

__level

• __level: number

Implementation of

IText.__level

Inherited from

UI.__level

Defined in

leafer/packages/display/src/Leaf.ts:70

---

__tempNumber

• __tempNumber: number

Implementation of

IText.__tempNumber

Inherited from

UI.__tempNumber

Defined in

leafer/packages/display/src/Leaf.ts:71

---

__hasAutoLayout

• Optional __hasAutoLayout: boolean

Implementation of

IText.__hasAutoLayout

Inherited from

UI.__hasAutoLayout

Defined in

leafer/packages/display/src/Leaf.ts:75

---

__hasMask

• Optional __hasMask: boolean

Implementation of

IText.__hasMask

Inherited from

UI.__hasMask

Defined in

leafer/packages/display/src/Leaf.ts:76

---

__hasEraser

• Optional __hasEraser: boolean

Implementation of

IText.__hasEraser

Inherited from

UI.__hasEraser

Defined in

leafer/packages/display/src/Leaf.ts:77

---

__hitCanvas

• Optional __hitCanvas: IHitCanvas

Implementation of

IText.__hitCanvas

Inherited from

UI.__hitCanvas

Defined in

leafer/packages/display/src/Leaf.ts:78

---

__captureMap

• Optional __captureMap: IEventListenerMap

Implementation of

IText.__captureMap

Inherited from

UI.__captureMap

Defined in

leafer/packages/display/src/Leaf.ts:89

---

__bubbleMap

• Optional __bubbleMap: IEventListenerMap

Implementation of

IText.__bubbleMap

Inherited from

UI.__bubbleMap

Defined in

leafer/packages/display/src/Leaf.ts:90

---

__parentWait

• Optional __parentWait: IFunction[]

Implementation of

IText.__parentWait

Inherited from

UI.__parentWait

Defined in

leafer/packages/display/src/Leaf.ts:92

---

__leaferWait

• Optional __leaferWait: IFunction[]

Implementation of

IText.__leaferWait

Inherited from

UI.__leaferWait

Defined in

leafer/packages/display/src/Leaf.ts:93

---

noBounds

• Optional noBounds: boolean

Implementation of

IText.noBounds

Inherited from

UI.noBounds

Defined in

leafer/packages/display/src/Leaf.ts:99

---

destroyed

• destroyed: boolean

Implementation of

IText.destroyed

Inherited from

UI.destroyed

Defined in

leafer/packages/display/src/Leaf.ts:101

---

__

• __: ITextData

Implementation of

IText.__

Overrides

UI.__

Defined in

ui/packages/display/src/Text.ts:20

---

width

• Optional width: number

Implementation of

IText.width

Overrides

UI.width

Defined in

ui/packages/display/src/Text.ts:24

---

height

• Optional height: number

Implementation of

IText.height

Overrides

UI.height

Defined in

ui/packages/display/src/Text.ts:27

---

resizeFontSize

• Optional resizeFontSize: boolean

Implementation of

IText.resizeFontSize

Defined in

ui/packages/display/src/Text.ts:30

---

fill

• Optional fill: IFill

Implementation of

IText.fill

Overrides

UI.fill

Defined in

ui/packages/display/src/Text.ts:33

---

strokeAlign

• Optional strokeAlign: IStrokeAlign

Implementation of

IText.strokeAlign

Overrides

UI.strokeAlign

Defined in

ui/packages/display/src/Text.ts:36

---

hitFill

• Optional hitFill: IHitType

Implementation of

IText.hitFill

Overrides

UI.hitFill

Defined in

ui/packages/display/src/Text.ts:39

---

text

• Optional text: string

Implementation of

IText.text

Defined in

ui/packages/display/src/Text.ts:42

---

fontFamily

• Optional fontFamily: string

Implementation of

IText.fontFamily

Defined in

ui/packages/display/src/Text.ts:45

---

fontSize

• Optional fontSize: number

Implementation of

IText.fontSize

Defined in

ui/packages/display/src/Text.ts:48

---

fontWeight

• Optional fontWeight: IFontWeight

Implementation of

IText.fontWeight

Defined in

ui/packages/display/src/Text.ts:51

---

italic

• Optional italic: boolean

Implementation of

IText.italic

Defined in

ui/packages/display/src/Text.ts:54

---

textCase

• Optional textCase: ITextCase

Implementation of

IText.textCase

Defined in

ui/packages/display/src/Text.ts:57

---

textDecoration

• Optional textDecoration: ITextDecoration

Implementation of

IText.textDecoration

Defined in

ui/packages/display/src/Text.ts:60

---

letterSpacing

• Optional letterSpacing: number | IUnitData

Implementation of

IText.letterSpacing

Defined in

ui/packages/display/src/Text.ts:63

---

lineHeight

• Optional lineHeight: number | IUnitData

Implementation of

IText.lineHeight

Defined in

ui/packages/display/src/Text.ts:66

---

paraIndent

• Optional paraIndent: number

Implementation of

IText.paraIndent

Defined in

ui/packages/display/src/Text.ts:69

---

paraSpacing

• Optional paraSpacing: number

Implementation of

IText.paraSpacing

Defined in

ui/packages/display/src/Text.ts:72

---

textAlign

• Optional textAlign: ITextAlign

Implementation of

IText.textAlign

Defined in

ui/packages/display/src/Text.ts:75

---

verticalAlign

• Optional verticalAlign: IVerticalAlign

Implementation of

IText.verticalAlign

Defined in

ui/packages/display/src/Text.ts:78

---

textWrap

• Optional textWrap: ITextWrap

Implementation of

IText.textWrap

Defined in

ui/packages/display/src/Text.ts:81

---

textOverflow

• Optional textOverflow: string

Implementation of

IText.textOverflow

Defined in

ui/packages/display/src/Text.ts:84

---

proxyData

• Optional proxyData: IUIInputData

Implementation of

IText.proxyData

Inherited from

UI.proxyData

Defined in

ui/packages/display/src/UI.ts:21

---

__proxyData

• Optional __proxyData: IUIInputData

Implementation of

IText.__proxyData

Inherited from

UI.__proxyData

Defined in

ui/packages/display/src/UI.ts:22

---

leafer

• Optional leafer: ILeafer

Implementation of

IText.leafer

Inherited from

UI.leafer

Defined in

ui/packages/display/src/UI.ts:26

---

parent

• Optional parent: IGroup

Implementation of

IText.parent

Inherited from

UI.parent

Defined in

ui/packages/display/src/UI.ts:27

---

zoomLayer

• zoomLayer: IGroup

Implementation of

IText.zoomLayer

Inherited from

UI.zoomLayer

Defined in

ui/packages/display/src/UI.ts:30

---

children

• Optional children: IUI[]

Implementation of

IText.children

Inherited from

UI.children

Defined in

ui/packages/display/src/UI.ts:34

---

id

• Optional id: string

Implementation of

IText.id

Inherited from

UI.id

Defined in

ui/packages/display/src/UI.ts:40

---

name

• Optional name: string

Implementation of

IText.name

Inherited from

UI.name

Defined in

ui/packages/display/src/UI.ts:43

---

className

• Optional className: string

Implementation of

IText.className

Inherited from

UI.className

Defined in

ui/packages/display/src/UI.ts:46

---

blendMode

• Optional blendMode: IBlendMode

Implementation of

IText.blendMode

Inherited from

UI.blendMode

Defined in

ui/packages/display/src/UI.ts:51

---

opacity

• Optional opacity: number

Implementation of

IText.opacity

Inherited from

UI.opacity

Defined in

ui/packages/display/src/UI.ts:54

---

visible

• Optional visible: boolean | 0

Implementation of

IText.visible

Inherited from

UI.visible

Defined in

ui/packages/display/src/UI.ts:57

---

selected

• Optional selected: boolean

Implementation of

IText.selected

Inherited from

UI.selected

Defined in

ui/packages/display/src/UI.ts:61

---

disabled

• Optional disabled: boolean

Implementation of

IText.disabled

Inherited from

UI.disabled

Defined in

ui/packages/display/src/UI.ts:64

---

locked

• Optional locked: boolean

Implementation of

IText.locked

Inherited from

UI.locked

Defined in

ui/packages/display/src/UI.ts:67

---

zIndex

• Optional zIndex: number

Implementation of

IText.zIndex

Inherited from

UI.zIndex

Defined in

ui/packages/display/src/UI.ts:71

---

mask

• Optional mask: boolean | IMaskType

Implementation of

IText.mask

Inherited from

UI.mask

Defined in

ui/packages/display/src/UI.ts:75

---

eraser

• Optional eraser: boolean | IEraserType

Implementation of

IText.eraser

Inherited from

UI.eraser

Defined in

ui/packages/display/src/UI.ts:78

---

x

• Optional x: number

Implementation of

IText.x

Inherited from

UI.x

Defined in

ui/packages/display/src/UI.ts:83

---

y

• Optional y: number

Implementation of

IText.y

Inherited from

UI.y

Defined in

ui/packages/display/src/UI.ts:86

---

scaleX

• Optional scaleX: number

Implementation of

IText.scaleX

Inherited from

UI.scaleX

Defined in

ui/packages/display/src/UI.ts:97

---

scaleY

• Optional scaleY: number

Implementation of

IText.scaleY

Inherited from

UI.scaleY

Defined in

ui/packages/display/src/UI.ts:100

---

rotation

• Optional rotation: number

Implementation of

IText.rotation

Inherited from

UI.rotation

Defined in

ui/packages/display/src/UI.ts:104

---

skewX

• Optional skewX: number

Implementation of

IText.skewX

Inherited from

UI.skewX

Defined in

ui/packages/display/src/UI.ts:108

---

skewY

• Optional skewY: number

Implementation of

IText.skewY

Inherited from

UI.skewY

Defined in

ui/packages/display/src/UI.ts:111

---

offsetX

• Optional offsetX: number

Implementation of

IText.offsetX

Inherited from

UI.offsetX

Defined in

ui/packages/display/src/UI.ts:116

---

offsetY

• Optional offsetY: number

Implementation of

IText.offsetY

Inherited from

UI.offsetY

Defined in

ui/packages/display/src/UI.ts:119

---

scrollX

• Optional scrollX: number

Implementation of

IText.scrollX

Inherited from

UI.scrollX

Defined in

ui/packages/display/src/UI.ts:123

---

scrollY

• Optional scrollY: number

Implementation of

IText.scrollY

Inherited from

UI.scrollY

Defined in

ui/packages/display/src/UI.ts:126

---

origin

• Optional origin: IUnitPointData | IDirection

Implementation of

IText.origin

Inherited from

UI.origin

Defined in

ui/packages/display/src/UI.ts:131

---

around

• Optional around: IUnitPointData | IDirection

Implementation of

IText.around

Inherited from

UI.around

Defined in

ui/packages/display/src/UI.ts:134

---

lazy

• Optional lazy: boolean

Implementation of

IText.lazy

Inherited from

UI.lazy

Defined in

ui/packages/display/src/UI.ts:139

---

pixelRatio

• Optional pixelRatio: number

Implementation of

IText.pixelRatio

Inherited from

UI.pixelRatio

Defined in

ui/packages/display/src/UI.ts:142

---

path

• Optional path: string | IPathCommandData

Implementation of

IText.path

Inherited from

UI.path

Defined in

ui/packages/display/src/UI.ts:147

---

windingRule

• Optional windingRule: IWindingRule

Implementation of

IText.windingRule

Inherited from

UI.windingRule

Defined in

ui/packages/display/src/UI.ts:150

---

closed

• Optional closed: boolean

Implementation of

IText.closed

Inherited from

UI.closed

Defined in

ui/packages/display/src/UI.ts:153

---

flow

• Optional flow: IFlowType

Implementation of

IText.flow

Inherited from

UI.flow

Defined in

ui/packages/display/src/UI.ts:158

---

padding

• Optional padding: IFourNumber

Implementation of

IText.padding

Inherited from

UI.padding

Defined in

ui/packages/display/src/UI.ts:161

---

gap

• Optional gap: IGap | IPointGap

Implementation of

IText.gap

Inherited from

UI.gap

Defined in

ui/packages/display/src/UI.ts:164

---

flowAlign

• Optional flowAlign: IFlowAlign | IFlowAxisAlign

Implementation of

IText.flowAlign

Inherited from

UI.flowAlign

Defined in

ui/packages/display/src/UI.ts:167

---

flowWrap

• Optional flowWrap: IFlowWrap

Implementation of

IText.flowWrap

Inherited from

UI.flowWrap

Defined in

ui/packages/display/src/UI.ts:170

---

itemBox

• Optional itemBox: IFlowBoxType

Implementation of

IText.itemBox

Inherited from

UI.itemBox

Defined in

ui/packages/display/src/UI.ts:173

---

inFlow

• Optional inFlow: boolean

Implementation of

IText.inFlow

Inherited from

UI.inFlow

Defined in

ui/packages/display/src/UI.ts:177

---

autoWidth

• Optional autoWidth: IAutoSize

Implementation of

IText.autoWidth

Inherited from

UI.autoWidth

Defined in

ui/packages/display/src/UI.ts:180

---

autoHeight

• Optional autoHeight: IAutoSize

Implementation of

IText.autoHeight

Inherited from

UI.autoHeight

Defined in

ui/packages/display/src/UI.ts:183

---

lockRatio

• Optional lockRatio: boolean

Implementation of

IText.lockRatio

Inherited from

UI.lockRatio

Defined in

ui/packages/display/src/UI.ts:186

---

autoBox

• Optional autoBox: IAutoBoxData | IConstraint

Implementation of

IText.autoBox

Inherited from

UI.autoBox

Defined in

ui/packages/display/src/UI.ts:189

---

widthRange

• Optional widthRange: IRangeSize

Implementation of

IText.widthRange

Inherited from

UI.widthRange

Defined in

ui/packages/display/src/UI.ts:193

---

heightRange

• Optional heightRange: IRangeSize

Implementation of

IText.heightRange

Inherited from

UI.heightRange

Defined in

ui/packages/display/src/UI.ts:196

---

draggable

• Optional draggable: boolean | IAxis

Implementation of

IText.draggable

Inherited from

UI.draggable

Defined in

ui/packages/display/src/UI.ts:201

---

dragBounds

• Optional dragBounds: "parent" | IBoundsData

Implementation of

IText.dragBounds

Inherited from

UI.dragBounds

Defined in

ui/packages/display/src/UI.ts:204

---

editable

• Optional editable: boolean

Implementation of

IText.editable

Inherited from

UI.editable

Defined in

ui/packages/display/src/UI.ts:208

---

hittable

• Optional hittable: boolean

Implementation of

IText.hittable

Inherited from

UI.hittable

Defined in

ui/packages/display/src/UI.ts:213

---

hitStroke

• Optional hitStroke: IHitType

Implementation of

IText.hitStroke

Inherited from

UI.hitStroke

Defined in

ui/packages/display/src/UI.ts:219

---

hitBox

• Optional hitBox: boolean

Implementation of

IText.hitBox

Inherited from

UI.hitBox

Defined in

ui/packages/display/src/UI.ts:222

---

hitChildren

• Optional hitChildren: boolean

Implementation of

IText.hitChildren

Inherited from

UI.hitChildren

Defined in

ui/packages/display/src/UI.ts:225

---

hitSelf

• Optional hitSelf: boolean

Implementation of

IText.hitSelf

Inherited from

UI.hitSelf

Defined in

ui/packages/display/src/UI.ts:228

---

hitRadius

• Optional hitRadius: number

Implementation of

IText.hitRadius

Inherited from

UI.hitRadius

Defined in

ui/packages/display/src/UI.ts:231

---

cursor

• Optional cursor: ICursorType | ICursorType[]

Implementation of

IText.cursor

Inherited from

UI.cursor

Defined in

ui/packages/display/src/UI.ts:234

---

stroke

• Optional stroke: IStroke

Implementation of

IText.stroke

Inherited from

UI.stroke

Defined in

ui/packages/display/src/UI.ts:247

---

strokeWidth

• Optional strokeWidth: string | IFourNumber

Implementation of

IText.strokeWidth

Inherited from

UI.strokeWidth

Defined in

ui/packages/display/src/UI.ts:253

---

strokeWidthFixed

• Optional strokeWidthFixed: boolean

Implementation of

IText.strokeWidthFixed

Inherited from

UI.strokeWidthFixed

Defined in

ui/packages/display/src/UI.ts:256

---

strokeCap

• Optional strokeCap: IStrokeCap

Implementation of

IText.strokeCap

Inherited from

UI.strokeCap

Defined in

ui/packages/display/src/UI.ts:259

---

strokeJoin

• Optional strokeJoin: IStrokeJoin

Implementation of

IText.strokeJoin

Inherited from

UI.strokeJoin

Defined in

ui/packages/display/src/UI.ts:262

---

dashPattern

• Optional dashPattern: string | number[]

Implementation of

IText.dashPattern

Inherited from

UI.dashPattern

Defined in

ui/packages/display/src/UI.ts:265

---

dashOffset

• Optional dashOffset: number

Implementation of

IText.dashOffset

Inherited from

UI.dashOffset

Defined in

ui/packages/display/src/UI.ts:268

---

miterLimit

• Optional miterLimit: number

Implementation of

IText.miterLimit

Inherited from

UI.miterLimit

Defined in

ui/packages/display/src/UI.ts:271

---

startArrow

• Optional startArrow: IArrowType

Implementation of

IText.startArrow

Inherited from

UI.startArrow

Defined in

ui/packages/display/src/UI.ts:277

---

endArrow

• Optional endArrow: IArrowType

Implementation of

IText.endArrow

Inherited from

UI.endArrow

Defined in

ui/packages/display/src/UI.ts:280

---

cornerRadius

• Optional cornerRadius: string | IFourNumber

Implementation of

IText.cornerRadius

Inherited from

UI.cornerRadius

Defined in

ui/packages/display/src/UI.ts:285

---

cornerSmoothing

• Optional cornerSmoothing: number

Implementation of

IText.cornerSmoothing

Inherited from

UI.cornerSmoothing

Defined in

ui/packages/display/src/UI.ts:288

---

shadow

• Optional shadow: string | IShadowEffect | IShadowEffect[]

Implementation of

IText.shadow

Inherited from

UI.shadow

Defined in

ui/packages/display/src/UI.ts:293

---

innerShadow

• Optional innerShadow: string | IShadowEffect | IShadowEffect[]

Implementation of

IText.innerShadow

Inherited from

UI.innerShadow

Defined in

ui/packages/display/src/UI.ts:296

---

blur

• Optional blur: number | IBlurEffect

Implementation of

IText.blur

Inherited from

UI.blur

Defined in

ui/packages/display/src/UI.ts:299

---

backgroundBlur

• Optional backgroundBlur: number | IBlurEffect

Implementation of

IText.backgroundBlur

Inherited from

UI.backgroundBlur

Defined in

ui/packages/display/src/UI.ts:302

---

grayscale

• Optional grayscale: number | IGrayscaleEffect

Implementation of

IText.grayscale

Inherited from

UI.grayscale

Defined in

ui/packages/display/src/UI.ts:305

---

normalStyle

• Optional normalStyle: IUIInputData

Implementation of

IText.normalStyle

Inherited from

UI.normalStyle

Defined in

ui/packages/display/src/UI.ts:311

---

hoverStyle

• Optional hoverStyle: IUIInputData

Implementation of

IText.hoverStyle

Inherited from

UI.hoverStyle

Defined in

ui/packages/display/src/UI.ts:314

---

pressStyle

• Optional pressStyle: IUIInputData

Implementation of

IText.pressStyle

Inherited from

UI.pressStyle

Defined in

ui/packages/display/src/UI.ts:317

---

focusStyle

• Optional focusStyle: IUIInputData

Implementation of

IText.focusStyle

Inherited from

UI.focusStyle

Defined in

ui/packages/display/src/UI.ts:320

---

selectedStyle

• Optional selectedStyle: IUIInputData

Implementation of

IText.selectedStyle

Inherited from

UI.selectedStyle

Defined in

ui/packages/display/src/UI.ts:323

---

disabledStyle

• Optional disabledStyle: IUIInputData

Implementation of

IText.disabledStyle

Inherited from

UI.disabledStyle

Defined in

ui/packages/display/src/UI.ts:326

---

data

• data: IObject

Implementation of

IText.data

Inherited from

UI.data

Defined in

ui/packages/display/src/UI.ts:331

Accessors

tag

• get tag(): string

Returns

string

Implementation of

IText.tag

Inherited from

UI.tag

Defined in

leafer/packages/display/src/Leaf.ts:24

• set tag(_value): void

Parameters

Name	Type
_value	string

Returns

void

Implementation of

IText.tag

Inherited from

UI.tag

Defined in

leafer/packages/display/src/Leaf.ts:25

---

innerName

• get innerName(): string

Returns

string

Implementation of

IText.innerName

Inherited from

UI.innerName

Defined in

leafer/packages/display/src/Leaf.ts:30

---

__DataProcessor

• get __DataProcessor(): typeof LeafData

Returns

typeof LeafData

Implementation of

IText.__DataProcessor

Inherited from

UI.__DataProcessor

Defined in

leafer/packages/display/src/Leaf.ts:32

---

__LayoutProcessor

• get __LayoutProcessor(): typeof LeafLayout

Returns

typeof LeafLayout

Implementation of

IText.__LayoutProcessor

Inherited from

UI.__LayoutProcessor

Defined in

leafer/packages/display/src/Leaf.ts:33

---

isLeafer

• get isLeafer(): boolean

Returns

boolean

Implementation of

IText.isLeafer

Inherited from

UI.isLeafer

Defined in

leafer/packages/display/src/Leaf.ts:38

---

isBranch

• get isBranch(): boolean

Returns

boolean

Implementation of

IText.isBranch

Inherited from

UI.isBranch

Defined in

leafer/packages/display/src/Leaf.ts:39

---

isBranchLeaf

• get isBranchLeaf(): boolean

Returns

boolean

Implementation of

IText.isBranchLeaf

Inherited from

UI.isBranchLeaf

Defined in

leafer/packages/display/src/Leaf.ts:40

---

__localMatrix

• get __localMatrix(): IMatrixData

Returns

IMatrixData

Implementation of

IText.__localMatrix

Inherited from

UI.__localMatrix

Defined in

leafer/packages/display/src/Leaf.ts:51

---

__localBoxBounds

• get __localBoxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IText.__localBoxBounds

Inherited from

UI.__localBoxBounds

Defined in

leafer/packages/display/src/Leaf.ts:52

---

worldTransform

• get worldTransform(): IMatrixWithScaleData

Returns

IMatrixWithScaleData

Implementation of

IText.worldTransform

Inherited from

UI.worldTransform

Defined in

leafer/packages/display/src/Leaf.ts:57

---

localTransform

• get localTransform(): IMatrixData

Returns

IMatrixData

Implementation of

IText.localTransform

Inherited from

UI.localTransform

Defined in

leafer/packages/display/src/Leaf.ts:58

---

boxBounds

• get boxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IText.boxBounds

Inherited from

UI.boxBounds

Defined in

leafer/packages/display/src/Leaf.ts:61

---

renderBounds

• get renderBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IText.renderBounds

Inherited from

UI.renderBounds

Defined in

leafer/packages/display/src/Leaf.ts:62

---

worldBoxBounds

• get worldBoxBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IText.worldBoxBounds

Inherited from

UI.worldBoxBounds

Defined in

leafer/packages/display/src/Leaf.ts:63

---

worldStrokeBounds

• get worldStrokeBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IText.worldStrokeBounds

Inherited from

UI.worldStrokeBounds

Defined in

leafer/packages/display/src/Leaf.ts:64

---

worldRenderBounds

• get worldRenderBounds(): IBoundsData

Returns

IBoundsData

Implementation of

IText.worldRenderBounds

Inherited from

UI.worldRenderBounds

Defined in

leafer/packages/display/src/Leaf.ts:65

---

worldOpacity

• get worldOpacity(): number

Returns

number

Implementation of

IText.worldOpacity

Inherited from

UI.worldOpacity

Defined in

leafer/packages/display/src/Leaf.ts:68

---

__worldFlipped

• get __worldFlipped(): boolean

Returns

boolean

Implementation of

IText.__worldFlipped

Inherited from

UI.__worldFlipped

Defined in

leafer/packages/display/src/Leaf.ts:73

---

__onlyHitMask

• get __onlyHitMask(): boolean

Returns

boolean

Implementation of

IText.__onlyHitMask

Inherited from

UI.__onlyHitMask

Defined in

leafer/packages/display/src/Leaf.ts:80

---

__ignoreHitWorld

• get __ignoreHitWorld(): boolean

Returns

boolean

Implementation of

IText.__ignoreHitWorld

Inherited from

UI.__ignoreHitWorld

Defined in

leafer/packages/display/src/Leaf.ts:81

---

__inLazyBounds

• get __inLazyBounds(): boolean

Returns

boolean

Implementation of

IText.__inLazyBounds

Inherited from

UI.__inLazyBounds

Defined in

leafer/packages/display/src/Leaf.ts:82

---

pathInputed

• get pathInputed(): boolean

Returns

boolean

Implementation of

IText.pathInputed

Inherited from

UI.pathInputed

Defined in

leafer/packages/display/src/Leaf.ts:84

---

event

• set event(map): void

Parameters

Name	Type
map	IEventMap

Returns

void

Implementation of

IText.event

Inherited from

UI.event

Defined in

leafer/packages/display/src/Leaf.ts:87

---

__tag

• get __tag(): string

Returns

string

Implementation of

IText.__tag

Overrides

UI.__tag

Defined in

ui/packages/display/src/Text.ts:17

---

editInner

• get editInner(): string

Returns

string

Implementation of

IText.editInner

Overrides

UI.editInner

Defined in

ui/packages/display/src/Text.ts:86

---

textDrawData

• get textDrawData(): ITextDrawData

Returns

ITextDrawData

Defined in

ui/packages/display/src/Text.ts:88

---

app

• get app(): ILeafer

Returns

ILeafer

Implementation of

IText.app

Inherited from

UI.app

Defined in

ui/packages/display/src/UI.ts:24

---

isFrame

• get isFrame(): boolean

Returns

boolean

Implementation of

IText.isFrame

Inherited from

UI.isFrame

Defined in

ui/packages/display/src/UI.ts:32

---

scale

• get scale(): number | IPointData

Returns

number | IPointData

Implementation of

IText.scale

Inherited from

UI.scale

Defined in

ui/packages/display/src/UI.ts:343

• set scale(value): void

Parameters

Name	Type
value	number | IPointData

Returns

void

Implementation of

IText.scale

Inherited from

UI.scale

Defined in

ui/packages/display/src/UI.ts:334

---

pen

• get pen(): IPathCreator

Returns

IPathCreator

Implementation of

IText.pen

Inherited from

UI.pen

Defined in

ui/packages/display/src/UI.ts:348

---

editConfig

• get editConfig(): IEditorConfig

Returns

IEditorConfig

Implementation of

IText.editConfig

Inherited from

UI.editConfig

Defined in

ui/packages/display/src/UI.ts:358

---

editOuter

• get editOuter(): string

Returns

string

Implementation of

IText.editOuter

Inherited from

UI.editOuter

Defined in

ui/packages/display/src/UI.ts:360

Methods

resetCustom

▸ resetCustom(): void

Returns

void

Implementation of

IText.resetCustom

Inherited from

UI.resetCustom

Defined in

leafer/packages/display/src/Leaf.ts:127

---

waitParent

▸ waitParent(item, bind?): void

Parameters

Name	Type
item	IFunction
bind?	IObject

Returns

void

Implementation of

IText.waitParent

Inherited from

UI.waitParent

Defined in

leafer/packages/display/src/Leaf.ts:133

---

waitLeafer

▸ waitLeafer(item, bind?): void

Parameters

Name	Type
item	IFunction
bind?	IObject

Returns

void

Implementation of

IText.waitLeafer

Inherited from

UI.waitLeafer

Defined in

leafer/packages/display/src/Leaf.ts:138

---

nextRender

▸ nextRender(item, bind?, off?): void

Parameters

Name	Type
item	IFunction
bind?	IObject
off?	"off"

Returns

void

Implementation of

IText.nextRender

Inherited from

UI.nextRender

Defined in

leafer/packages/display/src/Leaf.ts:143

---

removeNextRender

▸ removeNextRender(item): void

Parameters

Name	Type
item	IFunction

Returns

void

Implementation of

IText.removeNextRender

Inherited from

UI.removeNextRender

Defined in

leafer/packages/display/src/Leaf.ts:147

---

__bindLeafer

▸ __bindLeafer(leafer): void

Parameters

Name	Type
leafer	ILeaferBase

Returns

void

Implementation of

IText.__bindLeafer

Inherited from

UI.__bindLeafer

Defined in

leafer/packages/display/src/Leaf.ts:151

---

setAttr

▸ setAttr(name, value): void

Parameters

Name	Type
name	string
value	any

Returns

void

Implementation of

IText.setAttr

Inherited from

UI.setAttr

Defined in

leafer/packages/display/src/Leaf.ts:179

---

getAttr

▸ getAttr(name): any

Parameters

Name	Type
name	string

Returns

any

Implementation of

IText.getAttr

Inherited from

UI.getAttr

Defined in

leafer/packages/display/src/Leaf.ts:180

---

getComputedAttr

▸ getComputedAttr(name): any

Parameters

Name	Type
name	string

Returns

any

Implementation of

IText.getComputedAttr

Inherited from

UI.getComputedAttr

Defined in

leafer/packages/display/src/Leaf.ts:182

---

toJSON

▸ toJSON(options?): IObject

Parameters

Name	Type
options?	IJSONOptions

Returns

IObject

Implementation of

IText.toJSON

Inherited from

UI.toJSON

Defined in

leafer/packages/display/src/Leaf.ts:184

---

toString

▸ toString(options?): string

Parameters

Name	Type
options?	IJSONOptions

Returns

string

Implementation of

IText.toString

Inherited from

UI.toString

Defined in

leafer/packages/display/src/Leaf.ts:189

---

toSVG

▸ toSVG(): string

Returns

string

Implementation of

IText.toSVG

Inherited from

UI.toSVG

Defined in

leafer/packages/display/src/Leaf.ts:193

---

__SVG

▸ __SVG(_data): void

Parameters

Name	Type
_data	IObject

Returns

void

Implementation of

IText.__SVG

Inherited from

UI.__SVG

Defined in

leafer/packages/display/src/Leaf.ts:195

---

toHTML

▸ toHTML(): string

Returns

string

Implementation of

IText.toHTML

Inherited from

UI.toHTML

Defined in

leafer/packages/display/src/Leaf.ts:197

---

__setAttr

▸ __setAttr(_attrName, _newValue): boolean

Parameters

Name	Type
_attrName	string
_newValue	IValue

Returns

boolean

Implementation of

IText.__setAttr

Inherited from

UI.__setAttr

Defined in

leafer/packages/display/src/Leaf.ts:201

---

__getAttr

▸ __getAttr(_attrName): IValue

Parameters

Name	Type
_attrName	string

Returns

IValue

Implementation of

IText.__getAttr

Inherited from

UI.__getAttr

Defined in

leafer/packages/display/src/Leaf.ts:203

---

setProxyAttr

▸ setProxyAttr(_attrName, _newValue): void

Parameters

Name	Type
_attrName	string
_newValue	IValue

Returns

void

Implementation of

IText.setProxyAttr

Inherited from

UI.setProxyAttr

Defined in

leafer/packages/display/src/Leaf.ts:205

---

getProxyAttr

▸ getProxyAttr(_attrName): IValue

Parameters

Name	Type
_attrName	string

Returns

IValue

Implementation of

IText.getProxyAttr

Inherited from

UI.getProxyAttr

Defined in

leafer/packages/display/src/Leaf.ts:207

---

focus

▸ focus(_value?): void

Parameters

Name	Type
_value?	boolean

Returns

void

Implementation of

IText.focus

Inherited from

UI.focus

Defined in

leafer/packages/display/src/Leaf.ts:227

---

updateLayout

▸ updateLayout(): void

Returns

void

Implementation of

IText.updateLayout

Inherited from

UI.updateLayout

Defined in

leafer/packages/display/src/Leaf.ts:231

---

forceUpdate

▸ forceUpdate(attrName?): void

Parameters

Name	Type
attrName?	string

Returns

void

Implementation of

IText.forceUpdate

Inherited from

UI.forceUpdate

Defined in

leafer/packages/display/src/Leaf.ts:235

---

forceRender

▸ forceRender(_bounds?): void

Parameters

Name	Type
_bounds?	IBoundsData

Returns

void

Implementation of

IText.forceRender

Inherited from

UI.forceRender

Defined in

leafer/packages/display/src/Leaf.ts:243

---

__updateWorldMatrix

▸ __updateWorldMatrix(): void

Returns

void

Implementation of

IText.__updateWorldMatrix

Inherited from

UI.__updateWorldMatrix

Defined in

leafer/packages/display/src/Leaf.ts:249

---

__updateLocalMatrix

▸ __updateLocalMatrix(): void

Returns

void

Implementation of

IText.__updateLocalMatrix

Inherited from

UI.__updateLocalMatrix

Defined in

leafer/packages/display/src/Leaf.ts:251

---

__updateWorldBounds

▸ __updateWorldBounds(): void

Returns

void

Implementation of

IText.__updateWorldBounds

Inherited from

UI.__updateWorldBounds

Defined in

leafer/packages/display/src/Leaf.ts:257

---

__updateLocalBounds

▸ __updateLocalBounds(): void

Returns

void

Implementation of

IText.__updateLocalBounds

Inherited from

UI.__updateLocalBounds

Defined in

leafer/packages/display/src/Leaf.ts:259

---

__updateLocalBoxBounds

▸ __updateLocalBoxBounds(): void

Returns

void

Implementation of

IText.__updateLocalBoxBounds

Inherited from

UI.__updateLocalBoxBounds

Defined in

leafer/packages/display/src/Leaf.ts:262

---

__updateLocalStrokeBounds

▸ __updateLocalStrokeBounds(): void

Returns

void

Implementation of

IText.__updateLocalStrokeBounds

Inherited from

UI.__updateLocalStrokeBounds

Defined in

leafer/packages/display/src/Leaf.ts:264

---

__updateLocalRenderBounds

▸ __updateLocalRenderBounds(): void

Returns

void

Implementation of

IText.__updateLocalRenderBounds

Inherited from

UI.__updateLocalRenderBounds

Defined in

leafer/packages/display/src/Leaf.ts:266

---

__updateContentBounds

▸ __updateContentBounds(): void

Returns

void

Implementation of

IText.__updateContentBounds

Inherited from

UI.__updateContentBounds

Defined in

leafer/packages/display/src/Leaf.ts:272

---

__updateStrokeBounds

▸ __updateStrokeBounds(): void

Returns

void

Implementation of

IText.__updateStrokeBounds

Inherited from

UI.__updateStrokeBounds

Defined in

leafer/packages/display/src/Leaf.ts:274

---

__updateAutoLayout

▸ __updateAutoLayout(): void

Returns

void

Implementation of

IText.__updateAutoLayout

Inherited from

UI.__updateAutoLayout

Defined in

leafer/packages/display/src/Leaf.ts:279

---

__updateFlowLayout

▸ __updateFlowLayout(): void

Returns

void

Implementation of

IText.__updateFlowLayout

Inherited from

UI.__updateFlowLayout

Defined in

leafer/packages/display/src/Leaf.ts:281

---

__updateNaturalSize

▸ __updateNaturalSize(): void

Returns

void

Implementation of

IText.__updateNaturalSize

Inherited from

UI.__updateNaturalSize

Defined in

leafer/packages/display/src/Leaf.ts:283

---

__updateStrokeSpread

▸ __updateStrokeSpread(): number

Returns

number

Implementation of

IText.__updateStrokeSpread

Inherited from

UI.__updateStrokeSpread

Defined in

leafer/packages/display/src/Leaf.ts:286

---

__updateEraser

▸ __updateEraser(value?): void

Parameters

Name	Type
value?	boolean

Returns

void

Implementation of

IText.__updateEraser

Inherited from

UI.__updateEraser

Defined in

leafer/packages/display/src/Leaf.ts:295

---

__renderEraser

▸ __renderEraser(canvas, options): void

Parameters

Name	Type
canvas	ILeaferCanvas
options	IRenderOptions

Returns

void

Implementation of

IText.__renderEraser

Inherited from

UI.__renderEraser

Defined in

leafer/packages/display/src/Leaf.ts:299

---

__updateMask

▸ __updateMask(value?): void

Parameters

Name	Type
value?	boolean

Returns

void

Implementation of

IText.__updateMask

Inherited from

UI.__updateMask

Defined in

leafer/packages/display/src/Leaf.ts:307

---

__renderMask

▸ __renderMask(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Implementation of

IText.__renderMask

Inherited from

UI.__renderMask

Defined in

leafer/packages/display/src/Leaf.ts:313

---

__getNowWorld

▸ __getNowWorld(options): IMatrixWithBoundsScaleData

Parameters

Name	Type
options	IRenderOptions

Returns

IMatrixWithBoundsScaleData

Implementation of

IText.__getNowWorld

Inherited from

UI.__getNowWorld

Defined in

leafer/packages/display/src/Leaf.ts:321

---

getTransform

▸ getTransform(relative?): IMatrixData

Parameters

Name	Type
relative?	ILeaf | ILocationType

Returns

IMatrixData

Implementation of

IText.getTransform

Inherited from

UI.getTransform

Defined in

leafer/packages/display/src/Leaf.ts:333

---

getBounds

▸ getBounds(type?, relative?): IBoundsData

Parameters

Name	Type
type?	IBoundsType
relative?	ILeaf | ILocationType

Returns

IBoundsData

Implementation of

IText.getBounds

Inherited from

UI.getBounds

Defined in

leafer/packages/display/src/Leaf.ts:338

---

getLayoutBounds

▸ getLayoutBounds(type?, relative?, unscale?): ILayoutBoundsData

Parameters

Name	Type
type?	IBoundsType
relative?	ILeaf | ILocationType
unscale?	boolean

Returns

ILayoutBoundsData

Implementation of

IText.getLayoutBounds

Inherited from

UI.getLayoutBounds

Defined in

leafer/packages/display/src/Leaf.ts:342

---

getLayoutPoints

▸ getLayoutPoints(type?, relative?): IPointData[]

Parameters

Name	Type
type?	IBoundsType
relative?	ILeaf | ILocationType

Returns

IPointData[]

Implementation of

IText.getLayoutPoints

Inherited from

UI.getLayoutPoints

Defined in

leafer/packages/display/src/Leaf.ts:346

---

getWorldBounds

▸ getWorldBounds(inner, relative?, change?): IBoundsData

Parameters

Name	Type
inner	IBoundsData
relative?	ILeaf
change?	boolean

Returns

IBoundsData

Implementation of

IText.getWorldBounds

Inherited from

UI.getWorldBounds

Defined in

leafer/packages/display/src/Leaf.ts:351

---

worldToLocal

▸ worldToLocal(world, to?, distance?, relative?): void

Parameters

Name	Type
world	IPointData
to?	IPointData
distance?	boolean
relative?	ILeaf

Returns

void

Implementation of

IText.worldToLocal

Inherited from

UI.worldToLocal

Defined in

leafer/packages/display/src/Leaf.ts:359

---

localToWorld

▸ localToWorld(local, to?, distance?, relative?): void

Parameters

Name	Type
local	IPointData
to?	IPointData
distance?	boolean
relative?	ILeaf

Returns

void

Implementation of

IText.localToWorld

Inherited from

UI.localToWorld

Defined in

leafer/packages/display/src/Leaf.ts:367

---

worldToInner

▸ worldToInner(world, to?, distance?, relative?): void

Parameters

Name	Type
world	IPointData
to?	IPointData
distance?	boolean
relative?	ILeaf

Returns

void

Implementation of

IText.worldToInner

Inherited from

UI.worldToInner

Defined in

leafer/packages/display/src/Leaf.ts:375

---

innerToWorld

▸ innerToWorld(inner, to?, distance?, relative?): void

Parameters

Name	Type
inner	IPointData
to?	IPointData
distance?	boolean
relative?	ILeaf

Returns

void

Implementation of

IText.innerToWorld

Inherited from

UI.innerToWorld

Defined in

leafer/packages/display/src/Leaf.ts:383

---

getInnerPoint

▸ getInnerPoint(world, relative?, distance?, change?): IPointData

Parameters

Name	Type
world	IPointData
relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Implementation of

IText.getInnerPoint

Inherited from

UI.getInnerPoint

Defined in

leafer/packages/display/src/Leaf.ts:390

---

getInnerPointByLocal

▸ getInnerPointByLocal(local, _relative?, distance?, change?): IPointData

Parameters

Name	Type
local	IPointData
_relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Implementation of

IText.getInnerPointByLocal

Inherited from

UI.getInnerPointByLocal

Defined in

leafer/packages/display/src/Leaf.ts:396

---

getLocalPoint

▸ getLocalPoint(world, relative?, distance?, change?): IPointData

Parameters

Name	Type
world	IPointData
relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Implementation of

IText.getLocalPoint

Inherited from

UI.getLocalPoint

Defined in

leafer/packages/display/src/Leaf.ts:400

---

getLocalPointByInner

▸ getLocalPointByInner(inner, _relative?, distance?, change?): IPointData

Parameters

Name	Type
inner	IPointData
_relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Implementation of

IText.getLocalPointByInner

Inherited from

UI.getLocalPointByInner

Defined in

leafer/packages/display/src/Leaf.ts:406

---

getWorldPoint

▸ getWorldPoint(inner, relative?, distance?, change?): IPointData

Parameters

Name	Type
inner	IPointData
relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Implementation of

IText.getWorldPoint

Inherited from

UI.getWorldPoint

Defined in

leafer/packages/display/src/Leaf.ts:410

---

getWorldPointByLocal

▸ getWorldPointByLocal(local, relative?, distance?, change?): IPointData

Parameters

Name	Type
local	IPointData
relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Implementation of

IText.getWorldPointByLocal

Inherited from

UI.getWorldPointByLocal

Defined in

leafer/packages/display/src/Leaf.ts:416

---

getPagePoint

▸ getPagePoint(world, relative?, distance?, change?): IPointData

Parameters

Name	Type
world	IPointData
relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Implementation of

IText.getPagePoint

Inherited from

UI.getPagePoint

Defined in

leafer/packages/display/src/Leaf.ts:422

---

getWorldPointByPage

▸ getWorldPointByPage(page, relative?, distance?, change?): IPointData

Parameters

Name	Type
page	IPointData
relative?	ILeaf
distance?	boolean
change?	boolean

Returns

IPointData

Implementation of

IText.getWorldPointByPage

Inherited from

UI.getWorldPointByPage

Defined in

leafer/packages/display/src/Leaf.ts:427

---

setTransform

▸ setTransform(matrix, resize?): void

Parameters

Name	Type
matrix	IMatrixData
resize?	boolean

Returns

void

Implementation of

IText.setTransform

Inherited from

UI.setTransform

Defined in

leafer/packages/display/src/Leaf.ts:435

---

transform

▸ transform(matrix, resize?): void

Parameters

Name	Type
matrix	IMatrixData
resize?	boolean

Returns

void

Implementation of

IText.transform

Inherited from

UI.transform

Defined in

leafer/packages/display/src/Leaf.ts:439

---

move

▸ move(x, y?): void

Parameters

Name	Type
x	number | IPointData
y?	number

Returns

void

Implementation of

IText.move

Inherited from

UI.move

Defined in

leafer/packages/display/src/Leaf.ts:443

---

moveInner

▸ moveInner(x, y?): void

Parameters

Name	Type
x	number | IPointData
y?	number

Returns

void

Implementation of

IText.moveInner

Inherited from

UI.moveInner

Defined in

leafer/packages/display/src/Leaf.ts:448

---

scaleOf

▸ scaleOf(origin, scaleX, scaleY?, resize?): void

Parameters

Name	Type
origin	IPointData | IDirection
scaleX	number
scaleY?	number
resize?	boolean

Returns

void

Implementation of

IText.scaleOf

Inherited from

UI.scaleOf

Defined in

leafer/packages/display/src/Leaf.ts:452

---

rotateOf

▸ rotateOf(origin, rotation): void

Parameters

Name	Type
origin	IPointData | IDirection
rotation	number

Returns

void

Implementation of

IText.rotateOf

Inherited from

UI.rotateOf

Defined in

leafer/packages/display/src/Leaf.ts:456

---

skewOf

▸ skewOf(origin, skewX, skewY?, resize?): void

Parameters

Name	Type
origin	IPointData | IDirection
skewX	number
skewY?	number
resize?	boolean

Returns

void

Implementation of

IText.skewOf

Inherited from

UI.skewOf

Defined in

leafer/packages/display/src/Leaf.ts:460

---

transformWorld

▸ transformWorld(worldTransform?, resize?): void

Parameters

Name	Type
worldTransform?	IMatrixData
resize?	boolean

Returns

void

Implementation of

IText.transformWorld

Inherited from

UI.transformWorld

Defined in

leafer/packages/display/src/Leaf.ts:465

---

moveWorld

▸ moveWorld(x, y?): void

Parameters

Name	Type
x	number | IPointData
y?	number

Returns

void

Implementation of

IText.moveWorld

Inherited from

UI.moveWorld

Defined in

leafer/packages/display/src/Leaf.ts:469

---

scaleOfWorld

▸ scaleOfWorld(worldOrigin, scaleX, scaleY?, resize?): void

Parameters

Name	Type
worldOrigin	IPointData
scaleX	number
scaleY?	number
resize?	boolean

Returns

void

Implementation of

IText.scaleOfWorld

Inherited from

UI.scaleOfWorld

Defined in

leafer/packages/display/src/Leaf.ts:473

---

rotateOfWorld

▸ rotateOfWorld(worldOrigin, rotation): void

Parameters

Name	Type
worldOrigin	IPointData
rotation	number

Returns

void

Implementation of

IText.rotateOfWorld

Inherited from

UI.rotateOfWorld

Defined in

leafer/packages/display/src/Leaf.ts:477

---

skewOfWorld

▸ skewOfWorld(worldOrigin, skewX, skewY?, resize?): void

Parameters

Name	Type
worldOrigin	IPointData
skewX	number
skewY?	number
resize?	boolean

Returns

void

Implementation of

IText.skewOfWorld

Inherited from

UI.skewOfWorld

Defined in

leafer/packages/display/src/Leaf.ts:481

---

flip

▸ flip(axis): void

Parameters

Name	Type
axis	IAxis

Returns

void

Implementation of

IText.flip

Inherited from

UI.flip

Defined in

leafer/packages/display/src/Leaf.ts:485

---

scaleResize

▸ scaleResize(scaleX, scaleY?, _noResize?): void

Parameters

Name	Type	Default value
scaleX	number	undefined
scaleY	number	scaleX
_noResize?	boolean	undefined

Returns

void

Implementation of

IText.scaleResize

Inherited from

UI.scaleResize

Defined in

leafer/packages/display/src/Leaf.ts:492

---

__scaleResize

▸ __scaleResize(_scaleX, _scaleY): void

Parameters

Name	Type
_scaleX	number
_scaleY	number

Returns

void

Implementation of

IText.__scaleResize

Inherited from

UI.__scaleResize

Defined in

leafer/packages/display/src/Leaf.ts:497

---

resizeWidth

▸ resizeWidth(_width): void

Parameters

Name	Type
_width	number

Returns

void

Implementation of

IText.resizeWidth

Inherited from

UI.resizeWidth

Defined in

leafer/packages/display/src/Leaf.ts:500

---

resizeHeight

▸ resizeHeight(_height): void

Parameters

Name	Type
_height	number

Returns

void

Implementation of

IText.resizeHeight

Inherited from

UI.resizeHeight

Defined in

leafer/packages/display/src/Leaf.ts:502

---

__hitWorld

▸ __hitWorld(_point): boolean

Parameters

Name	Type
_point	IRadiusPointData

Returns

boolean

Implementation of

IText.__hitWorld

Inherited from

UI.__hitWorld

Defined in

leafer/packages/display/src/Leaf.ts:507

---

__hit

▸ __hit(_local): boolean

Parameters

Name	Type
_local	IRadiusPointData

Returns

boolean

Implementation of

IText.__hit

Inherited from

UI.__hit

Defined in

leafer/packages/display/src/Leaf.ts:509

---

__hitFill

▸ __hitFill(_inner): boolean

Parameters

Name	Type
_inner	IRadiusPointData

Returns

boolean

Implementation of

IText.__hitFill

Inherited from

UI.__hitFill

Defined in

leafer/packages/display/src/Leaf.ts:511

---

__hitStroke

▸ __hitStroke(_inner, _strokeWidth): boolean

Parameters

Name	Type
_inner	IRadiusPointData
_strokeWidth	number

Returns

boolean

Implementation of

IText.__hitStroke

Inherited from

UI.__hitStroke

Defined in

leafer/packages/display/src/Leaf.ts:513

---

__hitPixel

▸ __hitPixel(_inner): boolean

Parameters

Name	Type
_inner	IRadiusPointData

Returns

boolean

Implementation of

IText.__hitPixel

Inherited from

UI.__hitPixel

Defined in

leafer/packages/display/src/Leaf.ts:515

---

__updateHitCanvas

▸ __updateHitCanvas(): void

Returns

void

Implementation of

IText.__updateHitCanvas

Inherited from

UI.__updateHitCanvas

Defined in

leafer/packages/display/src/Leaf.ts:519

---

__render

▸ __render(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Implementation of

IText.__render

Inherited from

UI.__render

Defined in

leafer/packages/display/src/Leaf.ts:526

---

__drawFast

▸ __drawFast(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Implementation of

IText.__drawFast

Inherited from

UI.__drawFast

Defined in

leafer/packages/display/src/Leaf.ts:528

---

__draw

▸ __draw(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Implementation of

IText.__draw

Inherited from

UI.__draw

Defined in

leafer/packages/display/src/Leaf.ts:530

---

__clip

▸ __clip(_canvas, _options): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions

Returns

void

Implementation of

IText.__clip

Inherited from

UI.__clip

Defined in

leafer/packages/display/src/Leaf.ts:533

---

__renderShape

▸ __renderShape(_canvas, _options, _ignoreFill?, _ignoreStroke?): void

Parameters

Name	Type
_canvas	ILeaferCanvas
_options	IRenderOptions
_ignoreFill?	boolean
_ignoreStroke?	boolean

Returns

void

Implementation of

IText.__renderShape

Inherited from

UI.__renderShape

Defined in

leafer/packages/display/src/Leaf.ts:535

---

__updateWorldOpacity

▸ __updateWorldOpacity(): void

Returns

void

Implementation of

IText.__updateWorldOpacity

Inherited from

UI.__updateWorldOpacity

Defined in

leafer/packages/display/src/Leaf.ts:538

---

__updateChange

▸ __updateChange(): void

Returns

void

Implementation of

IText.__updateChange

Inherited from

UI.__updateChange

Defined in

leafer/packages/display/src/Leaf.ts:540

---

__updatePath

▸ __updatePath(): void

Returns

void

Implementation of

IText.__updatePath

Inherited from

UI.__updatePath

Defined in

leafer/packages/display/src/Leaf.ts:551

---

__updateSortChildren

▸ __updateSortChildren(): void

Returns

void

Implementation of

IText.__updateSortChildren

Inherited from

UI.__updateSortChildren

Defined in

leafer/packages/display/src/Leaf.ts:558

---

add

▸ add(_child, _index?): void

Parameters

Name	Type
_child	ILeaf
_index?	number

Returns

void

Implementation of

IText.add

Inherited from

UI.add

Defined in

leafer/packages/display/src/Leaf.ts:560

---

remove

▸ remove(_child?, destroy?): void

Parameters

Name	Type
_child?	ILeaf
destroy?	boolean

Returns

void

Implementation of

IText.remove

Inherited from

UI.remove

Defined in

leafer/packages/display/src/Leaf.ts:562

---

dropTo

▸ dropTo(parent, index?, resize?): void

Parameters

Name	Type
parent	ILeaf
index?	number
resize?	boolean

Returns

void

Implementation of

IText.dropTo

Inherited from

UI.dropTo

Defined in

leafer/packages/display/src/Leaf.ts:566

---

on

▸ on(_type, _listener, _options?): void

Parameters

Name	Type
_type	string | string[]
_listener	IFunction
_options?	IEventOption

Returns

void

Implementation of

IText.on

Inherited from

UI.on

Defined in

leafer/packages/display/src/Leaf.ts:575

---

off

▸ off(_type?, _listener?, _options?): void

Parameters

Name	Type
_type?	string | string[]
_listener?	IFunction
_options?	IEventOption

Returns

void

Implementation of

IText.off

Inherited from

UI.off

Defined in

leafer/packages/display/src/Leaf.ts:577

---

on_

▸ on_(_type, _listener, _bind?, _options?): IEventListenerId

Parameters

Name	Type
_type	string | string[]
_listener	IFunction
_bind?	IObject
_options?	IEventOption

Returns

IEventListenerId

Implementation of

IText.on_

Inherited from

UI.on_

Defined in

leafer/packages/display/src/Leaf.ts:579

---

off_

▸ off_(_id): void

Parameters

Name	Type
_id	IEventListenerId | IEventListenerId[]

Returns

void

Implementation of

IText.off_

Inherited from

UI.off_

Defined in

leafer/packages/display/src/Leaf.ts:581

---

once

▸ once(_type, _listener, _capture?): void

Parameters

Name	Type
_type	string | string[]
_listener	IFunction
_capture?	boolean

Returns

void

Implementation of

IText.once

Inherited from

UI.once

Defined in

leafer/packages/display/src/Leaf.ts:583

---

emit

▸ emit(_type, _event?, _capture?): void

Parameters

Name	Type
_type	string
_event?	IObject | IEvent
_capture?	boolean

Returns

void

Implementation of

IText.emit

Inherited from

UI.emit

Defined in

leafer/packages/display/src/Leaf.ts:585

---

emitEvent

▸ emitEvent(_event?, _capture?): void

Parameters

Name	Type
_event?	IEvent
_capture?	boolean

Returns

void

Implementation of

IText.emitEvent

Inherited from

UI.emitEvent

Defined in

leafer/packages/display/src/Leaf.ts:587

---

hasEvent

▸ hasEvent(_type, _capture?): boolean

Parameters

Name	Type
_type	string
_capture?	boolean

Returns

boolean

Implementation of

IText.hasEvent

Inherited from

UI.hasEvent

Defined in

leafer/packages/display/src/Leaf.ts:589

---

changeAttr

▸ changeAttr(attrName, defaultValue, fn?): void

Parameters

Name	Type
attrName	string
defaultValue	IValue
fn?	IAttrDecorator

Returns

void

Inherited from

UI.changeAttr

Defined in

leafer/packages/display/src/Leaf.ts:593

---

addAttr

▸ addAttr(attrName, defaultValue, fn?): void

Parameters

Name	Type
attrName	string
defaultValue	IValue
fn?	IAttrDecorator

Returns

void

Inherited from

UI.addAttr

Defined in

leafer/packages/display/src/Leaf.ts:597

---

__drawHitPath

▸ __drawHitPath(canvas): void

Parameters

Name	Type
canvas	ILeaferCanvas

Returns

void

Implementation of

IText.__drawHitPath

Overrides

UI.__drawHitPath

Defined in

ui/packages/display/src/Text.ts:98

---

__drawPathByData

▸ __drawPathByData(drawer, _data?): void

Parameters

Name	Type
drawer	IPathDrawer
_data?	IPathCommandData

Returns

void

Implementation of

IText.__drawPathByData

Overrides

UI.__drawPathByData

Defined in

ui/packages/display/src/Text.ts:110

---

__drawRenderPath

▸ __drawRenderPath(canvas): void

Parameters

Name	Type
canvas	ILeaferCanvas

Returns

void

Implementation of

IText.__drawRenderPath

Overrides

UI.__drawRenderPath

Defined in

ui/packages/display/src/Text.ts:115

---

__updateTextDrawData

▸ __updateTextDrawData(): void

Returns

void

Defined in

ui/packages/display/src/Text.ts:119

---

__updateBoxBounds

▸ __updateBoxBounds(): void

Returns

void

Implementation of

IText.__updateBoxBounds

Overrides

UI.__updateBoxBounds

Defined in

ui/packages/display/src/Text.ts:125

---

__updateRenderSpread

▸ __updateRenderSpread(): number

Returns

number

Implementation of

IText.__updateRenderSpread

Overrides

UI.__updateRenderSpread

Defined in

ui/packages/display/src/Text.ts:185

---

__updateRenderBounds

▸ __updateRenderBounds(): void

Returns

void

Implementation of

IText.__updateRenderBounds

Overrides

UI.__updateRenderBounds

Defined in

ui/packages/display/src/Text.ts:191

---

reset

▸ reset(_data?): void

Parameters

Name	Type
_data?	IUIInputData

Returns

void

Implementation of

IText.reset

Inherited from

UI.reset

Defined in

ui/packages/display/src/UI.ts:373

---

set

▸ set(data): void

Parameters

Name	Type
data	IUIInputData

Returns

void

Implementation of

IText.set

Inherited from

UI.set

Defined in

ui/packages/display/src/UI.ts:376

---

get

▸ get(name?): IValue | IUIInputData

Parameters

Name	Type
name?	string | string[] | IUIInputData

Returns

IValue | IUIInputData

Implementation of

IText.get

Inherited from

UI.get

Defined in

ui/packages/display/src/UI.ts:380

---

createProxyData

▸ createProxyData(): IUIInputData

Returns

IUIInputData

Implementation of

IText.createProxyData

Inherited from

UI.createProxyData

Defined in

ui/packages/display/src/UI.ts:384

---

find

▸ find(_condition, _options?): IUI[]

Parameters

Name	Type
_condition	string | number | IFindCondition | IFindUIMethod
_options?	any

Returns

IUI[]

Implementation of

IText.find

Inherited from

UI.find

Defined in

ui/packages/display/src/UI.ts:389

---

findTag

▸ findTag(tag): IUI[]

Parameters

Name	Type
tag	string | string[]

Returns

IUI[]

Implementation of

IText.findTag

Inherited from

UI.findTag

Defined in

ui/packages/display/src/UI.ts:391

---

findOne

▸ findOne(_condition, _options?): IUI

Parameters

Name	Type
_condition	string | number | IFindCondition | IFindUIMethod
_options?	any

Returns

IUI

Implementation of

IText.findOne

Inherited from

UI.findOne

Defined in

ui/packages/display/src/UI.ts:393

---

findId

▸ findId(id): IUI

Parameters

Name	Type
id	string | number

Returns

IUI

Implementation of

IText.findId

Inherited from

UI.findId

Defined in

ui/packages/display/src/UI.ts:395

---

getPath

▸ getPath(curve?, pathForRender?): IPathCommandData

Parameters

Name	Type
curve?	boolean
pathForRender?	boolean

Returns

IPathCommandData

Implementation of

IText.getPath

Inherited from

UI.getPath

Defined in

ui/packages/display/src/UI.ts:400

---

getPathString

▸ getPathString(curve?, pathForRender?): string

Parameters

Name	Type
curve?	boolean
pathForRender?	boolean

Returns

string

Implementation of

IText.getPathString

Inherited from

UI.getPathString

Defined in

ui/packages/display/src/UI.ts:407

---

load

▸ load(): void

Returns

void

Implementation of

IText.load

Inherited from

UI.load

Defined in

ui/packages/display/src/UI.ts:412

---

__onUpdateSize

▸ __onUpdateSize(): void

Returns

void

Implementation of

IText.__onUpdateSize

Inherited from

UI.__onUpdateSize

Defined in

ui/packages/display/src/UI.ts:416

---

__updateRenderPath

▸ __updateRenderPath(): void

Returns

void

Implementation of

IText.__updateRenderPath

Inherited from

UI.__updateRenderPath

Defined in

ui/packages/display/src/UI.ts:423

---

__drawPath

▸ __drawPath(canvas): void

Parameters

Name	Type
canvas	ILeaferCanvas

Returns

void

Implementation of

IText.__drawPath

Inherited from

UI.__drawPath

Defined in

ui/packages/display/src/UI.ts:436

---

__drawPathByBox

▸ __drawPathByBox(drawer): void

Parameters

Name	Type
drawer	IPathDrawer

Returns

void

Implementation of

IText.__drawPathByBox

Inherited from

UI.__drawPathByBox

Defined in

ui/packages/display/src/UI.ts:449

---

export

▸ export(filename, options?): Promise<IExportResult>

Parameters

Name	Type
filename	string
options?	number | boolean | IExportOptions

Returns

Promise<IExportResult>

Implementation of

IText.export

Inherited from

UI.export

Defined in

ui/packages/display/src/UI.ts:462

---

clone

▸ clone(): IUI

Returns

IUI

Implementation of

IText.clone

Inherited from

UI.clone

Defined in

ui/packages/display/src/UI.ts:466

---

one

▸ one(data, x?, y?, width?, height?): IUI

Parameters

Name	Type
data	IUIInputData
x?	number
y?	number
width?	number
height?	number

Returns

IUI

Inherited from

UI.one

Defined in

ui/packages/display/src/UI.ts:470

---

registerUI

▸ registerUI(): void

Returns

void

Inherited from

UI.registerUI

Defined in

ui/packages/display/src/UI.ts:474

---

registerData

▸ registerData(data): void

Parameters

Name	Type
data	IUIData

Returns

void

Inherited from

UI.registerData

Defined in

ui/packages/display/src/UI.ts:478

---

setEditConfig

▸ setEditConfig(_config): void

Parameters

Name	Type
_config	IEditorConfig | IEditorConfigFunction

Returns

void

Inherited from

UI.setEditConfig

Defined in

ui/packages/display/src/UI.ts:485

---

setEditOuter

▸ setEditOuter(_toolName): void

Parameters

Name	Type
_toolName	string | IEditToolFunction

Returns

void

Inherited from

UI.setEditOuter

Defined in

ui/packages/display/src/UI.ts:487

---

setEditInner

▸ setEditInner(_editorName): void

Parameters

Name	Type
_editorName	string | IEditToolFunction

Returns

void

Inherited from

UI.setEditInner

Defined in

ui/packages/display/src/UI.ts:489

---

destroy

▸ destroy(): void

Returns

void

Implementation of

IText.destroy

Inherited from

UI.destroy

Defined in

ui/packages/display/src/UI.ts:492