ExpandCollapse

Configs

Common

showCollapseInHeader: Boolean= true

Show an icon to expand/collapse columns and swimlanes in their headers.

Programmatic expand/collapse works independently of this setting, it only affects the UI.

Misc

collapseTitle: Boolean= false

Specify true to hide the column title instead of rotating it on collapse.

Used by default with swimlanes, since the title will overlap the swimlane header otherwise.

showCollapseTooltip: Boolean= trueAlso a property

By default, a tooltip showing Expand XX/Collapse XX is shown when hovering the expand/collapse icon for a column or swimlane. To disable the tooltip, set this to false.

Properties

Class hierarchy

isExpandCollapse: Boolean= truereadonly

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

isExpandCollapse: Boolean= truereadonlystatic

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

Misc

showCollapseTooltip: Boolean= trueAlso a config

By default, a tooltip showing Expand XX/Collapse XX is shown when hovering the expand/collapse icon for a column or swimlane. To disable the tooltip, set this to false.

Functions

collapse

Collapse a swimlane or column.

Await the call to be certain that the collapse transition has ended.

await taskBoard.collapse(taskBoard.columns.first);

Parameter	Type	Description
`record`	SwimlaneModel \| ColumnModel	Swimlane or column

expand

Expand a swimlane or column.

Await the call to be certain that the expand transition has ended.

await taskBoard.expand(taskBoard.columns.first);

Parameter	Type	Description
`record`	SwimlaneModel \| ColumnModel	Swimlane or column

toggleCollapse

Expand or collapse a swimlane or column.

Await the call to be certain that the expand/collapse transition has ended.

// Toggle
await taskBoard.toggleCollapse(taskBoard.columns.first);
// Force collapse
await taskBoard.toggleCollapse(taskBoard.columns.first, true);
// Force expand
await taskBoard.toggleCollapse(taskBoard.columns.first, false);

Parameter	Type	Description
`record`	SwimlaneModel \| ColumnModel	Swimlane or column
`collapse`	Boolean	Specify to force a certain state, leave out to toggle

Events

columnCollapse

Triggered when a column is collapsed.

// Adding a listener using the "on" method
expandCollapse.on('columnCollapse', ({ source, columnRecord }) => {

});

Parameter	Type	Description
`source`	TaskBoard	This TaskBoard
`columnRecord`	ColumnModel	Column record

columnExpand

Triggered when a column is expanded.

// Adding a listener using the "on" method
expandCollapse.on('columnExpand', ({ source, columnRecord }) => {

});

Parameter	Type	Description
`source`	TaskBoard	This TaskBoard
`columnRecord`	ColumnModel	Column record

columnToggle

Triggered when the column collapsed state is toggled.

// Adding a listener using the "on" method
expandCollapse.on('columnToggle', ({ source, columnRecord, collapse }) => {

});

Parameter	Type	Description
`source`	TaskBoard	This TaskBoard
`columnRecord`	ColumnModel	Column record
`collapse`	Boolean	`true` if the column is being collapsed.

swimlaneCollapse

Triggered when a swimlane is collapsed.

// Adding a listener using the "on" method
expandCollapse.on('swimlaneCollapse', ({ source, swimlaneRecord }) => {

});

Parameter	Type	Description
`source`	TaskBoard	This TaskBoard
`swimlaneRecord`	SwimlaneModel	Swimlane record

swimlaneExpand

Triggered when a swimlane is expanded.

// Adding a listener using the "on" method
expandCollapse.on('swimlaneExpand', ({ source, swimlaneRecord }) => {

});

Parameter	Type	Description
`source`	TaskBoard	This TaskBoard
`swimlaneRecord`	SwimlaneModel	Swimlane record

swimlaneToggle

Triggered when the swimlane collapsed state is toggled.

// Adding a listener using the "on" method
expandCollapse.on('swimlaneToggle', ({ source, swimlaneRecord, collapse }) => {

});

Parameter	Type	Description
`source`	TaskBoard	This TaskBoard
`swimlaneRecord`	SwimlaneModel	Swimlane record
`collapse`	Boolean	`true` if the column is being collapsed.

Event handlers

onColumnCollapse

Called when a column is collapsed.

new ExpandCollapse({
    onColumnCollapse({ source, columnRecord }) {

    }
});

Parameter	Type	Description
`source`	TaskBoard	This TaskBoard
`columnRecord`	ColumnModel	Column record

onColumnExpand

Called when a column is expanded.

new ExpandCollapse({
    onColumnExpand({ source, columnRecord }) {

    }
});

Parameter	Type	Description
`source`	TaskBoard	This TaskBoard
`columnRecord`	ColumnModel	Column record

onColumnToggle

Called when the column collapsed state is toggled.

new ExpandCollapse({
    onColumnToggle({ source, columnRecord, collapse }) {

    }
});

Parameter	Type	Description
`source`	TaskBoard	This TaskBoard
`columnRecord`	ColumnModel	Column record
`collapse`	Boolean	`true` if the column is being collapsed.

onSwimlaneCollapse

Called when a swimlane is collapsed.

new ExpandCollapse({
    onSwimlaneCollapse({ source, swimlaneRecord }) {

    }
});

Parameter	Type	Description
`source`	TaskBoard	This TaskBoard
`swimlaneRecord`	SwimlaneModel	Swimlane record

onSwimlaneExpand

Called when a swimlane is expanded.

new ExpandCollapse({
    onSwimlaneExpand({ source, swimlaneRecord }) {

    }
});

Parameter	Type	Description
`source`	TaskBoard	This TaskBoard
`swimlaneRecord`	SwimlaneModel	Swimlane record

onSwimlaneToggle

Called when the swimlane collapsed state is toggled.

new ExpandCollapse({
    onSwimlaneToggle({ source, swimlaneRecord, collapse }) {

    }
});

Parameter	Type	Description
`source`	TaskBoard	This TaskBoard
`swimlaneRecord`	SwimlaneModel	Swimlane record
`collapse`	Boolean	`true` if the column is being collapsed.