View corresponds to the view in APITable. Note View is not a resource.

Fields

id

The ID of this view.

name

The name of this view.

type

The view type.

rows

The row property array of this view.

columns

The column property array of this view.

property

The properties object of this view.

index

The index of this view in the view list.

Methods

getFields

getFields(options: IFieldsOptions): Promise<Field[]>

Obtain an array of Fields in the view, given the field options.

getRecords

getRecords(options: IRecordsOptions): Promise<Record[]>

Given the records options, obtain an array of Records in the view.

addRecords

addRecords(recordOptions: IAddRecordsOptions, saveOptions: ISaveOptions): Promise<ICommandExecutionResult<string[]>>

Add some records to this view.

delete

delete(saveOptions: ISaveOptions): Promise<ICommandExecutionResult<void>>

Delete this view.

modify

modify(view: IModifySelfView, saveOptions: ISaveOptions): Promise<ICommandExecutionResult<void>>

Modify properties of this view.

move

move(view: IMoveSelfView, saveOptions: ISaveOptions): Promise<ICommandExecutionResult<void>>

Move this view to a new position in the view list.

setLockInfo

setLockInfo(lockInfo: IViewLockInfo | null, saveOptions: ISaveOptions): Promise<ICommandExecutionResult<void>>

setAutoSave

setAutoSave(autoSave: boolean, saveOptions: ISaveOptions): Promise<ICommandExecutionResult<void>>

deriveDefaultViewProperty

deriveDefaultViewProperty(viewType?: ViewType): IViewProperty | null

Get the default property of a view.