PlotLayout
Class
PlotLayout objects hold information about the layout of the plot dialog. The use
of ViewportLayout objects, in conjunction with PlotLayout objects, allows scripts
to specify the same layout information accessible interactive via the “Configure Plot
Layout” dialog. A PlotLayout object is obtained by calling Plot.newPlotLayout().
PlotLayout methods are described in the table below.
PlotLayout Methods
|
Method |
Returns |
Description |
|
addViewport() |
ViewportLayout |
Adds a ViewportLayout to the PlotLayout with a default weight of 100. Returns a reference to the new ViewportLayout. |
|
addViewport(floating-point weight) |
ViewportLayout |
Adds a ViewportLayout to the PlotLayout with the specified weight. Returns a reference to the new ViewportLayout. |
|
hasLegend() |
0/1 |
Returns whether this PlotLayout is configured to display the legend. |
|
hasToolbar() |
0/1 |
Returns whether this PlotLayout is configured to display the toolbar. |
|
getViewportCount() |
integer |
Returns the number of ViewportLayout objects currently in the PlotLayout object. |
|
getViewports() |
java.util.List of ViewportLayouts |
Returns the ViewportLayout objects currently in the PlotLayout object. |
|
getViewportWeights() |
list of floating-points |
Returns the weights of the ViewportLayout objects currently in the PlotLayout object. |
|
setHasLegend(0/1 state) |
None |
Configures the PlotLayout object to display the legend or not, depending upon the specified state. |
|
setHasToolbar(0/1 state) |
None |
Configures the PlotLayout object to display the toolbar or not, depending upon the specified state. |