SmallMultipleCanvasService.createCanvasObjects Method

Add the specified adapters to the canvas. This action is undo-able.
 

Parameters

adapters

Type: Array
ElementType: Adapter
The adapters to be added to the canvas.
notUndoable

Type: Boolean - May be null
(Optional) True to make this not undoable.
options

Type: object - May be null
 (Optional) Options: 
     doNotFillTemplateCell       [type: "Boolean" default: "false"]    - True to stop adding adapter to be modified to fill the template cell it belongs in, if adapters.length == 1
     doNotClipAdapters           [type: "Boolean" default: "true"]     - True to stop making the templateCell clipping the adapter, if the adapter is in a cell.
     addToLockedLayer            [type: "Boolean" default: "false"]    - True to add to locked layers, otherwise if locked layer is detected, this command will abort.
     addToHiddenLayer            [type: "Boolean" default: "false"]    - True to add to hidden layers, otherwise if hidden layer is detected, this command will abort.
     assignTemplateCellIfNeeded  [type: "Boolean" default: "true"]     - True to automatically assign first body template cell of the repeater if no templateCellId is assigned.
     adjustTemplateCellHeight    [type: "Boolean" default: "false"]    - True to automatically adjusts the height of the template cells so that the added adapters will always be in-bound of the template cell.
     adjustTemplatecellWidth    [type: "Boolean" default: "false"]    - True to automatically adjusts the width of the template cells so that the added adapters will always be in-bound of the template cell.
     afterCreationAction       [type: "Function" default: "null"] - A function to run after objects are created, or creation by redo.
     doNotSelect             [type: "Boolean" default: "false"]  - True to not select the created canvas objects.
 

Return Value


Type: String
Reason that the creation has failed, or null otherwise.