Package net.sourceforge.plantuml.core
Interface ImageData
-
- All Known Implementing Classes:
ImageDataAbstract,ImageDataComplex,ImageDataSimple
public interface ImageDataInformation about a generated image for a diagram. For some diagrams, there are some position information about elements from the diagram. In that case, the methodcontainsCMapData()returnstrueand you can retrieve those information usinggetCMapData()method.- Author:
- Arnaud Roques
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description booleancontainsCMapData()Indicates if the image has some position information.java.lang.StringgetCMapData(java.lang.String nameId)Return position information as a CMap formated string.intgetHeight()Height in pixel of the image.intgetStatus()java.lang.StringgetWarningOrError()intgetWidth()Width in pixel of the image.
-
-
-
Method Detail
-
getWidth
int getWidth()
Width in pixel of the image.- Returns:
-
getHeight
int getHeight()
Height in pixel of the image.- Returns:
-
containsCMapData
boolean containsCMapData()
Indicates if the image has some position information.- Returns:
trueif the image has position information.
-
getCMapData
java.lang.String getCMapData(java.lang.String nameId)
Return position information as a CMap formated string. For example, if you call this method withnameIdset 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- thie id to be used in the cmap data string.- Returns:
-
getWarningOrError
java.lang.String getWarningOrError()
-
getStatus
int getStatus()
-
-