dojox/drawing/tools/Path (version 1.10)

dojox/drawing/stencil/Path

Summary

Class for a drawable Path

Usage

var foo = new Path();
dojox/drawing/tools/Path

Property Summary

Method Summary

  • _create(shp,sty) Creates a dojox.gfx.shape based on passed arguments.
  • _setNodeAtts(shape) Internal.
  • _toggleSelected()
  • addShadow(args)
  • animate(options,create)
  • applyTransform(mx) Applies the transform to the stencil NOTE: PARTIALLY IMPLEMENTED.
  • attr(key,value) Changes properties in the style or disabled styles, depending on whether the object is enabled.
  • checkClosePoint(firstPt,currPt,remove) Checks if points are close enough to indicate that path should be close.
  • connect(o,e,s,m,once) Convenience method for quick connects See comments below for possiblities functions can be strings
  • connectMouse() Internal.
  • connectMult() Convenience method for batches of quick connects Handles are not returned and therefore cannot be disconnected until Shape destroy time
  • createGuide(obj)
  • dataToPoints(data) Converts data to points.
  • deselect(useDelay) Called when the Stencil is deselected.
  • destroy() Destroys this Stencil
  • disable() Disables Stencil so it is not selectable.
  • disconnect(handles) Removes connections based on passed handles arguments
  • disconnectMouse() Internal.
  • enable() Enables Stencil so it is not selectable (if it was selectable to begin with).
  • exporter() Exports Stencil data
  • getAngle() Gets angle of Stencil NOTE: Only works for Lines, Arrows, Vectors and Axes (works on points, not transforms)
  • getBounds(absolute) Overwriting _Base.getBounds.
  • getLabel() Get the text of the label.
  • getRadius() Gets radius (length) of Stencil.
  • getTransform() Returns the current transform (position) of the Stencil's container
  • highlight() Changes style to the highlight theme.
  • makeSubPath(_closePath)
  • moveToBack() Moves Stencil to the back of all other items on the canvas.
  • moveToFront() Moves Stencil to the front of all other items on the canvas.
  • pointsToData(points) Converts points to data
  • preventNegativePos() Internal.
  • remove() Removes shape(s), typically before a re-render No args defaults to this.shape Pass in multiple args to remove multiple shapes
  • removeShadow()
  • render() Renders the 'hit' object (the shape used for an expanded hit area and for highlighting) and the'shape' (the actual display object).
  • select() Called when the Stencil is selected.
  • setData(data) Setter for Stencil data; also converts data to points.
  • setLabel(text) Creates and sets a label annotation for the Stencil.
  • setPoints(points) Setter for Stencil points; also converts points to data.
  • setTransform(mx) Sets the transform to the stencil NOTE: PARTIALLY IMPLEMENTED.
  • transformPoints(mx) Moves object to a new X Y location mx is additive.
  • unhighlight() Changes style to the current theme.

Event Summary

Properties

baseRender
closeColor
closePath
closeRadius
drawingType
draws
enabled

Whether the Stencil is enabled or not.

minimumSize

The minimum size allowed for a render. If the size is less, the shape is destroyed.

setup
StencilData
StencilPoints
type

Methods

_create(shp,sty)

Creates a dojox.gfx.shape based on passed arguments. Can be called many times by implementation to create multiple shapes in one stencil.

Parameter Type Description
shp String
sty Object
_setNodeAtts(shape)

