CanvasService.createNudgeCommand Method

Create a command that will nudge the adapters.

Parameters

adapters

Type: Array
ElementType: Adapter
Design object adapters to nudge.

nudgeOptions

Type: Object


     Nudge options: 
         horizontally - [type:Number] - Amount in px to nudge horizontally
         vertically - [type:Number] - Amount to nudge vertically
         isConstainedToTemplateCell - [type: Boolean] - true to limit nudges so that adapters stay withing their template cells, if applicable.
         transaction - [type:dundas.controls.Transaction] - The transaction to use instead of creating one.
         nudgeHidden - [type: Boolean] - true to allow nudging hidden adapters.
         nudgeLocked - [type: Boolean] - true to allow nudging locked adapters.

isNotUndoable

Type: Boolean - May be null
(optional) True to make an non-undoable command.

Return Value

Type: Command
The nudge command.