TaskBoardStores
Mixin

Mixin that handles TaskBoards stores, managed by a project.

No results

Configs

Configs are options you supply in a configuration object when creating an instance of this class

assignments : AssignmentModel[]/Object[]

Inline assignments, will be loaded into an internally created AssignmentStore as a part of a project.

Has a corresponding runtime assignments property.
newTaskDefaults : TaskModelConfig

Default values to apply to task records created by task boards features (such as the column header menu and the column toolbar)

project : ProjectModel/ProjectModelConfig

A project config object or an instance that holds all stores and data used by the TaskBoard.

const taskBoard = new TaskBoard({
    project : {
        // Use a custom task model
        taskModelClass : MyTaskModel,

        // Supply inline data
        tasks : [
            { id : 1, name: 'Task 1', ... },
            ...
        ]
});

Project has built-in crud manager functionality to handle syncing with a backend:

const taskBoard = new TaskBoard({
    project : {
        loadUrl : 'data/data.json'
    },
    autoLoad : true
});

Also has built-in state tracking manager functionality to handle undo/redo:

```javascript
const taskBoard = new TaskBoard({
    stm : {
        autoRecord : true,
        disabled   : false
    }
});

Has a corresponding runtime project property.

resources : ResourceModel[]/Object[]

Inline resources, will be loaded into an internally created ResourceStore as a part of a project.

Has a corresponding runtime resources property.
tasks : TaskModel[]/Object[]

Inline tasks, will be loaded into an internally created TaskStore as a part of a project.

Has a corresponding runtime tasks property.
syncMask : String/Object/nullnull

TaskBoard does not use a sync mask by default. If you want one, see syncMask for configuration options.

Properties

Properties are getters/setters or publicly accessible variables on this class

isTaskBoardStores : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of TaskBoardStores class, or subclass thereof.

project : ProjectModel/ProjectModelConfig

The ProjectModel instance, containing the data visualized by the TaskBoard.

Has a corresponding project config.
isTaskBoardStores : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of TaskBoardStores class, or subclass thereof.
assignments : AssignmentModel[]/Object[]

Inline assignments, will be loaded into an internally created AssignmentStore as a part of a project.

Has a corresponding assignments config.
resources : ResourceModel[]/Object[]

Inline resources, will be loaded into an internally created ResourceStore as a part of a project.

Has a corresponding resources config.
tasks : TaskModel[]/Object[]

Inline tasks, will be loaded into an internally created TaskStore as a part of a project.

Has a corresponding tasks config.

Functions

Functions are methods available for calling on the class

addTask( columnRecord, swimlaneRecord, taskData )
: Promise

ASYNC

Add a new task to the specified column / swimlane intersection (swimlane is optional), scroll it into view and start editing it (if an editing feature is enabled).

By default the task is created using the data defined in the newTaskDefaults combined with values for the columnField, the swimlaneField and a generated weight to place it last. To override these or to supply your own values for any field, pass the taskData argument.

If project is configured to auto sync changes to backend, the sync request will be awaited before editing starts.
removeTask( taskRecord )
: Boolean

ASYNC
Removes one or more tasks from the linked task store (and thus the TaskBoard).

First fires a 'beforeTaskRemove' event, which is preventable and async. Return false or a promise that resolves to false from a listener to prevent the operation.
```
taskBoard.on({
    async beforeRemoveTask() {
        const result = await askForConfirmation();
        return result;
    }
});

taskBoard.remove(myTask);
```

Events

Events are triggered for certain actions in this class and can be listened for to react to those actions in your code

beforeTaskRemove

ASYNC

PREVENTABLE
Triggered when one or more tasks are to be removed by a call to removeTask().

The UI routes through removeTask() (currently only the task menu offers task removal), this event can be used to add a confirmation flow or similar to those actions.

Return false or a promise that resolves to false in a listener to prevent removal.
```
taskBoard.on({
    async beforeRemoveTask() {
        const result = await askForConfirmation();
        return result;
    }
});
```

Event handlers

Event handlers are callbacks called as a result of certain actions in this class

onBeforeTaskRemove

ASYNC

PREVENTABLE
Called when one or more tasks are to be removed by a call to removeTask().

The UI routes through removeTask() (currently only the task menu offers task removal), this event can be used to add a confirmation flow or similar to those actions.

Return false or a promise that resolves to false in a listener to prevent removal.
```
taskBoard.on({
    async beforeRemoveTask() {
        const result = await askForConfirmation();
        return result;
    }
});
```

Source path

TaskBoard/view/mixin/TaskBoardStores.js

Inheritance tree1

TaskBoardStores

TaskBoardStores Mixin