Interface SheetTextBox.Builder

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

  • Method Details

    • sheetTextBoxId

      SheetTextBox.Builder sheetTextBoxId(String sheetTextBoxId)

      The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.

      Parameters:
      sheetTextBoxId - The unique identifier for a text box. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have text boxes that share identifiers.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • content

      SheetTextBox.Builder content(String content)

      The content that is displayed in the text box.

      Parameters:
      content - The content that is displayed in the text box.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • interactions

      SheetTextBox.Builder interactions(TextBoxInteractionOptions interactions)

      The general textbox interactions setup for a textbox.

      Parameters:
      interactions - The general textbox interactions setup for a textbox.
      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • interactions

      default SheetTextBox.Builder interactions(Consumer<TextBoxInteractionOptions.Builder> interactions)

      The general textbox interactions setup for a textbox.

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

      When the Consumer completes, SdkBuilder.build() is called immediately and its result is passed to interactions(TextBoxInteractionOptions).

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