Documentation of 'jhplot.HDiagram' Java class.
HDiagram
jhplot

Class HDiagram



  • public class HDiagram
    extends java.lang.Object
    Create diagrams from a string or a file using the PlantUML syntax. See http://plantuml.com/. It allows to make Sequence diagram
    Usecase diagram
    Class diagram
    Activity diagram (here is the legacy syntax)
    Component diagram
    State diagram
    Object diagram
    Deployment diagram
    Timing diagram
    In addition, it makes: Specification and Description Language (SDL)
    Ditaa diagram
    Gantt diagram
    Mathematic with AsciiMath or JLaTeXMath notation.
    Diagrams can be exported to EPS, PDF, PNG, SVG images.
    • Constructor Summary

      Constructors 
      Constructor and Description
      HDiagram()
      Default constructor.
      HDiagram(java.lang.String source)
      Initialize a from a source string.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method and Description
      void doc() 
      void export(java.lang.String file)
      Fast export of the diagram to an image file.
      void fromFile(java.lang.String file)
      Build a diagram from a file
      void fromString(java.lang.String source)
      Build a diagram from a string.
      net.sourceforge.plantuml.SourceStringReader getReader()
      Return reader.
      • Methods inherited from class java.lang.Object

        equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • HDiagram

        public HDiagram(java.lang.String source)
        Initialize a from a source string.
        Parameters:
        source - diagram using PlantUML Language.
      • HDiagram

        public HDiagram()
        Default constructor.
    • Method Detail

      • fromString

        public void fromString(java.lang.String source)
        Build a diagram from a string.
        Parameters:
        source - string in PlantUML Language.
      • fromFile

        public void fromFile(java.lang.String file)
        Build a diagram from a file
        Parameters:
        file - file with diagram in PlantUML Language.
      • getReader

        public net.sourceforge.plantuml.SourceStringReader getReader()
        Return reader.
        Returns:
        reader.
      • export

        public void export(java.lang.String file)
        Fast export of the diagram to an image file. The ouput format depends on the file extension:
        SVG - Scalable Vector Graphics (SVG)
        SVGZ - compressed SVG
        PNG - raster format
        PDF - PDF
        EPS - PostScript (encapsulated)
        HTMP5 - HTML5

        No questions will be asked and existing file will be rewritten

        Parameters:
        file - Output file with the proper extension (SVG, SVGZ, PNG, PDF, EPS). If no extension, PNG file is assumed.
      • doc

        public void doc()

DMelt 3.0 © DataMelt by jWork.ORG