TaskHighlighting
Mixin

Mixin that handles card highlighting for the TaskBoard.

The highlighting is done by adding the CSS class b-highlighted to the highlighted card elements. Also, the CSS class b-is-highlighting is added to the main TaskBoard element, dimming non-highlighted cards.

No results

Properties

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

isTaskHighlighting : Booleantrue

READONLY

static

ADVANCED

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

isTaskHighlighting : Booleantrue

READONLY

ADVANCED

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

Functions

Functions are methods available for calling on the class

highlightTasks( options )
Highlights the elements of the passed task records (or record ids).

The highlighting will be done by adding the css class b-highlighted to the highlighted card elements. Also, the css class b-is-highlighting will be added to the main TaskBoard element.
```
// Highlight single task
taskBoard.highlightTasks({ tasks : 22 });
// Highlight multiple tasks
taskBoard.highlightTasks({ tasks : [1, 40] });
// Don't un-highlight on click
taskBoard.highlightTasks({ tasks : 1000, unhighlightOnClick : false });
```
unhighlightTasks( options )
Removes highlighting from the elements of the passed task records (or record ids). If no tasks are passed, all highlighted tasks will be un-highlighted.
```
taskBoard.unhighlightTasks({ tasks : 22 }); // single task
taskBoard.unhighlightTasks({ tasks : [1, 40] }); // multiple tasks
taskBoard.unhighlightTasks(); // unhighlight all
```

Source path

TaskBoard/view/mixin/TaskHighlighting.js

Inheritance tree1

TaskHighlighting

TaskHighlighting Mixin

Properties

Functions

Source path

Inheritance tree1

Contents

TaskHighlighting
Mixin