Class XYPlotWidget
- java.lang.Object
-
- org.csstudio.display.builder.model.Widget
-
- org.csstudio.display.builder.model.widgets.VisibleWidget
-
- org.csstudio.display.builder.model.widgets.plots.XYPlotWidget
-
public class XYPlotWidget extends VisibleWidget
Widget that displays X/Y waveforms
-
-
Nested Class Summary
Nested Classes Modifier and Type Class Description static class
XYPlotWidget.MarkerProperty
Structure for Plot Marker
-
Field Summary
Fields Modifier and Type Field Description static org.csstudio.display.builder.model.WidgetDescriptor
WIDGET_DESCRIPTOR
Widget descriptor-
Fields inherited from class org.csstudio.display.builder.model.Widget
BASE_WIDGET_VERSION, USER_DATA_REPRESENTATION, USER_DATA_RUNTIME, USER_DATA_SCRIPT_SUPPORT, USER_DATA_TOOLKIT_PARENT
-
-
Constructor Summary
Constructors Constructor Description XYPlotWidget()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description org.csstudio.display.builder.model.WidgetConfigurator
getConfigurator(org.csstudio.display.builder.model.Version persisted_version)
Obtain configurator.WidgetProperty<?>
getProperty(java.lang.String name)
Get widget property.WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propBackground()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propForeground()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor>
propGridColor()
WidgetProperty<java.lang.Boolean>
propLegend()
org.csstudio.display.builder.model.ArrayWidgetProperty<XYPlotWidget.MarkerProperty>
propMarkers()
WidgetProperty<java.lang.String>
propTitle()
WidgetProperty<org.csstudio.display.builder.model.properties.WidgetFont>
propTitleFont()
WidgetProperty<java.lang.Boolean>
propToolbar()
org.csstudio.display.builder.model.ArrayWidgetProperty<org.csstudio.display.builder.model.widgets.plots.PlotWidgetProperties.TraceWidgetProperty>
propTraces()
org.csstudio.display.builder.model.widgets.plots.PlotWidgetProperties.AxisWidgetProperty
propXAxis()
org.csstudio.display.builder.model.ArrayWidgetProperty<org.csstudio.display.builder.model.widgets.plots.PlotWidgetProperties.AxisWidgetProperty>
propYAxes()
org.csstudio.display.builder.model.properties.RuntimeEventProperty
runtimePropConfigure()
-
Methods inherited from class org.csstudio.display.builder.model.widgets.VisibleWidget
propTooltip, propVisible, runtimePropConnected
-
Methods inherited from class org.csstudio.display.builder.model.Widget
checkDisplayModel, checkProperty, checkProperty, clearUserData, expandPropertyNames, getDisplayModel, getEffectiveMacros, getID, getMacrosOrProperties, getName, getParent, getProperties, getProperty, getPropertyByPath, getPropertyValue, getPropertyValue, getTopDisplayModel, getType, getUserData, getVersion, getWidgetClass, isClean, propActions, propClass, propHeight, propName, propRules, propScripts, propWidth, propX, propY, setConfiguratorResult, setPropertyValue, setPropertyValue, setUserData, toString
-
-
-
-
Method Detail
-
getConfigurator
public org.csstudio.display.builder.model.WidgetConfigurator getConfigurator(org.csstudio.display.builder.model.Version persisted_version) throws java.lang.Exception
Description copied from class:Widget
Obtain configurator.While typically using the default
WidgetConfigurator
, widget may provide a different configurator for reading older persisted date.- Overrides:
getConfigurator
in classWidget
- Parameters:
persisted_version
- Version of the persisted data.- Returns:
- Widget configurator for that version
- Throws:
java.lang.Exception
- if persisted version cannot be handled
-
getProperty
public WidgetProperty<?> getProperty(java.lang.String name)
Description copied from class:Widget
Get widget property.Meant for rules, scripts and similar code which does not know the exact widget type and thus fetches properties by name.
Supports access to complex properties by path name, for example "y_axes[1].minimum" to get the minimum property of the second Y axis of a plot.
To allow use of legacy scripts and rules, the widget implementation may override to handle deprecated property names.
Caller presumes that the widget actually has the requested property, otherwise throwing Exception.
- Overrides:
getProperty
in classWidget
- Parameters:
name
- Property name- Returns:
WidgetProperty
- See Also:
Widget.checkProperty(String)
-
propBackground
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propBackground()
- Returns:
- 'background_color' property
-
propForeground
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propForeground()
- Returns:
- 'foreground_color' property
-
propGridColor
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propGridColor()
- Returns:
- 'grid_color' property
-
propTitle
public WidgetProperty<java.lang.String> propTitle()
- Returns:
- 'title' property
-
propTitleFont
public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetFont> propTitleFont()
- Returns:
- 'title_font' property
-
propToolbar
public WidgetProperty<java.lang.Boolean> propToolbar()
- Returns:
- 'show_toolbar' property
-
propLegend
public WidgetProperty<java.lang.Boolean> propLegend()
- Returns:
- 'show_legend' property
-
propXAxis
public org.csstudio.display.builder.model.widgets.plots.PlotWidgetProperties.AxisWidgetProperty propXAxis()
- Returns:
- 'x_axis' property
-
propYAxes
public org.csstudio.display.builder.model.ArrayWidgetProperty<org.csstudio.display.builder.model.widgets.plots.PlotWidgetProperties.AxisWidgetProperty> propYAxes()
- Returns:
- 'y_axes' property
-
propTraces
public org.csstudio.display.builder.model.ArrayWidgetProperty<org.csstudio.display.builder.model.widgets.plots.PlotWidgetProperties.TraceWidgetProperty> propTraces()
- Returns:
- 'traces' property
-
propMarkers
public org.csstudio.display.builder.model.ArrayWidgetProperty<XYPlotWidget.MarkerProperty> propMarkers()
- Returns:
- 'markers' property
-
runtimePropConfigure
public org.csstudio.display.builder.model.properties.RuntimeEventProperty runtimePropConfigure()
- Returns:
- 'configure' property
-
-