API Reference › core-common › Views › ViewStoreRpc

ViewStoreRpc Namespace

Access to a ViewStore from the frontend.

Interface

Name Description
ViewStoreRpc.AddViewArgs Arguments for adding a new view to a ViewStore.
ViewStoreRpc.QueryBindings Bindings for parameterized values in where clause of SelectorQuery
ViewStoreRpc.QueryParams Parameters for querying for views in a ViewStore.
ViewStoreRpc.Reader Methods for reading from a ViewStore via Rpc from a frontend via IModelConnection.views.viewsStoreReader.
ViewStoreRpc.SelectorQuery Parameters for specifying a Query to select Categories or Models.
ViewStoreRpc.ViewGroupInfo Information about a ViewGroup in a ViewStore.
ViewStoreRpc.ViewInfo Information about a View in a ViewStore.
ViewStoreRpc.Writer Methods for writing to a ViewStore via Rpc from a frontend via IModelConnection.views.viewsStoreWriter.

Type alias

Name Description
ViewStoreRpc.ClassFullName The name for a view group.
ViewStoreRpc.IdString an Id of a View, DisplayStyle, ModelSelector, CategorySelector, or Timeline in a ViewStore.
ViewStoreRpc.NameOrId Argument for finding a category selector, model selector, display style, or timeline by name or Id.
ViewStoreRpc.OwnerName The name of an "owner".
ViewStoreRpc.SelectorProps A Model or Category selector may either be a query or a list of Ids.
ViewStoreRpc.TagName The name for a Tag.
ViewStoreRpc.ViewGroupName The name for a view group.
ViewStoreRpc.ViewGroupPath The path name of a view group (e.g.
ViewStoreRpc.ViewGroupSpec A string identifying a group.
ViewStoreRpc.ViewName The name for a view.

Function

Name Description
ViewStoreRpc.isViewStoreId Determine if a string is an Id of an entry in a ViewStore (base-36 integer with a leading "@")

Defined in

Last Updated: 25 April, 2024