Interface ImageCustomAction.Builder

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

  • Method Details

    • customActionId

      ImageCustomAction.Builder customActionId(String customActionId)

      The ID of the custom action.

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

    • name

      ImageCustomAction.Builder name(String name)

      The name of the custom action.

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

    • status

      ImageCustomAction.Builder status(String status)

      The status of the custom action.

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

    • status

      ImageCustomAction.Builder status(WidgetStatus status)

      The status of the custom action.

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

    • trigger

      ImageCustomAction.Builder trigger(String trigger)

      The trigger of the VisualCustomAction.

      Valid values are defined as follows:

      • CLICK: Initiates a custom action by a left pointer click on a 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:

      • CLICK: Initiates a custom action by a left pointer click on a 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

      ImageCustomAction.Builder trigger(ImageCustomActionTrigger trigger)

      The trigger of the VisualCustomAction.

      Valid values are defined as follows:

      • CLICK: Initiates a custom action by a left pointer click on a 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:

      • CLICK: Initiates a custom action by a left pointer click on a 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

      ImageCustomAction.Builder actionOperations(Collection<ImageCustomActionOperation> actionOperations)

      A list of ImageCustomActionOperations.

      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 ImageCustomActionOperations.

      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

      ImageCustomAction.Builder actionOperations(ImageCustomActionOperation... actionOperations)

      A list of ImageCustomActionOperations.

      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 ImageCustomActionOperations.

      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

      ImageCustomAction.Builder actionOperations(Consumer<ImageCustomActionOperation.Builder>... actionOperations)

      A list of ImageCustomActionOperations.

      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 ImageCustomActionOperation.Builder avoiding the need to create one manually via ImageCustomActionOperation.builder().

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

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