Diagram (PlantUML 1.2022.2 API)

All Known Subinterfaces:

WithSprite

All Known Implementing Classes:

AbstractClassOrObjectDiagram, AbstractEntityDiagram, AbstractPSystem, ActivityDiagram, ActivityDiagram3, BoardDiagram, BpmDiagram, ClassDiagram, CompositeDiagram, CucaDiagram, DescriptionDiagram, FlowDiagram, GanttDiagram, GitDiagram, Help, JsonDiagram, ListSpriteDiagram, MindMapDiagram, NewpagedDiagram, NwDiagram, PlainDiagram, PlainStringsDiagram, PSystemAppleTwo, PSystemCharlie, PSystemColors, PSystemCreole, PSystemDedication, PSystemDefinition, PSystemDitaa, PSystemDonors, PSystemDot, PSystemEgg, PSystemError, PSystemErrorEmpty, PSystemErrorPreprocessor, PSystemErrorV2, PSystemJcckit, PSystemKeycheck, PSystemKeygen, PSystemLatex, PSystemLicense, PSystemListEmoji, PSystemListFonts, PSystemListInternalSprites, PSystemListOpenIconic, PSystemLogo, PSystemLost, PSystemMath, PSystemOpenIconic, PSystemOregon, PSystemPath, PSystemRIP, PSystemSalt, PSystemSkinparameterList, PSystemStats, PSystemSudoku, PSystemVersion, PSystemWelcome, PSystemXearth, SequenceDiagram, StateDiagram, StdlibDiagram, TimingDiagram, TitledDiagram, UmlDiagram, WBSDiagram, WireDiagram
```
public interface Diagram
```
Represents a single diagram. A Diagram could be a UML (sequence diagram, class diagram...) or an non-UML diagram.

Author:

Arnaud Roques

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`ImageData`	`exportDiagram(OutputStream os, int num, FileFormatOption fileFormat)`	Export the diagram as an image to some format.
`DiagramDescription`	`getDescription()`
`String`	`getMetadata()`
`int`	`getNbImages()`	Number of images in this diagram (usually, 1)
`UmlSource`	`getSource()`	The original source of the diagram
`int`	`getSplitPagesHorizontal()`
`int`	`getSplitPagesVertical()`
`Display`	`getTitleDisplay()`
`String`	`getWarningOrError()`
`boolean`	`hasUrl()`	Check if the Diagram have some links.

- Method Detail
  - exportDiagram
```
ImageData exportDiagram(OutputStream os,
                        int num,
                        FileFormatOption fileFormat)
                 throws IOException
```
    Export the diagram as an image to some format. Note that a diagram could be drawn as several images (think about new page for sequence diagram for example).
    
    Parameters:
    
    os - where to write the image
    
    num - usually 0 (index of the image to be exported for this diagram).
    
    fileFormat - file format to use
    
    Returns:
    
    a description of the generated image
    
    Throws:
    
    IOException
  - getNbImages
```
int getNbImages()
```
    Number of images in this diagram (usually, 1)
    
    Returns:
    
    usually 1
  - getSplitPagesHorizontal
```
int getSplitPagesHorizontal()
```
  - getSplitPagesVertical
```
int getSplitPagesVertical()
```
  - getDescription
```
DiagramDescription getDescription()
```
  - getMetadata
```
String getMetadata()
```
  - getWarningOrError
```
String getWarningOrError()
```
  - getSource
```
UmlSource getSource()
```
    The original source of the diagram
  - hasUrl
```
boolean hasUrl()
```
    Check if the Diagram have some links.
  - getTitleDisplay
```
Display getTitleDisplay()
```