LineChartConfiguration (AWS Java SDK :: Services

java.lang.Object
- software.amazon.awssdk.services.quicksight.model.LineChartConfiguration

All Implemented Interfaces:: Serializable, SdkPojo, ToCopyableBuilder<LineChartConfiguration.Builder,LineChartConfiguration>

@Generated(value="software.amazon.awssdk:codegen")
public final class LineChartConfiguration
extends Object
implements SdkPojo, Serializable, ToCopyableBuilder<LineChartConfiguration.Builder,LineChartConfiguration>

The configuration of a line chart.

See Also:: Serialized Form

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface LineChartConfiguration.Builder

Nested Classes
Modifier and Type	Class and Description
`static interface`	`LineChartConfiguration.Builder`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static LineChartConfiguration.Builder`	`builder()`
`List<ContributionAnalysisDefault>`	`contributionAnalysisDefaults()` The default configuration of a line chart's contribution analysis.
`DataLabelOptions`	`dataLabels()` The data label configuration of a line chart.
`LineChartDefaultSeriesSettings`	`defaultSeriesSettings()` The options that determine the default presentation of all line series in `LineChartVisual`.
`boolean`	`equals(Object obj)`
`boolean`	`equalsBySdkFields(Object obj)`
`LineChartFieldWells`	`fieldWells()` The field well configuration of a line chart.
`List<ForecastConfiguration>`	`forecastConfigurations()` The forecast configuration of a line chart.
`<T> Optional<T>`	`getValueForField(String fieldName, Class<T> clazz)`
`boolean`	`hasContributionAnalysisDefaults()` For responses, this returns true if the service returned a value for the ContributionAnalysisDefaults property.
`boolean`	`hasForecastConfigurations()` For responses, this returns true if the service returned a value for the ForecastConfigurations property.
`int`	`hashCode()`
`boolean`	`hasReferenceLines()` For responses, this returns true if the service returned a value for the ReferenceLines property.
`boolean`	`hasSeries()` For responses, this returns true if the service returned a value for the Series property.
`LegendOptions`	`legend()` The legend configuration of a line chart.
`LineSeriesAxisDisplayOptions`	`primaryYAxisDisplayOptions()` The series axis configuration of a line chart.
`ChartAxisLabelOptions`	`primaryYAxisLabelOptions()` The options that determine the presentation of the y-axis label.
`List<ReferenceLine>`	`referenceLines()` The reference lines configuration of a line chart.
`List<SdkField<?>>`	`sdkFields()`
`LineSeriesAxisDisplayOptions`	`secondaryYAxisDisplayOptions()` The series axis configuration of a line chart.
`ChartAxisLabelOptions`	`secondaryYAxisLabelOptions()` The options that determine the presentation of the secondary y-axis label.
`static Class<? extends LineChartConfiguration.Builder>`	`serializableBuilderClass()`
`List<SeriesItem>`	`series()` The series item configuration of a line chart.
`SmallMultiplesOptions`	`smallMultiplesOptions()` The small multiples setup for the visual.
`LineChartSortConfiguration`	`sortConfiguration()` The sort configuration of a line chart.
`LineChartConfiguration.Builder`	`toBuilder()`
`TooltipOptions`	`tooltip()` The tooltip configuration of a line chart.
`String`	`toString()` Returns a string representation of this object.
`LineChartType`	`type()` Determines the type of the line chart.
`String`	`typeAsString()` Determines the type of the line chart.
`VisualPalette`	`visualPalette()` The visual palette configuration of a line chart.
`AxisDisplayOptions`	`xAxisDisplayOptions()` The options that determine the presentation of the x-axis.
`ChartAxisLabelOptions`	`xAxisLabelOptions()` The options that determine the presentation of the x-axis label.

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder
copy

- Method Detail
  - fieldWells
```
public final LineChartFieldWells fieldWells()
```
    The field well configuration of a line chart.
    
    Returns:
    
    The field well configuration of a line chart.
  - sortConfiguration
```
public final LineChartSortConfiguration sortConfiguration()
```
    The sort configuration of a line chart.
    
    Returns:
    
    The sort configuration of a line chart.
  - hasForecastConfigurations
```
public final boolean hasForecastConfigurations()
```
    For responses, this returns true if the service returned a value for the ForecastConfigurations property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - forecastConfigurations
```
public final List<ForecastConfiguration> forecastConfigurations()
```
    The forecast configuration of a line chart.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasForecastConfigurations() method.
    
    Returns:
    
    The forecast configuration of a line chart.
  - type
```
public final LineChartType type()
```
    Determines the type of the line chart.
    
    If the service returns an enum value that is not available in the current SDK version, type will return LineChartType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Determines the type of the line chart.
    
    See Also:
    
    LineChartType
  - typeAsString
```
public final String typeAsString()
```
    Determines the type of the line chart.
    
    If the service returns an enum value that is not available in the current SDK version, type will return LineChartType.UNKNOWN_TO_SDK_VERSION. The raw value returned by the service is available from typeAsString().
    
    Returns:
    
    Determines the type of the line chart.
    
    See Also:
    
    LineChartType
  - smallMultiplesOptions
```
public final SmallMultiplesOptions smallMultiplesOptions()
```
    The small multiples setup for the visual.
    
    Returns:
    
    The small multiples setup for the visual.
  - xAxisDisplayOptions
```
public final AxisDisplayOptions xAxisDisplayOptions()
```
    The options that determine the presentation of the x-axis.
    
    Returns:
    
    The options that determine the presentation of the x-axis.
  - xAxisLabelOptions
```
public final ChartAxisLabelOptions xAxisLabelOptions()
```
    The options that determine the presentation of the x-axis label.
    
    Returns:
    
    The options that determine the presentation of the x-axis label.
  - primaryYAxisDisplayOptions
```
public final LineSeriesAxisDisplayOptions primaryYAxisDisplayOptions()
```
    The series axis configuration of a line chart.
    
    Returns:
    
    The series axis configuration of a line chart.
  - primaryYAxisLabelOptions
```
public final ChartAxisLabelOptions primaryYAxisLabelOptions()
```
    The options that determine the presentation of the y-axis label.
    
    Returns:
    
    The options that determine the presentation of the y-axis label.
  - secondaryYAxisDisplayOptions
```
public final LineSeriesAxisDisplayOptions secondaryYAxisDisplayOptions()
```
    The series axis configuration of a line chart.
    
    Returns:
    
    The series axis configuration of a line chart.
  - secondaryYAxisLabelOptions
```
public final ChartAxisLabelOptions secondaryYAxisLabelOptions()
```
    The options that determine the presentation of the secondary y-axis label.
    
    Returns:
    
    The options that determine the presentation of the secondary y-axis label.
  - defaultSeriesSettings
```
public final LineChartDefaultSeriesSettings defaultSeriesSettings()
```
    The options that determine the default presentation of all line series in LineChartVisual.
    
    Returns:
    
    The options that determine the default presentation of all line series in LineChartVisual.
  - hasSeries
```
public final boolean hasSeries()
```
    For responses, this returns true if the service returned a value for the Series property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - series
```
public final List<SeriesItem> series()
```
    The series item configuration of a line chart.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasSeries() method.
    
    Returns:
    
    The series item configuration of a line chart.
  - legend
```
public final LegendOptions legend()
```
    The legend configuration of a line chart.
    
    Returns:
    
    The legend configuration of a line chart.
  - dataLabels
```
public final DataLabelOptions dataLabels()
```
    The data label configuration of a line chart.
    
    Returns:
    
    The data label configuration of a line chart.
  - hasReferenceLines
```
public final boolean hasReferenceLines()
```
    For responses, this returns true if the service returned a value for the ReferenceLines property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - referenceLines
```
public final List<ReferenceLine> referenceLines()
```
    The reference lines configuration of a line chart.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasReferenceLines() method.
    
    Returns:
    
    The reference lines configuration of a line chart.
  - tooltip
```
public final TooltipOptions tooltip()
```
    The tooltip configuration of a line chart.
    
    Returns:
    
    The tooltip configuration of a line chart.
  - hasContributionAnalysisDefaults
```
public final boolean hasContributionAnalysisDefaults()
```
    For responses, this returns true if the service returned a value for the ContributionAnalysisDefaults property. This DOES NOT check that the value is non-empty (for which, you should check the isEmpty() method on the property). This is useful because the SDK will never return a null collection or map, but you may need to differentiate between the service returning nothing (or null) and the service returning an empty collection or map. For requests, this returns true if a value for the property was specified in the request builder, and false if a value was not specified.
  - contributionAnalysisDefaults
```
public final List<ContributionAnalysisDefault> contributionAnalysisDefaults()
```
    The default configuration of a line chart's contribution analysis.
    
    Attempts to modify the collection returned by this method will result in an UnsupportedOperationException.
    
    This method will never return null. If you would like to know whether the service returned this field (so that you can differentiate between null and empty), you can use the hasContributionAnalysisDefaults() method.
    
    Returns:
    
    The default configuration of a line chart's contribution analysis.
  - visualPalette
```
public final VisualPalette visualPalette()
```
    The visual palette configuration of a line chart.
    
    Returns:
    
    The visual palette configuration of a line chart.
  - toBuilder
```
public LineChartConfiguration.Builder toBuilder()
```
    Specified by:
    
    toBuilder in interface ToCopyableBuilder<LineChartConfiguration.Builder,LineChartConfiguration>
  - builder
```
public static LineChartConfiguration.Builder builder()
```
  - serializableBuilderClass
```
public static Class<? extends LineChartConfiguration.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)
```
    Specified by:
    
    equalsBySdkFields in interface SdkPojo
  - 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

Class LineChartConfiguration

Nested Class Summary

Method Summary

Methods inherited from class java.lang.Object

Methods inherited from interface software.amazon.awssdk.utils.builder.ToCopyableBuilder

Method Detail

fieldWells

sortConfiguration

hasForecastConfigurations

forecastConfigurations

type

typeAsString

smallMultiplesOptions

xAxisDisplayOptions

xAxisLabelOptions

primaryYAxisDisplayOptions

primaryYAxisLabelOptions

secondaryYAxisDisplayOptions

secondaryYAxisLabelOptions

defaultSeriesSettings

hasSeries

series

legend

dataLabels

hasReferenceLines

referenceLines

tooltip

hasContributionAnalysisDefaults

contributionAnalysisDefaults

visualPalette

toBuilder

builder

serializableBuilderClass

hashCode

equals

equalsBySdkFields

toString

getValueForField

sdkFields