Module: data/common
Interfaces
Type aliases
GenericLayerTreeNode
Ƭ GenericLayerTreeNode: Replace
<LayerTreeNode
<LayerTreeNodeOptions
>, { append?
: ProcessedComputable
<boolean
> ; display
: ProcessedComputable
<CoercableComponent
> }>
Defined in
profectus/src/data/common.tsx:159
GenericResetButton
Ƭ GenericResetButton: Replace
<GenericClickable
& ResetButton
<ResetButtonOptions
>, { canClick
: ProcessedComputable
<boolean
> ; display
: ProcessedComputable
<CoercableComponent
> ; minimumGain
: ProcessedComputable
<DecimalSource
> ; resetDescription
: ProcessedComputable
<string
> ; showNextAt
: ProcessedComputable
<boolean
> }>
Defined in
profectus/src/data/common.tsx:64
LayerTreeNode
Ƭ LayerTreeNode<T
>: Replace
<TreeNode
<T
>, { append
: GetComputableType
<T
["append"
]> ; display
: GetComputableTypeWithDefault
<T
["display"
], T
["layerID"
]> }>
Type parameters
Name | Type |
---|---|
T | extends LayerTreeNodeOptions |
Defined in
profectus/src/data/common.tsx:152
ResetButton
Ƭ ResetButton<T
>: Replace
<Clickable
<T
>, { canClick
: GetComputableTypeWithDefault
<T
["canClick"
], Ref
<boolean
>> ; display
: GetComputableTypeWithDefault
<T
["display"
], Ref
<JSX.Element
>> ; minimumGain
: GetComputableTypeWithDefault
<T
["minimumGain"
], 1
> ; onClick
: VoidFunction
; resetDescription
: GetComputableTypeWithDefault
<T
["resetDescription"
], Ref
<string
>> ; showNextAt
: GetComputableTypeWithDefault
<T
["showNextAt"
], true
> }>
Type parameters
Name | Type |
---|---|
T | extends ResetButtonOptions |
Defined in
profectus/src/data/common.tsx:52
Functions
createCollapsibleModifierSections
▸ createCollapsibleModifierSections(sections
): [JSXFunction
, Persistent
<boolean
>[]]
Parameters
Name | Type |
---|---|
sections | { base? : Computable <DecimalSource > ; baseText? : Computable <CoercableComponent > ; modifier : WithRequired <Modifier , "description" > ; subtitle? : string ; title : string ; unit? : string ; visible? : Computable <boolean > }[] |
Returns
[JSXFunction
, Persistent
<boolean
>[]]
Defined in
profectus/src/data/common.tsx:194
createLayerTreeNode
▸ createLayerTreeNode<T
>(optionsFunc
): LayerTreeNode
<T
>
Type parameters
Name | Type |
---|---|
T | extends LayerTreeNodeOptions |
Parameters
Name | Type |
---|---|
optionsFunc | OptionsFunc <T , T , Record <string , unknown >> |
Returns
Defined in
profectus/src/data/common.tsx:167
createResetButton
▸ createResetButton<T
>(optionsFunc
): ResetButton
<T
>
Type parameters
Name | Type |
---|---|
T | extends ClickableOptions & ResetButtonOptions |
Parameters
Name | Type |
---|---|
optionsFunc | OptionsFunc <T , T , Record <string , unknown >> |
Returns
ResetButton
<T
>