API Reference › core-backend› ViewDefinitions › ViewStore › ViewStore.ReadMethods

ViewStore.ReadMethods Interface

methods of cloud ViewDb for read access

Extends

Implemented by

Methods

Name Description
getCategorySelectorSync(args: ViewStoreRpc.NameOrId & ViewStoreRpc.QueryBindings): CategorySelectorProps    
getDisplayStyleSync(args: ViewStoreRpc.NameOrId & { opts?: DisplayStyleLoadProps }): DisplayStyleProps    
getModelSelectorSync(args: ViewStoreRpc.NameOrId & ViewStoreRpc.QueryBindings): ModelSelectorProps    
getThumbnailSync(args: { viewId: string }): undefined | ThumbnailProps    
getViewByNameSync(arg: { groupId?: number, name: string }): undefined | ViewStoreRpc.ViewInfo    
getViewDefinitionSync(args: { viewId: string }): ViewDefinitionProps    
queryViewsSync(queryParams: ViewStoreRpc.QueryParams): ViewStoreRpc.ViewInfo[]    

Inherited methods

Name Inherited from Description
findViewsByOwner(args: { owner: string }): Promise<ViewStoreRpc.ViewInfo[]> ViewStoreRpc.Reader Find all views owned by the supplied owner name.
getCategorySelector(args: ViewStoreRpc.NameOrId & ViewStoreRpc.QueryBindings): Promise<CategorySelectorProps> ViewStoreRpc.Reader Get a category selector by Id.
getDisplayStyle(args: ViewStoreRpc.NameOrId & { opts?: DisplayStyleLoadProps }): Promise<DisplayStyleProps> ViewStoreRpc.Reader Get a display style by Id.
getModelSelector(args: ViewStoreRpc.NameOrId & ViewStoreRpc.QueryBindings): Promise<ModelSelectorProps> ViewStoreRpc.Reader Get a model selector by Id.
getThumbnail(args: { viewId: string }): Promise<undefined | ThumbnailProps> ViewStoreRpc.Reader Get a thumbnail for a view.
getTimeline(args: ViewStoreRpc.NameOrId): Promise<RenderTimelineProps> ViewStoreRpc.Reader Get a render timeline by Id.
getViewByName(arg: { groupId?: string, name: string }): Promise<undefined | ViewStoreRpc.ViewInfo> ViewStoreRpc.Reader Get a view by name.
getViewDefinition(args: { viewId: string }): Promise<ViewDefinitionProps> ViewStoreRpc.Reader Get a view definition by viewId.
getViewGroupInfo(args: { groupId?: string }): Promise<undefined | ViewStoreRpc.ViewGroupInfo> ViewStoreRpc.Reader get the properties of a ViewGroup by id.
getViewGroups(args: { parent?: string }): Promise<{ id: string, name: string }[]> ViewStoreRpc.Reader Get a list of ViewGroups that are children of the supplied parent.
getViewInfo(args: { viewId: string }): Promise<undefined | ViewStoreRpc.ViewInfo> ViewStoreRpc.Reader Get the ViewInfo for a view by Id.
queryViews(queryParams: ViewStoreRpc.QueryParams): Promise<ViewStoreRpc.ViewInfo[]> ViewStoreRpc.Reader Query for a list of ViewInfos for views that match the supplied QueryParams.

Defined in

ViewStore.ReadMethods Interface

methods of cloud ViewDb for read access

Extends

Implemented by

Methods

Name Description
getCategorySelectorSync(args: ViewStoreRpc.NameOrId & ViewStoreRpc.QueryBindings): CategorySelectorProps    
getDisplayStyleSync(args: ViewStoreRpc.NameOrId & { opts?: DisplayStyleLoadProps }): DisplayStyleProps    
getModelSelectorSync(args: ViewStoreRpc.NameOrId & ViewStoreRpc.QueryBindings): ModelSelectorProps    
getThumbnailSync(args: { viewId: string }): undefined | ThumbnailProps    
getViewByNameSync(arg: { groupId?: number, name: string }): undefined | ViewStoreRpc.ViewInfo    
getViewDefinitionSync(args: { viewId: string }): ViewDefinitionProps    
queryViewsSync(queryParams: ViewStoreRpc.QueryParams): ViewStoreRpc.ViewInfo[]    

Inherited methods

Name Inherited from Description
findViewsByOwner(args: { owner: string }): Promise<ViewStoreRpc.ViewInfo[]> ViewStoreRpc Find all views owned by the supplied owner name.
getCategorySelector(args: ViewStoreRpc.NameOrId & ViewStoreRpc.QueryBindings): Promise<CategorySelectorProps> ViewStoreRpc Get a category selector by Id.
getDisplayStyle(args: ViewStoreRpc.NameOrId & { opts?: DisplayStyleLoadProps }): Promise<DisplayStyleProps> ViewStoreRpc Get a display style by Id.
getModelSelector(args: ViewStoreRpc.NameOrId & ViewStoreRpc.QueryBindings): Promise<ModelSelectorProps> ViewStoreRpc Get a model selector by Id.
getThumbnail(args: { viewId: string }): Promise<undefined | ThumbnailProps> ViewStoreRpc Get a thumbnail for a view.
getTimeline(args: ViewStoreRpc.NameOrId): Promise<RenderTimelineProps> ViewStoreRpc Get a render timeline by Id.
getViewByName(arg: { groupId?: string, name: string }): Promise<undefined | ViewStoreRpc.ViewInfo> ViewStoreRpc Get a view by name.
getViewDefinition(args: { viewId: string }): Promise<ViewDefinitionProps> ViewStoreRpc Get a view definition by viewId.
getViewGroupInfo(args: { groupId?: string }): Promise<undefined | ViewStoreRpc.ViewGroupInfo> ViewStoreRpc get the properties of a ViewGroup by id.
getViewGroups(args: { parent?: string }): Promise<{ id: string, name: string }[]> ViewStoreRpc Get a list of ViewGroups that are children of the supplied parent.
getViewInfo(args: { viewId: string }): Promise<undefined | ViewStoreRpc.ViewInfo> ViewStoreRpc Get the ViewInfo for a view by Id.
queryViews(queryParams: ViewStoreRpc.QueryParams): Promise<ViewStoreRpc.ViewInfo[]> ViewStoreRpc Query for a list of ViewInfos for views that match the supplied QueryParams.

Defined in

Last Updated: 17 May, 2024