Appearance
API Reference / Input
Class: Input
Defined in: display/Input.ts:4
Extends
Constructors
Constructor
new Input(
value?,options?):Input
Defined in: display/Input.ts:18
Parameters
value?
string
options?
InputOption = {}
Returns
Overrides
Properties
$alpha
protected$alpha:number=1
Defined in: display/Layer.ts:29
Inherited from
$anchorX
protected$anchorX:number=0
Defined in: display/Layer.ts:22
Inherited from
$anchorY
protected$anchorY:number=0
Defined in: display/Layer.ts:23
Inherited from
$autoFitSize
protected$autoFitSize:boolean=false
Defined in: display/Text.ts:24
Inherited from
$background
protected$background:string=null
Defined in: display/Layer.ts:32
Inherited from
$boundFocus()
protected$boundFocus: () =>void
Defined in: display/Input.ts:16
Returns
void
$breakWord
protected$breakWord:boolean=false
Defined in: display/Text.ts:23
Inherited from
$canvas
protectedreadonly$canvas:HTMLCanvasElement
Defined in: display/Layer.ts:39
Inherited from
$children
protected$children:Layer[] =[]
Defined in: display/Layer.ts:35
Inherited from
$color
protected$color:string='black'
Defined in: display/Text.ts:12
Inherited from
$context
protectedreadonly$context:CanvasRenderingContext2D
Defined in: display/Layer.ts:40
Inherited from
$dirty
protected$dirty:boolean=true
Defined in: display/Layer.ts:36
Inherited from
$emittingType
protected$emittingType:string=null
Defined in: event/EventEmitter.ts:6
Inherited from
$events
protected$events:Object={}
Defined in: event/EventEmitter.ts:5
Inherited from
$explicitColor
protected$explicitColor:string='black'
Defined in: display/Input.ts:15
$explicitSize
protected$explicitSize:number=0
Defined in: display/Text.ts:26
Inherited from
$fontFamily
protected$fontFamily:string='Helvetica'
Defined in: display/Text.ts:21
Inherited from
$fontSize
protected$fontSize:number=Text.defaultFontSize
Defined in: display/Text.ts:13
Inherited from
$fontStyle
protected$fontStyle:FontStyle='normal'
Defined in: display/Text.ts:14
Inherited from
$fontWeight
protected$fontWeight:FontWeight='normal'
Defined in: display/Text.ts:15
Inherited from
$height
protected$height:number=0
Defined in: display/Layer.ts:21
Inherited from
$lineHeight
protected$lineHeight:number=1.2
Defined in: display/Text.ts:18
Inherited from
$lines
protected$lines:string[] =[]
Defined in: display/Text.ts:27
Inherited from
$maxLength
protected$maxLength:number=0xffffff
Defined in: display/Input.ts:12
$minFontSize
protected$minFontSize:number=0
Defined in: display/Text.ts:25
Inherited from
$multiline
protected$multiline:boolean=false
Defined in: display/Text.ts:22
Inherited from
$parent
protected$parent:Layer=null
Defined in: display/Layer.ts:34
Inherited from
$placeholder
protected$placeholder:string=''
Defined in: display/Input.ts:13
$placeholderColor
protected$placeholderColor:string='#888'
Defined in: display/Input.ts:14
$removedListeners
protected$removedListeners:Listener[] =[]
Defined in: event/EventEmitter.ts:7
Inherited from
$rotation
protected$rotation:number=0
Defined in: display/Layer.ts:28
Inherited from
$scaleX
protected$scaleX:number=1
Defined in: display/Layer.ts:26
Inherited from
$scaleY
protected$scaleY:number=1
Defined in: display/Layer.ts:27
Inherited from
$shouldEmitTap
protected$shouldEmitTap:boolean=true
Defined in: display/Layer.ts:37
Inherited from
$skewX
protected$skewX:number=0
Defined in: display/Layer.ts:24
Inherited from
$skewY
protected$skewY:number=0
Defined in: display/Layer.ts:25
Inherited from
$smoothing
protected$smoothing:boolean=true
Defined in: display/Layer.ts:31
Inherited from
$stage
protected$stage:Stage=null
Defined in: display/Layer.ts:33
Inherited from
$strokeColor
protected$strokeColor:string=null
Defined in: display/Text.ts:20
Inherited from
$strokeSize
protected$strokeSize:number=0
Defined in: display/Text.ts:19
Inherited from
$text
protected$text:string=''
Defined in: display/Text.ts:11
Inherited from
$textAlign
protected$textAlign:TextAlign='left'
Defined in: display/Text.ts:16
Inherited from
$touches
protected$touches:boolean[] =[]
Defined in: display/Layer.ts:38
Inherited from
$type
protected$type:InputType='text'
Defined in: display/Input.ts:11
$value
protected$value:string=''
Defined in: display/Input.ts:10
$verticalAlign
protected$verticalAlign:VerticalAlign='top'
Defined in: display/Text.ts:17
Inherited from
$visible
protected$visible:boolean=true
Defined in: display/Layer.ts:30
Inherited from
$width
protected$width:number=0
Defined in: display/Layer.ts:20
Inherited from
$x
protected$x:number=0
Defined in: display/Layer.ts:18
Inherited from
$y
protected$y:number=0
Defined in: display/Layer.ts:19
Inherited from
name
name:
string=''
Defined in: display/Layer.ts:14
Inherited from
tag
tag:
string=''
Defined in: display/Layer.ts:15
Inherited from
touchable
touchable:
boolean=true
Defined in: display/Layer.ts:16
Inherited from
$focusedInput
protectedstatic$focusedInput:Input
Defined in: display/Input.ts:6
$inputElement
protectedstatic$inputElement:HTMLInputElement
Defined in: display/Input.ts:7
$textAreaElement
protectedstatic$textAreaElement:HTMLTextAreaElement
Defined in: display/Input.ts:8
boundaryRe
protectedreadonlystaticboundaryRe:RegExp
Defined in: display/Text.ts:9
Inherited from
defaultFontSize
staticdefaultFontSize:number=16
Defined in: display/Text.ts:6
Inherited from
pixelRatio
staticpixelRatio:number
Defined in: display/Layer.ts:12
Inherited from
wordRe
protectedreadonlystaticwordRe:RegExp
Defined in: display/Text.ts:8
Inherited from
Accessors
alpha
Get Signature
get alpha():
number
Defined in: display/Layer.ts:169
Returns
number
Set Signature
set alpha(
alpha):void
Defined in: display/Layer.ts:173
Parameters
alpha
number
Returns
void
Inherited from
anchorX
Get Signature
get anchorX():
number
Defined in: display/Layer.ts:92
Returns
number
Set Signature
set anchorX(
anchorX):void
Defined in: display/Layer.ts:96
Parameters
anchorX
number
Returns
void
Inherited from
anchorY
Get Signature
get anchorY():
number
Defined in: display/Layer.ts:103
Returns
number
Set Signature
set anchorY(
anchorY):void
Defined in: display/Layer.ts:107
Parameters
anchorY
number
Returns
void
Inherited from
autoFitSize
Get Signature
get autoFitSize():
boolean
Defined in: display/Text.ts:166
Returns
boolean
Set Signature
set autoFitSize(
autoFitSize):void
Defined in: display/Text.ts:170
Parameters
autoFitSize
boolean
Returns
void
Inherited from
background
Get Signature
get background():
string
Defined in: display/Layer.ts:200
Returns
string
Set Signature
set background(
background):void
Defined in: display/Layer.ts:204
Parameters
background
string
Returns
void
Inherited from
breakWord
Get Signature
get breakWord():
boolean
Defined in: display/Text.ts:157
Returns
boolean
Set Signature
set breakWord(
breakWord):void
Defined in: display/Text.ts:161
Parameters
breakWord
boolean
Returns
void
Inherited from
canvas
Get Signature
get canvas():
HTMLCanvasElement
Defined in: display/Layer.ts:227
Returns
HTMLCanvasElement
Inherited from
color
Get Signature
get color():
string
Defined in: display/Input.ts:51
Returns
string
Set Signature
set color(
color):void
Defined in: display/Input.ts:55
Parameters
color
string
Returns
void
Overrides
fontFamily
Get Signature
get fontFamily():
string
Defined in: display/Text.ts:139
Returns
string
Set Signature
set fontFamily(
fontFamily):void
Defined in: display/Text.ts:143
Parameters
fontFamily
string
Returns
void
Inherited from
fontSize
Get Signature
get fontSize():
number
Defined in: display/Text.ts:67
Returns
number
Set Signature
set fontSize(
fontSize):void
Defined in: display/Text.ts:71
Parameters
fontSize
number
Returns
void
Inherited from
fontStyle
Get Signature
get fontStyle():
FontStyle
Defined in: display/Text.ts:76
Returns
Set Signature
set fontStyle(
fontStyle):void
Defined in: display/Text.ts:80
Parameters
fontStyle
Returns
void
Inherited from
fontWeight
Get Signature
get fontWeight():
FontWeight
Defined in: display/Text.ts:85
Returns
Set Signature
set fontWeight(
fontWeight):void
Defined in: display/Text.ts:89
Parameters
fontWeight
Returns
void
Inherited from
height
Get Signature
get height():
number
Defined in: display/Layer.ts:81
Returns
number
Set Signature
set height(
height):void
Defined in: display/Layer.ts:85
Parameters
height
number
Returns
void
Inherited from
lineHeight
Get Signature
get lineHeight():
number
Defined in: display/Text.ts:112
Returns
number
Set Signature
set lineHeight(
lineHeight):void
Defined in: display/Text.ts:116
Parameters
lineHeight
number
Returns
void
Inherited from
maxLength
Get Signature
get maxLength():
number
Defined in: display/Input.ts:65
Returns
number
Set Signature
set maxLength(
maxLength):void
Defined in: display/Input.ts:69
Parameters
maxLength
number
Returns
void
minFontSize
Get Signature
get minFontSize():
number
Defined in: display/Text.ts:175
Returns
number
Set Signature
set minFontSize(
minFontSize):void
Defined in: display/Text.ts:179
Parameters
minFontSize
number
Returns
void
Inherited from
multiline
Get Signature
get multiline():
boolean
Defined in: display/Text.ts:148
Returns
boolean
Set Signature
set multiline(
multiline):void
Defined in: display/Text.ts:152
Parameters
multiline
boolean
Returns
void
Inherited from
numChildren
Get Signature
get numChildren():
number
Defined in: display/Layer.ts:219
Returns
number
Inherited from
parent
Get Signature
get parent():
Layer
Defined in: display/Layer.ts:215
Returns
Inherited from
placeholder
Get Signature
get placeholder():
string
Defined in: display/Input.ts:73
Returns
string
Set Signature
set placeholder(
placeholder):void
Defined in: display/Input.ts:77
Parameters
placeholder
string
Returns
void
placeholderColor
Get Signature
get placeholderColor():
string
Defined in: display/Input.ts:82
Returns
string
Set Signature
set placeholderColor(
placeholderColor):void
Defined in: display/Input.ts:86
Parameters
placeholderColor
string
Returns
void
rotation
Get Signature
get rotation():
number
Defined in: display/Layer.ts:158
Returns
number
Set Signature
set rotation(
rotation):void
Defined in: display/Layer.ts:162
Parameters
rotation
number
Returns
void
Inherited from
scaleX
Get Signature
get scaleX():
number
Defined in: display/Layer.ts:136
Returns
number
Set Signature
set scaleX(
scaleX):void
Defined in: display/Layer.ts:140
Parameters
scaleX
number
Returns
void
Inherited from
scaleY
Get Signature
get scaleY():
number
Defined in: display/Layer.ts:147
Returns
number
Set Signature
set scaleY(
scaleY):void
Defined in: display/Layer.ts:151
Parameters
scaleY
number
Returns
void
Inherited from
skewX
Get Signature
get skewX():
number
Defined in: display/Layer.ts:114
Returns
number
Set Signature
set skewX(
skewX):void
Defined in: display/Layer.ts:118
Parameters
skewX
number
Returns
void
Inherited from
skewY
Get Signature
get skewY():
number
Defined in: display/Layer.ts:125
Returns
number
Set Signature
set skewY(
skewY):void
Defined in: display/Layer.ts:129
Parameters
skewY
number
Returns
void
Inherited from
smoothing
Get Signature
get smoothing():
boolean
Defined in: display/Layer.ts:191
Returns
boolean
Set Signature
set smoothing(
smoothing):void
Defined in: display/Layer.ts:195
Parameters
smoothing
boolean
Returns
void
Inherited from
stage
Get Signature
get stage():
Stage
Defined in: display/Layer.ts:211
Returns
Inherited from
strokeColor
Get Signature
get strokeColor():
string
Defined in: display/Text.ts:130
Returns
string
Set Signature
set strokeColor(
strokeColor):void
Defined in: display/Text.ts:134
Parameters
strokeColor
string
Returns
void
Inherited from
strokeSize
Get Signature
get strokeSize():
number
Defined in: display/Text.ts:121
Returns
number
Set Signature
set strokeSize(
strokeSize):void
Defined in: display/Text.ts:125
Parameters
strokeSize
number
Returns
void
Inherited from
text
Set Signature
set text(
text):void
Defined in: display/Input.ts:30
Parameters
text
string
Returns
void
Overrides
textAlign
Get Signature
get textAlign():
TextAlign
Defined in: display/Text.ts:94
Returns
Set Signature
set textAlign(
textAlign):void
Defined in: display/Text.ts:98
Parameters
textAlign
Returns
void
Inherited from
ticker
Get Signature
get ticker():
Ticker
Defined in: display/Layer.ts:223
Returns
Inherited from
type
Get Signature
get type():
InputType
Defined in: display/Input.ts:42
Returns
Set Signature
set type(
type):void
Defined in: display/Input.ts:46
Parameters
type
Returns
void
value
Get Signature
get value():
string
Defined in: display/Input.ts:33
Returns
string
Set Signature
set value(
value):void
Defined in: display/Input.ts:37
Parameters
value
string
Returns
void
verticalAlign
Get Signature
get verticalAlign():
VerticalAlign
Defined in: display/Text.ts:103
Returns
Set Signature
set verticalAlign(
verticalAlign):void
Defined in: display/Text.ts:107
Parameters
verticalAlign
Returns
void
Inherited from
visible
Get Signature
get visible():
boolean
Defined in: display/Layer.ts:180
Returns
boolean
Set Signature
set visible(
visible):void
Defined in: display/Layer.ts:184
Parameters
visible
boolean
Returns
void
Inherited from
width
Get Signature
get width():
number
Defined in: display/Layer.ts:70
Returns
number
Set Signature
set width(
width):void
Defined in: display/Layer.ts:74
Parameters
width
number
Returns
void
Inherited from
x
Get Signature
get x():
number
Defined in: display/Layer.ts:48
Returns
number
Set Signature
set x(
x):void
Defined in: display/Layer.ts:52
Parameters
x
number
Returns
void
Inherited from
y
Get Signature
get y():
number
Defined in: display/Layer.ts:59
Returns
number
Set Signature
set y(
y):void
Defined in: display/Layer.ts:63
Parameters
y
number
Returns
void
Inherited from
Methods
$divideLines()
protected$divideLines():void
Defined in: display/Text.ts:221
Returns
void
Inherited from
$divideUnits()
protected$divideUnits():string[]
Defined in: display/Text.ts:199
Returns
string[]
Inherited from
$drawChild()
protected$drawChild(child):number
Defined in: display/Layer.ts:605
Parameters
child
Returns
number
Inherited from
$emitAdded()
protected$emitAdded(parent):void
Defined in: display/Layer.ts:543
Parameters
parent
Returns
void
Inherited from
$emitAddedToStage()
protected$emitAddedToStage(stage):void
Defined in: display/Layer.ts:561
Parameters
stage
Returns
void
Inherited from
$emitRemoved()
protected$emitRemoved():void
Defined in: display/Layer.ts:552
Returns
void
Inherited from
$emitRemovedFromStage()
protected$emitRemovedFromStage():void
Defined in: display/Layer.ts:574
Returns
void
Inherited from
$emitTouchEvent()
protected$emitTouchEvent(event,inside):boolean
Defined in: display/Layer.ts:495
Parameters
event
inside
boolean
Returns
boolean
Inherited from
$getChildBounds()
protected$getChildBounds(child):Rectangle
Defined in: display/Layer.ts:449
Parameters
child
Returns
Inherited from
$getChildTransform()
protected$getChildTransform(child):Matrix
Defined in: display/Layer.ts:445
Parameters
child
Returns
Inherited from
$getContentBounds()
protected$getContentBounds():Rectangle
Defined in: display/Text.ts:273
Returns
Inherited from
$getTransform()
protected$getTransform():Matrix
Defined in: display/Layer.ts:434
Returns
Inherited from
$isChildVisible()
protected$isChildVisible(child):boolean
Defined in: display/Layer.ts:591
Parameters
child
Returns
boolean
Inherited from
$localHitTest()
protected$localHitTest(vector):boolean
Defined in: display/Layer.ts:587
Parameters
vector
Returns
boolean
Inherited from
$markDirty()
protected$markDirty(sizeDirty?):void
Defined in: display/Input.ts:177
Parameters
sizeDirty?
boolean
Returns
void
Overrides
$markParentDirty()
protected$markParentDirty():void
Defined in: display/Layer.ts:398
Returns
void
Inherited from
$onTouchTap()
protected$onTouchTap():void
Defined in: display/Input.ts:184
Returns
void
$render()
protected$render():number
Defined in: display/Text.ts:288
Returns
number
Inherited from
$resizeCanvas()
protected$resizeCanvas():void
Defined in: display/Text.ts:253
Returns
void
Inherited from
$resizeParentCanvas()
protected$resizeParentCanvas():void
Defined in: display/Layer.ts:428
Returns
void
Inherited from
$updateContext()
protected$updateContext():void
Defined in: display/Text.ts:184
Returns
void
Inherited from
$updateElement()
protected$updateElement():HTMLInputElement|HTMLTextAreaElement
Defined in: display/Input.ts:140
Returns
HTMLInputElement | HTMLTextAreaElement
$updateText()
protected$updateText():void
Defined in: display/Input.ts:119
Returns
void
addChild()
addChild(
child):this
Defined in: display/Layer.ts:231
Parameters
child
Returns
this
Inherited from
addChildAt()
addChildAt(
child,index):this
Defined in: display/Layer.ts:235
Parameters
child
index
number
Returns
this
Inherited from
blur()
blur():
this
Defined in: display/Input.ts:108
Returns
this
emit()
Call Signature
emit(
event):boolean
Defined in: event/EventEmitter.ts:42
Parameters
event
Returns
boolean
Inherited from
Call Signature
emit(
type, ...args):boolean
Defined in: event/EventEmitter.ts:43
Parameters
type
string
args
...any[]
Returns
boolean
Inherited from
focus()
focus():
this
Defined in: display/Input.ts:99
Returns
this
getChildAt()
getChildAt(
index):Layer
Defined in: display/Layer.ts:277
Parameters
index
number
Returns
Inherited from
getChildByName()
getChildByName(
name):Layer
Defined in: display/Layer.ts:256
Parameters
name
string
Returns
Inherited from
getChildIndex()
getChildIndex(
child):number
Defined in: display/Layer.ts:281
Parameters
child
Returns
number
Inherited from
getChildrenByTag()
getChildrenByTag(
tag):Layer[]
Defined in: display/Layer.ts:266
Parameters
tag
string
Returns
Layer[]
Inherited from
hasChild()
hasChild(
child):boolean
Defined in: display/Layer.ts:285
Parameters
child
Returns
boolean
Inherited from
hasEventListener()
hasEventListener(
type):boolean
Defined in: event/EventEmitter.ts:80
Parameters
type
string
Returns
boolean
Inherited from
off()
off(
type,listener?):this
Defined in: display/Layer.ts:684
Parameters
type
string
listener?
(...args) => void
Returns
this
Inherited from
on()
on(
type,listener):this
Defined in: display/Layer.ts:668
Parameters
type
string
listener
(...args) => void
Returns
this
Inherited from
once()
once(
type,listener):this
Defined in: event/EventEmitter.ts:33
Parameters
type
string
listener
Returns
this
Inherited from
removeAllChildren()
removeAllChildren():
this
Defined in: display/Layer.ts:372
Returns
this
Inherited from
removeAllListeners()
removeAllListeners():
this
Defined in: event/EventEmitter.ts:85
Returns
this
Inherited from
removeChild()
removeChild(
child):this
Defined in: display/Layer.ts:333
Parameters
child
Returns
this
Inherited from
removeChildAt()
removeChildAt(
index):this
Defined in: display/Layer.ts:338
Parameters
index
number
Returns
this
Inherited from
removeChildByName()
removeChildByName(
name):this
Defined in: display/Layer.ts:349
Parameters
name
string
Returns
this
Inherited from
removeChildrenByTag()
removeChildrenByTag(
tag):this
Defined in: display/Layer.ts:361
Parameters
tag
string
Returns
this
Inherited from
removeSelf()
removeSelf():
this
Defined in: display/Layer.ts:382
Returns
this
Inherited from
replaceChild()
replaceChild(
oldChild,newChild):this
Defined in: display/Layer.ts:249
Parameters
oldChild
newChild
Returns
this
Inherited from
selectAll()
selectAll():
this
Defined in: display/Input.ts:91
Returns
this
setChildIndex()
setChildIndex(
child,index):this
Defined in: display/Layer.ts:309
Parameters
child
index
number
Returns
this
Inherited from
swapChildren()
swapChildren(
child1,child2):this
Defined in: display/Layer.ts:289
Parameters
child1
child2
Returns
this
Inherited from
swapChildrenAt()
swapChildrenAt(
index1,index2):this
Defined in: display/Layer.ts:298
Parameters
index1
number
index2
number
Returns
this
Inherited from
$getElement()
protectedstatic$getElement(tagName):HTMLInputElement|HTMLTextAreaElement
Defined in: display/Input.ts:188
Parameters
tagName
string
Returns
HTMLInputElement | HTMLTextAreaElement