Class Visual

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

A visual displayed on a sheet in an analysis, dashboard, or template.

This is a union type structure. For this structure to be valid, only one of the attributes can be defined.

See Also:

  • Method Details

    • tableVisual

      public final TableVisual tableVisual()

      A table visual.

      For more information, see Using tables as visuals in the Amazon Quick Suite User Guide.

      Returns:
      A table visual.

      For more information, see Using tables as visuals in the Amazon Quick Suite User Guide.

    • pivotTableVisual

      public final PivotTableVisual pivotTableVisual()

      A pivot table.

      For more information, see Using pivot tables in the Amazon Quick Suite User Guide.

      Returns:
      A pivot table.

      For more information, see Using pivot tables in the Amazon Quick Suite User Guide.

    • barChartVisual

      public final BarChartVisual barChartVisual()

      A bar chart.

      For more information, see Using bar charts in the Amazon Quick Suite User Guide.

      Returns:
      A bar chart.

      For more information, see Using bar charts in the Amazon Quick Suite User Guide.

    • kpiVisual

      public final KPIVisual kpiVisual()

      A key performance indicator (KPI).

      For more information, see Using KPIs in the Amazon Quick Suite User Guide.

      Returns:
      A key performance indicator (KPI).

      For more information, see Using KPIs in the Amazon Quick Suite User Guide.

    • pieChartVisual

      public final PieChartVisual pieChartVisual()

      A pie or donut chart.

      For more information, see Using pie charts in the Amazon Quick Suite User Guide.

      Returns:
      A pie or donut chart.

      For more information, see Using pie charts in the Amazon Quick Suite User Guide.

    • gaugeChartVisual

      public final GaugeChartVisual gaugeChartVisual()

      A gauge chart.

      For more information, see Using gauge charts in the Amazon Quick Suite User Guide.

      Returns:
      A gauge chart.

      For more information, see Using gauge charts in the Amazon Quick Suite User Guide.

    • lineChartVisual

      public final LineChartVisual lineChartVisual()

      A line chart.

      For more information, see Using line charts in the Amazon Quick Suite User Guide.

      Returns:
      A line chart.

      For more information, see Using line charts in the Amazon Quick Suite User Guide.

    • heatMapVisual

      public final HeatMapVisual heatMapVisual()

      A heat map.

      For more information, see Using heat maps in the Amazon Quick Suite User Guide.

      Returns:
      A heat map.

      For more information, see Using heat maps in the Amazon Quick Suite User Guide.

    • treeMapVisual

      public final TreeMapVisual treeMapVisual()

      A tree map.

      For more information, see Using tree maps in the Amazon Quick Suite User Guide.

      Returns:
      A tree map.

      For more information, see Using tree maps in the Amazon Quick Suite User Guide.

    • geospatialMapVisual

      public final GeospatialMapVisual geospatialMapVisual()

      A geospatial map or a points on map visual.

      For more information, see Creating point maps in the Amazon Quick Suite User Guide.

      Returns:
      A geospatial map or a points on map visual.

      For more information, see Creating point maps in the Amazon Quick Suite User Guide.

    • filledMapVisual

      public final FilledMapVisual filledMapVisual()

      A filled map.

      For more information, see Creating filled maps in the Amazon Quick Suite User Guide.

      Returns:
      A filled map.

      For more information, see Creating filled maps in the Amazon Quick Suite User Guide.

    • layerMapVisual

      public final LayerMapVisual layerMapVisual()

      The properties for a layer map visual

      Returns:
      The properties for a layer map visual

    • funnelChartVisual

      public final FunnelChartVisual funnelChartVisual()

      A funnel chart.

      For more information, see Using funnel charts in the Amazon Quick Suite User Guide.

      Returns:
      A funnel chart.

      For more information, see Using funnel charts in the Amazon Quick Suite User Guide.

    • scatterPlotVisual

      public final ScatterPlotVisual scatterPlotVisual()

      A scatter plot.

      For more information, see Using scatter plots in the Amazon Quick Suite User Guide.

      Returns:
      A scatter plot.

      For more information, see Using scatter plots in the Amazon Quick Suite User Guide.

    • comboChartVisual

      public final ComboChartVisual comboChartVisual()

      A combo chart.

      For more information, see Using combo charts in the Amazon Quick Suite User Guide.

      Returns:
      A combo chart.

      For more information, see Using combo charts in the Amazon Quick Suite User Guide.

    • boxPlotVisual

      public final BoxPlotVisual boxPlotVisual()

      A box plot.

      For more information, see Using box plots in the Amazon Quick Suite User Guide.

      Returns:
      A box plot.

      For more information, see Using box plots in the Amazon Quick Suite User Guide.

    • waterfallVisual

      public final WaterfallVisual waterfallVisual()

      A waterfall chart.

      For more information, see Using waterfall charts in the Amazon Quick Suite User Guide.

      Returns:
      A waterfall chart.

      For more information, see Using waterfall charts in the Amazon Quick Suite User Guide.

    • histogramVisual

      public final HistogramVisual histogramVisual()

      A histogram.

      For more information, see Using histograms in the Amazon Quick Suite User Guide.

      Returns:
      A histogram.

      For more information, see Using histograms in the Amazon Quick Suite User Guide.

    • wordCloudVisual

      public final WordCloudVisual wordCloudVisual()

      A word cloud.

      For more information, see Using word clouds in the Amazon Quick Suite User Guide.

      Returns:
      A word cloud.

      For more information, see Using word clouds in the Amazon Quick Suite User Guide.

    • insightVisual

      public final InsightVisual insightVisual()

      An insight visual.

      For more information, see Working with insights in the Amazon Quick Suite User Guide.

      Returns:
      An insight visual.

      For more information, see Working with insights in the Amazon Quick Suite User Guide.

    • sankeyDiagramVisual

      public final SankeyDiagramVisual sankeyDiagramVisual()

      A sankey diagram.

      For more information, see Using Sankey diagrams in the Amazon Quick Suite User Guide.

      Returns:
      A sankey diagram.

      For more information, see Using Sankey diagrams in the Amazon Quick Suite User Guide.

    • customContentVisual

      public final CustomContentVisual customContentVisual()

      A visual that contains custom content.

      For more information, see Using custom visual content in the Amazon Quick Suite User Guide.

      Returns:
      A visual that contains custom content.

      For more information, see Using custom visual content in the Amazon Quick Suite User Guide.

    • emptyVisual

      public final EmptyVisual emptyVisual()

      An empty visual.

      Returns:
      An empty visual.

    • radarChartVisual

      public final RadarChartVisual radarChartVisual()

      A radar chart visual.

      For more information, see Using radar charts in the Amazon Quick Suite User Guide.

      Returns:
      A radar chart visual.

      For more information, see Using radar charts in the Amazon Quick Suite User Guide.

    • pluginVisual

      public final PluginVisual pluginVisual()

      The custom plugin visual type.

      Returns:
      The custom plugin visual type.

    • toBuilder

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

    • builder

      public static Visual.Builder builder()

    • serializableBuilderClass

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