Interface Widget.Builder

All Superinterfaces:
Buildable, CopyableBuilder<Widget.Builder,Widget>, SdkBuilder<Widget.Builder,Widget>, SdkPojo
Enclosing class:
Widget
@Mutable @NotThreadSafe public static interface Widget.Builder extends SdkPojo, CopyableBuilder<Widget.Builder,Widget>

  • Method Details

    • title

      Widget.Builder title(String title)

      The title of the widget.

      Parameters:
      title - The title of the widget.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • description

      Widget.Builder description(String description)

      A description of the widget's purpose or the data it displays.

      Parameters:
      description - A description of the widget's purpose or the data it displays.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • width

      Widget.Builder width(Integer width)

      The width of the widget in column spans. The dashboard layout consists of a grid system.

      Parameters:
      width - The width of the widget in column spans. The dashboard layout consists of a grid system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • height

      Widget.Builder height(Integer height)

      The height of the widget in row spans. The dashboard layout consists of a grid system.

      Parameters:
      height - The height of the widget in row spans. The dashboard layout consists of a grid system.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • horizontalOffset

      Widget.Builder horizontalOffset(Integer horizontalOffset)

      Specifies the starting column position of the widget in the dashboard's grid layout. Used to control widget placement.

      Parameters:
      horizontalOffset - Specifies the starting column position of the widget in the dashboard's grid layout. Used to control widget placement.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configs

      Widget.Builder configs(Collection<WidgetConfig> configs)

      An array of configurations that define the data queries and display settings for the widget.

      Parameters:
      configs - An array of configurations that define the data queries and display settings for the widget.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configs

      Widget.Builder configs(WidgetConfig... configs)

      An array of configurations that define the data queries and display settings for the widget.

      Parameters:
      configs - An array of configurations that define the data queries and display settings for the widget.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • configs

      Widget.Builder configs(Consumer<WidgetConfig.Builder>... configs)

      An array of configurations that define the data queries and display settings for the widget.

      This is a convenience method that creates an instance of the WidgetConfig.Builder avoiding the need to create one manually via WidgetConfig.builder().

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to configs(List<WidgetConfig>).

      Parameters:
      configs - a consumer that will call methods on WidgetConfig.Builder
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also: