Taskbar - Documentation

Taskbar

new Taskbar()

Description:

Taskbar Object

Source:

index.js, line 5041

Methods

addExternalItem(options)

Description:

Method for adding a new taskbar item in Header for External Screens

Source:

index.js, line 5057

Parameters:

Name	Type	Description
`options`		Net taskbar item options, id, icon and title

addGroup(groupData)

Description:

Method to add taskbar group

Source:

index.js, line 5105

Parameters:

Name	Type	Description
`groupData`

addItem(itemData)

Description:

Method to add taskbar item

Source:

index.js, line 5112

Parameters:

Name	Type	Description
`itemData`

attachEvent(eventName, listener)

Description:

Method for attaching event by event name

Source:

index.js, line 5231

Parameters:

Name	Type	Description
`eventName`
`listener`

clearAllExternalScreensOpened()

Description:

Method for clearing up all the external screens

Source:

index.js, line 5070

disable()

Description:

Method for disabling the Taskbar

Source:

index.js, line 5205

enable()

Description:

Method for enabling Taskbar

Source:

index.js, line 5199

getActiveGroupId()

Description:

Method to get active group id

Source:

index.js, line 5180

getActiveItem()

Description:

Method to get active item

Source:

index.js, line 5186

getActiveItemByGroupId(id)

Description:

Method to get active taskbar item by group id

Source:

index.js, line 5166

Parameters:

Name	Type	Description
`id`

getGroupById(id)

Description:

Method to get taskbar group by id

Source:

index.js, line 5084

Parameters:

Name	Type	Description
`id`

getGroupHasChangesById(id)

Description:

Method to get group has changes state by id

Source:

index.js, line 5098

Parameters:

Name	Type	Description
`id`	string

getGroups()

Description:

Method for getting all taskbar groups

Source:

index.js, line 5217

getItemById(id)

Description:

Method to get taskbar item by id

Source:

index.js, line 5159

Parameters:

Name	Type	Description
`id`

getItems()

Description:

Method for getting all taskbar items

Source:

index.js, line 5211

getLastSelectedGroup()

Description:

Method for getting last selected group

Source:

index.js, line 5223

removeExternalItem(id)

Description:

Method for removing the External screen taskbar items

Source:

index.js, line 5064

Parameters:

Name	Type	Description
`id`

removeGroupById(id)

Description:

Method for removing group item by id

Source:

index.js, line 5091

Parameters:

Name	Type	Description
`id`		Group id

removeItem(id)

Description:

Method to remove taskbar item by given id

Source:

index.js, line 5077

Parameters:

Name	Type	Description
`id`

selectItem(id, triggerEvent)

Description:

Method for selecting taskbar item by given id

Source:

index.js, line 5174

Parameters:

Name	Type	Default	Description
`id`
`triggerEvent`		`true`

setGroupTitle(groupId, title)

Description:

Method for setting a taskbar group item title

Source:

index.js, line 5144

Parameters:

Name	Type	Description
`groupId`
`title`

setItemCustomState(id, customStates)

Description:

Method for setting custom state on item by id

Source:

index.js, line 5152

Parameters:

Name	Type	Description
`id`
`customStates`

setItemHasChanges(itemId, hasErrors)

Description:

Method for setting the item hasErrors state

Source:

index.js, line 5128

Parameters:

Name	Type	Description
`itemId`		Item id
`hasErrors`		Item errors state

setItemHasErrors(itemId, hasErrors)

Description:

Method for setting the item hasErrors state

Source:

index.js, line 5120

Parameters:

Name	Type	Description
`itemId`		Item id
`hasErrors`		Item errors state

setItemTitle(itemId, title)

Description:

Method for setting a taskbar item title

Source:

index.js, line 5136

Parameters:

Name	Type	Description
`itemId`
`title`

updateGroup(groupData)

Description:

Method for updating group with given options

Source:

index.js, line 5193

Parameters:

Name	Type	Description
`groupData`