Search
Preparing search index...
The search index is not available
Swim Toolkit
Options
All
Public
Public/Protected
All
Inherited
Externals
Menu
Swim Toolkit
@swim/constraint
ConstraintProperty
Interface ConstraintProperty<O, T, U>
Type parameters
O =
unknown
T =
unknown
U =
T
Hierarchy
Property
<
O
,
T
,
U
>
ConstraintVariable
ConstraintProperty
Callable
Constraint
Property
(
)
:
T
Constraint
Property
(
state
:
T
|
U
, affinity
?:
number
)
:
O
Returns
T
Parameters
state:
T
|
U
Optional
affinity:
number
Returns
O
Index
Properties
condition
Count
flags
id
owner
state
strength
sub
Fasteners
super
Fastener
Accessors
affinity
coefficient
coherent
constant
constrained
constraining
family
Type
inherited
inherits
lazy
mounted
name
static
super
Name
super
State
terms
update
Flags
variable
Methods
add
Constraint
Condition
attach
Sub
Fastener
bind
Super
Fastener
constrain
decohere
decohere
Sub
Fastener
decohere
Sub
Fasteners
detach
Sub
Fastener
did
Bind
Super
Fastener
did
Inherit
did
Mount
did
Set
Affinity
did
Set
Inherits
did
Set
State
did
Start
Constraining
did
Stop
Constraining
did
Unbind
Super
Fastener
did
Uninherit
did
Unmount
divide
equal
State
evaluate
Constraint
Variable
from
Any
get
State
get
State
Or
get
Super
Fastener
get
Super
State
get
Super
State
Or
has
Affinity
init
init
Affinity
init
Inherits
is
Constant
is
Defined
is
Dummy
is
External
is
Invalid
min
Affinity
minus
mount
negative
on
Bind
Super
Fastener
on
Inherit
on
Mount
on
Set
Affinity
on
Set
Inherits
on
Set
State
on
Start
Constraining
on
Stop
Constraining
on
Unbind
Super
Fastener
on
Uninherit
on
Unmount
plus
recohere
remove
Constraint
Condition
set
Affinity
set
Coherent
set
Flags
set
Inherited
set
Inherits
set
State
set
Strength
start
Constraining
stop
Constraining
times
to
Number
to
String
unbind
Super
Fastener
unmount
update
Constraint
Solution
update
Constraint
Variable
will
Bind
Super
Fastener
will
Inherit
will
Mount
will
Set
Affinity
will
Set
Inherits
will
Set
State
will
Start
Constraining
will
Stop
Constraining
will
Unbind
Super
Fastener
will
Uninherit
will
Unmount
Properties
Readonly
condition
Count
condition
Count
:
number
Readonly
flags
flags
:
number
Readonly
id
id
:
number
Readonly
owner
owner
:
O
Readonly
state
state
:
T
Readonly
strength
strength
:
number
Readonly
sub
Fasteners
sub
Fasteners
:
null
|
readonly
Property
<
unknown
,
T
,
T
>
[]
Readonly
super
Fastener
super
Fastener
:
null
|
Property
<
unknown
,
T
,
T
>
Accessors
affinity
get
affinity
(
)
:
number
Returns
number
coefficient
get
coefficient
(
)
:
number
Returns
number
coherent
get
coherent
(
)
:
boolean
Returns
boolean
constant
get
constant
(
)
:
number
Returns
number
constrained
get
constrained
(
)
:
boolean
Returns
boolean
constraining
get
constraining
(
)
:
boolean
Returns
boolean
family
Type
get
familyType
(
)
:
null
|
Class
<
Property
<
any
,
any
,
any
>
>
Returns
null
|
Class
<
Property
<
any
,
any
,
any
>
>
inherited
get
inherited
(
)
:
boolean
Returns
boolean
inherits
get
inherits
(
)
:
boolean
Returns
boolean
lazy
get
lazy
(
)
:
boolean
Returns
boolean
mounted
get
mounted
(
)
:
boolean
Returns
boolean
name
get
name
(
)
:
string
Returns
string
static
get
static
(
)
:
string
|
boolean
Returns
string
|
boolean
super
Name
get
superName
(
)
:
undefined
|
string
Returns
undefined
|
string
super
State
get
superState
(
)
:
undefined
|
T
Returns
undefined
|
T
terms
get
terms
(
)
:
ConstraintMap
<
ConstraintVariable
,
number
>
Returns
ConstraintMap
<
ConstraintVariable
,
number
>
update
Flags
get
updateFlags
(
)
:
undefined
|
number
Returns
undefined
|
number
variable
get
variable
(
)
:
null
|
ConstraintVariable
Returns
null
|
ConstraintVariable
Methods
add
Constraint
Condition
add
Constraint
Condition
(
constraint
:
Constraint
, solver
:
ConstraintSolver
)
:
void
Parameters
constraint:
Constraint
solver:
ConstraintSolver
Returns
void
attach
Sub
Fastener
attach
Sub
Fastener
(
subFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
subFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
bind
Super
Fastener
bind
Super
Fastener
(
)
:
void
Returns
void
constrain
constrain
(
constrained
?:
boolean
)
:
ConstraintProperty
<
O
,
T
,
U
>
Parameters
Optional
constrained:
boolean
Returns
ConstraintProperty
<
O
,
T
,
U
>
decohere
decohere
(
)
:
void
Returns
void
decohere
Sub
Fastener
decohere
Sub
Fastener
(
subFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
subFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
decohere
Sub
Fasteners
decohere
Sub
Fasteners
(
)
:
void
Returns
void
detach
Sub
Fastener
detach
Sub
Fastener
(
subFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
subFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
did
Bind
Super
Fastener
did
Bind
Super
Fastener
(
superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
did
Inherit
did
Inherit
(
superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
did
Mount
did
Mount
(
)
:
void
Returns
void
did
Set
Affinity
did
Set
Affinity
(
newAffinity
:
number
, oldAffinity
:
number
)
:
void
Parameters
newAffinity:
number
oldAffinity:
number
Returns
void
did
Set
Inherits
did
Set
Inherits
(
inherits
:
boolean
, superName
:
undefined
|
string
)
:
void
Parameters
inherits:
boolean
superName:
undefined
|
string
Returns
void
did
Set
State
did
Set
State
(
newState
:
T
, oldState
:
T
)
:
void
Parameters
newState:
T
oldState:
T
Returns
void
did
Start
Constraining
did
Start
Constraining
(
)
:
void
Returns
void
did
Stop
Constraining
did
Stop
Constraining
(
)
:
void
Returns
void
did
Unbind
Super
Fastener
did
Unbind
Super
Fastener
(
superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
did
Uninherit
did
Uninherit
(
superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
did
Unmount
did
Unmount
(
)
:
void
Returns
void
divide
divide
(
scalar
:
number
)
:
ConstraintExpression
Parameters
scalar:
number
Returns
ConstraintExpression
equal
State
equal
State
(
newState
:
T
, oldState
:
undefined
|
T
)
:
boolean
Parameters
newState:
T
oldState:
undefined
|
T
Returns
boolean
evaluate
Constraint
Variable
evaluate
Constraint
Variable
(
)
:
void
Returns
void
from
Any
from
Any
(
value
:
T
|
U
)
:
T
Parameters
value:
T
|
U
Returns
T
get
State
get
State
(
)
:
NonNullable
<
T
>
Returns
NonNullable
<
T
>
get
State
Or
get
State
Or<E>
(
elseState
:
E
)
:
NonNullable
<
T
>
|
E
Type parameters
E
Parameters
elseState:
E
Returns
NonNullable
<
T
>
|
E
get
Super
Fastener
get
Super
Fastener
(
)
:
null
|
Property
<
unknown
,
T
,
T
>
Returns
null
|
Property
<
unknown
,
T
,
T
>
get
Super
State
get
Super
State
(
)
:
NonNullable
<
T
>
Returns
NonNullable
<
T
>
get
Super
State
Or
get
Super
State
Or<E>
(
elseState
:
E
)
:
NonNullable
<
T
>
|
E
Type parameters
E
Parameters
elseState:
E
Returns
NonNullable
<
T
>
|
E
has
Affinity
has
Affinity
(
affinity
:
number
)
:
boolean
Parameters
affinity:
number
Returns
boolean
init
init
(
)
:
void
Returns
void
init
Affinity
init
Affinity
(
affinity
:
number
)
:
void
Parameters
affinity:
number
Returns
void
init
Inherits
init
Inherits
(
inherits
:
string
|
boolean
)
:
void
Parameters
inherits:
string
|
boolean
Returns
void
is
Constant
is
Constant
(
)
:
boolean
Returns
boolean
is
Defined
is
Defined
(
value
:
T
)
:
boolean
Parameters
value:
T
Returns
boolean
is
Dummy
is
Dummy
(
)
:
boolean
Returns
boolean
is
External
is
External
(
)
:
boolean
Returns
boolean
is
Invalid
is
Invalid
(
)
:
boolean
Returns
boolean
min
Affinity
min
Affinity
(
affinity
:
undefined
|
number
)
:
boolean
Parameters
affinity:
undefined
|
number
Returns
boolean
minus
minus
(
that
:
AnyConstraintExpression
)
:
ConstraintExpression
Parameters
that:
AnyConstraintExpression
Returns
ConstraintExpression
mount
mount
(
)
:
void
Returns
void
negative
negative
(
)
:
ConstraintTerm
Returns
ConstraintTerm
on
Bind
Super
Fastener
on
Bind
Super
Fastener
(
superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
on
Inherit
on
Inherit
(
superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
on
Mount
on
Mount
(
)
:
void
Returns
void
on
Set
Affinity
on
Set
Affinity
(
newAffinity
:
number
, oldAffinity
:
number
)
:
void
Parameters
newAffinity:
number
oldAffinity:
number
Returns
void
on
Set
Inherits
on
Set
Inherits
(
inherits
:
boolean
, superName
:
undefined
|
string
)
:
void
Parameters
inherits:
boolean
superName:
undefined
|
string
Returns
void
on
Set
State
on
Set
State
(
newState
:
T
, oldState
:
T
)
:
void
Parameters
newState:
T
oldState:
T
Returns
void
on
Start
Constraining
on
Start
Constraining
(
)
:
void
Returns
void
on
Stop
Constraining
on
Stop
Constraining
(
)
:
void
Returns
void
on
Unbind
Super
Fastener
on
Unbind
Super
Fastener
(
superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
on
Uninherit
on
Uninherit
(
superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
on
Unmount
on
Unmount
(
)
:
void
Returns
void
plus
plus
(
that
:
AnyConstraintExpression
)
:
ConstraintExpression
Parameters
that:
AnyConstraintExpression
Returns
ConstraintExpression
recohere
recohere
(
t
:
number
)
:
void
Parameters
t:
number
Returns
void
remove
Constraint
Condition
remove
Constraint
Condition
(
constraint
:
Constraint
, solver
:
ConstraintSolver
)
:
void
Parameters
constraint:
Constraint
solver:
ConstraintSolver
Returns
void
set
Affinity
set
Affinity
(
affinity
:
number
)
:
void
Parameters
affinity:
number
Returns
void
set
Coherent
set
Coherent
(
coherent
:
boolean
)
:
void
Parameters
coherent:
boolean
Returns
void
set
Flags
set
Flags
(
flags
:
number
)
:
void
Parameters
flags:
number
Returns
void
set
Inherited
set
Inherited
(
inherited
:
boolean
, superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
inherited:
boolean
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
set
Inherits
set
Inherits
(
inherits
:
string
|
boolean
)
:
void
Parameters
inherits:
string
|
boolean
Returns
void
set
State
set
State
(
newState
:
T
|
U
, affinity
?:
number
)
:
void
Parameters
newState:
T
|
U
Optional
affinity:
number
Returns
void
set
Strength
set
Strength
(
strength
:
AnyConstraintStrength
)
:
void
Parameters
strength:
AnyConstraintStrength
Returns
void
start
Constraining
start
Constraining
(
)
:
void
Returns
void
stop
Constraining
stop
Constraining
(
)
:
void
Returns
void
times
times
(
scalar
:
number
)
:
ConstraintExpression
Parameters
scalar:
number
Returns
ConstraintExpression
to
Number
to
Number
(
value
:
T
)
:
number
Parameters
value:
T
Returns
number
to
String
to
String
(
)
:
string
Returns
string
unbind
Super
Fastener
unbind
Super
Fastener
(
)
:
void
Returns
void
unmount
unmount
(
)
:
void
Returns
void
update
Constraint
Solution
update
Constraint
Solution
(
value
:
number
)
:
void
Parameters
value:
number
Returns
void
update
Constraint
Variable
update
Constraint
Variable
(
)
:
void
Returns
void
will
Bind
Super
Fastener
will
Bind
Super
Fastener
(
superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
will
Inherit
will
Inherit
(
superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
will
Mount
will
Mount
(
)
:
void
Returns
void
will
Set
Affinity
will
Set
Affinity
(
newAffinity
:
number
, oldAffinity
:
number
)
:
void
Parameters
newAffinity:
number
oldAffinity:
number
Returns
void
will
Set
Inherits
will
Set
Inherits
(
inherits
:
boolean
, superName
:
undefined
|
string
)
:
void
Parameters
inherits:
boolean
superName:
undefined
|
string
Returns
void
will
Set
State
will
Set
State
(
newState
:
T
, oldState
:
T
)
:
void
Parameters
newState:
T
oldState:
T
Returns
void
will
Start
Constraining
will
Start
Constraining
(
)
:
void
Returns
void
will
Stop
Constraining
will
Stop
Constraining
(
)
:
void
Returns
void
will
Unbind
Super
Fastener
will
Unbind
Super
Fastener
(
superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
will
Uninherit
will
Uninherit
(
superFastener
:
Property
<
unknown
,
T
,
T
>
)
:
void
Parameters
superFastener:
Property
<
unknown
,
T
,
T
>
Returns
void
will
Unmount
will
Unmount
(
)
:
void
Returns
void
Modules
@swim/runtime
@swim/core
@swim/util
@swim/codec
@swim/fastener
@swim/collections
@swim/constraint
@swim/structure
@swim/streamlet
@swim/dataflow
@swim/recon
@swim/uri
@swim/math
@swim/geo
@swim/time
@swim/host
@swim/toolkit
Constraint
Property
condition
Count
flags
id
owner
state
strength
sub
Fasteners
super
Fastener
affinity
coefficient
coherent
constant
constrained
constraining
family
Type
inherited
inherits
lazy
mounted
name
static
super
Name
super
State
terms
update
Flags
variable
add
Constraint
Condition
attach
Sub
Fastener
bind
Super
Fastener
constrain
decohere
decohere
Sub
Fastener
decohere
Sub
Fasteners
detach
Sub
Fastener
did
Bind
Super
Fastener
did
Inherit
did
Mount
did
Set
Affinity
did
Set
Inherits
did
Set
State
did
Start
Constraining
did
Stop
Constraining
did
Unbind
Super
Fastener
did
Uninherit
did
Unmount
divide
equal
State
evaluate
Constraint
Variable
from
Any
get
State
get
State
Or
get
Super
Fastener
get
Super
State
get
Super
State
Or
has
Affinity
init
init
Affinity
init
Inherits
is
Constant
is
Defined
is
Dummy
is
External
is
Invalid
min
Affinity
minus
mount
negative
on
Bind
Super
Fastener
on
Inherit
on
Mount
on
Set
Affinity
on
Set
Inherits
on
Set
State
on
Start
Constraining
on
Stop
Constraining
on
Unbind
Super
Fastener
on
Uninherit
on
Unmount
plus
recohere
remove
Constraint
Condition
set
Affinity
set
Coherent
set
Flags
set
Inherited
set
Inherits
set
State
set
Strength
start
Constraining
stop
Constraining
times
to
Number
to
String
unbind
Super
Fastener
unmount
update
Constraint
Solution
update
Constraint
Variable
will
Bind
Super
Fastener
will
Inherit
will
Mount
will
Set
Affinity
will
Set
Inherits
will
Set
State
will
Start
Constraining
will
Stop
Constraining
will
Unbind
Super
Fastener
will
Uninherit
will
Unmount
Generated using
TypeDoc