ProfectusModule: features/boards/board
Components
Enumerations
Interfaces
- BaseBoard
- BaseBoardNodeAction
- BaseNodeType
- BoardNode
- BoardNodeActionOptions
- BoardNodeLink
- BoardOptions
- NodeLabel
- NodeTypeOptions
Type Aliases
Board
Ƭ Board<T>: Replace<T & BaseBoard, { classes: GetComputableType<T["classes"]> ; height: GetComputableType<T["height"]> ; style: GetComputableType<T["style"]> ; types: Record<string, GenericNodeType> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> ; width: GetComputableType<T["width"]> }>
Type parameters
| Name | Type |
|---|---|
T | extends BoardOptions |
Defined in
profectus/src/features/boards/board.ts:180
BoardData
Ƭ BoardData: Object
Type declaration
| Name | Type |
|---|---|
nodes | BoardNode[] |
selectedAction | string | null |
selectedNode | number | null |
Defined in
profectus/src/features/boards/board.ts:64
BoardNodeAction
Ƭ BoardNodeAction<T>: Replace<T & BaseBoardNodeAction, { fillColor: GetComputableType<T["fillColor"]> ; icon: GetComputableType<T["icon"]> ; links: GetComputableType<T["links"]> ; tooltip: GetComputableType<T["tooltip"]> ; visibility: GetComputableTypeWithDefault<T["visibility"], Visible> }>
Type parameters
| Name | Type |
|---|---|
T | extends BoardNodeActionOptions |
Defined in
profectus/src/features/boards/board.ts:141
GenericBoard
Ƭ GenericBoard: Replace<Board<BoardOptions>, { visibility: ProcessedComputable<Visibility> }>
Defined in
profectus/src/features/boards/board.ts:192
GenericBoardNodeAction
Ƭ GenericBoardNodeAction: Replace<BoardNodeAction<BoardNodeActionOptions>, { visibility: NodeComputable<Visibility> }>
Defined in
profectus/src/features/boards/board.ts:152
GenericNodeType
Ƭ GenericNodeType: Replace<NodeType<NodeTypeOptions>, { actionDistance: NodeComputable<number> ; canAccept: NodeComputable<boolean> ; draggable: NodeComputable<boolean> ; progressColor: NodeComputable<string> ; progressDisplay: NodeComputable<ProgressDisplay> ; shape: NodeComputable<Shape> ; size: NodeComputable<number> }>
Defined in
profectus/src/features/boards/board.ts:114
NodeComputable
Ƭ NodeComputable<T>: Computable<T> | (node: BoardNode) => T
Type parameters
| Name |
|---|
T |
Defined in
profectus/src/features/boards/board.ts:29
NodeType
Ƭ NodeType<T>: Replace<T & BaseNodeType, { actionDistance: GetComputableTypeWithDefault<T["actionDistance"], number> ; actions?: GenericBoardNodeAction[] ; canAccept: GetComputableTypeWithDefault<T["canAccept"], false> ; draggable: GetComputableTypeWithDefault<T["draggable"], false> ; fillColor: GetComputableType<T["fillColor"]> ; label: GetComputableType<T["label"]> ; outlineColor: GetComputableType<T["outlineColor"]> ; progress: GetComputableType<T["progress"]> ; progressColor: GetComputableTypeWithDefault<T["progressColor"], "none"> ; progressDisplay: GetComputableTypeWithDefault<T["progressDisplay"], Fill> ; shape: GetComputableTypeWithDefault<T["shape"], Circle> ; size: GetComputableTypeWithDefault<T["size"], 50> ; title: GetComputableType<T["title"]> ; titleColor: GetComputableType<T["titleColor"]> }>
Type parameters
| Name | Type |
|---|---|
T | extends NodeTypeOptions |
Defined in
profectus/src/features/boards/board.ts:94
Variables
BoardType
• Const BoardType: typeof BoardType
Defined in
profectus/src/features/boards/board.ts:27
Functions
createBoard
▸ createBoard<T>(optionsFunc): Board<T>
Type parameters
| Name | Type |
|---|---|
T | extends BoardOptions |
Parameters
| Name | Type |
|---|---|
optionsFunc | OptionsFunc<T, BaseBoard, GenericBoard> |
Returns
Board<T>
getNodeProperty
▸ getNodeProperty<T>(property, node): T
Type parameters
| Name |
|---|
T |
Parameters
| Name | Type |
|---|---|
property | NodeComputable<T> |
node | BoardNode |
Returns
T
getUniqueNodeID
▸ getUniqueNodeID(board): number
Parameters
| Name | Type |
|---|---|
board | GenericBoard |
Returns
number