dundas.controls.Canvas Class

Inheritance Hierarchy

Constructors

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

Properties

	Name	Description
	controlContainer	Gets the container of this control. Inherited from dundas.controls.FocusableControl.
	isDisabled	Gets or sets whether or not this control is disabled. Inherited from dundas.controls.FocusableControl.
	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.
	jQControlContainer	Gets the container of this control in JQuery object. Inherited from dundas.controls.FocusableControl.
	parentFocusable	Gets the focusable parent of this control. Inherited from dundas.controls.FocusableControl.
	uiCache	Gets the UI cache table Inherited from dundas.EventDisposable.

Methods

	Name	Description
	adjustCellSpacing	Adjust the cell spacings and cell paddings according to the canvas adapter.
	align	Align the viewmodels.
	alignTo
	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.
	createSelectionGroupVm	Create a selection group view model and make the canvas react to its changes.
	cut	Perform a clipboard cut.
	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.
	getCanvasContainerPageBound	Gets the canvas control container's bounding client rectangle.
	getCenter	Gets the center coordinate of the middle of the current view.
	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.
	getDesignBackgroundsContainerSize
	getDesignBackgroundSize
	getDesignPlaygroundSize	Gets the design playground width and height.
	getLayerManager	Retrieves the layer manager of the canvas.
	getPlaygroundOffset	Gets the playground offset.
	getTransactionFactory	Retrieves the transaction factory of this canvas.
	getViewModelFromElement
	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.
	resetTemplateLayer	remove the template visually and put everything as absolute positioning relative to the background
	saveCanvas
	scrollIntoView	Best effort to try to scroll the canvas so that all of the viewmodels are visible
	setActiveLayer	Sets the active layer.
	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.
	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.
	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.
	zoomView	Zooms into the canvas, and record a state, so next time zoomView is called the vision is restored.