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.
-
+
- Index + + +
- Methods + + +
- Properties + + +
- Attributes + + +
Item Index
+ + +Methods
+ +-
+
+
- + _appendShape + + + + + +
- + _createGraphicNode + + + + + +
- + _createGraphics + + + + + +
- + _getDocFrag + + + + + +
- + _getShapeClass + + + + + +
- + _getUpdatedContentBounds + + + + + +
- + _redraw + + + + + +
- + _removeChildren + + + + + +
- + _toBack + + + + + +
- + _toFront + + + + + +
- + _toggleVisible + + + + + +
- + addShape + + + + + +
- + addToRedrawQueue + + + + + +
- + batch + + + + + +
- + clear + + + + + +
- + destroy + + + + + +
- + getGradientNode + + + + + +
- + getShapeById + + + + + +
- + getXY + + + + + +
- + initializer + + + + + +
- + removeAllShapes + + + + + +
- + removeShape + + + + + +
- + render + + + + + +
- + set + + + + + +
Properties
+ +-
+
+
- + _shapeClass + + + + + +
- + _x + + + + + +
- + _y + + + + + +
Attributes
+ +-
+
+
- + autoDraw + + +
- + autoSize + + +
- + contentBounds + + +
- + height + + +
- + id + + +
- + node + + +
- + preserveAspectRatio + + +
- + render + + +
- + resizeDown + + +
- + shapes + + +
- + width + + +
- + x + + +
- + y + + +
Methods
+ + +_appendShape
+
+
+ -
+
+
-
+
+
shape+ +
+
+
Adds a shape instance to the graphic instance.
+Parameters:
+ +-
+
+
-
+
+
shape+ Shape + + + + +++ + +The shape instance to be added to the graphic.
+
+
+
_createGraphicNode
+
+
+ -
+
+
-
+
+
type+ +
+
+ -
+
+
pe+ +
+
+
Creates a graphic node
+Parameters:
+ + +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.
Parameters:
+ + +Returns:
+ +_getUpdatedContentBounds
+
+
+ ()
+
+
+
+
+ Object
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Recalculates and returns the contentBounds for the Graphic instance.
Returns:
+ +_redraw
+
+
+ ()
+
+
+
+
+
+
+
+ private
+
+
+
+
+
+
+
+
+
+
+
+
+ Redraws all shapes.
+_removeChildren
+
+
+ -
+
+
-
+
+
node+ +
+
+
Removes all child nodes.
+Parameters:
+ +-
+
+
-
+
+
node+ HTMLElement + + + + ++ ++ + +
+
+
_toBack
+
+
+ -
+
+
-
+
+
Shape+ +
+
+
Inserts shape as the first child of the content node.
+Parameters:
+ +-
+
+
-
+
+
Shape+ SVGShape + + + + +++ + +to add.
+
+
+
_toFront
+
+
+ -
+
+
-
+
+
Shape+ +
+
+
Inserts shape on the top of the tree.
+Parameters:
+ +-
+
+
-
+
+
Shape+ SVGShape + + + + +++ + +to add.
+
+
+
_toggleVisible
+
+
+ -
+
+
-
+
+
val+ +
+
+
Toggles visibility
+Parameters:
+ +-
+
+
-
+
+
val+ Boolean + + + + +++ + +indicates visibilitye
+
+
+
addShape
+
+
+ -
+
+
-
+
+
cfg+ +
+
+
Generates a shape instance by type.
+Parameters:
+ +-
+
+
-
+
+
cfg+ Object + + + + +++ + +attributes 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+ Function + + + + +++ + +Method 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+ String + + + + +++ + +Dom 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+ HTMLElement + + + + +++ + +node in which to render the graphics node into.
+
+
+
set
+
+
+ -
+
+
-
+
+
name+ +
+
+ -
+
+
value+ +
+
+
Sets the value of an attribute.
+Parameters:
+ +-
+
+
-
+
+
name+ String | Object + + + + +++ + +The name of the attribute. Alternatively, an object of key value pairs can +be passed in to set multiple attributes at once.
+
+
+ -
+
+
value+ Any + + + + +++ + +The value to set the attribute to. This value is ignored if an object is received as +the name param.
+
+
+
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 | String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Determines the sizing of the Graphic.
+ +-
+
- sizeContentToGraphic
- The Graphic's width and height attributes are, either explicitly set through the
+
widthandheightattributes or are determined by the dimensions of the parent element. The + content contained in the Graphic will be sized to fit with in the Graphic instance's dimensions. When using this + setting, thepreserveAspectRatioattribute will determine how the contents are sized.
+ - sizeGraphicToContent
- (Also accepts a value of true) The Graphic's width and height are determined by the + size and positioning of the content. +
- false
- The Graphic's width and height attributes are, either explicitly set through the
width+ andheightattributes or are determined by the dimensions of the parent element. The contents of the + Graphic instance are not affected by this setting.
+
Default: false
+ + + + + +contentBounds
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+ Object containing size and coordinate data for the content of a Graphic in relation to the coordSpace node.
+height
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates the height of the Graphic.
node
+ HTMLElement
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+ The html element that represents to coordinate system of the Graphic instance.
+preserveAspectRatio
+ String
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Determines how content is sized when autoSize is set to sizeContentToGraphic.
-
+
- none
- Do not force uniform scaling. Scale the graphic content of the given element non-uniformly if necessary + such that the element's bounding box exactly matches the viewport rectangle. +
- xMinYMin
- Force uniform scaling position along the top left of the Graphic's node. +
- xMidYMin
- Force uniform scaling horizontally centered and positioned at the top of the Graphic's node.
- +
- xMaxYMin
- Force uniform scaling positioned horizontally from the right and vertically from the top. +
- xMinYMid Force uniform scaling positioned horizontally from the left and vertically centered. +
- xMidYMid (the default)
- Force uniform scaling with the content centered. +
- xMaxYMid
- Force uniform scaling positioned horizontally from the right and vertically centered. +
- xMinYMax
- Force uniform scaling positioned horizontally from the left and vertically from the bottom. +
- xMidYMax
- Force uniform scaling horizontally centered and position vertically from the bottom. +
- xMaxYMax
- Force uniform scaling positioned horizontally from the right and vertically from the bottom. +
Default: xMidYMid
+ + + + + +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.
+shapes
+ Object
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ readonly
+
+
+
+
+ Key value pairs in which a shape instance is associated with its id.
+width
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates the width of the Graphic.
x
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates the x-coordinate for the instance.
+y
+ Number
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+ Indicates the y-coordinate for the instance.
+