Struct View 

pub struct View(/* private fields */);

The View struct is Perspective’s query and serialization interface. It represents a query on the Table’s dataset and is always created from an existing Table instance via the Table::view method.

Views are immutable with respect to the arguments provided to the Table::view method; to change these parameters, you must create a new View on the same Table. However, each View is live with respect to the Table’s data, and will (within a conflation window) update with the latest state as its parent Table updates, including incrementally recalculating all aggregates, pivots, filters, etc. View query parameters are composable, in that each parameter works independently and in conjunction with each other, and there is no limit to the number of pivots, filters, etc. which can be applied.

Implementations

impl View

pub async fn column_paths( &self, window: Option<JsColumnWindow>, ) -> ApiResult<JsValue>

Returns an array of strings containing the column paths of the View without any of the source columns.

A column path shows the columns that a given cell belongs to after pivots are applied.

pub async fn delete(self) -> ApiResult<()>

Delete this View and clean up all resources associated with it. View objects do not stop consuming resources or processing updates when they are garbage collected - you must call this method to reclaim these.

pub async fn dimensions(&self) -> ApiResult<JsValue>

Returns this View’s dimensions, row and column count, as well as those of the crate::Table from which it was derived.

• num_table_rows - The number of rows in the underlying crate::Table.
• num_table_columns - The number of columns in the underlying crate::Table (including the index column if this crate::Table was constructed with one).
• num_view_rows - The number of rows in this View. If this View has a group_by clause, num_view_rows will also include aggregated rows.
• num_view_columns - The number of columns in this View. If this View has a split_by clause, num_view_columns will include all column paths, e.g. the number of columns clause times the number of split_by groups.

pub async fn expression_schema(&self) -> ApiResult<JsValue>

The expression schema of this View, which contains only the expressions created on this View. See View::schema for details.

pub async fn get_config(&self) -> ApiResult<JsValue>

A copy of the config object passed to the Table::view method which created this View.

pub async fn get_min_max(&self, name: String) -> ApiResult<Array>

Calculates the [min, max] of the leaf nodes of a column column_name.

Returns

A tuple of [min, max], whose types are column and aggregate dependent.

pub async fn num_rows(&self) -> ApiResult<i32>

The number of aggregated rows in this View. This is affected by the “group_by” configuration parameter supplied to this view’s contructor.

Returns

The number of aggregated rows.

pub async fn schema(&self) -> ApiResult<JsValue>

The schema of this View.

The View schema differs from the schema returned by Table::schema; it may have different column names due to expressions or columns configs, or it maye have different column types due to the application og group_by and aggregates config. You can think of Table::schema as the input schema and View::schema as the output schema of a Perspective pipeline.

pub async fn to_arrow( &self, window: Option<JsViewWindow>, ) -> ApiResult<ArrayBuffer>

Serializes a View to the Apache Arrow data format.

pub async fn to_columns_string( &self, window: Option<JsViewWindow>, ) -> ApiResult<String>

Serializes this View to a string of JSON data. Useful if you want to save additional round trip serialize/deserialize cycles.

pub async fn to_columns( &self, window: Option<JsViewWindow>, ) -> ApiResult<Object>

Serializes this View to JavaScript objects in a column-oriented format.

pub async fn to_json_string( &self, window: Option<JsViewWindow>, ) -> ApiResult<String>

Render this View as a JSON string.

pub async fn to_json(&self, window: Option<JsViewWindow>) -> ApiResult<Array>

Serializes this View to JavaScript objects in a row-oriented format.

pub async fn to_ndjson(&self, window: Option<JsViewWindow>) -> ApiResult<String>

Renders this View as an NDJSON formatted String.

pub async fn to_csv(&self, window: Option<JsViewWindow>) -> ApiResult<String>

Serializes this View to CSV data in a standard format.

pub fn on_update( &self, on_update_js: Function, options: Option<JsOnUpdateOptions>, ) -> ApiFuture<u32>

Register a callback with this View. Whenever the view’s underlying table emits an update, this callback will be invoked with an object containing port_id, indicating which port the update fired on, and optionally delta, which is the new data that was updated for each cell or each row.

Arguments

• on_update - A callback function invoked on update, which receives an object with two keys: port_id, indicating which port the update was triggered on, and delta, whose value is dependent on the mode parameter.
• options - If this is provided as OnUpdateOptions { mode: Some(OnUpdateMode::Row) }, then delta is an Arrow of the updated rows. Otherwise delta will be Option::None.

