Package io.deephaven.engine.util

Interface LiveWidgetVisibilityProvider

All Known Implementing Classes:
FigureWidget
public interface LiveWidgetVisibilityProvider

LiveWidgets may implement this interface to restrict the users who can see a particular widget.

This interface only enables the widget developer to limit the users who may open the widget; it does not provide any control over what users can see after the widget is opened. The widget itself is responsible for determining which data should be presented to the user and applying any appropriate viewer permissions.

If widgets do not implement this interface, they are visible to all users of the query.

Unlike tables, limiting the visibility of one widget does not affect the visibility of other widgets.

  • Method Summary

    Modifier and Type
    Method
    Description
    String[]
    getValidGroups()
    Provide a list of groups which may view this widget.

  • Method Details

    • getValidGroups

      String[] getValidGroups()
      Provide a list of groups which may view this widget. null indicates that there are no viewing restrictions on this widget.
      Returns:
      the list of groups which may view this widget, null for no restrictions