Scrawl-canvas API
SC inline documentation
SC demo test suite
SC developer runbook
GitHub
Preparing search index...
PolylineFactoryFunctions
Interface PolylineFactoryFunctions
interface
PolylineFactoryFunctions
{
actionPacket
:
(
item
:
string
,
override
?:
CommonObjectInput
)
=>
any
;
addFilters
?:
(
...
items
:
(
string
|
FilterInstance
)
[]
)
=>
EntityInstance
;
checkHit
?:
(
tests
:
HitTests
)
=>
boolean
|
HitOutput
;
clearFilters
?:
()
=>
EntityInstance
;
clickAnchor
?:
()
=>
void
;
clickButton
?:
()
=>
void
;
clone
:
(
item
?:
PolylineFactoryInputs
)
=>
PolylineInstance
;
dropArtefact
?:
()
=>
ArtefactInstance
;
get
:
(
item
:
string
)
=>
any
;
getBoundingBox
:
()
=>
number
[]
;
getPathPositionData
:
(
pos
:
number
,
constantSpeed
?:
boolean
,
)
=>
PathPositionObject
;
getPinAt
:
(
item
:
number
)
=>
[
number
,
number
]
;
importPacket
:
(
item
:
string
|
string
[]
,
override
?:
CommonObjectInput
,
)
=>
any
;
kill
:
(
item
?:
any
)
=>
void
;
pickupArtefact
?:
(
items
:
CommonHereObjectInput
|
CommonTwoElementArrayInput
,
)
=>
ArtefactInstance
;
removeFilters
?:
(
...
items
:
(
string
|
FilterInstance
)
[]
)
=>
EntityInstance
;
removePinAt
:
(
index
:
number
)
=>
void
;
reverseByDelta
:
()
=>
ArtefactInstance
;
saveAsPacket
:
(
item
?:
boolean
|
PolylineSaveInputs
)
=>
string
;
set
:
(
item
?:
PolylineFactoryInputs
)
=>
PolylineInstance
;
setDelta
:
(
item
?:
PolylineFactoryDeltaInputs
)
=>
PolylineInstance
;
setDeltaValues
:
(
item
?:
CommonObjectInput
)
=>
ArtefactInstance
;
simpleStamp
:
(
host
:
CellInstance
,
items
?:
PolylineFactoryInputs
)
=>
void
;
updateByDelta
:
()
=>
ArtefactInstance
;
updatePinAt
:
(
pin
:
PolylinePinInput
,
index
:
number
)
=>
void
;
}
Hierarchy (
View Summary
)
BaseMixinFunctions
ShapeBasicMixinFunctions
PolylineFactoryFunctions
PolylineInstance
Index
Properties
action
Packet
add
Filters?
check
Hit?
clear
Filters?
click
Anchor?
click
Button?
clone
drop
Artefact?
get
get
Bounding
Box
get
Path
Position
Data
get
Pin
At
import
Packet
kill
pickup
Artefact?
remove
Filters?
remove
Pin
At
reverse
By
Delta
save
As
Packet
set
set
Delta
set
Delta
Values
simple
Stamp
update
By
Delta
update
Pin
At
Properties
action
Packet
actionPacket
:
(
item
:
string
,
override
?:
CommonObjectInput
)
=>
any
Optional
add
Filters
addFilters
?:
(
...
items
:
(
string
|
FilterInstance
)
[]
)
=>
EntityInstance
Optional
check
Hit
checkHit
?:
(
tests
:
HitTests
)
=>
boolean
|
HitOutput
Optional
clear
Filters
clearFilters
?:
()
=>
EntityInstance
Optional
click
Anchor
clickAnchor
?:
()
=>
void
Optional
click
Button
clickButton
?:
()
=>
void
clone
clone
:
(
item
?:
PolylineFactoryInputs
)
=>
PolylineInstance
Optional
drop
Artefact
dropArtefact
?:
()
=>
ArtefactInstance
get
get
:
(
item
:
string
)
=>
any
get
Bounding
Box
getBoundingBox
:
()
=>
number
[]
get
Path
Position
Data
getPathPositionData
:
(
pos
:
number
,
constantSpeed
?:
boolean
,
)
=>
PathPositionObject
get
Pin
At
getPinAt
:
(
item
:
number
)
=>
[
number
,
number
]
import
Packet
importPacket
:
(
item
:
string
|
string
[]
,
override
?:
CommonObjectInput
)
=>
any
kill
kill
:
(
item
?:
any
)
=>
void
Optional
pickup
Artefact
pickupArtefact
?:
(
items
:
CommonHereObjectInput
|
CommonTwoElementArrayInput
,
)
=>
ArtefactInstance
Optional
remove
Filters
removeFilters
?:
(
...
items
:
(
string
|
FilterInstance
)
[]
)
=>
EntityInstance
remove
Pin
At
removePinAt
:
(
index
:
number
)
=>
void
reverse
By
Delta
reverseByDelta
:
()
=>
ArtefactInstance
save
As
Packet
saveAsPacket
:
(
item
?:
boolean
|
PolylineSaveInputs
)
=>
string
set
set
:
(
item
?:
PolylineFactoryInputs
)
=>
PolylineInstance
set
Delta
setDelta
:
(
item
?:
PolylineFactoryDeltaInputs
)
=>
PolylineInstance
set
Delta
Values
setDeltaValues
:
(
item
?:
CommonObjectInput
)
=>
ArtefactInstance
simple
Stamp
simpleStamp
:
(
host
:
CellInstance
,
items
?:
PolylineFactoryInputs
)
=>
void
update
By
Delta
updateByDelta
:
()
=>
ArtefactInstance
update
Pin
At
updatePinAt
:
(
pin
:
PolylinePinInput
,
index
:
number
)
=>
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
action
Packet
add
Filters
check
Hit
clear
Filters
click
Anchor
click
Button
clone
drop
Artefact
get
get
Bounding
Box
get
Path
Position
Data
get
Pin
At
import
Packet
kill
pickup
Artefact
remove
Filters
remove
Pin
At
reverse
By
Delta
save
As
Packet
set
set
Delta
set
Delta
Values
simple
Stamp
update
By
Delta
update
Pin
At
SC inline documentation
SC demo test suite
SC developer runbook
GitHub
Scrawl-canvas API
Loading...