Class FunnelChartDataLabelOptions

java.lang.Object
software.amazon.awssdk.services.quicksight.model.FunnelChartDataLabelOptions
All Implemented Interfaces:
Serializable, SdkPojo, ToCopyableBuilder<FunnelChartDataLabelOptions.Builder,FunnelChartDataLabelOptions>
@Generated("software.amazon.awssdk:codegen") public final class FunnelChartDataLabelOptions extends Object implements SdkPojo, Serializable, ToCopyableBuilder<FunnelChartDataLabelOptions.Builder,FunnelChartDataLabelOptions>

The options that determine the presentation of the data labels.

See Also:

  • Method Details

    • visibility

      public final Visibility visibility()

      The visibility option that determines if data labels are displayed.

      If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

      Returns:
      The visibility option that determines if data labels are displayed.
      See Also:

    • visibilityAsString

      public final String visibilityAsString()

      The visibility option that determines if data labels are displayed.

      If the service returns an enum value that is not available in the current SDK version, visibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from visibilityAsString().

      Returns:
      The visibility option that determines if data labels are displayed.
      See Also:

    • categoryLabelVisibility

      public final Visibility categoryLabelVisibility()

      The visibility of the category labels within the data labels.

      If the service returns an enum value that is not available in the current SDK version, categoryLabelVisibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from categoryLabelVisibilityAsString().

      Returns:
      The visibility of the category labels within the data labels.
      See Also:

    • categoryLabelVisibilityAsString

      public final String categoryLabelVisibilityAsString()

      The visibility of the category labels within the data labels.

      If the service returns an enum value that is not available in the current SDK version, categoryLabelVisibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from categoryLabelVisibilityAsString().

      Returns:
      The visibility of the category labels within the data labels.
      See Also:

    • measureLabelVisibility

      public final Visibility measureLabelVisibility()

      The visibility of the measure labels within the data labels.

      If the service returns an enum value that is not available in the current SDK version, measureLabelVisibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from measureLabelVisibilityAsString().

      Returns:
      The visibility of the measure labels within the data labels.
      See Also:

    • measureLabelVisibilityAsString

      public final String measureLabelVisibilityAsString()

      The visibility of the measure labels within the data labels.

      If the service returns an enum value that is not available in the current SDK version, measureLabelVisibility will return Visibility.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from measureLabelVisibilityAsString().

      Returns:
      The visibility of the measure labels within the data labels.
      See Also:

    • position

      public final DataLabelPosition position()

      Determines the positioning of the data label relative to a section of the funnel.

      If the service returns an enum value that is not available in the current SDK version, position will return DataLabelPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from positionAsString().

      Returns:
      Determines the positioning of the data label relative to a section of the funnel.
      See Also:

    • positionAsString

      public final String positionAsString()

      Determines the positioning of the data label relative to a section of the funnel.

      If the service returns an enum value that is not available in the current SDK version, position will return DataLabelPosition.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from positionAsString().

      Returns:
      Determines the positioning of the data label relative to a section of the funnel.
      See Also:

    • labelFontConfiguration

      public final FontConfiguration labelFontConfiguration()

      The font configuration for the data labels.

      Only the FontSize attribute of the font configuration is used for data labels.

      Returns:
      The font configuration for the data labels.

      Only the FontSize attribute of the font configuration is used for data labels.

    • labelColor

      public final String labelColor()

      The color of the data label text.

      Returns:
      The color of the data label text.

    • measureDataLabelStyle

      public final FunnelChartMeasureDataLabelStyle measureDataLabelStyle()

      Determines the style of the metric labels.

      If the service returns an enum value that is not available in the current SDK version, measureDataLabelStyle will return FunnelChartMeasureDataLabelStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from measureDataLabelStyleAsString().

      Returns:
      Determines the style of the metric labels.
      See Also:

    • measureDataLabelStyleAsString

      public final String measureDataLabelStyleAsString()

      Determines the style of the metric labels.

      If the service returns an enum value that is not available in the current SDK version, measureDataLabelStyle will return FunnelChartMeasureDataLabelStyle.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from measureDataLabelStyleAsString().

      Returns:
      Determines the style of the metric labels.
      See Also:

    • toBuilder

      public FunnelChartDataLabelOptions.Builder toBuilder()
      Description copied from interface: ToCopyableBuilder
      Take this object and create a builder that contains all of the current property values of this object.
      Specified by:
      toBuilder in interface ToCopyableBuilder<FunnelChartDataLabelOptions.Builder,FunnelChartDataLabelOptions>
      Returns:
      a builder for type T

    • builder

      public static FunnelChartDataLabelOptions.Builder builder()

    • serializableBuilderClass

      public static Class<? extends FunnelChartDataLabelOptions.Builder> serializableBuilderClass()

    • hashCode

      public final int hashCode()
      Overrides:
      hashCode in class Object

    • equals

      public final boolean equals(Object obj)
      Overrides:
      equals in class Object

    • equalsBySdkFields

      public final boolean equalsBySdkFields(Object obj)
      Description copied from interface: SdkPojo
      Indicates whether some other object is "equal to" this one by SDK fields. An SDK field is a modeled, non-inherited field in an SdkPojo class, and is generated based on a service model.

      If an SdkPojo class does not have any inherited fields, equalsBySdkFields and equals are essentially the same.

      Specified by:
      equalsBySdkFields in interface SdkPojo
      Parameters:
      obj - the object to be compared with
      Returns:
      true if the other object equals to this object by sdk fields, false otherwise.

    • toString

      public final String toString()
      Returns a string representation of this object. This is useful for testing and debugging. Sensitive data will be redacted from this string using a placeholder value.
      Overrides:
      toString in class Object

    • getValueForField

      public final <T> Optional<T> getValueForField(String fieldName, Class<T> clazz)

    • sdkFields

      public final List<SdkField<?>> sdkFields()
      Specified by:
      sdkFields in interface SdkPojo
      Returns:
      List of SdkField in this POJO. May be empty list but should never be null.

    • sdkFieldNameToField

      public final Map<String,SdkField<?>> sdkFieldNameToField()
      Specified by:
      sdkFieldNameToField in interface SdkPojo
      Returns:
      The mapping between the field name and its corresponding field.