dundas.views.CanvasService Class

Inheritance Hierarchy

Constructors

	Name	Description
	init	Initializes the CanvasService. Called during construction. Inherited from dundas.Component.

Properties

	Name	Description
	baseViewService
	canvas	Gets or sets a value that holds a reference to the main canvas in the application.
	canvasAdapter	Gets or sets the canvas adapter.
	canvasTransactionFactory	Gets deferred manager.
	canvasViewModel	Gets or sets the canvas viewModel.
	commandService	Gets the command service.
	contextFocused	Gets the context focus status.
	eventsManager	Inherited from dundas.Service.
	highlighted	Gets a list of currently highlighted adapters.
	isCanvasReady	Gets a flag to indicate that the canvas is ready to use or not.
	isDisposed	Gets a value indicating whether this instance has been disposed. Inherited from dundas.Component.
	isEditMode	Gets or sets a value indicating whether the Canvas is currently in edit mode.
	isModalViewMode	Gets a value indicating whether or not the canvas is in modal view model.
	isSwitchingViewMode
	layerExplorer	Gets or sets the layer explorer.
	layerManager	Gets layer manager.
	selection	Gets all selected view models
	site	Gets or sets the site that this component is a part of. Inherited from dundas.Component.
	snappydots	Gets or sets a value that holds a reference to the snappy dots in the application.
	uniqueId	Gets or sets the unique ID of this component within the site. Inherited from dundas.Component.
	viewPanel	Gets or sets a value that holds a reference to the view panel in the application.
	viewService	Gets the view service.

