DependencyMenu
Feature

Displays a context menu when right-clicking dependency lines. Items are populated by other features and/or application code.

Default dependency menu items

Here is the list of menu items provided by the feature and populated by the other features:

Reference	Text	Weight	Feature	Description
`edit`	Edit	100	DependencyEdit	Edit in the dependency editor. Hidden when read-only
`delete`	Delete	500	This feature	Remove dependency. Hidden when read-only

Customizing the menu items

The menu items in the dependency 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 dependencies:

const scheduler = new Scheduler({
    features : {
        dependencyMenu : {
            items : {
                extraItem : {
                    text : 'Extra',
                    icon : 'fa fa-fw fa-flag',
                    onItem({ dependencyRecord }) {
                        dependencyRecord.critical = true;
                    }
                }
            }
        }
    }
});

Remove existing items:

const scheduler = new Scheduler({
    features : {
        dependencyMenu : {
            items : {
                delete : false
            }
        }
    }
});

Customize existing item:

const scheduler = new Scheduler({
    features : {
        dependencyMenu : {
            items : {
                delete : {
                    text : 'Delete link'
                }
            },
            // Process items before menu is shown
            processItems({ dependencyRecord, items}) {
                 // Push an extra item
                 if (dependencyRecord.isCritical === 'conference') {
                     items.markAsCriticalItem = {
                         text : 'Mark as critical',
                         onItem({ dependencyRecord }) {
                             // Do cool things
                         }
                     };
                 }

                 // Do not show menu for secret links
                 if (dependencyRecord.isSecret === 'secret') {
                     return false;
                 }
            }
        }
    }
});

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

Note that the menuContext is applied to the Menu's item event, so your onItem handler's single event parameter also contains the following properties:

source The Scheduler whose UI was right-clicked.
targetElement The element right-clicked on.
dependencyRecord The dependency record clicked on.

This feature is enabled by default from version 7.0.

Useful configs and functions

Member	Description
items	Menu items configuration object
dependencyMenuBeforeShow	Fires before menu is shown
dependencyMenuItem	Fires when a menu item is clicked
dependencyMenuShow	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>
This is a preconfigured set of items used to create the default context menu. The default options are listed at the top of the page.

To remove existing items, set corresponding keys null:
```
const scheduler = new Scheduler({
    features : {
        dependencyMenu : {
            items : {
                delete   : null
            }
        }
    }
});
```
See the feature config in the above example for details.
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         : {
   dependencyMenu : {
        processItems({ items, dependencyRecord }) {
            // Add or hide existing items here as needed
            items.myAction = {
                text   : 'Cool action',
                icon   : 'fa fa-fw fa-ban',
                onItem : () => console.log(`Clicked ${dependencyRecord.name}`),
                weight : 1000 // Move to end
            };

           if (!dependencyRecord.allowDelete) {
                items.delete.hidden = true;
            }
        }
    }
},
```
Parameters
- context : Object
  
  An object with information about the menu being shown.
- feature : DependencyMenu
  
  A reference to this feature.
- domEvent : Event
  
  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.
- dependencyRecord : DependencyModel
  
  The dependency record.
- 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

isDependencyMenu : Booleantrue

READONLY

static

ADVANCED

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

menuContext : SchedulerMenuContext

READONLY

An informational object containing contextual information about the last activation of the context menu.
isDependencyMenu : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of DependencyMenu 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

dependencyMenuBeforeShow

PREVENTABLE

ON-OWNER

This event fires on the owning Scheduler before the context menu is shown for a dependency. Allows manipulation of the items to show in the same way as in processItems. Returning false from a listener prevents the menu from being shown.

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

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:
dependencyMenuShow

ON-OWNER

This event fires on the owning Scheduler after showing the context menu for an event

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

onDependencyMenuBeforeShow

PREVENTABLE

ON-OWNER

This handler is called on the owning Scheduler before the context menu is shown for a dependency. Allows manipulation of the items to show in the same way as in processItems. Returning false from a listener prevents the menu from being shown.

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

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:
onDependencyMenuShow

ON-OWNER

This handler is called on the owning Scheduler after showing the context menu for an event

Note that this handler is called on the owning widget:

Type definitions

DependencyMenuContext : MenuContext
A context object passed to any processItems method defined for a context menu feature, and the basis of events fired by context menu features.
Properties
- dependencyRecord : DependencyModel
  
  The dependency record clicked on.

id: dependencyMenu

Source path

Scheduler/feature/DependencyMenu.js

Demo

examples/dependencies

DependencyMenu
Feature

Default dependency menu items

Customizing the menu items

Useful configs and functions

See also

Configs

Parameters

Returns

Properties

Events

Event handlers

Type definitions

Properties

Source path

Demo

Inheritance tree4

Mixins2

Contents

DependencyMenu Feature

Default dependency menu items

Customizing the menu items

Useful configs and functions

See also

Configs

Parameters

Returns

Properties

Events

Event handlers

Type definitions

Properties

Source path

Demo

Inheritance tree4

Mixins2

Contents

DependencyMenu
Feature