DataCubeCanvasService.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: 
     doNotClipAdapters       [type: "Boolean" default: "true"]   - True to stop making the templateCell clipping the adapter, if the adapter is in a cell.
     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
     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.
     ignoreDefaultTheme      [type: "Boolean" default: "false"]  - True to not apply the default theme.
     afterCreationAction       [type: "Function" default: "null"] - A function to run after objects are created, or creation redo.
     doNotSelect             [type: "Boolean" default: "false"]  - True to not select the created canvas objects.
     doNotShowSimplePropertyPanel [type:"Boolean", default: "false"] - True to not show the simple property panel upon creation.
     preventOutOfPlaygroundBounce [type:"Boolean", default: false] - True to prevent adapters to be created out-of-bounce.
     chooseBestLayer         [type: "Boolean", default: false] - True to allow the canvas to determine which layer adapter should be inserted into if it has unspecified layerID
 

Return Value


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