Scrawl-canvas API
SC inline documentation
SC demo test suite
SC developer runbook
GitHub
Preparing search index...
CanvasFactoryFunctions
Interface CanvasFactoryFunctions
interface
CanvasFactoryFunctions
{
actionPacket
:
(
item
:
string
,
override
?:
CommonObjectInput
)
=>
any
;
addCell
:
(
item
:
string
|
CellInstance
)
=>
CanvasInstance
;
addClasses
:
(
item
:
string
)
=>
void
;
apply
:
()
=>
void
;
buildCell
:
(
items
:
CellFactoryInputs
)
=>
CellInstance
;
checkHit
?:
(
tests
:
HitTests
)
=>
boolean
|
HitOutput
;
checkHover
:
()
=>
void
;
clear
:
()
=>
void
;
clickAnchor
?:
()
=>
void
;
clickButton
?:
()
=>
void
;
clone
:
(
item
?:
CanvasFactoryInputs
)
=>
CanvasInstance
;
compile
:
()
=>
void
;
deltaSetBase
:
(
items
:
CellFactoryInputs
)
=>
CanvasInstance
;
dropArtefact
?:
()
=>
ArtefactInstance
;
get
:
(
item
:
string
)
=>
any
;
getBase
:
()
=>
CellInstance
;
getBaseHere
:
()
=>
CommonHereObjectInput
;
importPacket
:
(
item
:
string
|
string
[]
,
override
?:
CommonObjectInput
,
)
=>
any
;
kill
:
(
item
?:
any
)
=>
void
;
killCell
:
(
item
:
string
|
CellInstance
)
=>
CanvasInstance
;
pickupArtefact
?:
(
items
:
CommonHereObjectInput
|
CommonTwoElementArrayInput
,
)
=>
ArtefactInstance
;
removeCell
:
(
item
:
string
|
CellInstance
)
=>
CanvasInstance
;
removeClasses
:
(
item
:
string
)
=>
void
;
render
:
()
=>
void
;
reset
:
()
=>
void
;
reverseByDelta
:
()
=>
ArtefactInstance
;
saveAsPacket
:
(
item
?:
boolean
|
CanvasSaveInputs
)
=>
string
;
set
:
(
item
?:
CanvasFactoryInputs
)
=>
CanvasInstance
;
setActionBannerShape
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
;
setActionLandscapeShape
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
;
setActionLargerArea
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
;
setActionLargestArea
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
;
setActionPortraitShape
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
;
setActionRectangleShape
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
;
setActionRegularArea
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
;
setActionSkyscraperShape
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
;
setActionSmallerArea
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
;
setActionSmallestArea
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
;
setAsCurrentCanvas
:
()
=>
CanvasInstance
;
setBase
:
(
items
:
CellFactoryInputs
)
=>
CanvasInstance
;
setColorSchemeDarkAction
:
DefaultInputFunction
;
setColorSchemeLightAction
:
DefaultInputFunction
;
setDelta
:
(
item
?:
CanvasFactoryDeltaInputs
)
=>
CanvasInstance
;
setDeltaValues
:
(
item
?:
CommonObjectInput
)
=>
ArtefactInstance
;
setDisplayShapeBreakpoints
:
(
item
?:
CommonObjectInput
)
=>
ArtefactInstance
;
setMoreContrastAction
:
DefaultInputFunction
;
setNoPreferenceDataAction
:
DefaultInputFunction
;
setNoPreferenceMotionAction
:
DefaultInputFunction
;
setNoPreferenceTransparencyAction
:
DefaultInputFunction
;
setOtherContrastAction
:
DefaultInputFunction
;
setReduceDataAction
:
DefaultInputFunction
;
setReduceMotionAction
:
DefaultInputFunction
;
setReduceTransparencyAction
:
DefaultInputFunction
;
show
:
()
=>
void
;
simpleStamp
:
()
=>
void
;
updateByDelta
:
()
=>
ArtefactInstance
;
updateDisplay
:
()
=>
void
;
updateDisplayArea
:
()
=>
void
;
updateDisplayShape
:
()
=>
void
;
}
Hierarchy (
View Summary
)
BaseMixinFunctions
DomMixinFunctions
DisplayShapeMixinFunctions
CanvasFactoryFunctions
CanvasInstance
Index
Properties
action
Packet
add
Cell
add
Classes
apply
build
Cell
check
Hit?
check
Hover
clear
click
Anchor?
click
Button?
clone
compile
delta
Set
Base
drop
Artefact?
get
get
Base
get
Base
Here
import
Packet
kill
kill
Cell
pickup
Artefact?
remove
Cell
remove
Classes
render
reset
reverse
By
Delta
save
As
Packet
set
set
Action
Banner
Shape
set
Action
Landscape
Shape
set
Action
Larger
Area
set
Action
Largest
Area
set
Action
Portrait
Shape
set
Action
Rectangle
Shape
set
Action
Regular
Area
set
Action
Skyscraper
Shape
set
Action
Smaller
Area
set
Action
Smallest
Area
set
As
Current
Canvas
set
Base
set
Color
Scheme
Dark
Action
set
Color
Scheme
Light
Action
set
Delta
set
Delta
Values
set
Display
Shape
Breakpoints
set
More
Contrast
Action
set
No
Preference
Data
Action
set
No
Preference
Motion
Action
set
No
Preference
Transparency
Action
set
Other
Contrast
Action
set
Reduce
Data
Action
set
Reduce
Motion
Action
set
Reduce
Transparency
Action
show
simple
Stamp
update
By
Delta
update
Display
update
Display
Area
update
Display
Shape
Properties
action
Packet
actionPacket
:
(
item
:
string
,
override
?:
CommonObjectInput
)
=>
any
add
Cell
addCell
:
(
item
:
string
|
CellInstance
)
=>
CanvasInstance
add
Classes
addClasses
:
(
item
:
string
)
=>
void
apply
apply
:
()
=>
void
build
Cell
buildCell
:
(
items
:
CellFactoryInputs
)
=>
CellInstance
Optional
check
Hit
checkHit
?:
(
tests
:
HitTests
)
=>
boolean
|
HitOutput
check
Hover
checkHover
:
()
=>
void
clear
clear
:
()
=>
void
Optional
click
Anchor
clickAnchor
?:
()
=>
void
Optional
click
Button
clickButton
?:
()
=>
void
clone
clone
:
(
item
?:
CanvasFactoryInputs
)
=>
CanvasInstance
compile
compile
:
()
=>
void
delta
Set
Base
deltaSetBase
:
(
items
:
CellFactoryInputs
)
=>
CanvasInstance
Optional
drop
Artefact
dropArtefact
?:
()
=>
ArtefactInstance
get
get
:
(
item
:
string
)
=>
any
get
Base
getBase
:
()
=>
CellInstance
get
Base
Here
getBaseHere
:
()
=>
CommonHereObjectInput
import
Packet
importPacket
:
(
item
:
string
|
string
[]
,
override
?:
CommonObjectInput
)
=>
any
kill
kill
:
(
item
?:
any
)
=>
void
kill
Cell
killCell
:
(
item
:
string
|
CellInstance
)
=>
CanvasInstance
Optional
pickup
Artefact
pickupArtefact
?:
(
items
:
CommonHereObjectInput
|
CommonTwoElementArrayInput
,
)
=>
ArtefactInstance
remove
Cell
removeCell
:
(
item
:
string
|
CellInstance
)
=>
CanvasInstance
remove
Classes
removeClasses
:
(
item
:
string
)
=>
void
render
render
:
()
=>
void
reset
reset
:
()
=>
void
reverse
By
Delta
reverseByDelta
:
()
=>
ArtefactInstance
save
As
Packet
saveAsPacket
:
(
item
?:
boolean
|
CanvasSaveInputs
)
=>
string
set
set
:
(
item
?:
CanvasFactoryInputs
)
=>
CanvasInstance
set
Action
Banner
Shape
setActionBannerShape
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
set
Action
Landscape
Shape
setActionLandscapeShape
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
set
Action
Larger
Area
setActionLargerArea
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
set
Action
Largest
Area
setActionLargestArea
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
set
Action
Portrait
Shape
setActionPortraitShape
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
set
Action
Rectangle
Shape
setActionRectangleShape
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
set
Action
Regular
Area
setActionRegularArea
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
set
Action
Skyscraper
Shape
setActionSkyscraperShape
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
set
Action
Smaller
Area
setActionSmallerArea
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
set
Action
Smallest
Area
setActionSmallestArea
:
(
item
?:
DefaultInputFunction
)
=>
ArtefactInstance
set
As
Current
Canvas
setAsCurrentCanvas
:
()
=>
CanvasInstance
set
Base
setBase
:
(
items
:
CellFactoryInputs
)
=>
CanvasInstance
set
Color
Scheme
Dark
Action
setColorSchemeDarkAction
:
DefaultInputFunction
set
Color
Scheme
Light
Action
setColorSchemeLightAction
:
DefaultInputFunction
set
Delta
setDelta
:
(
item
?:
CanvasFactoryDeltaInputs
)
=>
CanvasInstance
set
Delta
Values
setDeltaValues
:
(
item
?:
CommonObjectInput
)
=>
ArtefactInstance
set
Display
Shape
Breakpoints
setDisplayShapeBreakpoints
:
(
item
?:
CommonObjectInput
)
=>
ArtefactInstance
set
More
Contrast
Action
setMoreContrastAction
:
DefaultInputFunction
set
No
Preference
Data
Action
setNoPreferenceDataAction
:
DefaultInputFunction
set
No
Preference
Motion
Action
setNoPreferenceMotionAction
:
DefaultInputFunction
set
No
Preference
Transparency
Action
setNoPreferenceTransparencyAction
:
DefaultInputFunction
set
Other
Contrast
Action
setOtherContrastAction
:
DefaultInputFunction
set
Reduce
Data
Action
setReduceDataAction
:
DefaultInputFunction
set
Reduce
Motion
Action
setReduceMotionAction
:
DefaultInputFunction
set
Reduce
Transparency
Action
setReduceTransparencyAction
:
DefaultInputFunction
show
show
:
()
=>
void
simple
Stamp
simpleStamp
:
()
=>
void
update
By
Delta
updateByDelta
:
()
=>
ArtefactInstance
update
Display
updateDisplay
:
()
=>
void
update
Display
Area
updateDisplayArea
:
()
=>
void
update
Display
Shape
updateDisplayShape
:
()
=>
void
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Properties
action
Packet
add
Cell
add
Classes
apply
build
Cell
check
Hit
check
Hover
clear
click
Anchor
click
Button
clone
compile
delta
Set
Base
drop
Artefact
get
get
Base
get
Base
Here
import
Packet
kill
kill
Cell
pickup
Artefact
remove
Cell
remove
Classes
render
reset
reverse
By
Delta
save
As
Packet
set
set
Action
Banner
Shape
set
Action
Landscape
Shape
set
Action
Larger
Area
set
Action
Largest
Area
set
Action
Portrait
Shape
set
Action
Rectangle
Shape
set
Action
Regular
Area
set
Action
Skyscraper
Shape
set
Action
Smaller
Area
set
Action
Smallest
Area
set
As
Current
Canvas
set
Base
set
Color
Scheme
Dark
Action
set
Color
Scheme
Light
Action
set
Delta
set
Delta
Values
set
Display
Shape
Breakpoints
set
More
Contrast
Action
set
No
Preference
Data
Action
set
No
Preference
Motion
Action
set
No
Preference
Transparency
Action
set
Other
Contrast
Action
set
Reduce
Data
Action
set
Reduce
Motion
Action
set
Reduce
Transparency
Action
show
simple
Stamp
update
By
Delta
update
Display
update
Display
Area
update
Display
Shape
SC inline documentation
SC demo test suite
SC developer runbook
GitHub
Scrawl-canvas API
Loading...