Struct aws_sdk_quicksight::types::KpiVisual

#[non_exhaustive]
pub struct KpiVisual {
    pub visual_id: String,
    pub title: Option<VisualTitleLabelOptions>,
    pub subtitle: Option<VisualSubtitleLabelOptions>,
    pub chart_configuration: Option<KpiConfiguration>,
    pub conditional_formatting: Option<KpiConditionalFormatting>,
    pub actions: Option<Vec<VisualCustomAction>>,
    pub column_hierarchies: Option<Vec<ColumnHierarchy>>,
}

A key performance indicator (KPI).

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

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

visual_id: String

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

title: Option<VisualTitleLabelOptions>

The title that is displayed on the visual.

subtitle: Option<VisualSubtitleLabelOptions>

The subtitle that is displayed on the visual.

chart_configuration: Option<KpiConfiguration>

The configuration of a KPI visual.

conditional_formatting: Option<KpiConditionalFormatting>

The conditional formatting of a KPI visual.

actions: Option<Vec<VisualCustomAction>>

The list of custom actions that are configured for a visual.

column_hierarchies: Option<Vec<ColumnHierarchy>>

The column hierarchy that is used during drill-downs and drill-ups.

Implementations

impl KpiVisual

pub fn visual_id(&self) -> &str

The unique identifier of a visual. This identifier must be unique within the context of a dashboard, template, or analysis. Two dashboards, analyses, or templates can have visuals with the same identifiers.

pub fn title(&self) -> Option<&VisualTitleLabelOptions>

The title that is displayed on the visual.

pub fn subtitle(&self) -> Option<&VisualSubtitleLabelOptions>

The subtitle that is displayed on the visual.

pub fn chart_configuration(&self) -> Option<&KpiConfiguration>

The configuration of a KPI visual.

pub fn conditional_formatting(&self) -> Option<&KpiConditionalFormatting>

The conditional formatting of a KPI visual.

pub fn actions(&self) -> &[VisualCustomAction]

The list of custom actions that are configured for a visual.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .actions.is_none().

pub fn column_hierarchies(&self) -> &[ColumnHierarchy]

The column hierarchy that is used during drill-downs and drill-ups.

If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .column_hierarchies.is_none().

impl KpiVisual

pub fn builder() -> KpiVisualBuilder

Creates a new builder-style object to manufacture KpiVisual.

Trait Implementations

impl Clone for KpiVisual

fn clone(&self) -> KpiVisual

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for KpiVisual

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for KpiVisual

fn eq(&self, other: &KpiVisual) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for KpiVisual