dojox/drawing/plugins/tools/Pan (version 1.10)

dojox/drawing/plugins/_Plugin

Summary

A plugin that allows for a scrolling canvas. An action tool is added to the toolbar that allows for panning. Holding the space bar is a shortcut to that action. The canvas will only pan and scroll if there are objects out of the viewable area.

Usage

var foo = new Pan(options);
dojox/drawing/plugins/tools/Pan
Parameter Type Description
options undefined

Examples

Example 1

<div dojoType="dojox.drawing.Toolbar" drawingId="drawingNode" class="drawingToolbar vertical">
    <div tool="dojox.drawing.tools.Line" selected="true">Line</div>
    <div plugin="dojox.drawing.plugins.tools.Pan" options="{}">Pan</div>
</div>

Property Summary

Method Summary

Event Summary

Properties

anchors
Defined by: dojox/drawing/plugins/_Plugin
button
Defined by: dojox/drawing/plugins/_Plugin
canvas
Defined by: dojox/drawing/plugins/_Plugin
drawing
Defined by: dojox/drawing/plugins/_Plugin
interval
Defined by: dojox/drawing/plugins/tools/Pan
keys
Defined by: dojox/drawing/plugins/_Plugin
keyScroll
Defined by: dojox/drawing/plugins/tools/Pan
mouse
Defined by: dojox/drawing/plugins/_Plugin
node
Defined by: dojox/drawing/plugins/_Plugin
selected
Defined by: dojox/drawing/plugins/tools/Pan
setup
Defined by: dojox/drawing/plugins/tools/Pan
stencils
Defined by: dojox/drawing/plugins/_Plugin
type
Defined by: dojox/drawing/plugins/tools/Pan
util
Defined by: dojox/drawing/plugins/_Plugin

Methods

checkBounds()
Defined by dojox/drawing/plugins/tools/Pan
connect()
Defined by dojox/drawing/plugins/_Plugin
disconnect(handles)
Defined by dojox/drawing/plugins/_Plugin

Removes connections based on passed handles arguments

Parameter Type Description
handles Handle | Array

Events

onArrow(evt)
Defined by: dojox/drawing/plugins/tools/Pan
Parameter Type Description
evt undefined

Examples

Example 1

<div dojoType="dojox.drawing.Toolbar" drawingId="drawingNode" class="drawingToolbar vertical">
    <div tool="dojox.drawing.tools.Line" selected="true">Line</div>
    <div plugin="dojox.drawing.plugins.tools.Pan" options="{}">Pan</div>
</div>
onKeyDown(evt)
Defined by: dojox/drawing/plugins/tools/Pan
Parameter Type Description
evt undefined

Examples

Example 1

<div dojoType="dojox.drawing.Toolbar" drawingId="drawingNode" class="drawingToolbar vertical">
    <div tool="dojox.drawing.tools.Line" selected="true">Line</div>
    <div plugin="dojox.drawing.plugins.tools.Pan" options="{}">Pan</div>
</div>
onKeyUp(evt)
Defined by: dojox/drawing/plugins/tools/Pan
Parameter Type Description
evt undefined

Examples

Example 1

<div dojoType="dojox.drawing.Toolbar" drawingId="drawingNode" class="drawingToolbar vertical">
    <div tool="dojox.drawing.tools.Line" selected="true">Line</div>
    <div plugin="dojox.drawing.plugins.tools.Pan" options="{}">Pan</div>
</div>
onPanDrag(obj)
Defined by: dojox/drawing/plugins/tools/Pan
Parameter Type Description
obj undefined

Examples

Example 1

<div dojoType="dojox.drawing.Toolbar" drawingId="drawingNode" class="drawingToolbar vertical">
    <div tool="dojox.drawing.tools.Line" selected="true">Line</div>
    <div plugin="dojox.drawing.plugins.tools.Pan" options="{}">Pan</div>
</div>
onPanUp(obj)
Defined by: dojox/drawing/plugins/tools/Pan
Parameter Type Description
obj undefined

Examples

Example 1

<div dojoType="dojox.drawing.Toolbar" drawingId="drawingNode" class="drawingToolbar vertical">
    <div tool="dojox.drawing.tools.Line" selected="true">Line</div>
    <div plugin="dojox.drawing.plugins.tools.Pan" options="{}">Pan</div>
</div>
onSetPan(bool)
Defined by: dojox/drawing/plugins/tools/Pan
Parameter Type Description
bool Boolean | Event

Examples

Example 1

<div dojoType="dojox.drawing.Toolbar" drawingId="drawingNode" class="drawingToolbar vertical">
    <div tool="dojox.drawing.tools.Line" selected="true">Line</div>
    <div plugin="dojox.drawing.plugins.tools.Pan" options="{}">Pan</div>
</div>
onStencilDrag(obj)
Defined by: dojox/drawing/plugins/tools/Pan
Parameter Type Description
obj undefined

Examples

Example 1

<div dojoType="dojox.drawing.Toolbar" drawingId="drawingNode" class="drawingToolbar vertical">
    <div tool="dojox.drawing.tools.Line" selected="true">Line</div>
    <div plugin="dojox.drawing.plugins.tools.Pan" options="{}">Pan</div>
</div>
onStencilUp(obj)
Defined by: dojox/drawing/plugins/tools/Pan
Parameter Type Description
obj undefined

Examples

Example 1

<div dojoType="dojox.drawing.Toolbar" drawingId="drawingNode" class="drawingToolbar vertical">
    <div tool="dojox.drawing.tools.Line" selected="true">Line</div>
    <div plugin="dojox.drawing.plugins.tools.Pan" options="{}">Pan</div>
</div>
onUp(obj)
Defined by: dojox/drawing/plugins/tools/Pan
Parameter Type Description
obj undefined

Examples

Example 1

<div dojoType="dojox.drawing.Toolbar" drawingId="drawingNode" class="drawingToolbar vertical">
    <div tool="dojox.drawing.tools.Line" selected="true">Line</div>
    <div plugin="dojox.drawing.plugins.tools.Pan" options="{}">Pan</div>
</div>
Error in the documentation? Can’t find what you are looking for? Let us know!