| OpenLayers. | |
| Properties | |
| xmlns | {String} |
| xlinkns | {String} |
| Constants | |
| MAX_PIXEL | {Integer} Firefox has a limitation where values larger or smaller than about 15000 in an SVG document lock the browser up. |
| Properties | |
| translationParameters | {Object} Hash with “x” and “y” properties |
| symbolMetrics | {Object} Cache for symbol metrics according to their svg coordinate space. |
| Constructor | |
| OpenLayers. | |
| Functions | |
| supported | {Boolean} Whether or not the browser supports the SVG renderer |
| inValidRange | See #669 for more information |
| setExtent | |
| translate | Transforms the SVG coordinate system |
| setSize | Sets the size of the drawing surface. |
| getNodeType | |
| setStyle | Use to set all the style attributes to a SVG node. |
| dashStyle | |
| createNode | |
| nodeTypeCompare | |
| createRenderRoot | {DOMElement} The specific render engine’s root element |
| createRoot | |
| createDefs | {DOMElement} The element to which we’ll add the symbol definitions |
| drawPoint | This method is only called by the renderer itself. |
| drawCircle | This method is only called by the renderer itself. |
| drawLineString | This method is only called by the renderer itself. |
| drawLinearRing | This method is only called by the renderer itself. |
| drawPolygon | This method is only called by the renderer itself. |
| drawRectangle | This method is only called by the renderer itself. |
| drawText | This method is only called by the renderer itself. |
| getComponentString | |
| clipLine | Given two points (one inside the valid range, and one outside), clips the line betweeen the two points so that the new points are both inside the valid range. |
| getShortString | |
| getPosition | Finds the position of an svg node. |
| importSymbol | add a new symbol definition from the rendererer’s symbol hash |
| getFeatureIdFromEvent | |
| Constants | |
| OpenLayers. | {Object} |
| OpenLayers. | {Object} |
| OpenLayers. | {Object} |
| Functions | |
| OpenLayers. | Used to prevent default events (especially opening images in a new tab on ctrl-click) from being executed for externalGraphic symbols |
inValidRange: function( x, y, xyOnly )
See #669 for more information
| x | {Integer} |
| y | {Integer} |
| xyOnly | {Boolean} whether or not to just check for x and y, which means to not take the current translation parameters into account if true. |
{Boolean} Whether or not the ‘x’ and ‘y’ coordinates are in the valid range.
setExtent: function( extent, resolutionChanged )
| extent | {OpenLayers.Bounds} |
| resolutionChanged | {Boolean} |
{Boolean} true to notify the layer that the new extent does not exceed the coordinate range, and the features will not need to be redrawn. False otherwise.
setSize: function( size )
Sets the size of the drawing surface.
| size | {OpenLayers.Size} The size of the drawing surface |
getNodeType: function( geometry, style )
| geometry | {OpenLayers.Geometry} |
| style | {Object} |
{String} The corresponding node type for the specified geometry
setStyle: function( node, style, options )
Use to set all the style attributes to a SVG node.
Takes care to adjust stroke width and point radius to be resolution-relative
| node | {SVGDomElement} An SVG element to decorate |
| style | {Object} |
| options | {Object} Currently supported options include ‘isFilled’ {Boolean} and ‘isStroked’ {Boolean} |
drawPoint: function( node, geometry )
This method is only called by the renderer itself.
| node | {DOMElement} |
| geometry | {OpenLayers.Geometry} |
{DOMElement} or false if the renderer could not draw the point
drawCircle: function( node, geometry, radius )
This method is only called by the renderer itself.
| node | {DOMElement} |
| geometry | {OpenLayers.Geometry} |
| radius | {Float} |
{DOMElement} or false if the renderer could not draw the circle
drawLineString: function( node, geometry )
This method is only called by the renderer itself.
| node | {DOMElement} |
| geometry | {OpenLayers.Geometry} |
{DOMElement} or null if the renderer could not draw all components of the linestring, or false if nothing could be drawn
drawLinearRing: function( node, geometry )
This method is only called by the renderer itself.
| node | {DOMElement} |
| geometry | {OpenLayers.Geometry} |
{DOMElement} or null if the renderer could not draw all components of the linear ring, or false if nothing could be drawn
drawPolygon: function( node, geometry )
This method is only called by the renderer itself.
| node | {DOMElement} |
| geometry | {OpenLayers.Geometry} |
{DOMElement} or null if the renderer could not draw all components of the polygon, or false if nothing could be drawn
drawRectangle: function( node, geometry )
This method is only called by the renderer itself.
| node | {DOMElement} |
| geometry | {OpenLayers.Geometry} |
{DOMElement} or false if the renderer could not draw the rectangle
drawText: function( featureId, style, location )
This method is only called by the renderer itself.
| featureId | {String} style - |
| location | {OpenLayers.Geometry.Point} |
| components | {Array(OpenLayers.Geometry.Point)} Array of points |
| separator | {String} character between coordinate pairs. Defaults to “,” |
{Object} hash with properties “path” (the string created from the components and “complete” (false if the renderer was unable to draw all components)
clipLine: function( badComponent, goodComponent )
Given two points (one inside the valid range, and one outside), clips the line betweeen the two points so that the new points are both inside the valid range.
| badComponent | {OpenLayers.Geometry.Point} original geometry of the invalid point |
| goodComponent | {OpenLayers.Geometry.Point} original geometry of the valid point Returns {String} the SVG coordinate pair of the clipped point (like getShortString), or an empty string if both passed componets are at the same point. |
getShortString: function( point )
| point | {OpenLayers.Geometry.Point} |
{String} or false if point is outside the valid range
getFeatureIdFromEvent: function( evt )
| evt | {Object} An OpenLayers.Event object |
{String} A feature id or undefined.
{Boolean} Whether or not the browser supports the SVG renderer
supported: function()
See #669 for more information
inValidRange: function( x, y, xyOnly )
setExtent: function( extent, resolutionChanged )
Transforms the SVG coordinate system
translate: function( x, y )
Sets the size of the drawing surface.
setSize: function( size )
getNodeType: function( geometry, style )
Use to set all the style attributes to a SVG node.
setStyle: function( node, style, options )
dashStyle: function( style, widthFactor )
createNode: function( type, id )
nodeTypeCompare: function( node, type )
{DOMElement} The specific render engine’s root element
createRenderRoot: function()
createRoot: function( suffix )
{DOMElement} The element to which we’ll add the symbol definitions
createDefs: function()
This method is only called by the renderer itself.
drawPoint: function( node, geometry )
This method is only called by the renderer itself.
drawCircle: function( node, geometry, radius )
This method is only called by the renderer itself.
drawLineString: function( node, geometry )
This method is only called by the renderer itself.
drawLinearRing: function( node, geometry )
This method is only called by the renderer itself.
drawPolygon: function( node, geometry )
This method is only called by the renderer itself.
drawRectangle: function( node, geometry )
This method is only called by the renderer itself.
drawText: function( featureId, style, location )
Given two points (one inside the valid range, and one outside), clips the line betweeen the two points so that the new points are both inside the valid range.
clipLine: function( badComponent, goodComponent )
getShortString: function( point )
Finds the position of an svg node.
getPosition: function( node )
add a new symbol definition from the rendererer’s symbol hash
importSymbol: function ( graphicName )
getFeatureIdFromEvent: function( evt )
Used to prevent default events (especially opening images in a new tab on ctrl-click) from being executed for externalGraphic symbols
OpenLayers.Renderer.SVG.preventDefault = function( e )
