Package net.sourceforge.plantuml.core

Interface ImageData

All Known Implementing Classes:
ImageDataAbstract, ImageDataComplex, ImageDataSimple
public interface ImageData
Information about a generated image for a diagram. For some diagrams, there are some position information about elements from the diagram. In that case, the method containsCMapData() returns true and you can retrieve those information using getCMapData() method.

  • Method Details

    • getWidth

      int getWidth()
      Width in pixel of the image.

    • getHeight

      int getHeight()
      Height in pixel of the image.

    • containsCMapData

      boolean containsCMapData()
      Indicates if the image has some position information.
      Returns:
      true if the image has position information.

    • getCMapData

      String getCMapData(String nameId)
      Return position information as a CMap formated string. For example, if you call this method with nameId set to "foo_map", you will get something like: 
       <map id="foo_map" name="foo_map">
 <area shape="rect" id="..." href="..." title="..." alt="" coords="64,68,93,148"/>
 </map>
      Parameters:
      nameId - the id to be used in the cmap data string.

    • getWarningOrError

      String getWarningOrError()

    • getStatus

      int getStatus()