Gephi Toolkit Javadoc

org.gephi.preview.api
Interface SVGTarget

All Superinterfaces:
RenderTarget
All Known Implementing Classes:
SVGRenderTargetBuilder.SVGRenderTargetImpl

public interface SVGTarget
extends RenderTarget

Rendering target to SVG format.

This target is used by renderers objects to render a graph to a SVG DOM and uses the Batik library to transcode the SVG DOM in a SVG document.

To allow further document further manipulation the DOM is organized with top elements. Top elements are nodes, edges, node-labels, edge-labels and arrows and are elements to append items to. For instance when a node label element is created it should be appended to the node-label element instead of directly to the root. Use the getTopElement() method to retrieve or create top elements.

Author:
Mathieu Bastian

Field Summary
static java.lang.String SCALE_STROKES
          SVG Boolean property whether to rescale stroke's width/thickness.
static java.lang.String TOP_ARROWS
          Default top element name for arrows
static java.lang.String TOP_EDGE_LABELS
          Default top element name for edge labels
static java.lang.String TOP_EDGE_LABELS_OUTLINE
          Default top element name for edge labels outline
static java.lang.String TOP_EDGES
          Default top element name for edges
static java.lang.String TOP_NODE_LABELS
          Default top element name for node labels
static java.lang.String TOP_NODE_LABELS_OUTLINE
          Default top element name for node labels outline
static java.lang.String TOP_NODES
          Default top element name for nodes
 
Fields inherited from interface org.gephi.preview.api.RenderTarget
PDF_TARGET, PROCESSING_TARGET, SVG_TARGET
 
Method Summary
 org.w3c.dom.Element createElement(java.lang.String qualifiedName)
          Create a new element qualifiedName in the document.
 org.w3c.dom.Text createTextNode(java.lang.String data)
          Create a new text node with data in it.
 org.w3c.dom.Document getDocument()
          Returns the SVG document
 float getScaleRatio()
          When SCALE_STROKES property is true returns the scale ratio to scale strokes with.
 org.w3c.dom.Element getTopElement(java.lang.String name)
          Returns the top element name in the document.
 java.lang.String toHexString(java.awt.Color color)
          Returns color in the hex format (e.g.
 

Field Detail

SCALE_STROKES

static final java.lang.String SCALE_STROKES
SVG Boolean property whether to rescale stroke's width/thickness.

See Also:
Constant Field Values

TOP_NODES

static final java.lang.String TOP_NODES
Default top element name for nodes

See Also:
Constant Field Values

TOP_EDGES

static final java.lang.String TOP_EDGES
Default top element name for edges

See Also:
Constant Field Values

TOP_NODE_LABELS

static final java.lang.String TOP_NODE_LABELS
Default top element name for node labels

See Also:
Constant Field Values

TOP_NODE_LABELS_OUTLINE

static final java.lang.String TOP_NODE_LABELS_OUTLINE
Default top element name for node labels outline

See Also:
Constant Field Values

TOP_EDGE_LABELS

static final java.lang.String TOP_EDGE_LABELS
Default top element name for edge labels

See Also:
Constant Field Values

TOP_EDGE_LABELS_OUTLINE

static final java.lang.String TOP_EDGE_LABELS_OUTLINE
Default top element name for edge labels outline

See Also:
Constant Field Values

TOP_ARROWS

static final java.lang.String TOP_ARROWS
Default top element name for arrows

See Also:
Constant Field Values
Method Detail

createElement

org.w3c.dom.Element createElement(java.lang.String qualifiedName)
Create a new element qualifiedName in the document.

Parameters:
qualifiedName - the name of the element
Returns:
the newly created element

createTextNode

org.w3c.dom.Text createTextNode(java.lang.String data)
Create a new text node with data in it.

Parameters:
data - the text data
Returns:
the newly created text node

getTopElement

org.w3c.dom.Element getTopElement(java.lang.String name)
Returns the top element name in the document. Top elements are direct children of the root node and help to organize the SVG document (e.g. all edges in the same parent DOM node). Create the top element if it missing.

Parameters:
name - the top element name to lookup
Returns:
the top element

getDocument

org.w3c.dom.Document getDocument()
Returns the SVG document

Returns:
the SVG document

getScaleRatio

float getScaleRatio()
When SCALE_STROKES property is true returns the scale ratio to scale strokes with.

Returns:
the current scale ratio

toHexString

java.lang.String toHexString(java.awt.Color color)
Returns color in the hex format (e.g. #ff0000).

Parameters:
color - the color to convert
Returns:
the color in a hex format

Gephi Toolkit Javadoc