Class ImageWidget


  • public class ImageWidget
    extends PVWidget
    Widget that displays an image
    • Field Detail

      • WIDGET_DESCRIPTOR

        public static final org.csstudio.display.builder.model.WidgetDescriptor WIDGET_DESCRIPTOR
        Widget descriptor
      • propXValue

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Double> propXValue
      • propYValue

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Double> propYValue
      • propWidthValue

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Double> propWidthValue
      • propHeightValue

        public static final org.csstudio.display.builder.model.WidgetPropertyDescriptor<java.lang.Double> propHeightValue
      • propROIs

        public static final org.csstudio.display.builder.model.ArrayWidgetProperty.Descriptor<ImageWidget.ROIWidgetProperty> propROIs
        'roi' array
    • Constructor Detail

      • ImageWidget

        public ImageWidget()
    • Method Detail

      • 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 class Widget
        Parameters:
        name - Property name
        Returns:
        WidgetProperty
        See Also:
        Widget.checkProperty(String)
      • 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 class Widget
        Parameters:
        persisted_version - Version of the persisted data.
        Returns:
        Widget configurator for that version
        Throws:
        java.lang.Exception - if persisted version cannot be handled
      • propBackground

        public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propBackground()
        Returns:
        'background_color' property
      • propForegroundColor

        public WidgetProperty<org.csstudio.display.builder.model.properties.WidgetColor> propForegroundColor()
        Returns:
        'foreground_color' property
      • propToolbar

        public WidgetProperty<java.lang.Boolean> propToolbar()
        Returns:
        'show_toolbar' property
      • propDataColormap

        public WidgetProperty<org.csstudio.display.builder.model.properties.ColorMap> propDataColormap()
        Returns:
        'color_map' property
      • propDataWidth

        public WidgetProperty<java.lang.Integer> propDataWidth()
        Returns:
        'data_width' property
      • propDataHeight

        public WidgetProperty<java.lang.Integer> propDataHeight()
        Returns:
        'data_height' property
      • propDataInterpolation

        public WidgetProperty<org.csstudio.display.builder.model.widgets.plots.InterpolationType> propDataInterpolation()
        Returns:
        'interpolation' property
      • propDataColorMode

        public WidgetProperty<org.epics.vtype.VImageType> propDataColorMode()
        Returns:
        'color_mode' property
      • propDataUnsigned

        public WidgetProperty<java.lang.Boolean> propDataUnsigned()
        Returns:
        'unsigned' property
      • propDataAutoscale

        public WidgetProperty<java.lang.Boolean> propDataAutoscale()
        Returns:
        'autoscale' property
      • propDataLogscale

        public WidgetProperty<java.lang.Boolean> propDataLogscale()
        Returns:
        'logscale' property
      • propDataMinimum

        public WidgetProperty<java.lang.Double> propDataMinimum()
        Returns:
        'minimum' property
      • propDataMaximum

        public WidgetProperty<java.lang.Double> propDataMaximum()
        Returns:
        'maximum' property
      • propCursorInfoPV

        public WidgetProperty<java.lang.String> propCursorInfoPV()
        Returns:
        'cursor_info_pv' property
      • propCursorXPV

        public WidgetProperty<java.lang.String> propCursorXPV()
        Returns:
        'x_pv' property
      • propCursorYPV

        public WidgetProperty<java.lang.String> propCursorYPV()
        Returns:
        'y_pv' property
      • runtimePropCursorInfo

        public WidgetProperty<org.epics.vtype.VType> runtimePropCursorInfo()
        Returns:
        Runtime 'cursor_info' property
      • propCursorCrosshair

        public WidgetProperty<java.lang.Boolean> propCursorCrosshair()
        Returns:
        'cursor_crosshair' property
      • runtimePropCrosshair

        public WidgetProperty<java.lang.Double[]> runtimePropCrosshair()
        Returns:
        Runtime property for location of cursor crosshair, holds Double[] { x, y }
      • runtimePropConfigure

        public org.csstudio.display.builder.model.properties.RuntimeEventProperty runtimePropConfigure()
        Returns:
        'configure' property