#[non_exhaustive]pub struct DashboardVersionDefinition {
pub data_set_identifier_declarations: Vec<DataSetIdentifierDeclaration>,
pub sheets: Option<Vec<SheetDefinition>>,
pub calculated_fields: Option<Vec<CalculatedField>>,
pub parameter_declarations: Option<Vec<ParameterDeclaration>>,
pub filter_groups: Option<Vec<FilterGroup>>,
pub column_configurations: Option<Vec<ColumnConfiguration>>,
pub analysis_defaults: Option<AnalysisDefaults>,
pub options: Option<AssetOptions>,
pub static_files: Option<Vec<StaticFile>>,
}
Expand description
The contents of a dashboard.
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.data_set_identifier_declarations: Vec<DataSetIdentifierDeclaration>
An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.
sheets: Option<Vec<SheetDefinition>>
An array of sheet definitions for a dashboard.
calculated_fields: Option<Vec<CalculatedField>>
An array of calculated field definitions for the dashboard.
parameter_declarations: Option<Vec<ParameterDeclaration>>
The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.
For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
filter_groups: Option<Vec<FilterGroup>>
The filter definitions for a dashboard.
For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
column_configurations: Option<Vec<ColumnConfiguration>>
An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.
analysis_defaults: Option<AnalysisDefaults>
The configuration for default analysis settings.
options: Option<AssetOptions>
An array of option definitions for a dashboard.
static_files: Option<Vec<StaticFile>>
The static files for the definition.
Implementations§
Source§impl DashboardVersionDefinition
impl DashboardVersionDefinition
Sourcepub fn data_set_identifier_declarations(
&self,
) -> &[DataSetIdentifierDeclaration]
pub fn data_set_identifier_declarations( &self, ) -> &[DataSetIdentifierDeclaration]
An array of dataset identifier declarations. With this mapping,you can use dataset identifiers instead of dataset Amazon Resource Names (ARNs) throughout the dashboard's sub-structures.
Sourcepub fn sheets(&self) -> &[SheetDefinition]
pub fn sheets(&self) -> &[SheetDefinition]
An array of sheet definitions for a dashboard.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .sheets.is_none()
.
Sourcepub fn calculated_fields(&self) -> &[CalculatedField]
pub fn calculated_fields(&self) -> &[CalculatedField]
An array of calculated field definitions for the dashboard.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .calculated_fields.is_none()
.
Sourcepub fn parameter_declarations(&self) -> &[ParameterDeclaration]
pub fn parameter_declarations(&self) -> &[ParameterDeclaration]
The parameter declarations for a dashboard. Parameters are named variables that can transfer a value for use by an action or an object.
For more information, see Parameters in Amazon QuickSight in the Amazon QuickSight User Guide.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .parameter_declarations.is_none()
.
Sourcepub fn filter_groups(&self) -> &[FilterGroup]
pub fn filter_groups(&self) -> &[FilterGroup]
The filter definitions for a dashboard.
For more information, see Filtering Data in Amazon QuickSight in the Amazon QuickSight User Guide.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .filter_groups.is_none()
.
Sourcepub fn column_configurations(&self) -> &[ColumnConfiguration]
pub fn column_configurations(&self) -> &[ColumnConfiguration]
An array of dashboard-level column configurations. Column configurations are used to set the default formatting for a column that is used throughout a dashboard.
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_configurations.is_none()
.
Sourcepub fn analysis_defaults(&self) -> Option<&AnalysisDefaults>
pub fn analysis_defaults(&self) -> Option<&AnalysisDefaults>
The configuration for default analysis settings.
Sourcepub fn options(&self) -> Option<&AssetOptions>
pub fn options(&self) -> Option<&AssetOptions>
An array of option definitions for a dashboard.
Sourcepub fn static_files(&self) -> &[StaticFile]
pub fn static_files(&self) -> &[StaticFile]
The static files for the definition.
If no value was sent for this field, a default will be set. If you want to determine if no value was sent, use .static_files.is_none()
.
Source§impl DashboardVersionDefinition
impl DashboardVersionDefinition
Sourcepub fn builder() -> DashboardVersionDefinitionBuilder
pub fn builder() -> DashboardVersionDefinitionBuilder
Creates a new builder-style object to manufacture DashboardVersionDefinition
.
Trait Implementations§
Source§impl Clone for DashboardVersionDefinition
impl Clone for DashboardVersionDefinition
Source§fn clone(&self) -> DashboardVersionDefinition
fn clone(&self) -> DashboardVersionDefinition
1.0.0 · Source§const fn clone_from(&mut self, source: &Self)
const fn clone_from(&mut self, source: &Self)
source
. Read moreSource§impl Debug for DashboardVersionDefinition
impl Debug for DashboardVersionDefinition
Source§impl PartialEq for DashboardVersionDefinition
impl PartialEq for DashboardVersionDefinition
Source§fn eq(&self, other: &DashboardVersionDefinition) -> bool
fn eq(&self, other: &DashboardVersionDefinition) -> bool
self
and other
values to be equal, and is used by ==
.impl StructuralPartialEq for DashboardVersionDefinition
Auto Trait Implementations§
impl Freeze for DashboardVersionDefinition
impl RefUnwindSafe for DashboardVersionDefinition
impl Send for DashboardVersionDefinition
impl Sync for DashboardVersionDefinition
impl Unpin for DashboardVersionDefinition
impl UnwindSafe for DashboardVersionDefinition
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);