Interface LegendOptions.Builder

All Superinterfaces:
Buildable, CopyableBuilder<LegendOptions.Builder,LegendOptions>, SdkBuilder<LegendOptions.Builder,LegendOptions>, SdkPojo
Enclosing class:
LegendOptions

public static interface LegendOptions.Builder extends SdkPojo, CopyableBuilder<LegendOptions.Builder,LegendOptions>
  • Method Details

    • visibility

      LegendOptions.Builder visibility(String visibility)

      Determines whether or not the legend is visible.

      Parameters:
      visibility - Determines whether or not the legend is visible.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • visibility

      LegendOptions.Builder visibility(Visibility visibility)

      Determines whether or not the legend is visible.

      Parameters:
      visibility - Determines whether or not the legend is visible.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
      See Also:
    • title

      The custom title for the legend.

      Parameters:
      title - The custom title for the legend.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • title

      The custom title for the legend.

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

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

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

      LegendOptions.Builder position(String position)

      The positions for the legend. Choose one of the following options:

      • AUTO

      • RIGHT

      • BOTTOM

      • LEFT

      Parameters:
      position - The positions for the legend. Choose one of the following options:

      • AUTO

      • RIGHT

      • BOTTOM

      • LEFT

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

      The positions for the legend. Choose one of the following options:

      • AUTO

      • RIGHT

      • BOTTOM

      • LEFT

      Parameters:
      position - The positions for the legend. Choose one of the following options:

      • AUTO

      • RIGHT

      • BOTTOM

      • LEFT

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

      The width of the legend. If this value is omitted, a default width is used when rendering.

      Parameters:
      width - The width of the legend. If this value is omitted, a default width is used when rendering.
      Returns:
      Returns a reference to this object so that method calls can be chained together.
    • height

      LegendOptions.Builder height(String height)

      The height of the legend. If this value is omitted, a default height is used when rendering.

      Parameters:
      height - The height of the legend. If this value is omitted, a default height is used when rendering.
      Returns:
      Returns a reference to this object so that method calls can be chained together.