com.illumon.iris.db.plot

Interface BaseFigure

All Superinterfaces:

Serializable

All Known Subinterfaces:

Figure

All Known Implementing Classes:

FigureImpl, ScatterPlotMatrix

public interface BaseFigure
extends Serializable

Container for Charts.

Method Summary

Modifier and Type	Method and Description
Chart	chart(int index) Gets the chart at the index from this Figure's grid.
Chart	chart(int rowNum, int colNum) Gets the chart at the[rowNum, colNum from this Figure's grid.
BaseFigure	figureRemoveSeries(String... names) Removes all series with names from this Figure.
BaseFigure	figureTitle(String title) Sets the title of this Figure
BaseFigure	figureTitleColor(com.illumon.iris.gui.color.Paint color) Sets the color of this Figure's title
BaseFigure	figureTitleColor(String color) Sets the color of this Figure's title
BaseFigure	figureTitleFont(Font font) Sets the font of this Figure's title
BaseFigure	figureTitleFont(String family, String style, int size) Sets the font of this Figure's title
Chart	newChart() Adds a new Chart to this figure.
Chart	newChart(int index) Adds a new Chart to this figure.
Chart	newChart(int rowNum, int colNum) Adds a new Chart to this figure.
BaseFigure	removeChart(int index) Removes the chart at the index from this Figure's grid.
BaseFigure	removeChart(int rowNum, int colNum) Removes the chart at the[rowNum, colNum from this Figure's grid.
BaseFigure	save(String saveLocation) Saves the Figure as an image to the specified saveLocation.
BaseFigure	save(String saveLocation, int width, int height) Saves the Figure as an image to the specified saveLocation.
BaseFigure	theme(String theme) Sets the Theme of this Figure
BaseFigure	theme(Theme theme) Sets the Theme of this Figure
BaseFigure	updateInterval(long updateIntervalMillis) Sets the update interval of this Figure.

Method Detail

figureRemoveSeries

BaseFigure figureRemoveSeries(String... names)

Removes all series with names from this Figure.

Parameters:

names - series names

Returns:

this Figure

theme

BaseFigure theme(Theme theme)

Sets the Theme of this Figure

Parameters:

theme - theme

Returns:

this Figure

theme

BaseFigure theme(String theme)

Sets the Theme of this Figure

Parameters:

theme - theme name

Returns:

this Figure

updateInterval

BaseFigure updateInterval(long updateIntervalMillis)

Sets the update interval of this Figure. The plot will be redrawn at this update interval.

Parameters:

updateIntervalMillis - update interval, in milliseconds

Returns:

this Figure

figureTitle

BaseFigure figureTitle(String title)

Sets the title of this Figure

Parameters:

title - title

Returns:

this Figure

figureTitleFont

BaseFigure figureTitleFont(Font font)

Sets the font of this Figure's title

Parameters:

font - font

Returns:

this Figure

figureTitleFont

BaseFigure figureTitleFont(String family,
                           String style,
                           int size)

Sets the font of this Figure's title

Parameters:

family - font family; if null, set to Arial

style - font style; if null, set to Font.FontStyle PLAIN

size - the point size of the Font

Returns:

this Figure

figureTitleColor

BaseFigure figureTitleColor(com.illumon.iris.gui.color.Paint color)

Sets the color of this Figure's title

Parameters:

color - color

Returns:

this Figure

figureTitleColor

BaseFigure figureTitleColor(String color)

Sets the color of this Figure's title

Parameters:

color - color

Returns:

this Figure

newChart

Chart newChart()

Adds a new Chart to this figure. The Chart is placed in the next available grid space, starting at the upper left hand corner of the grid, going left to right, top to bottom. If no available space is found in the grid: if this Figure was created with no specified grid size, then the Figure will resize itself to add the new Chart; if not, a RuntimeException will be thrown.

Returns:

the new Chart

Throws:

RuntimeException - if no space for the new Chart exists or can not be made

newChart

Chart newChart(int index)

Adds a new Chart to this figure. The Chart is placed at the grid space indicated by the index. The index starts at 0 in the upper left hand corner of the grid and increases going left to right, top to bottom. E.g. for a 2x2 Figure, the indices would be [0, 1] [2, 3]

Parameters:

index - index of this Figure's grid

Returns:

the new Chart

Throws:

RuntimeException - if index is outside this Figure's grid

newChart

Chart newChart(int rowNum,
               int colNum)

Adds a new Chart to this figure. The Chart is placed at the grid space [rowNum, colNum. Row and column numbers start at 0 in the upper left hand corner of the grid and increase going top to bottom and left to right respectively. E.g. for a 2x2 Figure, the coordinates would be [(0,0), (0,1)] [(1,0), (1,1)]

Parameters:

rowNum - row index of this Figure's grid

colNum - column index of this Figure's grid

Returns:

the new Chart

Throws:

RuntimeException - if the coordinates are outside the Figure's grid

removeChart

BaseFigure removeChart(int index)

Removes the chart at the index from this Figure's grid. The index starts at 0 in the upper left hand corner of the grid and increases going left to right, top to bottom. E.g. for a 2x2 Figure, the indices would be [0, 1] [2, 3]

Parameters:

index - index

Returns:

this Figure

removeChart

BaseFigure removeChart(int rowNum,
                       int colNum)

Removes the chart at the[rowNum, colNum from this Figure's grid. Row and column numbers start at 0 in the upper left hand corner of the grid and increase going top to bottom and left to right respectively. E.g. for a 2x2 Figure, the coordinates would be [(0,0), (0,1)] [(1,0), (1,1)]

Parameters:

rowNum - row index of this Figure's grid

colNum - column index of this Figure's grid

Returns:

the new Chart

Throws:

RuntimeException - if the coordinates are outside the Figure's grid

chart

Chart chart(int index)

Gets the chart at the index from this Figure's grid. The index starts at 0 in the upper left hand corner of the grid and increases going left to right, top to bottom. E.g. for a 2x2 Figure, the indices would be [0, 1] [2, 3]

Parameters:

index - index

Returns:

selected Chart

Throws:

RuntimeException - if the index is outside the Figure's grid

chart

Chart chart(int rowNum,
            int colNum)

Gets the chart at the[rowNum, colNum from this Figure's grid. Row and column numbers start at 0 in the upper left hand corner of the grid and increase going top to bottom and left to right respectively. E.g. for a 2x2 Figure, the coordinates would be [(0,0), (0,1)] [(1,0), (1,1)]

Parameters:

rowNum - row index of this Figure's grid

colNum - column index of this Figure's grid

Returns:

selected Chart

Throws:

RuntimeException - if the coordinates are outside the Figure's grid

save

BaseFigure save(String saveLocation)

Saves the Figure as an image to the specified saveLocation. This image's size is 2480x2160.

Parameters:

saveLocation - save location. Must not be null

Throws:

com.fishlib.base.verify.RequirementFailure - saveLocation is null

save

BaseFigure save(String saveLocation,
                int width,
                int height)

Saves the Figure as an image to the specified saveLocation. This image's size is width x height.

Parameters:

saveLocation - save location. Must not be null

width - width of the resultant image

height - height of the resultant image

Throws:

com.fishlib.base.verify.RequirementFailure - saveLocation is null