dundas.controls.Canvas Class

Inheritance Hierarchy

Constructors

	Name	Description
	init	Attaches a designer control to the specified div container.

Properties

	Name	Description
	activeGridTemplateAdorner	Gets the active GridTemplateAdorner in edit mode.
	canvasAdapter	Gets the canvas adapter.
	collapsePlayground
	contextFocused	Gets all the adapters that are contextually focused.
	controlContainer	Gets the container of this control. Inherited from dundas.controls.FocusableControl.
	designBackground
	gridTemplateAdorner	Gets the default GridTemplateAdorner
	gridTemplateAdorners	Gets all the GridTemplateAdorners used in this canvas.
	height	The height of the canvas.
	infoLayer	Gets the info layer element.
	initialized	Gets the value indicating whether the canvas is initialized and ready
	isDisposed	Gets a value indicating whether this instance has been disposed. Inherited from dundas.EventDisposable.
	isFocused	Gets or sets the focused state of this control. Inherited from dundas.controls.FocusableControl.
	isInModalViewMode	Get a value to indicate whether ot not the canva sis in Model view mode.
	isInViewMode	Get or set the ViewMode
	isLoading
	isResizerVisible	Gets a value indicating whether canvas resizers are visible. This can include the resizers generally visible whenever editing a repeater view.
	isSubCanvas	Gets the value to indicate whether or not this is a subcanvas.
	isTemplateCellResizersOn	Gets a value indicating whether the dedicated template cell resize mode is on.
	jQControlContainer	Gets the container of this control in JQuery object. Inherited from dundas.controls.FocusableControl.
	layerManager	Gets the layer manager
	loadedTemplateCells
	modalAdapter	Get the adapter that is showing in modal mode.
	pageHeight	The height of a single virtualized page.
	pageWidth	The width of a single virtualized page.
	parentFocusable	Gets the focusable parent of this control. Inherited from dundas.controls.FocusableControl.
	resizeMode
	rulerSize	Get the ruler size
	scale	Gets the horizontal scaling factor.
	scaledViewportHeight	Gets the height of the contained area inside the viewport in pixels.
	scaledViewportWidth	Gets the width of the contained area inside the viewport in pixels.
	scaleY	Gets the vertical scaling factor.
	selectedLayer
	selectionAdorner	Gets the SelectionAdorner
	templateViewModel	Get the view model of the template canvas
	uiCache	Gets the UI cache table Inherited from dundas.EventDisposable.
	viewContainer	Gets the view container that contains this canvas.
	viewModel	Get the view model of the canvas
	viewportHeight	Gets the height of the viewport in pixels.
	viewportWidth	Gets the width of the viewport in pixels.
	visibleTemplateCells
	width	The Width of the canvas.