JavaScript Examples

// Attach an `on_update` callback
view.on_update((updated) => console.log(updated.port_id));

// `on_update` with row deltas
view.on_update((updated) => console.log(updated.delta), { mode: "row" });

pub async fn remove_update(&self, callback_id: u32) -> ApiResult<()>

Unregister a previously registered update callback with this View.

Arguments

• id - A callback id as returned by a recipricol call to View::on_update.

pub fn on_delete(&self, on_delete: Function) -> ApiFuture<u32>

Register a callback with this View. Whenever the View is deleted, this callback will be invoked.

pub async fn num_columns(&self) -> ApiResult<u32>

The number of aggregated columns in this View. This is affected by the “split_by” configuration parameter supplied to this view’s contructor.

Returns

The number of aggregated columns.

pub fn remove_delete(&self, callback_id: u32) -> ApiFuture<()>

Unregister a previously registered View::on_delete callback.

pub async fn collapse(&self, row_index: u32) -> ApiResult<u32>

Collapses the group_by row at row_index.

pub async fn expand(&self, row_index: u32) -> ApiResult<u32>

Expand the group_by row at row_index.

pub async fn set_depth(&self, depth: u32) -> ApiResult<()>

Set expansion depth of the group_by tree.

Trait Implementations

impl Clone for View

fn clone(&self) -> View

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl From<View> for JsValue

fn from(value: View) -> Self

Converts to this type from the input type.

impl From<View> for View

fn from(value: View) -> Self

Converts to this type from the input type.

impl FromWasmAbi for View

type Abi = u32

The Wasm ABI type that this converts from when coming back out from the ABI boundary.

unsafe fn from_abi(js: u32) -> Self

Recover a Self from Self::Abi.

impl IntoWasmAbi for View

type Abi = u32

The Wasm ABI type that this converts into when crossing the ABI boundary.

fn into_abi(self) -> u32

Convert self into Self::Abi so that it can be sent across the wasm ABI boundary.

impl LongRefFromWasmAbi for View

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRef<View>

Same as RefFromWasmAbi::Anchor

unsafe fn long_ref_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl OptionFromWasmAbi for View

fn is_none(abi: &Self::Abi) -> bool

Tests whether the argument is a “none” instance. If so it will be deserialized as None, and otherwise it will be passed to FromWasmAbi.

impl OptionIntoWasmAbi for View

fn none() -> Self::Abi

Returns an ABI instance indicating “none”, which JS will interpret as the None branch of this option.

impl RefFromWasmAbi for View

type Abi = u32

The Wasm ABI type references to Self are recovered from.

type Anchor = RcRef<View>

The type that holds the reference to Self for the duration of the invocation of the function that has an &Self parameter. This is required to ensure that the lifetimes don’t persist beyond one function call, and so that they remain anonymous.

unsafe fn ref_from_abi(js: Self::Abi) -> Self::Anchor

Recover a Self::Anchor from Self::Abi.

impl RefMutFromWasmAbi for View

type Abi = u32

Same as RefFromWasmAbi::Abi

type Anchor = RcRefMut<View>

Same as RefFromWasmAbi::Anchor

unsafe fn ref_mut_from_abi(js: Self::Abi) -> Self::Anchor

Same as RefFromWasmAbi::ref_from_abi

impl TryFromJsValue for View

type Error = JsValue

The type returned in the event of a conversion error.

fn try_from_js_value(value: JsValue) -> Result<Self, Self::Error>

Performs the conversion.

impl VectorFromWasmAbi for View

type Abi = <Box<[JsValue]> as FromWasmAbi>::Abi

unsafe fn vector_from_abi(js: Self::Abi) -> Box<[View]>

impl VectorIntoJsValue for View

fn vector_into_jsvalue(vector: Box<[View]>) -> JsValue

impl VectorIntoWasmAbi for View

type Abi = <Box<[JsValue]> as IntoWasmAbi>::Abi

fn vector_into_abi(vector: Box<[View]>) -> Self::Abi

impl WasmDescribe for View

fn describe()

impl WasmDescribeVector for View

fn describe_vector()

impl SupportsConstructor for View

impl SupportsInstanceProperty for View

impl SupportsStaticProperty for View