Base JS SDK

English

中文

English

中文

Appearance

Form View ​

id ​

Get the view id

tableId ​

Get the id of current view belongs to

getType ​

Get the type of the view. Returns ViewType.Form for table view.

typescript
getType(): Promise<ViewType.Form>;
getType(): Promise<ViewType.Form>;

getMeta ​

typescript
getMeta(): Promise<IFormViewMeta>;
getMeta(): Promise<IFormViewMeta>;

Get FormView meta information, where the IFormViewMeta type is defined as:

typescript
interface IFormViewMeta {
    id: string;
    name: string;
    type: ViewType.Form;
    property: null
}
interface IFormViewMeta {
    id: string;
    name: string;
    type: ViewType.Form;
    property: null
}

getFieldMetaList ​

typescript
getFieldMetaList(): Promise<IFieldMeta[]>;
getFieldMetaList(): Promise<IFieldMeta[]>;

Get the list of field metadata. The field metadata is ordered as it appears in the UI.

getVisibleRecordIdList ​

typescript
getVisibleRecordIdList(filterInfo?: IFilterInfo, sortInfo?: ISortInfo[]): Promise<(string | undefined)[]>;
getVisibleRecordIdList(filterInfo?: IFilterInfo, sortInfo?: ISortInfo[]): Promise<(string | undefined)[]>;

Get the list of visible record IDs based on the filter and sort criteria. You can pass filter and sort information to get the filtered and sorted record IDs. (IFilterInfo definition and ISortInfo definition)

getVisibleFieldIdList ​

typescript
getVisibleFieldIdList(): Promise<string[]>;
getVisibleFieldIdList(): Promise<string[]>;

Get the list of visible field IDs.