Interface VisualCustomAction.Builder

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

  • Method Details

    • customActionId

      VisualCustomAction.Builder customActionId(String customActionId)

      The ID of the VisualCustomAction.

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

    • name

      VisualCustomAction.Builder name(String name)

      The name of the VisualCustomAction.

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

    • status

      VisualCustomAction.Builder status(String status)

      The status of the VisualCustomAction.

      Parameters:
      status - The status of the VisualCustomAction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • status

      VisualCustomAction.Builder status(WidgetStatus status)

      The status of the VisualCustomAction.

      Parameters:
      status - The status of the VisualCustomAction.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trigger

      VisualCustomAction.Builder trigger(String trigger)

      The trigger of the VisualCustomAction.

      Valid values are defined as follows:

      • DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

      • DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

      Parameters:
      trigger - The trigger of the VisualCustomAction.

      Valid values are defined as follows:

      • DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

      • DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • trigger

      VisualCustomAction.Builder trigger(VisualCustomActionTrigger trigger)

      The trigger of the VisualCustomAction.

      Valid values are defined as follows:

      • DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

      • DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

      Parameters:
      trigger - The trigger of the VisualCustomAction.

      Valid values are defined as follows:

      • DATA_POINT_CLICK: Initiates a custom action by a left pointer click on a data point.

      • DATA_POINT_MENU: Initiates a custom action by right pointer click from the menu.

      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:

    • actionOperations

      VisualCustomAction.Builder actionOperations(Collection<VisualCustomActionOperation> actionOperations)

      A list of VisualCustomActionOperations.

      This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

      Parameters:
      actionOperations - A list of VisualCustomActionOperations.

      This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionOperations

      VisualCustomAction.Builder actionOperations(VisualCustomActionOperation... actionOperations)

      A list of VisualCustomActionOperations.

      This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

      Parameters:
      actionOperations - A list of VisualCustomActionOperations.

      This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

      Returns:
      Returns a reference to this object so that method calls can be chained together.

    • actionOperations

      VisualCustomAction.Builder actionOperations(Consumer<VisualCustomActionOperation.Builder>... actionOperations)

      A list of VisualCustomActionOperations.

      This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

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

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

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