Internal. Sets the rawNode attribute. (Or in Silverlight an "object attribute". "stencil" is used by the application to determine if something is selectable or not. This also sets the mouse custom events like: "onStencilUp". To disable the selectability, make the att "", which causes a standard mouse event. Labels are special and used to select master stencils.

Parameter Type Description
shape undefined
_toggleSelected()
addShadow(args)
Parameter Type Description
args Object
animate(options,create)
Parameter Type Description
options undefined
create undefined
applyTransform(mx)

Applies the transform to the stencil

NOTE: PARTIALLY IMPLEMENTED. Only applies x y coords.

Parameter Type Description
mx undefined
attr(key,value)

Changes properties in the style or disabled styles, depending on whether the object is enabled. Also can be used to change most position and size props.

Parameter Type Description
key String | Object
value String | Number
Optional
checkClosePoint(firstPt,currPt,remove)

Checks if points are close enough to indicate that path should be close. Provides a visual cue.

Not actually used in stencil.path - this is used for drawable tools that extend it. Note that those tools need to remove the shape created: this.closeGuide, or add arg: remove

Parameter Type Description
firstPt Object
currPt Object
remove Boolean
Returns:boolean
connect(o,e,s,m,once)

Convenience method for quick connects See comments below for possiblities functions can be strings

Parameter Type Description
o undefined
e undefined
s undefined
m undefined
once Boolean

If true, the connection happens only once then disconnects. Five args are required for this functionality.

Returns:undefined
connectMouse()

Internal. Registers this Stencil to receive mouse events.

connectMult()

Convenience method for batches of quick connects Handles are not returned and therefore cannot be disconnected until Shape destroy time

createGuide(obj)
Parameter Type Description
obj undefined
dataToPoints(data)

Converts data to points.

Parameter Type Description
data Object
deselect(useDelay)

Called when the Stencil is deselected. NOTE: Calling this will not deselect the Stencil calling this just sets the style to the current theme. 'manager.Stencil' should be used for selecting and deselecting Stencils.

Parameter Type Description
useDelay Boolean

Adds slight delay before the style is set.

destroy()

Destroys this Stencil

disable()

Disables Stencil so it is not selectable. Changes the color to the disabled style.

disconnect(handles)

Removes connections based on passed handles arguments

Parameter Type Description
handles Handle | Array
disconnectMouse()

Internal. Unregisters this Stencil from receiving mouse events.

enable()

Enables Stencil so it is not selectable (if it was selectable to begin with). Changes the color to the current style.

exporter()

Exports Stencil data

Returns:undefined
getAngle()

Gets angle of Stencil NOTE: Only works for Lines, Arrows, Vectors and Axes (works on points, not transforms)

Returns:undefined
getBounds(absolute)

Overwriting _Base.getBounds. Not sure how absolute should work for a path.

Parameter Type Description
absolute ? Boolean
Returns:object
getLabel()

Get the text of the label.

Returns:undefined | null
getRadius()

Gets radius (length) of Stencil.

NOTE: Only works for Lines, Arrows and Vectors (not for Ellipse, Axes has its own version)

Returns:undefined
getTransform()

Returns the current transform (position) of the Stencil's container

Returns:object
highlight()

Changes style to the highlight theme.

makeSubPath(_closePath)
Parameter Type Description
_closePath undefined
moveToBack()

Moves Stencil to the back of all other items on the canvas.

moveToFront()

Moves Stencil to the front of all other items on the canvas.

pointsToData(points)

Converts points to data

Parameter Type Description
points Array
preventNegativePos()

Internal. Prevent item from being drawn/rendered less than zero on the X or Y.

remove()

Removes shape(s), typically before a re-render No args defaults to this.shape Pass in multiple args to remove multiple shapes

removeShadow()
render()

Renders the 'hit' object (the shape used for an expanded hit area and for highlighting) and the'shape' (the actual display object).

select()

Called when the Stencil is selected. NOTE: Calling this will not select the Stencil calling this just sets the style to the 'selected' theme. 'manager.Stencil' should be used for selecting Stencils.

setData(data)

Setter for Stencil data; also converts data to points. See individual Stencils for specific data properties.

Parameter Type Description
data StencilData
setLabel(text)

Creates and sets a label annotation for the Stencil. If Stencil contains a labelPosition method, that will be used for positioning. Otherwise dojox.drawing.util.positioning.label is used.

Parameter Type Description
text String

The text to set as the label.

setPoints(points)

Setter for Stencil points; also converts points to data. See individual Stencils for specific points properties.

Parameter Type Description
points StencilPoints
setTransform(mx)

Sets the transform to the stencil

NOTE: PARTIALLY IMPLEMENTED. Only applies x y coords.

Parameter Type Description
mx Object
transformPoints(mx)

Moves object to a new X Y location mx is additive. So mx.dx=1 will move the stencil 1 pixel to the right from wherever it was.

Parameter Type Description
mx undefined
unhighlight()

Changes style to the current theme.

Events

_onPostRender(data)

Drag-create or programmatic create calls onRender and afterwards, _onPostRender is called and manages further events.

Parameter Type Description
data Object
onBeforeRender(stencil)

Stub - Fires before render occurs.

Parameter Type Description
stencil Object
onChangeData(stencil)

Stub - fires on change of dimensional properties or a text change

Parameter Type Description
stencil Object
onChangeStyle(stencil)

Fires when styles of shape has changed

Parameter Type Description
stencil Object
onChangeText(value)
Parameter Type Description
value undefined
onCompletePath(_closePath)
Parameter Type Description
_closePath undefined
onDelete(stencil)

Stub - fires before this is destroyed

Parameter Type Description
stencil Stencil
onDown(obj)
Parameter Type Description
obj undefined
onDrag(obj)
Parameter Type Description
obj undefined
onModify(stencil)

Stub - fires on change of any property, including style properties

Parameter Type Description
stencil Object
onMove(obj)
Parameter Type Description
obj undefined
onRender(stencil)

Stub - Fires on creation. Drawing connects to this (once!) to be notified of drag completion. But only if it was registered as a Tool. Creating Stencil in and of itself does not register it.

This should fire at the end of creation (not during drag)

Parameter Type Description
stencil Object
onStartPath(obj)
Parameter Type Description
obj undefined
onTransform(anchor)

Called from anchor point mouse drag also called from plugins.Pan.checkBounds

Parameter Type Description
anchor ? manager.Anchor
onTransformBegin(anchor)

Fired at the start of a transform. This would be an anchor drag or a selection.

Parameter Type Description
anchor ? manager.Anchor
onTransformEnd(anchor)

Called from anchor point up mouse up

Parameter Type Description
anchor manager.Anchor
onUp(obj)
Parameter Type Description
obj EventObject
Error in the documentation? Can’t find what you are looking for? Let us know!