net.sourceforge.plantuml.core
Interface ImageData

All Known Implementing Classes:

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.

Author:

Arnaud Roques

Method Summary

boolean	containsCMapData() Indicates if the image has some position information.
String	getCMapData(String nameId) Return position information as a CMap formated string.
int	getHeight() Height in pixel of the image.
String	getWarningOrError()
int	getWidth() 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:

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 - thie id to be used in the cmap data string.

Returns:

getWarningOrError

String getWarningOrError()