#[non_exhaustive]pub struct Visual {Show 25 fields
pub table_visual: Option<TableVisual>,
pub pivot_table_visual: Option<PivotTableVisual>,
pub bar_chart_visual: Option<BarChartVisual>,
pub kpi_visual: Option<KpiVisual>,
pub pie_chart_visual: Option<PieChartVisual>,
pub gauge_chart_visual: Option<GaugeChartVisual>,
pub line_chart_visual: Option<LineChartVisual>,
pub heat_map_visual: Option<HeatMapVisual>,
pub tree_map_visual: Option<TreeMapVisual>,
pub geospatial_map_visual: Option<GeospatialMapVisual>,
pub filled_map_visual: Option<FilledMapVisual>,
pub layer_map_visual: Option<LayerMapVisual>,
pub funnel_chart_visual: Option<FunnelChartVisual>,
pub scatter_plot_visual: Option<ScatterPlotVisual>,
pub combo_chart_visual: Option<ComboChartVisual>,
pub box_plot_visual: Option<BoxPlotVisual>,
pub waterfall_visual: Option<WaterfallVisual>,
pub histogram_visual: Option<HistogramVisual>,
pub word_cloud_visual: Option<WordCloudVisual>,
pub insight_visual: Option<InsightVisual>,
pub sankey_diagram_visual: Option<SankeyDiagramVisual>,
pub custom_content_visual: Option<CustomContentVisual>,
pub empty_visual: Option<EmptyVisual>,
pub radar_chart_visual: Option<RadarChartVisual>,
pub plugin_visual: Option<PluginVisual>,
}
Expand description
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.
Fields (Non-exhaustive)§
This struct is marked as non-exhaustive
Struct { .. }
syntax; cannot be matched against without a wildcard ..
; and struct update syntax will not work.table_visual: Option<TableVisual>
A table visual.
For more information, see Using tables as visuals in the Amazon QuickSight User Guide.
pivot_table_visual: Option<PivotTableVisual>
A pivot table.
For more information, see Using pivot tables in the Amazon QuickSight User Guide.
bar_chart_visual: Option<BarChartVisual>
A bar chart.
For more information, see Using bar charts in the Amazon QuickSight User Guide.
kpi_visual: Option<KpiVisual>
A key performance indicator (KPI).
For more information, see Using KPIs in the Amazon QuickSight User Guide.
pie_chart_visual: Option<PieChartVisual>
A pie or donut chart.
For more information, see Using pie charts in the Amazon QuickSight User Guide.
gauge_chart_visual: Option<GaugeChartVisual>
A gauge chart.
For more information, see Using gauge charts in the Amazon QuickSight User Guide.
line_chart_visual: Option<LineChartVisual>
A line chart.
For more information, see Using line charts in the Amazon QuickSight User Guide.
heat_map_visual: Option<HeatMapVisual>
A heat map.
For more information, see Using heat maps in the Amazon QuickSight User Guide.
tree_map_visual: Option<TreeMapVisual>
A tree map.
For more information, see Using tree maps in the Amazon QuickSight User Guide.
geospatial_map_visual: Option<GeospatialMapVisual>
A geospatial map or a points on map visual.
For more information, see Creating point maps in the Amazon QuickSight User Guide.
filled_map_visual: Option<FilledMapVisual>
A filled map.
For more information, see Creating filled maps in the Amazon QuickSight User Guide.
layer_map_visual: Option<LayerMapVisual>
The properties for a layer map visual
funnel_chart_visual: Option<FunnelChartVisual>
A funnel chart.
For more information, see Using funnel charts in the Amazon QuickSight User Guide.
scatter_plot_visual: Option<ScatterPlotVisual>
A scatter plot.
For more information, see Using scatter plots in the Amazon QuickSight User Guide.
combo_chart_visual: Option<ComboChartVisual>
A combo chart.
For more information, see Using combo charts in the Amazon QuickSight User Guide.
box_plot_visual: Option<BoxPlotVisual>
A box plot.
For more information, see Using box plots in the Amazon QuickSight User Guide.
waterfall_visual: Option<WaterfallVisual>
A waterfall chart.
For more information, see Using waterfall charts in the Amazon QuickSight User Guide.
histogram_visual: Option<HistogramVisual>
A histogram.
For more information, see Using histograms in the Amazon QuickSight User Guide.
word_cloud_visual: Option<WordCloudVisual>
A word cloud.
For more information, see Using word clouds in the Amazon QuickSight User Guide.
insight_visual: Option<InsightVisual>
An insight visual.
For more information, see Working with insights in the Amazon QuickSight User Guide.
sankey_diagram_visual: Option<SankeyDiagramVisual>
A sankey diagram.
For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.
custom_content_visual: Option<CustomContentVisual>
A visual that contains custom content.
For more information, see Using custom visual content in the Amazon QuickSight User Guide.
empty_visual: Option<EmptyVisual>
An empty visual.
radar_chart_visual: Option<RadarChartVisual>
A radar chart visual.
For more information, see Using radar charts in the Amazon QuickSight User Guide.
plugin_visual: Option<PluginVisual>
The custom plugin visual type.
Implementations§
Source§impl Visual
impl Visual
Sourcepub fn table_visual(&self) -> Option<&TableVisual>
pub fn table_visual(&self) -> Option<&TableVisual>
A table visual.
For more information, see Using tables as visuals in the Amazon QuickSight User Guide.
Sourcepub fn pivot_table_visual(&self) -> Option<&PivotTableVisual>
pub fn pivot_table_visual(&self) -> Option<&PivotTableVisual>
A pivot table.
For more information, see Using pivot tables in the Amazon QuickSight User Guide.
Sourcepub fn bar_chart_visual(&self) -> Option<&BarChartVisual>
pub fn bar_chart_visual(&self) -> Option<&BarChartVisual>
A bar chart.
For more information, see Using bar charts in the Amazon QuickSight User Guide.
Sourcepub fn kpi_visual(&self) -> Option<&KpiVisual>
pub fn kpi_visual(&self) -> Option<&KpiVisual>
A key performance indicator (KPI).
For more information, see Using KPIs in the Amazon QuickSight User Guide.
Sourcepub fn pie_chart_visual(&self) -> Option<&PieChartVisual>
pub fn pie_chart_visual(&self) -> Option<&PieChartVisual>
A pie or donut chart.
For more information, see Using pie charts in the Amazon QuickSight User Guide.
Sourcepub fn gauge_chart_visual(&self) -> Option<&GaugeChartVisual>
pub fn gauge_chart_visual(&self) -> Option<&GaugeChartVisual>
A gauge chart.
For more information, see Using gauge charts in the Amazon QuickSight User Guide.
Sourcepub fn line_chart_visual(&self) -> Option<&LineChartVisual>
pub fn line_chart_visual(&self) -> Option<&LineChartVisual>
A line chart.
For more information, see Using line charts in the Amazon QuickSight User Guide.
Sourcepub fn heat_map_visual(&self) -> Option<&HeatMapVisual>
pub fn heat_map_visual(&self) -> Option<&HeatMapVisual>
A heat map.
For more information, see Using heat maps in the Amazon QuickSight User Guide.
Sourcepub fn tree_map_visual(&self) -> Option<&TreeMapVisual>
pub fn tree_map_visual(&self) -> Option<&TreeMapVisual>
A tree map.
For more information, see Using tree maps in the Amazon QuickSight User Guide.
Sourcepub fn geospatial_map_visual(&self) -> Option<&GeospatialMapVisual>
pub fn geospatial_map_visual(&self) -> Option<&GeospatialMapVisual>
A geospatial map or a points on map visual.
For more information, see Creating point maps in the Amazon QuickSight User Guide.
Sourcepub fn filled_map_visual(&self) -> Option<&FilledMapVisual>
pub fn filled_map_visual(&self) -> Option<&FilledMapVisual>
A filled map.
For more information, see Creating filled maps in the Amazon QuickSight User Guide.
Sourcepub fn layer_map_visual(&self) -> Option<&LayerMapVisual>
pub fn layer_map_visual(&self) -> Option<&LayerMapVisual>
The properties for a layer map visual
Sourcepub fn funnel_chart_visual(&self) -> Option<&FunnelChartVisual>
pub fn funnel_chart_visual(&self) -> Option<&FunnelChartVisual>
A funnel chart.
For more information, see Using funnel charts in the Amazon QuickSight User Guide.
Sourcepub fn scatter_plot_visual(&self) -> Option<&ScatterPlotVisual>
pub fn scatter_plot_visual(&self) -> Option<&ScatterPlotVisual>
A scatter plot.
For more information, see Using scatter plots in the Amazon QuickSight User Guide.
Sourcepub fn combo_chart_visual(&self) -> Option<&ComboChartVisual>
pub fn combo_chart_visual(&self) -> Option<&ComboChartVisual>
A combo chart.
For more information, see Using combo charts in the Amazon QuickSight User Guide.
Sourcepub fn box_plot_visual(&self) -> Option<&BoxPlotVisual>
pub fn box_plot_visual(&self) -> Option<&BoxPlotVisual>
A box plot.
For more information, see Using box plots in the Amazon QuickSight User Guide.
Sourcepub fn waterfall_visual(&self) -> Option<&WaterfallVisual>
pub fn waterfall_visual(&self) -> Option<&WaterfallVisual>
A waterfall chart.
For more information, see Using waterfall charts in the Amazon QuickSight User Guide.
Sourcepub fn histogram_visual(&self) -> Option<&HistogramVisual>
pub fn histogram_visual(&self) -> Option<&HistogramVisual>
A histogram.
For more information, see Using histograms in the Amazon QuickSight User Guide.
Sourcepub fn word_cloud_visual(&self) -> Option<&WordCloudVisual>
pub fn word_cloud_visual(&self) -> Option<&WordCloudVisual>
A word cloud.
For more information, see Using word clouds in the Amazon QuickSight User Guide.
Sourcepub fn insight_visual(&self) -> Option<&InsightVisual>
pub fn insight_visual(&self) -> Option<&InsightVisual>
An insight visual.
For more information, see Working with insights in the Amazon QuickSight User Guide.
Sourcepub fn sankey_diagram_visual(&self) -> Option<&SankeyDiagramVisual>
pub fn sankey_diagram_visual(&self) -> Option<&SankeyDiagramVisual>
A sankey diagram.
For more information, see Using Sankey diagrams in the Amazon QuickSight User Guide.
Sourcepub fn custom_content_visual(&self) -> Option<&CustomContentVisual>
pub fn custom_content_visual(&self) -> Option<&CustomContentVisual>
A visual that contains custom content.
For more information, see Using custom visual content in the Amazon QuickSight User Guide.
Sourcepub fn empty_visual(&self) -> Option<&EmptyVisual>
pub fn empty_visual(&self) -> Option<&EmptyVisual>
An empty visual.
Sourcepub fn radar_chart_visual(&self) -> Option<&RadarChartVisual>
pub fn radar_chart_visual(&self) -> Option<&RadarChartVisual>
A radar chart visual.
For more information, see Using radar charts in the Amazon QuickSight User Guide.
Sourcepub fn plugin_visual(&self) -> Option<&PluginVisual>
pub fn plugin_visual(&self) -> Option<&PluginVisual>
The custom plugin visual type.
Trait Implementations§
impl StructuralPartialEq for Visual
Auto Trait Implementations§
impl Freeze for Visual
impl RefUnwindSafe for Visual
impl Send for Visual
impl Sync for Visual
impl Unpin for Visual
impl UnwindSafe for Visual
Blanket Implementations§
Source§impl<T> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Source§impl<T> CloneToUninit for Twhere
T: Clone,
impl<T> CloneToUninit for Twhere
T: Clone,
Source§impl<T> Instrument for T
impl<T> Instrument for T
Source§fn instrument(self, span: Span) -> Instrumented<Self>
fn instrument(self, span: Span) -> Instrumented<Self>
Source§fn in_current_span(self) -> Instrumented<Self>
fn in_current_span(self) -> Instrumented<Self>
Source§impl<T> IntoEither for T
impl<T> IntoEither for T
Source§fn into_either(self, into_left: bool) -> Either<Self, Self>
fn into_either(self, into_left: bool) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left
is true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
self
into a Left
variant of Either<Self, Self>
if into_left(&self)
returns true
.
Converts self
into a Right
variant of Either<Self, Self>
otherwise. Read moreSource§impl<T> Paint for Twhere
T: ?Sized,
impl<T> Paint for Twhere
T: ?Sized,
Source§fn fg(&self, value: Color) -> Painted<&T>
fn fg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the foreground set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like red()
and
green()
, which have the same functionality but are
pithier.
§Example
Set foreground color to white using fg()
:
use yansi::{Paint, Color};
painted.fg(Color::White);
Set foreground color to white using white()
.
use yansi::Paint;
painted.white();
Source§fn bright_black(&self) -> Painted<&T>
fn bright_black(&self) -> Painted<&T>
Source§fn bright_red(&self) -> Painted<&T>
fn bright_red(&self) -> Painted<&T>
Source§fn bright_green(&self) -> Painted<&T>
fn bright_green(&self) -> Painted<&T>
Source§fn bright_yellow(&self) -> Painted<&T>
fn bright_yellow(&self) -> Painted<&T>
Source§fn bright_blue(&self) -> Painted<&T>
fn bright_blue(&self) -> Painted<&T>
Source§fn bright_magenta(&self) -> Painted<&T>
fn bright_magenta(&self) -> Painted<&T>
Source§fn bright_cyan(&self) -> Painted<&T>
fn bright_cyan(&self) -> Painted<&T>
Source§fn bright_white(&self) -> Painted<&T>
fn bright_white(&self) -> Painted<&T>
Source§fn bg(&self, value: Color) -> Painted<&T>
fn bg(&self, value: Color) -> Painted<&T>
Returns a styled value derived from self
with the background set to
value
.
This method should be used rarely. Instead, prefer to use color-specific
builder methods like on_red()
and
on_green()
, which have the same functionality but
are pithier.
§Example
Set background color to red using fg()
:
use yansi::{Paint, Color};
painted.bg(Color::Red);
Set background color to red using on_red()
.
use yansi::Paint;
painted.on_red();
Source§fn on_primary(&self) -> Painted<&T>
fn on_primary(&self) -> Painted<&T>
Source§fn on_magenta(&self) -> Painted<&T>
fn on_magenta(&self) -> Painted<&T>
Source§fn on_bright_black(&self) -> Painted<&T>
fn on_bright_black(&self) -> Painted<&T>
Source§fn on_bright_red(&self) -> Painted<&T>
fn on_bright_red(&self) -> Painted<&T>
Source§fn on_bright_green(&self) -> Painted<&T>
fn on_bright_green(&self) -> Painted<&T>
Source§fn on_bright_yellow(&self) -> Painted<&T>
fn on_bright_yellow(&self) -> Painted<&T>
Source§fn on_bright_blue(&self) -> Painted<&T>
fn on_bright_blue(&self) -> Painted<&T>
Source§fn on_bright_magenta(&self) -> Painted<&T>
fn on_bright_magenta(&self) -> Painted<&T>
Source§fn on_bright_cyan(&self) -> Painted<&T>
fn on_bright_cyan(&self) -> Painted<&T>
Source§fn on_bright_white(&self) -> Painted<&T>
fn on_bright_white(&self) -> Painted<&T>
Source§fn attr(&self, value: Attribute) -> Painted<&T>
fn attr(&self, value: Attribute) -> Painted<&T>
Enables the styling Attribute
value
.
This method should be used rarely. Instead, prefer to use
attribute-specific builder methods like bold()
and
underline()
, which have the same functionality
but are pithier.
§Example
Make text bold using attr()
:
use yansi::{Paint, Attribute};
painted.attr(Attribute::Bold);
Make text bold using using bold()
.
use yansi::Paint;
painted.bold();
Source§fn rapid_blink(&self) -> Painted<&T>
fn rapid_blink(&self) -> Painted<&T>
Source§fn quirk(&self, value: Quirk) -> Painted<&T>
fn quirk(&self, value: Quirk) -> Painted<&T>
Enables the yansi
Quirk
value
.
This method should be used rarely. Instead, prefer to use quirk-specific
builder methods like mask()
and
wrap()
, which have the same functionality but are
pithier.
§Example
Enable wrapping using .quirk()
:
use yansi::{Paint, Quirk};
painted.quirk(Quirk::Wrap);
Enable wrapping using wrap()
.
use yansi::Paint;
painted.wrap();
Source§fn clear(&self) -> Painted<&T>
👎Deprecated since 1.0.1: renamed to resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.
fn clear(&self) -> Painted<&T>
resetting()
due to conflicts with Vec::clear()
.
The clear()
method will be removed in a future release.Source§fn whenever(&self, value: Condition) -> Painted<&T>
fn whenever(&self, value: Condition) -> Painted<&T>
Conditionally enable styling based on whether the Condition
value
applies. Replaces any previous condition.
See the crate level docs for more details.
§Example
Enable styling painted
only when both stdout
and stderr
are TTYs:
use yansi::{Paint, Condition};
painted.red().on_yellow().whenever(Condition::STDOUTERR_ARE_TTY);