1 GraphML
Class Ax.graph.GraphML
GraphML is an XML-based file format for graphs. This class lets you use it to generate an ER diagram of a db.
Constructor Summary
Method
Description
JSGraphML(Ax.db conn)
Create a new GraphML instance, that will use the given connection to get the db metadata to build the ER diagram.
JSGraphML(Ax.db conn, Ax.text.String bgcolor)
Create a new GraphML instance, that will use the given connection to get the db metadata to build the ER diagram;
with the specified background color
Method Summary
Modifier and Type
Method
Description
Ax.graph.GraphML
Adds a new group to the graph, composed of the specified tables and with the chosen background color.
void
setShowTableColumns(boolean show)
Enables or diasbles the table columns in the graph nodes (tables of the db).
void
setShowTableStatistics(boolean show)
Enables or diasbles the table statistics in the graph nodes (tables of the db).
Ax.text.String
toString()
Returns the XML document defining the GraphML.
Constructor Detail
Ax.graph.GraphML.JSGraphML
-
Ax.graph.GraphML.JSGraphML( object conn )
- Info:
-
Create a new GraphML instance, that will use the given connection to get the db metadata to build the ER diagram. - Parameters:
- conn - connection to get metadata
Ax.graph.GraphML.JSGraphML
-
Ax.graph.GraphML.JSGraphML( object conn, string bgcolor )
- Info:
-
Create a new GraphML instance, that will use the given connection to get the db metadata to build the ER diagram; with the specified background color - Parameters:
- conn - connection to get metadata
- bgcolor - background color
Method Detail
Ax.graph.GraphML.addGroup
-
object Ax.graph.GraphML.addGroup( string name, string bgcolor, string[] tables )
- Info:
-
Adds a new group to the graph, composed of the specified tables and with the chosen background color. - Parameters:
- name - name of the new group
- bgcolor - background color of the group
- tables - tables to ad to the group
- Returns:
- object
Ax.graph.GraphML.setShowTableColumns
-
null Ax.graph.GraphML.setShowTableColumns( boolean show )
- Info:
-
Enables or diasbles the table columns in the graph nodes (tables of the db). - Parameters:
- show - true to show columns, false to hide them
- Returns:
- null
Ax.graph.GraphML.setShowTableStatistics
-
null Ax.graph.GraphML.setShowTableStatistics( boolean show )
- Info:
-
Enables or diasbles the table statistics in the graph nodes (tables of the db). - Parameters:
- show - true to show statistics, false to hide them
- Returns:
- null
Ax.graph.GraphML.toString
-
string Ax.graph.GraphML.toString()
- Info:
-
Returns the XML document defining the GraphML. - Returns:
- string
2 GraphViz
Class Ax.graph.GraphViz
Wrapper for server GraphViz processor.
Graphviz (short for Graph Visualization Software) is a package of open-source tools initiated by AT
Constructor Summary
Method
Description
JSGraphViz(Ax.text.String dot)
Creates a new instance of the GraphViz microservice.
Method Summary
Modifier and Type
Method
Description
boolean
isReady()
Checks if the GraphViz microservice is ready.
boolean
isReady(boolean forceOnlineCheck)
Checks if the GraphViz microservice is ready.
boolean
isReady(MicroserviceType arg0)
boolean
isReady(MicroserviceType arg0,boolean arg1)
Ax.text.String
toFOP()
Transforms the graph to a FO document.
Ax.text.String
toSVG()
Transforms the graph to SVG format.
Constructor Detail
Ax.graph.GraphViz.JSGraphViz
-
Ax.graph.GraphViz.JSGraphViz( string dot )
- Info:
-
Creates a new instance of the GraphViz microservice. - Parameters:
- dot - DOT language script specifying the graph.
Method Detail
Ax.graph.GraphViz.isReady
-
boolean Ax.graph.GraphViz.isReady()
- Info:
-
Checks if the GraphViz microservice is ready. - Returns:
- boolean
Ax.graph.GraphViz.isReady
-
boolean Ax.graph.GraphViz.isReady( boolean forceOnlineCheck )
- Info:
-
Checks if the GraphViz microservice is ready. - Parameters:
- forceOnlineCheck - to disable or force whether the server is reachable
- Returns:
- boolean
Ax.graph.GraphViz.isReady
-
boolean Ax.graph.GraphViz.isReady( object arg0 )
- Parameters:
- arg0 -
- Returns:
- boolean
Ax.graph.GraphViz.isReady
-
boolean Ax.graph.GraphViz.isReady( object arg0, boolean arg1 )
- Parameters:
- arg0 -
- arg1 -
- Returns:
- boolean
Ax.graph.GraphViz.toFOP
-
string Ax.graph.GraphViz.toFOP()
- Info:
-
Transforms the graph to a FO document. - Returns:
- string
Ax.graph.GraphViz.toSVG
-
string Ax.graph.GraphViz.toSVG()
- Info:
-
Transforms the graph to SVG format. - Returns:
- string
3 Ditaa
Class Ax.graph.Ditaa
Wrapper for server DITAA processor.
Ditaa (Diagrams Through Ascii Art).
Constructor Summary
Method
Description
JSDitaa(Ax.text.String diagram)
Creates a new DITAA graph specified by the diagram.
Method Summary
Constructor Detail
Ax.graph.Ditaa.JSDitaa
-
Ax.graph.Ditaa.JSDitaa( string diagram )
- Info:
-
Creates a new DITAA graph specified by the diagram. - Parameters:
- diagram - diagram representing the graph
Method Detail
Ax.graph.Ditaa.toPNG
-
byte[] Ax.graph.Ditaa.toPNG()
- Info:
-
Returns the graph as a PNG image. - Returns:
- byte[]