Scrawl-canvas API
SC inline documentation
SC demo test suite
SC developer runbook
GitHub
Preparing search index...
TickerInstance
Interface TickerInstance
interface
TickerInstance
{
actionPacket
:
(
item
:
string
,
override
?:
CommonObjectInput
)
=>
any
;
clone
:
(
item
?:
TickerFactoryInputs
)
=>
TickerInstance
;
complete
:
()
=>
TickerInstance
;
cycles
?:
number
;
delta
?:
TickerFactoryDeltaInputs
;
duration
?:
StringOrNumberInput
;
get
:
(
item
:
string
)
=>
any
;
halt
:
()
=>
TickerInstance
;
importPacket
:
(
item
:
string
|
string
[]
,
override
?:
CommonObjectInput
,
)
=>
any
;
isRunning
:
()
=>
boolean
;
kill
:
(
item
?:
any
)
=>
void
;
killOnComplete
?:
boolean
;
name
?:
string
;
observer
?:
string
|
RenderInstance
;
onComplete
?:
DefaultInputFunction
;
onHalt
?:
DefaultInputFunction
;
onReset
?:
DefaultInputFunction
;
onResume
?:
DefaultInputFunction
;
onReverse
?:
DefaultInputFunction
;
onRun
?:
DefaultInputFunction
;
onSeekFor
?:
DefaultInputFunction
;
onSeekTo
?:
DefaultInputFunction
;
order
?:
number
;
reset
:
()
=>
TickerInstance
;
resume
:
()
=>
TickerInstance
;
reverse
:
(
resume
?:
boolean
)
=>
TickerInstance
;
run
:
()
=>
TickerInstance
;
saveAsPacket
:
(
item
?:
boolean
|
TickerSaveInputs
)
=>
string
;
seekFor
:
(
item
:
number
)
=>
TickerInstance
;
seekTo
:
(
milliseconds
:
number
,
resume
?:
boolean
)
=>
TickerInstance
;
set
:
(
item
?:
TickerFactoryInputs
)
=>
TickerInstance
;
setDelta
:
(
item
?:
TickerFactoryDeltaInputs
)
=>
TickerInstance
;
subscribe
:
(
...
args
:
(
|
string
|
ActionInstance
|
TweenInstance
|
(
string
|
ActionInstance
|
TweenInstance
)
[]
)
[]
,
)
=>
TickerInstance
;
subscribers
?:
(
string
|
ActionInstance
|
TweenInstance
)
[]
;
unsubscribe
:
(
...
args
:
(
|
string
|
ActionInstance
|
TweenInstance
|
(
string
|
ActionInstance
|
TweenInstance
)
[]
)
[]
,
)
=>
TickerInstance
;
}
Hierarchy (
View Summary
)
TickerFactoryInputs
TickerFactoryFunctions
TickerInstance
Index
Properties
action
Packet
clone
complete
cycles?
delta?
duration?
get
halt
import
Packet
is
Running
kill
kill
On
Complete?
name?
observer?
on
Complete?
on
Halt?
on
Reset?
on
Resume?
on
Reverse?
on
Run?
on
Seek
For?
on
Seek
To?
order?
reset
resume
reverse
run
save
As
Packet
seek
For
seek
To
set
set
Delta
subscribe
subscribers?
unsubscribe
Properties
action
Packet
actionPacket
:
(
item
:
string
,
override
?:
CommonObjectInput
)
=>
any
clone
clone
:
(
item
?:
TickerFactoryInputs
)
=>
TickerInstance
complete
complete
:
()
=>
TickerInstance
Optional
cycles
cycles
?:
number
Optional
delta
delta
?:
TickerFactoryDeltaInputs
Optional
duration
duration
?:
StringOrNumberInput
get
get
:
(
item
:
string
)
=>
any
halt
halt
:
()
=>
TickerInstance
import
Packet
importPacket
:
(
item
:
string
|
string
[]
,
override
?:
CommonObjectInput
)
=>
any
is
Running
isRunning
:
()
=>
boolean
kill
kill
:
(
item
?:
any
)
=>
void
Optional
kill
On
Complete
killOnComplete
?:
boolean
Optional
name
name
?:
string
Optional
observer
observer
?:
string
|
RenderInstance
Optional
on
Complete
onComplete
?:
DefaultInputFunction
Optional
on
Halt
onHalt
?:
DefaultInputFunction
Optional
on
Reset
onReset
?:
DefaultInputFunction
Optional
on
Resume
onResume
?:
DefaultInputFunction
Optional
on
Reverse
onReverse
?:
DefaultInputFunction
Optional
on
Run
onRun
?:
DefaultInputFunction
Optional
on
Seek
For
onSeekFor
?:
DefaultInputFunction
Optional
on
Seek
To
onSeekTo
?:
DefaultInputFunction
Optional
order
order
?:
number
reset
reset
:
()
=>
TickerInstance
resume
resume
:
()
=>
TickerInstance
reverse
reverse
:
(
resume
?:
boolean
)
=>
TickerInstance
run
run
:
()
=>
TickerInstance
save
As
Packet
saveAsPacket
:
(
item
?:
boolean
|
TickerSaveInputs
)
=>
string
seek
For
seekFor
:
(
item
:
number
)
=>
TickerInstance
seek
To
seekTo
:
(
milliseconds
:
number
,
resume
?:
boolean
)
=>
TickerInstance
set
set
:
(
item
?:
TickerFactoryInputs
)
=>
TickerInstance
set
Delta
setDelta
:
(
item
?:
TickerFactoryDeltaInputs
)
=>
TickerInstance
subscribe
subscribe
:
(
...
args
:
(
|
string
|
ActionInstance
|
TweenInstance
|
(
string
|
ActionInstance
|
TweenInstance
)
[]
)
[]
,
)
=>
TickerInstance
Optional
subscribers
subscribers
?:
(
string
|
ActionInstance
|
TweenInstance
)
[]
unsubscribe
unsubscribe
:
(
...
args
:
(
|
string
|
ActionInstance
|
TweenInstance
|
(
string
|
ActionInstance
|
TweenInstance
)
[]
)
[]
,
)
=>
TickerInstance
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
action
Packet
clone
complete
cycles
delta
duration
get
halt
import
Packet
is
Running
kill
kill
On
Complete
name
observer
on
Complete
on
Halt
on
Reset
on
Resume
on
Reverse
on
Run
on
Seek
For
on
Seek
To
order
reset
resume
reverse
run
save
As
Packet
seek
For
seek
To
set
set
Delta
subscribe
subscribers
unsubscribe
SC inline documentation
SC demo test suite
SC developer runbook
GitHub
Scrawl-canvas API
Loading...