Kanban View ​

id ​

Get the view id

tableId ​

Get the id of current view belongs to

getType ​

Get the view type

getType(): Promise<ViewType.Kanban>;

getType(): Promise<ViewType.Kanban>;

getName ​

getName(): Promise<string>;

getName(): Promise<string>;

Get the view name

getType ​

Get the view type

getType(): Promise<ViewType.Kanban>;

getType(): Promise<ViewType.Kanban>;

getMeta ​

getMeta(): Promise<IKanbanViewMeta>;

getMeta(): Promise<IKanbanViewMeta>;

Get view metadata, where IKanbanViewMeta is defined as:

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

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

getFieldMetaList ​

getFieldMetaList(): Promise<IFieldMeta[]>;

getFieldMetaList(): Promise<IFieldMeta[]>;

Get the list of field information, because the View layer involves the display of UI, the field information obtained at this time is ordered

getVisibleRecordIdList ​

getVisibleRecordIdList(): Promise<(string | undefined)[]>;

getVisibleRecordIdList(): Promise<(string | undefined)[]>;

Get the ID list of visible records

getVisibleFieldIdList ​

getVisibleFieldIdList(): Promise<string[]>;

getVisibleFieldIdList(): Promise<string[]>;

Get the ID list of visible fields

applySetting ​

applySetting(): Promise<void>;

applySetting(): Promise<void>;

Submit the view configuration of the set grouping/filtering/sorting, etc., and synchronize it with other users

getFilterInfo ​

getFilterInfo(): Promise<IFilterInfo | null>;

getFilterInfo(): Promise<IFilterInfo | null>;

Get the current filter information (IFilterInfo definition)

addFilterCondition ​

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

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

Add a filter condition, if the addition fails, it will return false (when calling this API, the modified settings will not be saved, if you need to save, you need to call view.applySetting() separately)

deleteFilterCondition ​

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

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

Delete the filter condition, if the deletion fails, it will return false (when calling this API, the modified settings will not be saved, if you need to save, you need to call view.applySetting() separately)

updateFilterCondition ​

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

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

Update the filter condition, if the update fails, it will return false (when calling this API, the modified settings will not be saved, if you need to save, you need to call view.applySetting() separately)

setFilterConjunction ​

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

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

Set the relationship between filter conditions, where the FilterConjunction type is defined as:

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

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

You can choose to meet all filter conditions or any one condition (when calling this API, the modified settings will not be saved, if you need to save, you need to call view.applySetting() separately)

getSortInfo ​

getSortInfo(): Promise<ISortInfo[]>;

getSortInfo(): Promise<ISortInfo[]>;

Get the current sorting conditions (sortInfo definition)

setAutoSort ​

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

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

Set whether to automatically sort (after setting the sort condition, it will automatically be set to true, when calling this API, the modified settings will not be saved, if you need to save, you need to call view.applySetting() separately)

addSort ​

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

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

Add sorting conditions (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 the sorting conditions (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 the sorting conditions (when calling this API, the modified settings will not be saved, if you need to save, you need to call view.applySetting() separately)