Struct re_view_dataframe::Query

pub struct Query {
    query_property: ViewProperty,
}

Wrapper over the DataframeQuery blueprint archetype that can also display some UI.

Fields

query_property: ViewProperty

Implementations

impl Query

pub(crate) fn timeline_name( &self, ctx: &ViewerContext<'_>, ) -> Result<TimelineName, ViewSystemExecutionError>

Get the query timeline name.

This dis-regards whether a timeline actually exists with this name.

pub fn timeline( &self, ctx: &ViewerContext<'_>, ) -> Result<Option<Timeline>, ViewSystemExecutionError>

Get the query timeline.

This returns the query timeline if it actually exists, or None otherwise.

pub fn save_timeline_name( &self, ctx: &ViewerContext<'_>, timeline_name: &TimelineName, )

Save the timeline to the one specified.

Note: this resets the range filter timestamps to -inf/+inf as any other value might be invalidated.

pub fn filter_by_range( &self, ) -> Result<ResolvedTimeRange, ViewSystemExecutionError>

pub fn save_filter_by_range( &self, ctx: &ViewerContext<'_>, range: ResolvedTimeRange, )

pub fn filter_is_not_null( &self, ) -> Result<Option<ComponentColumnSelector>, ViewSystemExecutionError>

Get the filter column for the filter-is-not-null feature, if active.

pub fn filter_is_not_null_raw( &self, ) -> Result<Option<FilterIsNotNull>, ViewSystemExecutionError>

Get the raw components::FilterIsNotNull struct (for ui purposes).

pub fn save_filter_is_not_null( &self, ctx: &ViewerContext<'_>, filter_is_not_null: &FilterIsNotNull, )

pub fn latest_at_enabled(&self) -> Result<bool, ViewSystemExecutionError>

pub fn save_latest_at_enabled(&self, ctx: &ViewerContext<'_>, enabled: bool)

pub fn save_selected_columns( &self, ctx: &ViewerContext<'_>, columns: impl IntoIterator<Item = ColumnSelector>, )

pub fn save_all_columns_selected(&self, ctx: &ViewerContext<'_>)

pub fn save_all_columns_unselected(&self, ctx: &ViewerContext<'_>)

pub fn apply_column_visibility_to_view_columns( &self, ctx: &ViewerContext<'_>, view_columns: &[ColumnDescriptor], ) -> Result<Option<Vec<ColumnSelector>>, ViewSystemExecutionError>

Given some view columns, list the columns that should be visible (aka “selected columns”), according to the blueprint.

This operates by filtering the view columns based on the blueprint specified columns.

Returns Ok(None) if all columns should be displayed (aka a column selection isn’t provided in the blueprint).

pub(crate) fn handle_hide_column_actions( &self, ctx: &ViewerContext<'_>, view_columns: &[ColumnDescriptor], actions: Vec<HideColumnAction>, ) -> Result<(), ViewSystemExecutionError>

impl Query

pub(super) fn timeline_ui( &self, ctx: &ViewerContext<'_>, ui: &mut Ui, timeline_name: TimelineName, ) -> Result<(), ViewSystemExecutionError>

pub(super) fn filter_range_ui( &self, ctx: &ViewerContext<'_>, ui: &mut Ui, timeline: Option<&Timeline>, ) -> Result<(), ViewSystemExecutionError>

pub(super) fn filter_is_not_null_ui( &self, ctx: &ViewerContext<'_>, ui: &mut Ui, timeline: Option<&Timeline>, view_id: ViewId, ) -> Result<(), ViewSystemExecutionError>

pub(super) fn column_visibility_ui( &self, ctx: &ViewerContext<'_>, ui: &mut Ui, timeline: Option<&Timeline>, view_columns: Option<&[ColumnDescriptor]>, ) -> Result<(), ViewSystemExecutionError>

fn column_visibility_ui_impl( &self, ctx: &ViewerContext<'_>, ui: &mut Ui, timeline: &Timeline, view_columns: &[ColumnDescriptor], ) -> Result<(), ViewSystemExecutionError>

fn column_visibility_ui_fallback(ui: &mut Ui)

pub(super) fn latest_at_ui( &self, ctx: &ViewerContext<'_>, ui: &mut Ui, ) -> Result<(), ViewSystemExecutionError>

impl Query

pub fn from_blueprint(ctx: &ViewerContext<'_>, view_id: ViewId) -> Self

Create a query object from the blueprint store.

See the blueprint_io module for more related accessors.

pub(crate) fn selection_panel_ui( &self, ctx: &ViewerContext<'_>, ui: &mut Ui, view_id: ViewId, view_columns: Option<&[ColumnDescriptor]>, ) -> Result<(), ViewSystemExecutionError>

Display the selection panel ui for this query.

Implementation is in the ui module.