ResourceMenu
Feature

Applicable only for Scheduler in vertical mode. Right click resource header cells to display a context menu.

To invoke the menu in a keyboard-accessible manner, use the Space key when a resource cell is focused.

Default menu items

The ResourceMenu feature provides only one item by default:

Reference	Text	Weight	Description
`remove`	Delete	100	Delete the resource

Customizing the menu items

The menu items in the resource menu can be customized, existing items can be changed or removed, and new items can be added. This is handled using the items config of the feature.

Add extra items for all columns:

const scheduler = new Scheduler({
    mode     : 'vertical',
    features : {
        resourceMenu : {
            items : {
                extraItem : {
                    text   : 'My cell item',
                    icon   : 'fa fa-bus',
                    weight : 200,
                    onItem : () => ...
                }
            }
        }
    }
});

Remove an existing item:

const scheduler = new Scheduler({
    mode     : 'vertical',
    features : {
        resourceMenu : {
            items : {
                remove : null
            }
        }
    }
});

Customize existing item:

const scheduler = new Scheduler({
    mode     : 'vertical',
    features : {
        resourceMenu : {
            items : {
                remove : {
                    text : 'Remove',
                    icon : 'fa fa-dumpster'
                }
            }
        }
    }
});

It is also possible to manipulate the default items and add new items in the processing function:

const scheduler = new Scheduler({
    mode     : 'vertical',
    features : {
        resourceMenu : {
            processItems({items, record}) {
                if (record.cost > 5000) {
                    items.myItem = { text : 'Split cost' };
                }
            }
        }
    }
});

The processItems implementation may be an async function which awaits a result to mutate the items object.

This feature is disabled by default.

Useful configs and functions

Member	Description
resourceMenuBeforeShow	Fires before menu is shown
resourceMenuItem	Fires when a menu item is clicked
resourceMenuShow	Fires after menu is shown

Configs

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

items : Object<String, MenuItemEntry>

Menu items object containing named child menu items to apply to the feature's provided context menu.

This may add extra items as below, but you can also configure, or remove any of the default items by configuring the name of the item as null

features : {
    resourceMenu : {
        // This object is applied to the Feature's predefined default items
        items : {
            switchToDog : {
                text : 'Dog',
                icon : 'fa fa-fw fa-dog',
                onItem({record}) {
                    record.dog = true;
                    record.cat = false;
                },
                weight : 500     // Make this second from end
            },
            switchToCat : {
                text : 'Cat',
                icon : 'fa fa-fw fa-cat',
                onItem({record}) {
                    record.dog = false;
                    record.cat = true;
                },
                weight : 510     // Make this sink to end
            },
            remove : {
                // Change icon for the delete item
                icon : 'fa fa-times'
            }
        }
    }
},

processItems : Function
A function called before displaying the menu that allows manipulations of its items. Returning false from this function prevents the menu being shown.
```
features : {
    resourceMenu : {
        processItems({ items, record, column }) {
            // Add or hide existing items here as needed
            items.myAction = {
                text   : 'Cool action',
                icon   : 'fa fa-fw fa-ban',
                onItem : () => console.log(`Clicked ${record.name}`),
                weight : 1000 // Move to end
            };

            if (!record.allowDelete) {
                items.remove.hidden = true;
            }
        }
    }
},
```
Parameters
- context : Object
  
  An object with information about the menu being shown.
- feature : ResourceMenu
  
  A reference to this feature.
- domEvent : Event
  
  The initiating event.
- event : Event
  
  DEPRECATED: The initiating event.
- point : Number[]
  
  The client X and Y position of the initiating event.
- targetElement : HTMLElement
  
  The target to which the menu is being applied.
- resourceRecord : ResourceModel
  
  The record representing the current resource.
- items : Object<String, MenuItemEntry>
  
  An object containing the menu item configs keyed by their id.
Returns

Boolean/null
:

Returning false from this function prevents the menu being shown

Properties

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

isResourceMenu : Booleantrue

READONLY

static

ADVANCED

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

isResourceMenu : Booleantrue

READONLY

ADVANCED

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

Events

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

resourceMenuBeforeShow

PREVENTABLE

ON-OWNER

This event fires on the owning scheduler before the context menu is shown for a resource. Allows manipulation of the items to show in the same way as in the processItems.

Returning false from a listener prevents the menu from being shown.

Note that this event is triggered on the owning widget:
resourceMenuItem

ON-OWNER

This event fires on the owning scheduler when an item is selected in the context menu.

Note that this event is triggered on the owning widget:
resourceMenuShow

ON-OWNER

This event fires on the owning scheduler after the context menu is shown for a resource.

Note that this event is triggered on the owning widget:
resourceMenuToggleItem

ON-OWNER

This event fires on the owning grid when a check item is toggled in the context menu.

Note that this event is triggered on the owning widget:

Event handlers

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

onResourceMenuBeforeShow

PREVENTABLE

ON-OWNER

This handler is called on the owning scheduler before the context menu is shown for a resource. Allows manipulation of the items to show in the same way as in the processItems.

Returning false from a listener prevents the menu from being shown.

Note that this handler is called on the owning widget:
onResourceMenuItem

ON-OWNER

This handler is called on the owning scheduler when an item is selected in the context menu.

Note that this handler is called on the owning widget:
onResourceMenuShow

ON-OWNER

This handler is called on the owning scheduler after the context menu is shown for a resource.

Note that this handler is called on the owning widget:
onResourceMenuToggleItem

ON-OWNER

This handler is called on the owning grid when a check item is toggled in the context menu.

Note that this handler is called on the owning widget:

id: resourceMenu

Source path

Scheduler/feature/ResourceMenu.js

Demo

examples/vertical

ResourceMenu
Feature

Default menu items

Customizing the menu items

Useful configs and functions

See also

Configs

Parameters

Returns

Properties

Events

Event handlers

Source path

Demo

Inheritance tree4

Mixins2

Contents

ResourceMenu Feature

Default menu items

Customizing the menu items

Useful configs and functions

See also

Configs

Parameters

Returns

Properties

Events

Event handlers

Source path

Demo

Inheritance tree4

Mixins2

Contents

ResourceMenu
Feature