DashboardCanvasService.createDeleteCommand Method

Create a command to delete adapters.

Parameters

adaptersOrViewModels

Type: Array
ElementType: dundas.view.controls.Adapter or dundas.view.controls.DesignObjectViewModel or dundas.view.controls.MultiSelectionViewModel
Design object adapters or view models to be deleted.

notUndoable

Type: Boolean
True to make this command not undoable.

options

Type: object - May be null

 (Optional) Options: 
     removeLocked            [type: "Boolean" default:"false"]   - True to remove locked adapters, otherwise if locked adapter is detected, this command will abort.
     removeInLockedLayers    [type: "Boolean" default: "false"]  - True to remove adapters in locked layer, otherwise if locked layer is detected, this command will abort.
     removeInTemplate        [type: "Boolean" default: "false"]  - True to visually remove adapters from template.
     suppressWarning         [type: "Boolean" default: "false"]  - True to suppress any warning box and only show console warning messages.
     isUndo                  [type: "Boolean" default: "false"]  - True to designate this command as a result of an undo action.
     isRedo                  [type: "Boolean" default: "false"]  - True to designate this command as a result of a redo action.

Return Value

Type: UndoableCommand - May be null
The delete command, null if the invalid adapters are provided.