Methods

	Name	Description
	adjustCellSpacing	Adjust the cell spacings and cell paddings according to the canvas adapter.
	align	Align the viewmodels.
	alignTo
	appendTemplateCellColumns	Append new columns of template cells
	appendTemplateCellRows	Append new rows of template cells
	bind	Bind an event to this class object. Inherited from dundas.EventDisposable.
	borderHint	Border highlight the adapters or view models. Unhighlight any previously border highlighted items
	centerView	Places the current view port to the center of the playground.
	clearTemplate	Clears the template being used.
	copy	Perform a clipboard copy.
	createCanvasObjects	Add a designer object to the design surface.
	createLayer
	createSelectionGroupVm	Create a selection group view model and make the canvas react to its changes.
	cut	Perform a clipboard cut.
	determineTemplateCellVisible
	dispose	Disposes the canvas. Inherited from dundas.EventDisposable.
	distribute	Equally distribute the spacing between the viewModels.
	focus	Put this control into focus. Inherited from dundas.controls.FocusableControl.
	fromJObject	Applies the property values from a plain object created from JSON to the properties of this instance. Inherited from Class.
	getAllGroups	Get all groups.
	getAllViewModels	Retrieve all view models.
	getCanvasContainerPageBound	Gets the canvas control container's bounding client rectangle.
	getCanvasDebugPrefix
	getCenter	Gets the center coordinate of the middle of the current view.
	getClosestTemplateCell	Retrieves the closest templateCell relative to toCheckRectangle of the current layer.
	getContainerTemplateCell
	getContextState	Set the UI context state to be saved in dundas.UIContextFocus Inherited from dundas.controls.FocusableControl.
	getDesignBackgroundOffset	Gets the design background offset value.
	getDesignBackgrounds	Retrieve the design background (actual area of the dashboard). The design background
	getDesignBackgroundsContainerSize
	getDesignBackgroundSize
	getDesignObjects	Get all design objects from the canvas.
	getDesignPlayground	Retrieve the design playground DOM.
	getDesignPlaygroundSize	Gets the design playground width and height.
	getGroup	Get group.
	getLayerManager	Retrieves the layer manager of the canvas.
	getPlaygroundOffset	Gets the playground offset.
	getTemplateCellById	Retrieve the template cell view model by the ID.
	getTemplateCellsByPage	Retrieve the template cells of the desired page.
	getTransactionFactory	Retrieves the transaction factory of this canvas.
	getViewModelFromElement
	getViewModels	Retrieves the viewModels of adapters.
	getVision	Get the current vision. (left, top and scale)
	group	Group the design object or existing groups.
	groupTemplateCells	Group the template cells.
	hideDropZones	Hide drop zones.
	hideResizer	Hides the template cell resizer.
	highlight	Highlight the adapters or view models. Unhighlight any previously highlighted items
	loadCanvas	Load the canvas with data.
	loadTemplate	Load a template, or template cells.
	manipulateCanvasObjects	Manipulate the position and size of a canvas object.
	onContextMenu	Fires when the user does a context click on the canvas.
	onDragEnter	Fires when something enters the canvas.
	onDragLeave	Fires when something leaves the canvas.
	onDragOver	Fires when something is dragged-over the canvas.
	onDragStart	Fires when something starts dragging from the canvas.
	onDrop	Fires when something is dropped on the canvas.
	onPasteComplete	Fires the Pasted event when callback is null. Register callback as an event handler otherwise.
	onVisionChanged	Fires the VisionChanged event when callback is null. Register callback as an event handler otherwise.
	onVisionChangeStart	Fires the VisionChangeStart event when callback is null. Register callback as an event handler otherwise.
	onVisionChanging	Fires the VisionChanging event when callback is null. Register callback as an event handler otherwise.
	paste	Perform a clipboard paste.
	raiseBindEvent	Fire the event specified with eventName, or subscribe a handler. Inherited from dundas.EventDisposable.
	reInvalidateAdapters	Re-assign the top, left, width, and height properties of the adapters to effectively make them re-render.
	releaseAdapterContextFocus
	releaseModalAdapter	Restores the modal adapter to its original location.
	removeCanvasObjects	Remove a design object from the canvas.
	removeLayer
	resetTemplateLayer	remove the template visually and put everything as absolute positioning relative to the background
	resizeBackground	Resizes the canvas background (actual dashboard surface).
	saveCanvas
	scrollIntoView	Best effort to try to scroll the canvas so that all of the viewmodels are visible
	setActiveLayer	Sets the active layer.
	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.
	setContextState	Restore this control to the state as defined. Inherited from dundas.controls.FocusableControl.
	setDoubleTapToZoom	Turns on/off double tapping the canvas to cause a zoom.
	setModalAdapter	Displays the specified adapter in a modal overlay over other content in view mode.
	setSnap	Set the snap distance of the design surface.
	setVision	Set the current vision of the canvas.
	setVisionCoordinate	Set the current vision of the canvas as a coordinate.
	setWatermark	Sets water mark on the canvas background.
	showCanvas	Shows the canvas and taskbar.
	showDropZone	Show the drop zones.
	showResizer	Shows the template cell resizer.
	subscribe	Subscribe or unsubscribe an event handler for an event. Inherited from dundas.EventDisposable.
	subscribeAdapterInputEvents	Subscribe input event handlers for adapters.
	subscribeBackgroundChanged	Subscribe a handler for the background changed event.
	subscribeBackgroundResized
	subscribeBlurred	Inherited from dundas.controls.FocusableControl.
	subscribeCanvasLoadedEvent	Subscribe a handler to the canvasloaded event.
	subscribeCanvasScrolledEvent
	subscribeContextFocusChanged	Subscribe a handler for the context focus changed event.
	subscribeDisposed	Subscribe to the disposed event. Inherited from dundas.EventDisposable.
	subscribeFocused	Inherited from dundas.controls.FocusableControl.
	subscribeOnce	Subscribe a one time event handler for an event. Inherited from dundas.EventDisposable.
	subscribeViewModeChanged	Fires when the viewmode if changed.
	subscribeViewportResized	Subscribe an event handler for try viewport resized event.
	toggleTemplateCellResizers	Turns on or off the template cells resizers.
	toJSON	Implementation for toJSON to return an object that will include this class's prototype property values when stringified. Inherited from Class.
	trigger	Raise an event. Inherited from dundas.EventDisposable.
	unbind	Unsubscribe an event. if handler is specified, unsubscribe that handler. if no parameters are specified, unbind everything. Inherited from dundas.EventDisposable.
	unbindAll	unsubscribe all events. Inherited from dundas.EventDisposable.
	ungroup	Ungroup the groups.
	ungroupTemplateCells	Ungroup a template cell group.
	updateViewport	Notify the canvas that the viewport has been modified.
	windowResize	Notify the canvas that the canvas DOM element is resized.
	zoomView	Zooms into the canvas, and record a state, so next time zoomView is called the vision is restored.