WaterfallPlotParameters (CSS Core API)

Overview

Package

Class

Use

Tree

Deprecated

Index

Help

PREV CLASS NEXT CLASS

FRAMES NO FRAMES

SUMMARY: NESTED | FIELD | CONSTR | METHOD

DETAIL: FIELD | CONSTR | METHOD

org.epics.pvmanager.extra
Class WaterfallPlotParameters

java.lang.Object
  org.epics.pvmanager.extra.Parameters
      org.epics.pvmanager.extra.WaterfallPlotParameters

public class WaterfallPlotParameters
extends Parameters
extends Parameters

Parameters for the waterfall plot

Author:: carcassi

Method Summary
`static WaterfallPlotParameters`	`adaptiveRange(boolean adaptiveRange)` True if the range for the display should be the automatically determined or should be desumed by the data.
`static WaterfallPlotParameters`	`backgroundColor(int rgb)` The background color for the plot.
`static WaterfallPlotParameters`	`colorScheme(ColorScheme colorScheme)` The color scheme to convert a value to an rgb pixel in the plot.
`static WaterfallPlotParameters`	`defaults()` Defaults parameters for the waterfall plot.
`ColorScheme`	`getColorScheme()` Color scheme used for the plot.
`int`	`getHeight()` The height of the plot in pixels.
`TimeDuration`	`getPixelDuration()` Time interval for each line.
`static WaterfallPlotParameters`	`height(int height)` Height of the plot in pixels.
`boolean`	`isAdaptiveRange()` True if range is automatic, false if taken from data.
`boolean`	`isScrollDown()` Whether the plot scrolls up or down.
`static WaterfallPlotParameters`	`pixelDuration(TimeDuration pixelDuration)` How much time should be allocated to each line of the plot.
`static WaterfallPlotParameters`	`scrollDown(boolean scrollDown)` Whether the plot should scroll down or up.
`WaterfallPlotParameters`	`with(WaterfallPlotParameters... newParameters)` Returns a new set of parameters with the given changes;

Methods inherited from class org.epics.pvmanager.extra.Parameters
`getParameters`

Methods inherited from class java.lang.Object
`clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Method Detail

defaults

public static WaterfallPlotParameters defaults()

Defaults parameters for the waterfall plot.

Returns:: set of default parameters

height

public static WaterfallPlotParameters height(int height)

Height of the plot in pixels.

Parameters:: height - height of the plot in pixels
Returns:: a new parameter

colorScheme

public static WaterfallPlotParameters colorScheme(ColorScheme colorScheme)

The color scheme to convert a value to an rgb pixel in the plot.

Parameters:: colorScheme - color scheme
Returns:: a new parameter

adaptiveRange

public static WaterfallPlotParameters adaptiveRange(boolean adaptiveRange)

True if the range for the display should be the automatically determined or should be desumed by the data.

Parameters:: adaptiveRange - true automatic range, false use the data form the channel
Returns:: a new parameter

scrollDown

public static WaterfallPlotParameters scrollDown(boolean scrollDown)

Whether the plot should scroll down or up.

Parameters:: scrollDown - true if scrolls down (current value at the top), false if scrolls down (current value at the bottom)
Returns:: a new parameter

pixelDuration

public static WaterfallPlotParameters pixelDuration(TimeDuration pixelDuration)

How much time should be allocated to each line of the plot.

Parameters:: pixelDuration - amount of time for each pixel
Returns:: a new parameter

backgroundColor

public static WaterfallPlotParameters backgroundColor(int rgb)

The background color for the plot.

Parameters:: rgb - background color for the plot
Returns:: a new parameter

with

public WaterfallPlotParameters with(WaterfallPlotParameters... newParameters)

Returns a new set of parameters with the given changes;

Parameters:: newParameters - parameters to change
Returns:: a new set of parameters

getHeight

public int getHeight()

The height of the plot in pixels.

Returns:: height of the plot

isAdaptiveRange

public boolean isAdaptiveRange()

True if range is automatic, false if taken from data.

Returns:: true if using automatic range

isScrollDown

public boolean isScrollDown()

Whether the plot scrolls up or down.

Returns:: true if scrolls down

getColorScheme

public ColorScheme getColorScheme()

Color scheme used for the plot.

Returns:: a color scheme

getPixelDuration

public TimeDuration getPixelDuration()

Time interval for each line.

Returns:: the duration for each line