Base JS SDK

中文

English

中文

English

Appearance

GanttView 甘特视图 ​

id ​

当前视图的 id

tableId ​

当前视图所属的数据表 id

getName ​

typescript
getName(): Promise<string>;
getName(): Promise<string>;

获取视图名

getType ​

获取视图类型

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

getMeta ​

获取视图元数据，其中 IGanttViewMeta 的类型定义为：

typescript
getMeta(): Promise<IGanttViewMeta>;

interface IGanttViewMeta {
  id: string;
  name: string;
  type: ViewType.Gantt;
  property: {
    filterInfo: IFilterInfo | null;
    sortInfo: ISortInfo[];
    groupInfo: IGroupInfo[];
  };
}
getMeta(): Promise<IGanttViewMeta>;

interface IGanttViewMeta {
  id: string;
  name: string;
  type: ViewType.Gantt;
  property: {
    filterInfo: IFilterInfo | null;
    sortInfo: ISortInfo[];
    groupInfo: IGroupInfo[];
  };
}

showField ​

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

显示字段

hideField ​

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

隐藏字段

getFieldMetaList ​

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

获取字段信息的列表，因为 View 层涉及到了 UI 的展示，所以此时获取的字段信息是有序的

getVisibleRecordIdList ​

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

获取可见记录的 ID 列表

getVisibleFieldIdList ​

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

获取可见字段的 ID 列表

applySetting ​

typescript
applySetting(): Promise<void>;
applySetting(): Promise<void>;

将设置的分组/筛选/排序等视图配置提交，同步给其他用户

getFilterInfo ​

typescript
getFilterInfo(): Promise<IFilterInfo | null>;
getFilterInfo(): Promise<IFilterInfo | null>;

获取当前的筛选信息(IFilterInfo 定义)

addFilterCondition ​

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

新增筛选条件，如果新增失败，则会返回 false (调用该 API 时，并不会保存修改的设置，如果需要保存则需要额外调用 view.applySetting())

deleteFilterCondition ​

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

删除筛选条件，如果删除失败，则会返回 false (调用该 API 时，并不会保存修改的设置，如果需要保存则需要额外调用 view.applySetting())

updateFilterCondition ​

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

更新筛选条件，如果更新失败，则会返回 false (调用该 API 时，并不会保存修改的设置，如果需要保存则需要额外调用 view.applySetting())

setFilterConjunction ​

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

设置筛选条件之间的关系，其中 FilterConjunction 类型定义为:

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

可以选择满足所有筛选条件或者其中某条件 (调用该 API 时，并不会保存修改的设置，如果需要保存则需要额外调用 view.applySetting())

getSortInfo ​

typescript
getSortInfo(): Promise<ISortInfo[]>;
getSortInfo(): Promise<ISortInfo[]>;

获取当前的排序条件(sortInfo定义)

setAutoSort ​

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

设置是否自动进行排序（在设置了排序条件之后，会自动设置为 true, 调用该 API 时，并不会保存修改的设置，如果需要保存则需要额外调用 view.applySetting())

addSort ​

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

新增排序条件（调用该 API 时，并不会保存修改的设置，如果需要保存则需要额外调用 view.applySetting()）

deleteSort ​

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

删除排序条件 （调用该 API 时，并不会保存修改的设置，如果需要保存则需要额外调用 view.applySetting()）

updateSort ​

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

更新排序条件 （调用该 API 时，并不会保存修改的设置，如果需要保存则需要额外调用 view.applySetting()）

getGroupInfo ​

typescript
getGroupInfo(): Promise<IGroupInfo[]>;
getGroupInfo(): Promise<IGroupInfo[]>;

获取分组信息(IGroupInfo定义)

addGroup ​

typescript
addGroup: (param: IGroupInfo | IGroupInfo[]) => Promise<boolean>;
addGroup: (param: IGroupInfo | IGroupInfo[]) => Promise<boolean>;

新增分组 （调用该 API 时，并不会保存修改的设置，如果需要保存则需要额外调用 view.applySetting()）

deleteGroup ​

typescript
deleteGroup: (param: string | IGroupInfo) => Promise<boolean>;
deleteGroup: (param: string | IGroupInfo) => Promise<boolean>;

删除分组 （调用该 API 时，并不会保存修改的设置，如果需要保存则需要额外调用 view.applySetting()）

updateGroup ​

typescript
updateGroup: (param: IGroupInfo) => Promise<boolean>;
updateGroup: (param: IGroupInfo) => Promise<boolean>;

更新分组（调用该 API 时，并不会保存修改的设置，如果需要保存则需要额外调用 view.applySetting()）