Interface: BaseBoard ​

features/boards/board.BaseBoard

The properties that are added onto a processed BoardOptions to create a Board.

Properties ​

[Component] ​

• [Component]: GenericComponent

The Vue component used to render this feature.

Defined in ​

profectus/src/features/boards/board.ts:254

[GatherProps] ​

• [GatherProps]: () => Record<string, unknown>

Type declaration ​

▸ (): Record<string, unknown>

A function to gather the props the vue component requires for this feature.

Returns ​

Record<string, unknown>

Defined in ​

profectus/src/features/boards/board.ts:256

id ​

• id: string

An auto-generated ID for identifying features that appear in the DOM. Will not persist between refreshes or updates.

Defined in ​

profectus/src/features/boards/board.ts:242

mousePosition ​

• mousePosition: Ref<null | { x: number ; y: number }>

The current mouse position, if over the board.

Defined in ​

profectus/src/features/boards/board.ts:250

nodes ​

• nodes: Ref<BoardNode[]>

All the nodes currently on the board.

Defined in ​

profectus/src/features/boards/board.ts:244

selectedAction ​

• selectedAction: Ref<null | GenericBoardNodeAction>

The currently selected action, if any.

Defined in ​

profectus/src/features/boards/board.ts:248

selectedNode ​

• selectedNode: Ref<null | BoardNode>

The currently selected node, if any.

Defined in ​

profectus/src/features/boards/board.ts:246

type ​

• type: typeof BoardType

A symbol that helps identify features of the same type.

Defined in ​

profectus/src/features/boards/board.ts:252