The base class IlvGraphLayoutReport stores the following
information:
Code
This field contains information about
special, predefined cases that have occurred during the layout.
The possible values are:
LAYOUT_DONEappears if the layout was performed successfully.STOPPED_AND_VALIDappears if the layout was performed but was stopped before completion, either because the layout time elapsed or because the methodstopImmediatelywas called. The positions of nodes and links are valid at the stopping point because the layout algorithm uses an iterative mechanism.STOPPED_AND_INVALIDappears if a (noniterative) layout was performed but was stopped before completion, either because the layout time elapsed or because the methodstopImmediatelywas called. The positions of nodes and links are not valid at the stopping point. Often, they have not yet been changed at all.NOT_NEEDEDappears if the layout was not performed because no changes occurred in the grapher and parameters since the last time the layout was performed successfully.EMPTY_GRAPHERappears if the grapher is empty.
To read the code, use the method:
int getCode()
Layout time
This field contains the total duration of
the layout algorithm at the end of the layout. To read the time
(in milliseconds), use the method:
long getLayoutTime()
Percentage of completion
This field contains an estimation of the percentage of the layout
that has been completed. It can be used if the layout algorithm
supports the generic percentage completion calculation feature,
see Percentage of completion calculation. It is
typically used inside layout event listeners that are described
in the following section.
To access the percentage, use the
method:
int getPercentageComplete()
Additional information
Additional information for particular layout algorithms is stored
by the subclasses of
IlvGraphLayoutReport
. For details, see the reference documentation of these classes: