SVGGraphic Class
SVG implementation of the Graphic
class.
SVGGraphic
is not intended to be used directly. Instead, use the Graphic
class.
If the browser has SVG capabilities, the Graphic
class will point to the SVGGraphic
class.
Item Index
Methods
Properties
Methods
_appendShape
-
shape
Adds a shape instance to the graphic instance.
Parameters:
-
shape
ShapeThe shape instance to be added to the graphic.
_createGraphicNode
-
type
-
pe
Creates a graphic node
Returns:
_createGraphics
()
private
Creates a contentNode element
_getDocFrag
()
private
Returns a document fragment to for attaching shapes.
Returns:
_getShapeClass
-
val
Returns a shape class. Used by addShape
.
Returns:
_getUpdatedContentBounds
()
Object
private
Recalculates and returns the contentBounds
for the Graphic
instance.
Returns:
_redraw
()
private
Redraws all shapes.
addShape
-
cfg
Generates a shape instance by type.
Parameters:
-
cfg
Objectattributes for the shape
Returns:
addToRedrawQueue
-
shape
Adds a shape to the redraw queue and calculates the contentBounds. Used internally
by Shape
instances.
Parameters:
-
shape
SVGShape
batch
-
method
Allows for creating multiple shapes in order to batch appending and redraw operations.
Parameters:
-
method
FunctionMethod to execute.
clear
()
Clears the graphics object.
destroy
()
Removes all nodes.
getGradientNode
-
key
-
type
Returns a reference to a gradient definition based on an id and type.
Parameters:
Returns:
getShapeById
-
id
Returns a shape based on the id of its dom node.
Parameters:
-
id
StringDom id of the shape's node attribute.
Returns:
getXY
()
Gets the current position of the graphic instance in page coordinates.
Returns:
initializer
()
private
Initializes the class.
removeAllShapes
()
Removes all shape instances from the dom.
removeShape
-
shape
Removes a shape instance from from the graphic instance.
render
-
parentNode
Adds the graphics node to the dom.
Parameters:
-
parentNode
HTMLElementnode in which to render the graphics node into.
Properties
_shapeClass
Object
private
Look up for shape classes. Used by addShape
to retrieve a class for instantiation.
Attributes
autoDraw
Boolean
private
Indicates whether or not the instance will automatically redraw after a change is made to a shape. This property will get set to false when batching operations.
Default: true
autoSize
Boolean
Determines how the size of instance is calculated. If true, the width and height are determined by the size of the contents. If false, the width and height values are either explicitly set or determined by the size of the parent node's dimensions.
Default: false
contentBounds
Object
Object containing size and coordinate data for the content of a Graphic in relation to the coordSpace node.
render
Node | String
Whether or not to render the Graphic
automatically after to a specified parent node after init. This can be a Node instance or a CSS selector string.
resizeDown
Boolean
The contentBounds will resize to greater values but not to smaller values. (for performance) When resizing the contentBounds down is desirable, set the resizeDown value to true.