Methods

	Name	Description
	addLayer	Add a layer to the current canvas.
	addMenuLayer	Add a menu layer.
	addNextAdhocTemplateCell	Adds and returns the new template cell for the ad hoc dashboard when a new visual is being added.
	addParameterAdapter
	adjustCellSpacing	Adjusts the spacing between template cells.
	align	Align the selected objects.
	bind	Subscribe a handler for an event. Inherited from dundas.Service.
	borderHint	Border highlight the adapters or view models. Unhighlight any previously highlighted items
	bringForward	Send the selected objects forward.
	centerView	Centers the view on the canvas.
	changeSelection	Notify this service that selection state has been modified.
	clearBorderHint	Clear all border hinted adapters.
	clearGetViewModelCache	Clear the cache for storing all view models.
	clearHighlight	Clear all highlighted adapters.
	clearTemplate	Clears all templates used.
	clearTemplateCellHighlight	Clears the template cell highlight.
	copy	Copy the selected adapters.
	createAdapterReplacementCommand	Create a command to replace (insert replacer, then remove replacee) an existing adapter with another adapter.
	createAdaptersHistoriesCommand	Create a command to take a snapshot of the adapter. This function is slow, but reliable in restoring the state of an adapter.
	createAdapterViewModel	Creates an adapter view model that can be added to the canvas.
	createAddLayersCommand	Create a command that creates layers.
	createArrangeCommand	Creates a command that does all sorts of arrangements. Null if arrangement is not possible.
	createCanvas	Create a new canvas.
	createCanvasObjectCore	Perform minimal operation for creation of a design object.
	createCanvasObjects	Add the specified adapters to the canvas. This action is undo-able.
	createCanvasTransaction	Create a transaction that the canvas will respond to.
	createDelegate	Helper for creating delegate functions. Inherited from dundas.Component.
	createDeleteCommand	Create a command to delete adapters.
	createDetachTemplateCommand	Create a command to detach the template.
	createGroupCommand	Create a group command.
	createGroupTemplateCellsCommand	Create a command to ungroup a template cell group.
	createHideLayersCommand	Create a command to hide layers.
	createLockLayersCommand	Create a command to lock layers.
	createMergeCommand	Create a Merge command.
	createModalViewCommand	Creates the modal view command which will either enter or exist depending on the current state.
	createModifyColumnWidthCommand	Create a command that changes the width of a column in a template grid.
	createModifyRowHeightCommand	Create a command that changes the height of a row in a template grid.
	createNudgeCommand	Create a command that will nudge the adapters.
	createPropertyChangeCommand	Create a command that sets properties.
	createRemoveLayersCommand	Create a command that removes layers from the canvas.
	createSelectTemplateCellGroupCommand	Create a command to select the template cell group.
	createSetSameSizeCommand
	createShowLayersCommand	Create a command to show layers.
	createSplitCommand	Create a split command.
	createTimeout	Creates a timeout. Inherited from dundas.Component.
	createUngroupCommand	Create and undoable command that removes groups.
	createUngroupTemplateCellsCommand	Create a command to ungroup a template cell group.
	createUnlockLayersCommand	Create a command to unlock layers.
	cut	Cut the selected adapters.
	deleteLayers	Deletes a layer from the current canvas.
	detachTemplate	Detach the template.
	dispatch	Dispatches a call by creating a delegate and running it right away on a timer. Inherited from dundas.Component.
	dispose	Inherited from dundas.Component.
	distribute	Equally distribute the spacing between the selected objects.
	executeCommand	Executes a command.
	fromJObject	Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
	generateTemplateCells	Generate a set of template cells.
	getAdapter	Given the coordinates, gets the closest adapter that contains the coordinates (if any).
	getAllGroups	Get a dictionary of all groups and their adapters.
	getAllLayers	Get all layers.
	getAllViewModels	Retrieve all view models. Group members of a group will be omitted.
	getBackgroundAbsoluteBound	Retrieves the background absolute bounds for an adapter or view model.
	getCenter	Gets the center coordinate of the current view.
	getColumnWidth	Get the width of the column.
	getGroup	Retrieve a group, or a set of groups.
	getLayerByName	Get layer.
	getLayersByFriendlyName	Get layers by friendly name.
	getLayersByIds	Get layers.
	getObstructedAdapters	Get any adapters under the boundary an obstructing adapter.
	getRowHeight	Get the height of the row.
	getSelectedAdapters	Get all selected adapters.
	getSelectedDesignObjectViewModels	Get all the selected Design Object view models.
	getSelectedLayers	Get the currently selected layers.
	getSelectionContextualCommands	Get the contextual commands.
	getService	Gets the requested service. Inherited from dundas.Component.
	getSnappyDotTargets	Retrieves the targets for snappy dots to be applied on.
	getTemplateCell	Given the coordinates, gets the closest template cell that contains the coordinates (if any).
	getTemplateCellById	Retrieve the template cell view model by the ID.
	getTemplateCells	Retrieve the template cells view models.
	getTemplateCellsByPage	Retrieve the template cells of the desired page.
	getUnderlyingAdapters	Get any adapters that is under a certain point.
	getUnderlyingTemplateCells	Get the template cell that is under a certain point.
	getViewModelByName	Retrieve a view model by its name.
	getViewModelsById	Get the view models of the adapters or groups.
	getViewModelsOfAdapters	Get the view models of the adapters.
	getViewModelsOfLayer	Get the view models of the specified layer.
	getViewModelsOfTemplateCell	Get the view models of the specified template cell.
	getVision	Get the current vision;
	group	Group the selected adapters.
	groupTemplateCells	Group a set of template cells.
	hideDropZones	Hides the drop zones for the adapters.
	hideLayers	Hide layers.
	hideViewPanel	Hide the view panel.
	highlight	Highlight the adapters or view models. Unhighlight any previously highlighted items
	highlightTemplateCell	Given the coordinates, highlight the template cell that contains the coordinates.
	initializeAdhocTemplateCells	Adds the initial template grid cells for the ad hoc dashboard.
	insertEditModeInteractable	Insert some interact-able content to the canvas while it is in edit mode. This will render sub-selection not usable.
	invalidateAdhocTemplate	Invalidates the template by checking to ensure every cell has content and remove those that do not, and ensuring each adapter has a cell. This is a heavy call as it will re-create the entire template grid every time.
	isAdapterSelected	Check if an adapter is selected.
	isAdhocDashboardFull	Checks if the ad hoc dashboard is full as the number of visualizations that can be added is limited.
	loadCanvas	Load a canvas.
	loadSubCanvas	Create a new canvas and load a View into it.
	loadTemplate	Loads a template into the current canvas.
	lockLayers	Lock layers.
	mergeSelectedTemplateCells	Merges the selected template cells.
	modifyColumnWidth	Change the width of a column in a template grid.
	modifyRowHeight	Change the height of a row in a template grid.
	notifySubcanvasHiddenChanged	Notify that this sub-canvas is being hidden/unhidden
	nudge	Move the adapters by some amount.
	onLoaded	Called when the service is loaded. Inherited from dundas.Service.
	paste	Paste the adapters stored in the clipboard.
	redo	Redo a command.
	refreshSelectionContext	Refresh the selection context. So that the selections are reselected, and associated contextual controls are refreshed.
	releaseAdapterContextFocus	Releasing a context focus on the current context-focused adapters.
	releaseModalAdapter	Set the canvas out of modal view mode.
	removeCanvasObjectCore	Perform minimal operation for removal of a design object.
	removeCanvasObjects	Removes objects from the canvas. This action is undo-able.
	removeParameterAdapter
	removeTemplate	Removes the template, and position all design objects not in the template absolutely relative to the background.
	replaceAdapter	Replace an existing adapter with another adapter.
	saveCanvas	Prepares the canvas for saving.
	scrollIntoView	Best effort to try to scroll the canvas so that all of the viewmodels are visible
	select	Select the specified objects.
	selectAll	Selects all controls.
	sendBackward	Send the selected objects backward.
	sendToLayer	Sends a viewmodel to a target layer and/or target cell.
	setAdapterContextFocus	Set a context focus on the adapters, thereby disabling selection on all adapters except for the provided ones, and altering them visually to put them out of context of whatever the current work flow.
	setGroupPosition	Sets the group's position.
	setGroupProperty	Sets a group's property.
	setGroupVisibility	Sets the group's visibility.
	setLayersArrangement	Changes the layers arrangements.
	setModalAdapter	Set the canvas into modal view mode with the specified adapter.
	setSameSize
	setSelectedLayers	Set the selected layers.
	setTemplate	Sets a template.
	setTemplateCells	Sets a template.
	setVision	Sets the current vision of the canvas.
	showDropZone	Show drop zones for the adapters.
	showLayers	Show layers.
	showViewPanel	Show the view panel.
	splitSelectedTemplateCells	Splits the selected template cells.
	subscribe	Subscribe or unsubscribe an event handler for an event. Inherited from dundas.Service.
	subscribeAdapterChanged	Set a handler to handle the event when one more adapters gets deleted or created. The event has a property changedAdapters that will provide information on what adapters has been created or deleted.
	subscribeAdapterInputEvents	Subscribe input event handlers for adapters.
	subscribeAdapterReplaced	Subscribe a handler to the adapter replaced event.
	subscribeCanvasLoaded	Subscribe a handler to the Canvas loaded event.
	subscribeContextFocusChanged	Subscribe/Unsubscribe an event handler to the selection changed event.
	subscribeEditViewModeChanged	Subscribe an event handler for View Mode Changed event.
	subscribeOnce	Subscribe a one time handler for an event. Inherited from dundas.Service.
	subscribeSelectionChanged	Subscribe/Unsubscribe an event handler to the selection changed event.
	subscribeSubcanvasHiddenChanged	Set a handler to handle the event when this sub-canvas becomes hidden by the parent canvas.
	takeAdaptersSnapshot	Take a snapshot of the adapter specified as the key of .
	toggleTempSnapState	Toggle the temp snap state on or off.
	toJSON	Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
	trigger	Triggers an event. Inherited from dundas.Service.
	unbind	Unsubscribe an event. Inherited from dundas.Service.
	undo	Undo a command.
	ungroup	Ungroup the selected adapters.
	ungroupTemplateCells	Ungroup a set of template cells.
	unlockLayers	Unlock layers.