Gallery View ​

id ​

Get the view id

tableId ​

Get the id of current view belongs to

getType ​

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

getType(): Promise<ViewType.Gallery>;

getType(): Promise<ViewType.Gallery>;

getMeta ​

getMeta(): Promise<IGalleryViewMeta>;

getMeta(): Promise<IGalleryViewMeta>;

Get GalleryView meta information, where the IGalleryViewMeta type is defined as:

interface IGalleryViewMeta {
    id: string;
    name: string;
    type: ViewType.Gallery;
    property: {
      filterInfo: IFilterInfo | null;
      sortInfo: ISortInfo[];
    }
}

interface IGalleryViewMeta {
    id: string;
    name: string;
    type: ViewType.Gallery;
    property: {
      filterInfo: IFilterInfo | null;
      sortInfo: ISortInfo[];
    }
}

getFieldMetaList ​

getFieldMetaList(): Promise<IFieldMeta[]>;

getFieldMetaList(): Promise<IFieldMeta[]>;

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

getVisibleRecordIdList ​

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 ​

getVisibleFieldIdList(): Promise<string[]>;

getVisibleFieldIdList(): Promise<string[]>;

Get the list of visible field IDs.

getChildRecordIdList ​

getChildRecordIdList(parentRecordId: string): Promise<RecordId[] | undefined>;

getChildRecordIdList(parentRecordId: string): Promise<RecordId[] | undefined>;

Get the list of child record IDs for a given parent record ID. Returns undefined if the record has no child records.

getFilterInfo ​

getFilterInfo(): Promise<IFilterInfo | null>;

getFilterInfo(): Promise<IFilterInfo | null>;

Get the current filter information. (IFilterInfo definition)

showField ​

showField: (fieldId: string | string[]) => Promise<boolean>;

showField: (fieldId: string | string[]) => Promise<boolean>;

Show field

hideField ​

hideField: (fieldId: string | string[]) => Promise<boolean>;

hideField: (fieldId: string | string[]) => Promise<boolean>;

Hide field

addFilterCondition ​

addFilterCondition: (param: IAddFilterConditionParams) => Promise<boolean>;

addFilterCondition: (param: IAddFilterConditionParams) => Promise<boolean>;

Add a filter condition. Returns false if the addition fails. (Calling this API does not save the modified settings. To save the modifications, you need to call view.applySetting() separately.)

deleteFilterCondition ​

deleteFilterCondition: (conditionId: string) => Promise<boolean>;

deleteFilterCondition: (conditionId: string) => Promise<boolean>;

Delete a filter condition. Returns false if the deletion fails. (Calling this API does not save the modified settings. To save the modifications, you need to call view.applySetting() separately.)

updateFilterCondition ​

updateFilterCondition: (param: IUpdateFilterConditionParams) => Promise<boolean>;

updateFilterCondition: (param: IUpdateFilterConditionParams) => Promise<boolean>;

Update a filter condition. Returns false if the update fails. (Calling this API does not save the modified settings. To save the modifications, you need to call view.applySetting() separately.)

setFilterConjunction ​

setFilterConjunction: (conjunction: FilterConjunction) => Promise<boolean>;

setFilterConjunction: (conjunction: FilterConjunction) => Promise<boolean>;

Set the conjunction between filter conditions. The FilterConjunction type is defined as:

enum FilterConjunction {
    And = "and",
    Or = "or"
}

enum FilterConjunction {
    And = "and",
    Or = "or"
}

You can choose to satisfy all filter conditions or any of the conditions. (Calling this API does not save the modified settings. To save the modifications, you need to call view.applySetting() separately.)

getSortInfo ​

getSortInfo(): Promise<ISortInfo[]>;

getSortInfo(): Promise<ISortInfo[]>;

Get the current sort information. (ISortInfo definition)

setAutoSort ​

setAutoSort(param: boolean): Promise<boolean>;

setAutoSort(param: boolean): Promise<boolean>;

Set whether to automatically sort the table. After setting the sort criteria, it will automatically be set to true. (Calling this API does not save the modified settings. To save the modifications, you need to call view.applySetting() separately.)

addSort ​

addSort: (param: ISortInfo | ISortInfo[]) => Promise<boolean>;

addSort: (param: ISortInfo | ISortInfo[]) => Promise<boolean>;

Add a new sorting condition (when calling this API, the modified settings will not be saved. If you need to save, you need to call view.applySetting() separately)

deleteSort ​

deleteSort: (param: ISortInfo | string) => Promise<boolean>;

deleteSort: (param: ISortInfo | string) => Promise<boolean>;

Delete sorting condition (when calling this API, the modified settings will not be saved. If you need to save, you need to call view.applySetting() separately)

updateSort ​

updateSort: (param: ISortInfo) => Promise<boolean>;

updateSort: (param: ISortInfo) => Promise<boolean>;

Update sorting condition (when calling this API, the modified settings will not be saved. If you need to save, you need to call view.applySetting() separately)

applySetting ​

applySetting(): Promise<void>;

applySetting(): Promise<void>;

Submit the set grouping/filtering/sorting and synchronize with other users