Class SparklinesOptions

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

The options for sparklines in a table.

See Also:

  • Method Details

    • fieldId

      public final String fieldId()

      The field ID of the value column that the sparkline is applied to.

      Returns:
      The field ID of the value column that the sparkline is applied to.

    • xAxisField

      public final DimensionField xAxisField()
      Returns the value of the XAxisField property for this object.
      Returns:
      The value of the XAxisField property for this object.

    • yAxisBehavior

      public final SparklineAxisBehavior yAxisBehavior()

      Determines whether the Y axis is shared across all sparklines or independent for each sparkline.

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

      Returns:
      Determines whether the Y axis is shared across all sparklines or independent for each sparkline.
      See Also:

    • yAxisBehaviorAsString

      public final String yAxisBehaviorAsString()

      Determines whether the Y axis is shared across all sparklines or independent for each sparkline.

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

      Returns:
      Determines whether the Y axis is shared across all sparklines or independent for each sparkline.
      See Also:

    • visualType

      public final SparklineVisualType visualType()

      The type of the sparkline. Valid values are LINE and AREA_LINE.

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

      Returns:
      The type of the sparkline. Valid values are LINE and AREA_LINE.
      See Also:

    • visualTypeAsString

      public final String visualTypeAsString()

      The type of the sparkline. Valid values are LINE and AREA_LINE.

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

      Returns:
      The type of the sparkline. Valid values are LINE and AREA_LINE.
      See Also:

    • lineColor

      public final String lineColor()

      The color of the sparkline line.

      Returns:
      The color of the sparkline line.

    • lineInterpolation

      public final LineInterpolation lineInterpolation()

      The interpolation style for the sparkline line.

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

      Returns:
      The interpolation style for the sparkline line.
      See Also:

    • lineInterpolationAsString

      public final String lineInterpolationAsString()

      The interpolation style for the sparkline line.

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

      Returns:
      The interpolation style for the sparkline line.
      See Also:

    • allPointsMarker

      public final LineChartMarkerStyleSettings allPointsMarker()
      Returns the value of the AllPointsMarker property for this object.
      Returns:
      The value of the AllPointsMarker property for this object.

    • maxValueMarker

      public final LineChartMarkerStyleSettings maxValueMarker()
      Returns the value of the MaxValueMarker property for this object.
      Returns:
      The value of the MaxValueMarker property for this object.

    • minValueMarker

      public final LineChartMarkerStyleSettings minValueMarker()
      Returns the value of the MinValueMarker property for this object.
      Returns:
      The value of the MinValueMarker property for this object.

    • toBuilder

      public SparklinesOptions.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<SparklinesOptions.Builder,SparklinesOptions>
      Returns:
      a builder for type T

    • builder

      public static SparklinesOptions.Builder builder()

    • serializableBuilderClass

      public static Class<? extends SparklinesOptions.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.