DependencyEdit
Feature

Feature that displays a popup containing fields for editing a dependency. Requires the Dependencies feature to be enabled. Double-click a dependency line in the demo below to show the editor.

Customizing the built-in widgets

 const scheduler = new Scheduler({
     columns : [
         { field : 'name', text : 'Name', width : 100 }
     ],
     features : {
         dependencies   : true,
         dependencyEdit : {
             editorConfig : {
                 items : {
                     // Custom label for the type field
                     typeField : {
                         label : 'Kind'
                     }
                 },

                 bbar : {
                     items : {
                         // Hiding save button
                         saveButton : {
                             hidden : true
                         }
                     }
                 }
             }
         }
     }
 });

Built-in widgets

Widget ref	Type	Weight	Description
`fromNameField`	DisplayField	100	From task name (readonly)
`toNameField`	DisplayField	200	To task name (readonly)
`typeField`	Combo	300	Edit type
`lagField`	DurationField	400	Edit lag

The built-in buttons are:

Widget ref	Type	Weight	Description
`saveButton`	Button	100	Save button on the bbar
`deleteButton`	Button	200	Delete button on the bbar
`cancelButton`	Button	300	Cancel editing button on the bbar

This feature is disabled by default. For info on enabling it, see GridFeatures.

Useful configs and functions

Member	Description
beforeDependencyEditShow	Fires before editor is shown
beforeDependencyEdit	Fires before editing starts
beforeDependencySave	Fires before save
beforeDependencyDelete	Fires before delete
afterDependencySave	Fires after dependency is saved

Configs

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

autoClose : Booleantrue

True to hide this editor if a click is detected outside it (defaults to true)
editorConfig : PopupConfig

Default editor configuration, used to configure the Popup.
saveAndCloseOnEnter : Booleantrue

True to save and close this panel if ENTER is pressed in one of the input fields inside the panel.
triggerEvent : Stringdependencydblclick

The event that shall trigger showing the editor. Defaults to dependencydblclick, set to empty string or null to disable editing of dependencies.

Has a corresponding runtime triggerEvent property.
showDeleteButton : Booleantrue

True to show a delete button in the form.
showLagField : Booleanfalse

True to show the lag field for the dependency

Properties

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

isDependencyEdit : Booleantrue

READONLY

static

ADVANCED

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

cancelButton : Button

READONLY

Reference to the cancel button, if used
deleteButton : Button

READONLY

Reference to the delete button, if used
fromNameField : DisplayField

READONLY

Reference to the source task name field
lagField : DurationField

READONLY

Reference to the lag field
saveButton : Button

READONLY

Reference to the save button, if used
toNameField : DisplayField

READONLY

Reference to the target task name field
typeField : Combo

READONLY

Reference to the dependency type field
isDependencyEdit : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of DependencyEdit class, or subclass thereof.
triggerEvent : Stringdependencydblclick

The event that shall trigger showing the editor. Defaults to dependencydblclick, set to empty string or null to disable editing of dependencies.

Has a corresponding triggerEvent config.

Functions

Functions are methods available for calling on the class

deleteDependency( )
: Promise

private

ASYNC

Delete dependency being edited

Triggers: beforeDependencyDelete
editDependency( dependencyRecord )
: Promise

ASYNC

Opens a popup to edit the passed dependency.
getEditor( )
: DependencyEditor

internal

Gets an editor instance. Creates on first call, reuses on consecutive
loadRecord( )

private

Sets fields values from record being edited
onAfterSave( dependencyRecord )

Template method, intended to be overridden. Called after the dependency record has been updated.
onBeforeSave( dependencyRecord )

Template method, intended to be overridden. Called before the dependency record has been updated.
save( )
: *

private

ASYNC

Saves the changes (applies them to record if valid, if invalid editor stays open)

Triggers: beforeDependencySave, beforeDependencyAdd, afterDependencySave
updateRecord( )

private

Updates record being edited with values from the editor

Events

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

afterDependencySave

ON-OWNER

Fires on the owning Scheduler or Gantt widget after a dependency is successfully saved using the dependency edit popup

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

PREVENTABLE

ON-OWNER

Fires on the owning Scheduler or Gantt widget before a dependency is added from the dependency edit popup

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

ASYNC

PREVENTABLE

ON-OWNER

Fires on the owning Scheduler or Gantt widget before a dependency is deleted from the dependency edit popup, or when clicking the delete icon on a selected dependency line.

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

ASYNC

PREVENTABLE

ON-OWNER

Fires on the owning Scheduler or Gantt widget before an dependency is displayed in the editor. This may be listened for to allow an application to take over dependency editing duties. Return false to stop the default editing UI from being shown or a Promise yielding true or false for async vetoing.

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

ON-OWNER

Fires on the owning Scheduler or Gantt widget when the editor for a dependency is available, but before it is shown. Allows manipulating fields before the widget is shown.

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

PREVENTABLE

ON-OWNER

Fires on the owning Scheduler or Gantt widget before a dependency is saved using the dependency edit popup

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

onAfterDependencySave

ON-OWNER

Called on the owning Scheduler or Gantt widget after a dependency is successfully saved using the dependency edit popup

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

PREVENTABLE

ON-OWNER

Called on the owning Scheduler or Gantt widget before a dependency is added from the dependency edit popup

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

ASYNC

PREVENTABLE

ON-OWNER

Called on the owning Scheduler or Gantt widget before a dependency is deleted from the dependency edit popup, or when clicking the delete icon on a selected dependency line.

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

ASYNC

PREVENTABLE

ON-OWNER

Called on the owning Scheduler or Gantt widget before an dependency is displayed in the editor. This may be listened for to allow an application to take over dependency editing duties. Return false to stop the default editing UI from being shown or a Promise yielding true or false for async vetoing.

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

ON-OWNER

Called on the owning Scheduler or Gantt widget when the editor for a dependency is available, but before it is shown. Allows manipulating fields before the widget is shown.

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

PREVENTABLE

ON-OWNER

Called on the owning Scheduler or Gantt widget before a dependency is saved using the dependency edit popup

Note that this handler is called on the owning widget:

id: dependencyEdit

Source path

Scheduler/feature/DependencyEdit.js

Demo

examples/dependencies

DependencyEdit
Feature

Customizing the built-in widgets

Built-in widgets

Useful configs and functions

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Demo

Inheritance tree3

Mixins2

Contents

DependencyEdit Feature

Customizing the built-in widgets

Built-in widgets

Useful configs and functions

See also

Configs

Properties

Functions

Events

Event handlers

Source path

Demo

Inheritance tree3

Mixins2

Contents

DependencyEdit
Feature