#[non_exhaustive]pub struct NumericRangeFilterBuilder { /* private fields */ }
Expand description
A builder for NumericRangeFilter
.
Implementations§
source§impl NumericRangeFilterBuilder
impl NumericRangeFilterBuilder
sourcepub fn filter_id(self, input: impl Into<String>) -> Self
pub fn filter_id(self, input: impl Into<String>) -> Self
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
This field is required.sourcepub fn set_filter_id(self, input: Option<String>) -> Self
pub fn set_filter_id(self, input: Option<String>) -> Self
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
sourcepub fn get_filter_id(&self) -> &Option<String>
pub fn get_filter_id(&self) -> &Option<String>
An identifier that uniquely identifies a filter within a dashboard, analysis, or template.
sourcepub fn column(self, input: ColumnIdentifier) -> Self
pub fn column(self, input: ColumnIdentifier) -> Self
The column that the filter is applied to.
This field is required.sourcepub fn set_column(self, input: Option<ColumnIdentifier>) -> Self
pub fn set_column(self, input: Option<ColumnIdentifier>) -> Self
The column that the filter is applied to.
sourcepub fn get_column(&self) -> &Option<ColumnIdentifier>
pub fn get_column(&self) -> &Option<ColumnIdentifier>
The column that the filter is applied to.
sourcepub fn include_minimum(self, input: bool) -> Self
pub fn include_minimum(self, input: bool) -> Self
Determines whether the minimum value in the filter value range should be included in the filtered results.
sourcepub fn set_include_minimum(self, input: Option<bool>) -> Self
pub fn set_include_minimum(self, input: Option<bool>) -> Self
Determines whether the minimum value in the filter value range should be included in the filtered results.
sourcepub fn get_include_minimum(&self) -> &Option<bool>
pub fn get_include_minimum(&self) -> &Option<bool>
Determines whether the minimum value in the filter value range should be included in the filtered results.
sourcepub fn include_maximum(self, input: bool) -> Self
pub fn include_maximum(self, input: bool) -> Self
Determines whether the maximum value in the filter value range should be included in the filtered results.
sourcepub fn set_include_maximum(self, input: Option<bool>) -> Self
pub fn set_include_maximum(self, input: Option<bool>) -> Self
Determines whether the maximum value in the filter value range should be included in the filtered results.
sourcepub fn get_include_maximum(&self) -> &Option<bool>
pub fn get_include_maximum(&self) -> &Option<bool>
Determines whether the maximum value in the filter value range should be included in the filtered results.
sourcepub fn range_minimum(self, input: NumericRangeFilterValue) -> Self
pub fn range_minimum(self, input: NumericRangeFilterValue) -> Self
The minimum value for the filter value range.
sourcepub fn set_range_minimum(self, input: Option<NumericRangeFilterValue>) -> Self
pub fn set_range_minimum(self, input: Option<NumericRangeFilterValue>) -> Self
The minimum value for the filter value range.
sourcepub fn get_range_minimum(&self) -> &Option<NumericRangeFilterValue>
pub fn get_range_minimum(&self) -> &Option<NumericRangeFilterValue>
The minimum value for the filter value range.
sourcepub fn range_maximum(self, input: NumericRangeFilterValue) -> Self
pub fn range_maximum(self, input: NumericRangeFilterValue) -> Self
The maximum value for the filter value range.
sourcepub fn set_range_maximum(self, input: Option<NumericRangeFilterValue>) -> Self
pub fn set_range_maximum(self, input: Option<NumericRangeFilterValue>) -> Self
The maximum value for the filter value range.
sourcepub fn get_range_maximum(&self) -> &Option<NumericRangeFilterValue>
pub fn get_range_maximum(&self) -> &Option<NumericRangeFilterValue>
The maximum value for the filter value range.
sourcepub fn select_all_options(self, input: NumericFilterSelectAllOptions) -> Self
pub fn select_all_options(self, input: NumericFilterSelectAllOptions) -> Self
Select all of the values. Null is not the assigned value of select all.
-
FILTER_ALL_VALUES
sourcepub fn set_select_all_options(
self,
input: Option<NumericFilterSelectAllOptions>
) -> Self
pub fn set_select_all_options( self, input: Option<NumericFilterSelectAllOptions> ) -> Self
Select all of the values. Null is not the assigned value of select all.
-
FILTER_ALL_VALUES
sourcepub fn get_select_all_options(&self) -> &Option<NumericFilterSelectAllOptions>
pub fn get_select_all_options(&self) -> &Option<NumericFilterSelectAllOptions>
Select all of the values. Null is not the assigned value of select all.
-
FILTER_ALL_VALUES
sourcepub fn aggregation_function(self, input: AggregationFunction) -> Self
pub fn aggregation_function(self, input: AggregationFunction) -> Self
The aggregation function of the filter.
sourcepub fn set_aggregation_function(
self,
input: Option<AggregationFunction>
) -> Self
pub fn set_aggregation_function( self, input: Option<AggregationFunction> ) -> Self
The aggregation function of the filter.
sourcepub fn get_aggregation_function(&self) -> &Option<AggregationFunction>
pub fn get_aggregation_function(&self) -> &Option<AggregationFunction>
The aggregation function of the filter.
sourcepub fn null_option(self, input: FilterNullOption) -> Self
pub fn null_option(self, input: FilterNullOption) -> Self
This option determines how null values should be treated when filtering data.
-
ALL_VALUES
: Include null values in filtered results. -
NULLS_ONLY
: Only include null values in filtered results. -
NON_NULLS_ONLY
: Exclude null values from filtered results.
sourcepub fn set_null_option(self, input: Option<FilterNullOption>) -> Self
pub fn set_null_option(self, input: Option<FilterNullOption>) -> Self
This option determines how null values should be treated when filtering data.
-
ALL_VALUES
: Include null values in filtered results. -
NULLS_ONLY
: Only include null values in filtered results. -
NON_NULLS_ONLY
: Exclude null values from filtered results.
sourcepub fn get_null_option(&self) -> &Option<FilterNullOption>
pub fn get_null_option(&self) -> &Option<FilterNullOption>
This option determines how null values should be treated when filtering data.
-
ALL_VALUES
: Include null values in filtered results. -
NULLS_ONLY
: Only include null values in filtered results. -
NON_NULLS_ONLY
: Exclude null values from filtered results.
sourcepub fn default_filter_control_configuration(
self,
input: DefaultFilterControlConfiguration
) -> Self
pub fn default_filter_control_configuration( self, input: DefaultFilterControlConfiguration ) -> Self
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
sourcepub fn set_default_filter_control_configuration(
self,
input: Option<DefaultFilterControlConfiguration>
) -> Self
pub fn set_default_filter_control_configuration( self, input: Option<DefaultFilterControlConfiguration> ) -> Self
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
sourcepub fn get_default_filter_control_configuration(
&self
) -> &Option<DefaultFilterControlConfiguration>
pub fn get_default_filter_control_configuration( &self ) -> &Option<DefaultFilterControlConfiguration>
The default configurations for the associated controls. This applies only for filters that are scoped to multiple sheets.
sourcepub fn build(self) -> Result<NumericRangeFilter, BuildError>
pub fn build(self) -> Result<NumericRangeFilter, BuildError>
Consumes the builder and constructs a NumericRangeFilter
.
This method will fail if any of the following fields are not set:
Trait Implementations§
source§impl Clone for NumericRangeFilterBuilder
impl Clone for NumericRangeFilterBuilder
source§fn clone(&self) -> NumericRangeFilterBuilder
fn clone(&self) -> NumericRangeFilterBuilder
1.0.0 · source§fn clone_from(&mut self, source: &Self)
fn clone_from(&mut self, source: &Self)
source
. Read moresource§impl Debug for NumericRangeFilterBuilder
impl Debug for NumericRangeFilterBuilder
source§impl Default for NumericRangeFilterBuilder
impl Default for NumericRangeFilterBuilder
source§fn default() -> NumericRangeFilterBuilder
fn default() -> NumericRangeFilterBuilder
source§impl PartialEq for NumericRangeFilterBuilder
impl PartialEq for NumericRangeFilterBuilder
source§fn eq(&self, other: &NumericRangeFilterBuilder) -> bool
fn eq(&self, other: &NumericRangeFilterBuilder) -> bool
self
and other
values to be equal, and is used
by ==
.impl StructuralPartialEq for NumericRangeFilterBuilder
Auto Trait Implementations§
impl Freeze for NumericRangeFilterBuilder
impl RefUnwindSafe for NumericRangeFilterBuilder
impl Send for NumericRangeFilterBuilder
impl Sync for NumericRangeFilterBuilder
impl Unpin for NumericRangeFilterBuilder
impl UnwindSafe for NumericRangeFilterBuilder
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> 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 more