Hypertable Client Library / Exports / HypView
Class: HypView
A view in a Hypertable project.
A limited number of properties of the view may be read currently, and more properties and methods to update them will be added in the future.
Implements
ClientLibView
Table of contents
Properties
Methods
Properties
collectionId
• Optional Readonly collectionId: string
The ID of the associated collection, if there is one.
Only views with the type "collection" or "record" have an associated collection.
Implementation of
ClientLibView.collectionId
description
• Readonly description: string
The longer description of the view
Implementation of
ClientLibView.description
filter
• Optional Readonly filter: HypFilter
The definition of any filters that are applied to this "collection" View (only available for "collection" Views)
Implementation of
ClientLibView.filter
id
• Readonly id: string
The ID of the view
Implementation of
ClientLibView.id
name
• Readonly name: string
The name of the view
Implementation of
ClientLibView.name
sort
• Optional Readonly sort: HypSort
The definition of any sorts that are applied to this "collection" View (only available for "collection" Views)
Implementation of
ClientLibView.sort
subtype
• Readonly subtype: string
The sub-type of view within the view's "type".
The available "subtypes" depend on the view's "type":
- "project" - one of: "dashboard", "custom"
- "collection" - one of: "list", "kanban", "grid", "calendar", "custom"
- "record" - one of: "detail", "form", "report", "custom"
Implementation of
ClientLibView.subtype
type
• Readonly type: "project" | "collection" | "record"
The "type" of view, defining the scope of data that can be displayed.
One of: "project", "collection", "record"
Implementation of
ClientLibView.type
Methods
getRecords
▸ getRecords(): Promise<undefined | HypRecord[]>
Get all the Records currently visible in this "collection" View.
N.B. this method only returns Records for "collection" Views, and undefined fo other View types.
Returns
Promise<undefined | HypRecord[]>
The list of Records currently visible in the "collection" View
open
▸ open(): Promise<boolean>
Open this View immediately
Returns
Promise<boolean>
Whether this View was successfully opened