smartbi-toolkit 1.1.3 → 1.1.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (61) hide show
  1. package/dist/index.d.ts +30 -0
  2. package/dist/index.js +141 -0
  3. package/dist/methods/AnalysisReportService.d.ts +93 -0
  4. package/dist/methods/AnalysisReportService.js +126 -0
  5. package/dist/methods/BusinessThemeService.d.ts +8 -0
  6. package/dist/methods/BusinessThemeService.js +11 -0
  7. package/dist/methods/BusinessViewService.d.ts +94 -0
  8. package/dist/methods/BusinessViewService.js +120 -0
  9. package/dist/methods/CatalogService.d.ts +188 -0
  10. package/dist/methods/CatalogService.js +230 -0
  11. package/dist/methods/ClientCombinedReportService.d.ts +63 -0
  12. package/dist/methods/ClientCombinedReportService.js +82 -0
  13. package/dist/methods/ClientInsightService.d.ts +83 -0
  14. package/dist/methods/ClientInsightService.js +107 -0
  15. package/dist/methods/ClientReportService.d.ts +162 -0
  16. package/dist/methods/ClientReportService.js +206 -0
  17. package/dist/methods/CombinedReportService.d.ts +7 -0
  18. package/dist/methods/CombinedReportService.js +10 -0
  19. package/dist/methods/DataSourceService.d.ts +178 -0
  20. package/dist/methods/DataSourceService.js +220 -0
  21. package/dist/methods/GraphicReportService.d.ts +7 -0
  22. package/dist/methods/GraphicReportService.js +10 -0
  23. package/dist/methods/InsightReport.d.ts +71 -0
  24. package/dist/methods/InsightReport.js +98 -0
  25. package/dist/methods/MetadataService.d.ts +37 -0
  26. package/dist/methods/MetadataService.js +47 -0
  27. package/dist/methods/OfficeReport.d.ts +49 -0
  28. package/dist/methods/OfficeReport.js +65 -0
  29. package/dist/methods/OfficeReportService.d.ts +36 -0
  30. package/dist/methods/OfficeReportService.js +46 -0
  31. package/dist/methods/OltpMetadataService.d.ts +19 -0
  32. package/dist/methods/OltpMetadataService.js +25 -0
  33. package/dist/methods/ParameterService.d.ts +12 -0
  34. package/dist/methods/ParameterService.js +18 -0
  35. package/dist/methods/PoolService.d.ts +11 -0
  36. package/dist/methods/PoolService.js +17 -0
  37. package/dist/methods/PortalService.d.ts +66 -0
  38. package/dist/methods/PortalService.js +89 -0
  39. package/dist/methods/Report.d.ts +178 -0
  40. package/dist/methods/Report.js +230 -0
  41. package/dist/methods/SSReport.d.ts +86 -0
  42. package/dist/methods/SSReport.js +114 -0
  43. package/dist/methods/ScheduleTaskService.d.ts +12 -0
  44. package/dist/methods/ScheduleTaskService.js +18 -0
  45. package/dist/methods/SimpleReportService.d.ts +12 -0
  46. package/dist/methods/SimpleReportService.js +18 -0
  47. package/dist/methods/SpreadSheetReportService.d.ts +43 -0
  48. package/dist/methods/SpreadSheetReportService.js +55 -0
  49. package/dist/methods/SystemConfigService.d.ts +17 -0
  50. package/dist/methods/SystemConfigService.js +23 -0
  51. package/dist/methods/TimeConsuming.d.ts +6 -0
  52. package/dist/methods/TimeConsuming.js +9 -0
  53. package/dist/methods/TimeConsumingService.d.ts +5 -0
  54. package/dist/methods/TimeConsumingService.js +9 -0
  55. package/dist/methods/UserManagerService.d.ts +236 -0
  56. package/dist/methods/UserManagerService.js +312 -0
  57. package/dist/types.d.ts +412 -0
  58. package/dist/types.js +61 -0
  59. package/dist/vite-plugin-smartbi/index.d.ts +36 -0
  60. package/dist/vite-plugin-smartbi/index.js +107 -0
  61. package/package.json +1 -1
@@ -0,0 +1,188 @@
1
+ import type { AccessType, CatalogElementType, HiddenInBrowse, CatalogElement, ICatalogSearchResult, ResourcePermission, ResourcePermissionItem, PermissionDescendType, PermissionType } from '../types';
2
+ /**
3
+ * 判断某个资源是否可访问。
4
+ * 参数:
5
+ * elementId - 资源ID
6
+ * type - 访问类型:
7
+ * 1.引用权限:REF
8
+ * 2.查看权限:READ
9
+ * 3.编辑权限:WRITE
10
+ * @param elementId 资源ID
11
+ * @param type 访问类型
12
+ * @returns 返回是否有权限的布尔值
13
+ */
14
+ export declare const isCatalogElementAccessible: (elementId: string, type: AccessType) => Promise<boolean>;
15
+ /**
16
+ * 获取资源树的顶层节点列表
17
+ * @returns 返回顶层节点列表,节点类型为CatalogElement
18
+ */
19
+ export declare const getRootElements: () => Promise<CatalogElement[]>;
20
+ /**
21
+ * 获得指定节点的子节点列表
22
+ * @param nodeId 指定节点ID
23
+ * @returns 返回子节点列表,节点类型为CatalogElement
24
+ */
25
+ export declare const getChildElements: (nodeId: string) => Promise<CatalogElement[]>;
26
+ /**
27
+ * 创建目录
28
+ * @param parentNodeId 父目录ID
29
+ * @param name 目录名称
30
+ * @param alias 目录别名
31
+ * @param desc 目录描述
32
+ * @param type 目录类型,此项可为空,系统会自动根据父目录的类型进行设置
33
+ * @param hiddenInBrowse 是否在浏览模块中隐藏此目录
34
+ * @returns 返回创建的目录对象,类型为CatalogElement
35
+ */
36
+ export declare const createFolder: (parentNodeId: string, name: string, alias: string, desc: string, type: CatalogElementType | string, hiddenInBrowse: HiddenInBrowse) => Promise<CatalogElement>;
37
+ /**
38
+ * 通过ID创建目录
39
+ * @param parentNodeId 父目录ID
40
+ * @param id 目录ID
41
+ * @param name 目录名称
42
+ * @param alias 目录别名
43
+ * @param desc 目录描述
44
+ * @param type 目录类型,此项可为空,系统会自动根据父目录的类型进行设置
45
+ * @param hiddenInBrowse 是否在浏览模块中隐藏此目录
46
+ * @returns 返回创建的目录对象,类型为CatalogElement
47
+ */
48
+ export declare const createFolderById: (parentNodeId: string, id: string, name: string, alias: string, desc: string, type: CatalogElementType | string, hiddenInBrowse: HiddenInBrowse) => Promise<CatalogElement>;
49
+ /**
50
+ * 通过ID访问资源
51
+ * @param elementId 资源ID
52
+ * @returns 返回资源对象,类型为CatalogElement
53
+ */
54
+ export declare const getCatalogElementById: (elementId: string) => Promise<CatalogElement>;
55
+ /**
56
+ * 通过类型获取结点
57
+ * @param type 节点类型
58
+ * @returns 返回指定类型的节点列表,节点类型为CatalogElement
59
+ */
60
+ export declare const getCatalogElementByType: (type: CatalogElementType | string) => Promise<CatalogElement[]>;
61
+ /**
62
+ * 获取目录下指定类型的子元素
63
+ * @param parentNodeId 父节点ID
64
+ * @param types 要获取的子元素类型数组
65
+ * @returns 返回指定类型的子元素列表,节点类型为CatalogElement
66
+ */
67
+ export declare const getChildElementsByTypes: (parentNodeId: string, types: (CatalogElementType | string)[]) => Promise<CatalogElement[]>;
68
+ /**
69
+ * 获取资源直接被授予的权限信息
70
+ * @param resId 资源ID
71
+ * @returns 返回资源直接被授予的权限信息,类型为ResourcePermission
72
+ */
73
+ export declare const getAssignedPermissions: (resId: string) => Promise<ResourcePermission>;
74
+ /**
75
+ * 获取资源继承的权限信息
76
+ * @param resId 资源ID
77
+ * @returns 返回资源继承的权限信息列表,类型为ResourcePermissionItem[]
78
+ */
79
+ export declare const getInheritedPermissions: (resId: string) => Promise<ResourcePermissionItem[]>;
80
+ /**
81
+ * 通过ID删除资源
82
+ * @param id 资源ID
83
+ * @returns 无返回值
84
+ */
85
+ export declare const deleteCatalogElement: (id: string) => Promise<void>;
86
+ /**
87
+ * 根据别名或名称模糊查询资源信息
88
+ * @param alias 别名或名称关键字
89
+ * @param purview "READ":"查看"; "WRITE":"编辑"; "REF":"引用"
90
+ * @returns 返回搜索结果列表,类型为ICatalogSearchResult[]
91
+ */
92
+ export declare const searchCatalogElementLikeAlias: (alias: string, purview: AccessType) => Promise<ICatalogSearchResult[]>;
93
+ /**
94
+ * 设置该资源的组权限
95
+ * @param elementId 资源ID
96
+ * @param groupId 组ID
97
+ * @param type 权限类型
98
+ * @param inherited 是否继承
99
+ * @param permissionDescendType 权限下降类型
100
+ * @param isGroupDescend 是否组下降
101
+ * @returns 无返回值
102
+ */
103
+ export declare const setAssignedPermissionByGroup: (elementId: string, groupId: string, type: PermissionType, inherited: boolean, permissionDescendType: PermissionDescendType, isGroupDescend: boolean) => Promise<void>;
104
+ /**
105
+ * 设置该资源的角色权限
106
+ * @param elementId 资源ID
107
+ * @param roleId 角色ID
108
+ * @param type 权限类型
109
+ * @param inherited 是否继承
110
+ * @param permissionDescendType 权限下降类型
111
+ * @returns 无返回值
112
+ */
113
+ export declare const setAssignedPermissionByRole: (elementId: string, roleId: string, type: PermissionType, inherited: boolean, permissionDescendType: PermissionDescendType) => Promise<void>;
114
+ /**
115
+ * 设置该资源的用户权限
116
+ * @param elementId 资源ID
117
+ * @param userId 用户ID
118
+ * @param type 权限类型
119
+ * @param inherited 是否继承
120
+ * @param permissionDescendType 权限下降类型
121
+ * @returns 无返回值
122
+ */
123
+ export declare const setAssignedPermissionByUser: (elementId: string, userId: string, type: PermissionType, inherited: boolean, permissionDescendType: PermissionDescendType) => Promise<void>;
124
+ /**
125
+ * 更换资源节点的图片
126
+ * @param id 资源ID
127
+ * @param image 图片路径或图片数据
128
+ * @returns 无返回值
129
+ */
130
+ export declare const updateCatalogElementImage: (id: string, image: string) => Promise<void>;
131
+ /**
132
+ * 根据ID修改资源信息
133
+ * @param id 资源ID
134
+ * @param jsonNodeConfig JSON节点配置 资源定义,json字符串,格式如下: "{\"alias\":\"复选框_报表2\",\"desc\":\"复选框_报表2\",\"deletedExtKeys\":\"hasChild,detectChild\",\"extended\":\"{'customImage':'Foldera.jpg','hiddenInBrowse':'false'}\"}" alias: 可选属性,别名 desc: 可选属性,描述 deletedExtKeys:可选属性,需要删除的扩展属性的key,参数内容可以不包含该属性 extended:可选属性,需要新增或修改的扩展属性内容,参数内容可以不包含该属性
135
+ * @param wholeExtended 完整的扩展内容,json字符串,格式如下:{"extended": "{\"hasChild\":\"false\",\"hiddenInBrowse\":\"false\"}"}。 该参数内容可为空。如不为空,扩展字段内容将全部替换为该参数内容,否则只对扩展属性进行增量添加。
136
+ * @returns 无返回值
137
+ */
138
+ export declare const updateCatalogNode: (id: string, jsonNodeConfig: string, wholeExtended: string) => Promise<void>;
139
+ /**
140
+ * 创建WEB链接
141
+ * @param parentFolderId 父文件夹ID
142
+ * @param urlName URL名称
143
+ * @param urlAlias URL别名
144
+ * @param urlDesc URL描述
145
+ * @param url URL地址
146
+ * @param setting 设置是否新窗口打开以及是否传递登录信息
147
+ * 设置在当前窗口打开设置如下: {"currentWindow":true}
148
+ * 设置在当前窗口打开并传递登录信息设置如下: {"currentWindow":true,"autoLogin":true}
149
+ * 如果此值设置为空,则系统会默认为在新窗口打开并不传递登录信息
150
+ * @returns 返回新创建的URL链接ID
151
+ */
152
+ export declare const createURLLink: (parentFolderId: string, urlName: string, urlAlias: string, urlDesc: string, url: string, setting: string) => Promise<string>;
153
+ /**
154
+ * 更新WEB链接
155
+ * @param urlID 结点ID
156
+ * @param urlAlias URL别名
157
+ * @param urlDesc URL描述
158
+ * @param url URL地址
159
+ * @param setting 设置是否新窗口打开以及是否传递登录信息
160
+ * 设置在当前窗口打开设置如下: {"currentWindow":true}
161
+ * 设置在当前窗口打开并传递登录信息设置如下: {"currentWindow":true,"autoLogin":true}
162
+ * 如果此值设置为空,则系统会默认为在新窗口打开并不传递登录信
163
+ * @returns 无返回值
164
+ */
165
+ export declare const updateURLLink: (urlID: string, urlAlias: string, urlDesc: string, url: string, setting: string) => Promise<void>;
166
+ /**
167
+ * 复制粘贴并返回新ID
168
+ * @param toId 目标ID
169
+ * @param srcId 源ID
170
+ * @param name 名称
171
+ * @param alias 别名
172
+ * @param desc 描述
173
+ * @returns 返回新创建元素的ID
174
+ */
175
+ export declare const copyAndPasteReturnNewId: (toId: string, srcId: string, name: string, alias: string, desc: string) => Promise<string>;
176
+ /**
177
+ * 创建资源树结点
178
+ * 注意:此方法是单纯新建一个树结点,调用此方法前,必须存在此结点类型的实体资源.
179
+ * @param parentId 父ID
180
+ * @param id ID
181
+ * @param name 名称
182
+ * @param alias 别名
183
+ * @param desc 描述
184
+ * @param order 顺序
185
+ * @param type 类型
186
+ * @returns 返回创建的资源节点,类型为CatalogElement
187
+ */
188
+ export declare const createCatalogElement: (parentId: string, id: string, name: string, alias: string, desc: string, order: number, type: CatalogElementType | string) => Promise<CatalogElement>;
@@ -0,0 +1,230 @@
1
+ import { smartbi } from "../index";
2
+ /**
3
+ * 判断某个资源是否可访问。
4
+ * 参数:
5
+ * elementId - 资源ID
6
+ * type - 访问类型:
7
+ * 1.引用权限:REF
8
+ * 2.查看权限:READ
9
+ * 3.编辑权限:WRITE
10
+ * @param elementId 资源ID
11
+ * @param type 访问类型
12
+ * @returns 返回是否有权限的布尔值
13
+ */
14
+ export const isCatalogElementAccessible = (elementId, type) => {
15
+ return smartbi('CatalogService', 'isCatalogElementAccessible', [elementId, type]);
16
+ };
17
+ /**
18
+ * 获取资源树的顶层节点列表
19
+ * @returns 返回顶层节点列表,节点类型为CatalogElement
20
+ */
21
+ export const getRootElements = () => {
22
+ return smartbi('CatalogService', 'getRootElements', []);
23
+ };
24
+ /**
25
+ * 获得指定节点的子节点列表
26
+ * @param nodeId 指定节点ID
27
+ * @returns 返回子节点列表,节点类型为CatalogElement
28
+ */
29
+ export const getChildElements = (nodeId) => {
30
+ return smartbi('CatalogService', 'getChildElements', [nodeId]);
31
+ };
32
+ /**
33
+ * 创建目录
34
+ * @param parentNodeId 父目录ID
35
+ * @param name 目录名称
36
+ * @param alias 目录别名
37
+ * @param desc 目录描述
38
+ * @param type 目录类型,此项可为空,系统会自动根据父目录的类型进行设置
39
+ * @param hiddenInBrowse 是否在浏览模块中隐藏此目录
40
+ * @returns 返回创建的目录对象,类型为CatalogElement
41
+ */
42
+ export const createFolder = (parentNodeId, name, alias, desc, type, hiddenInBrowse) => {
43
+ return smartbi('CatalogService', 'createFolder', [parentNodeId, name, alias, desc, type, hiddenInBrowse]);
44
+ };
45
+ /**
46
+ * 通过ID创建目录
47
+ * @param parentNodeId 父目录ID
48
+ * @param id 目录ID
49
+ * @param name 目录名称
50
+ * @param alias 目录别名
51
+ * @param desc 目录描述
52
+ * @param type 目录类型,此项可为空,系统会自动根据父目录的类型进行设置
53
+ * @param hiddenInBrowse 是否在浏览模块中隐藏此目录
54
+ * @returns 返回创建的目录对象,类型为CatalogElement
55
+ */
56
+ export const createFolderById = (parentNodeId, id, name, alias, desc, type, hiddenInBrowse) => {
57
+ return smartbi('CatalogService', 'createFolderById', [parentNodeId, id, name, alias, desc, type, hiddenInBrowse]);
58
+ };
59
+ /**
60
+ * 通过ID访问资源
61
+ * @param elementId 资源ID
62
+ * @returns 返回资源对象,类型为CatalogElement
63
+ */
64
+ export const getCatalogElementById = (elementId) => {
65
+ return smartbi('CatalogService', 'getCatalogElementById', [elementId]);
66
+ };
67
+ /**
68
+ * 通过类型获取结点
69
+ * @param type 节点类型
70
+ * @returns 返回指定类型的节点列表,节点类型为CatalogElement
71
+ */
72
+ export const getCatalogElementByType = (type) => {
73
+ return smartbi('CatalogService', 'getCatalogElementByType', [type]);
74
+ };
75
+ /**
76
+ * 获取目录下指定类型的子元素
77
+ * @param parentNodeId 父节点ID
78
+ * @param types 要获取的子元素类型数组
79
+ * @returns 返回指定类型的子元素列表,节点类型为CatalogElement
80
+ */
81
+ export const getChildElementsByTypes = (parentNodeId, types) => {
82
+ return smartbi('CatalogService', 'getChildElementsByTypes', [parentNodeId, types.toString()]);
83
+ };
84
+ /**
85
+ * 获取资源直接被授予的权限信息
86
+ * @param resId 资源ID
87
+ * @returns 返回资源直接被授予的权限信息,类型为ResourcePermission
88
+ */
89
+ export const getAssignedPermissions = (resId) => {
90
+ return smartbi('CatalogService', 'getAssignedPermissions', [resId]);
91
+ };
92
+ /**
93
+ * 获取资源继承的权限信息
94
+ * @param resId 资源ID
95
+ * @returns 返回资源继承的权限信息列表,类型为ResourcePermissionItem[]
96
+ */
97
+ export const getInheritedPermissions = (resId) => {
98
+ return smartbi('CatalogService', 'getInheritedPermissions', [resId]);
99
+ };
100
+ /**
101
+ * 通过ID删除资源
102
+ * @param id 资源ID
103
+ * @returns 无返回值
104
+ */
105
+ export const deleteCatalogElement = (id) => {
106
+ return smartbi('CatalogService', 'deleteCatalogElement', [id]);
107
+ };
108
+ /**
109
+ * 根据别名或名称模糊查询资源信息
110
+ * @param alias 别名或名称关键字
111
+ * @param purview "READ":"查看"; "WRITE":"编辑"; "REF":"引用"
112
+ * @returns 返回搜索结果列表,类型为ICatalogSearchResult[]
113
+ */
114
+ export const searchCatalogElementLikeAlias = (alias, purview) => {
115
+ return smartbi('CatalogService', 'searchCatalogElementLikeAlias', [alias, purview]);
116
+ };
117
+ /**
118
+ * 设置该资源的组权限
119
+ * @param elementId 资源ID
120
+ * @param groupId 组ID
121
+ * @param type 权限类型
122
+ * @param inherited 是否继承
123
+ * @param permissionDescendType 权限下降类型
124
+ * @param isGroupDescend 是否组下降
125
+ * @returns 无返回值
126
+ */
127
+ export const setAssignedPermissionByGroup = (elementId, groupId, type, inherited, permissionDescendType, isGroupDescend) => {
128
+ return smartbi('CatalogService', 'setAssignedPermissionByGroup', [elementId, groupId, type, inherited, permissionDescendType, isGroupDescend]);
129
+ };
130
+ /**
131
+ * 设置该资源的角色权限
132
+ * @param elementId 资源ID
133
+ * @param roleId 角色ID
134
+ * @param type 权限类型
135
+ * @param inherited 是否继承
136
+ * @param permissionDescendType 权限下降类型
137
+ * @returns 无返回值
138
+ */
139
+ export const setAssignedPermissionByRole = (elementId, roleId, type, inherited, permissionDescendType) => {
140
+ return smartbi('CatalogService', 'setAssignedPermissionByRole', [elementId, roleId, type, inherited, permissionDescendType]);
141
+ };
142
+ /**
143
+ * 设置该资源的用户权限
144
+ * @param elementId 资源ID
145
+ * @param userId 用户ID
146
+ * @param type 权限类型
147
+ * @param inherited 是否继承
148
+ * @param permissionDescendType 权限下降类型
149
+ * @returns 无返回值
150
+ */
151
+ export const setAssignedPermissionByUser = (elementId, userId, type, inherited, permissionDescendType) => {
152
+ return smartbi('CatalogService', 'setAssignedPermissionByUser', [elementId, userId, type, inherited, permissionDescendType]);
153
+ };
154
+ /**
155
+ * 更换资源节点的图片
156
+ * @param id 资源ID
157
+ * @param image 图片路径或图片数据
158
+ * @returns 无返回值
159
+ */
160
+ export const updateCatalogElementImage = (id, image) => {
161
+ return smartbi('CatalogService', 'updateCatalogElementImage', [id, image]);
162
+ };
163
+ /**
164
+ * 根据ID修改资源信息
165
+ * @param id 资源ID
166
+ * @param jsonNodeConfig JSON节点配置 资源定义,json字符串,格式如下: "{\"alias\":\"复选框_报表2\",\"desc\":\"复选框_报表2\",\"deletedExtKeys\":\"hasChild,detectChild\",\"extended\":\"{'customImage':'Foldera.jpg','hiddenInBrowse':'false'}\"}" alias: 可选属性,别名 desc: 可选属性,描述 deletedExtKeys:可选属性,需要删除的扩展属性的key,参数内容可以不包含该属性 extended:可选属性,需要新增或修改的扩展属性内容,参数内容可以不包含该属性
167
+ * @param wholeExtended 完整的扩展内容,json字符串,格式如下:{"extended": "{\"hasChild\":\"false\",\"hiddenInBrowse\":\"false\"}"}。 该参数内容可为空。如不为空,扩展字段内容将全部替换为该参数内容,否则只对扩展属性进行增量添加。
168
+ * @returns 无返回值
169
+ */
170
+ export const updateCatalogNode = (id, jsonNodeConfig, wholeExtended) => {
171
+ return smartbi('CatalogService', 'updateCatalogNode', [id, jsonNodeConfig, wholeExtended]);
172
+ };
173
+ /**
174
+ * 创建WEB链接
175
+ * @param parentFolderId 父文件夹ID
176
+ * @param urlName URL名称
177
+ * @param urlAlias URL别名
178
+ * @param urlDesc URL描述
179
+ * @param url URL地址
180
+ * @param setting 设置是否新窗口打开以及是否传递登录信息
181
+ * 设置在当前窗口打开设置如下: {"currentWindow":true}
182
+ * 设置在当前窗口打开并传递登录信息设置如下: {"currentWindow":true,"autoLogin":true}
183
+ * 如果此值设置为空,则系统会默认为在新窗口打开并不传递登录信息
184
+ * @returns 返回新创建的URL链接ID
185
+ */
186
+ export const createURLLink = (parentFolderId, urlName, urlAlias, urlDesc, url, setting) => {
187
+ return smartbi('CatalogService', 'createURLLink', [parentFolderId, urlName, urlAlias, urlDesc, url, setting]);
188
+ };
189
+ /**
190
+ * 更新WEB链接
191
+ * @param urlID 结点ID
192
+ * @param urlAlias URL别名
193
+ * @param urlDesc URL描述
194
+ * @param url URL地址
195
+ * @param setting 设置是否新窗口打开以及是否传递登录信息
196
+ * 设置在当前窗口打开设置如下: {"currentWindow":true}
197
+ * 设置在当前窗口打开并传递登录信息设置如下: {"currentWindow":true,"autoLogin":true}
198
+ * 如果此值设置为空,则系统会默认为在新窗口打开并不传递登录信
199
+ * @returns 无返回值
200
+ */
201
+ export const updateURLLink = (urlID, urlAlias, urlDesc, url, setting) => {
202
+ return smartbi('CatalogService', 'updateURLLink', [urlID, urlAlias, urlDesc, url, setting]);
203
+ };
204
+ /**
205
+ * 复制粘贴并返回新ID
206
+ * @param toId 目标ID
207
+ * @param srcId 源ID
208
+ * @param name 名称
209
+ * @param alias 别名
210
+ * @param desc 描述
211
+ * @returns 返回新创建元素的ID
212
+ */
213
+ export const copyAndPasteReturnNewId = (toId, srcId, name, alias, desc) => {
214
+ return smartbi('CatalogService', 'copyAndPasteReturnNewId', [toId, srcId, name, alias, desc]);
215
+ };
216
+ /**
217
+ * 创建资源树结点
218
+ * 注意:此方法是单纯新建一个树结点,调用此方法前,必须存在此结点类型的实体资源.
219
+ * @param parentId 父ID
220
+ * @param id ID
221
+ * @param name 名称
222
+ * @param alias 别名
223
+ * @param desc 描述
224
+ * @param order 顺序
225
+ * @param type 类型
226
+ * @returns 返回创建的资源节点,类型为CatalogElement
227
+ */
228
+ export const createCatalogElement = (parentId, id, name, alias, desc, order, type) => {
229
+ return smartbi('CatalogService', 'createCatalogElement', [parentId, id, name, alias, desc, order, type]);
230
+ };
@@ -0,0 +1,63 @@
1
+ import type { IClientCombinedReportView } from '../types';
2
+ /**
3
+ * 打开一个即席查询报表
4
+ * @param queryId 报表ID
5
+ * @returns 返回打开的报表视图,类型为IClientCombinedReportView
6
+ */
7
+ export declare const openQuery: (queryId: string) => Promise<IClientCombinedReportView>;
8
+ /**
9
+ * 打开一个即席查询报表(不初始化)
10
+ * @param queryId 报表ID
11
+ * @returns 返回打开的报表视图,类型为IClientCombinedReportView
12
+ */
13
+ export declare const openQueryWithoutInit: (queryId: string) => Promise<IClientCombinedReportView>;
14
+ /**
15
+ * 同步条件面板参数
16
+ * @param combinedClientId combinedClientId
17
+ * @param condPanelClientId condPanelClientId
18
+ * @returns 无返回值
19
+ */
20
+ export declare const updateConditionPanel: (combinedClientId: string, condPanelClientId: string) => Promise<void>;
21
+ /**
22
+ * 将报表信息从服务端的会话状态中清除
23
+ * @param combinedClientId 客户ID
24
+ * @returns 无返回值
25
+ */
26
+ export declare const removeFromSession: (combinedClientId: string) => Promise<void>;
27
+ /**
28
+ * 克隆查询
29
+ * @param clientId 客户端ID
30
+ * @param parentNodeId 父节点ID
31
+ * @param name 名称
32
+ * @param alias 别名
33
+ * @param desc 描述
34
+ * @returns 返回新客户端ID
35
+ */
36
+ export declare const cloneQuery: (clientId: string, parentNodeId: string, name: string, alias: string, desc: string) => Promise<string>;
37
+ /**
38
+ * 导出报表
39
+ * @param clientId 客户端ID
40
+ * @param reportId 报表ID
41
+ * @returns 无返回值
42
+ */
43
+ export declare const dump: (clientId: string, reportId: string) => Promise<void>;
44
+ /**
45
+ * 覆盖查询
46
+ * @param clientId 客户端ID
47
+ * @param replacedReportId 报表ID
48
+ * @param desc 描述
49
+ * @returns 返回true/false
50
+ */
51
+ export declare const overwriteQuery: (clientId: string, replacedReportId: string, desc: string) => Promise<boolean>;
52
+ /**
53
+ * 获取即席查询的数据来源类型
54
+ * @param queryId 即席查询id
55
+ * @returns 返回数据来源类型
56
+ */
57
+ export declare const getDataSourceType: (queryId: string) => Promise<string>;
58
+ /**
59
+ * 获取即席查询的类型
60
+ * @param reportId 即席查询id
61
+ * @returns 返回类型
62
+ */
63
+ export declare const getExtendedType: (reportId: string) => Promise<string>;
@@ -0,0 +1,82 @@
1
+ // ClientCombinedReportService 服务方法
2
+ import { smartbi } from "../index";
3
+ /**
4
+ * 打开一个即席查询报表
5
+ * @param queryId 报表ID
6
+ * @returns 返回打开的报表视图,类型为IClientCombinedReportView
7
+ */
8
+ export const openQuery = (queryId) => {
9
+ return smartbi('ClientCombinedReportService', 'openQuery', [queryId]);
10
+ };
11
+ /**
12
+ * 打开一个即席查询报表(不初始化)
13
+ * @param queryId 报表ID
14
+ * @returns 返回打开的报表视图,类型为IClientCombinedReportView
15
+ */
16
+ export const openQueryWithoutInit = (queryId) => {
17
+ return smartbi('ClientCombinedReportService', 'openQueryWithoutInit', [queryId]);
18
+ };
19
+ /**
20
+ * 同步条件面板参数
21
+ * @param combinedClientId combinedClientId
22
+ * @param condPanelClientId condPanelClientId
23
+ * @returns 无返回值
24
+ */
25
+ export const updateConditionPanel = (combinedClientId, condPanelClientId) => {
26
+ return smartbi('ClientCombinedReportService', 'updateConditionPanel', [combinedClientId, condPanelClientId]);
27
+ };
28
+ /**
29
+ * 将报表信息从服务端的会话状态中清除
30
+ * @param combinedClientId 客户ID
31
+ * @returns 无返回值
32
+ */
33
+ export const removeFromSession = (combinedClientId) => {
34
+ return smartbi('ClientCombinedReportService', 'removeFromSession', [combinedClientId]);
35
+ };
36
+ /**
37
+ * 克隆查询
38
+ * @param clientId 客户端ID
39
+ * @param parentNodeId 父节点ID
40
+ * @param name 名称
41
+ * @param alias 别名
42
+ * @param desc 描述
43
+ * @returns 返回新客户端ID
44
+ */
45
+ export const cloneQuery = (clientId, parentNodeId, name, alias, desc) => {
46
+ return smartbi('ClientCombinedReportService', 'cloneQuery', [clientId, parentNodeId, name, alias, desc]);
47
+ };
48
+ /**
49
+ * 导出报表
50
+ * @param clientId 客户端ID
51
+ * @param reportId 报表ID
52
+ * @returns 无返回值
53
+ */
54
+ export const dump = (clientId, reportId) => {
55
+ return smartbi('ClientCombinedReportService', 'dump', [clientId, reportId]);
56
+ };
57
+ /**
58
+ * 覆盖查询
59
+ * @param clientId 客户端ID
60
+ * @param replacedReportId 报表ID
61
+ * @param desc 描述
62
+ * @returns 返回true/false
63
+ */
64
+ export const overwriteQuery = (clientId, replacedReportId, desc) => {
65
+ return smartbi('ClientCombinedReportService', 'overwriteQuery', [clientId, replacedReportId, desc]);
66
+ };
67
+ /**
68
+ * 获取即席查询的数据来源类型
69
+ * @param queryId 即席查询id
70
+ * @returns 返回数据来源类型
71
+ */
72
+ export const getDataSourceType = (queryId) => {
73
+ return smartbi('ClientCombinedReportService', 'getDataSourceType', [queryId]);
74
+ };
75
+ /**
76
+ * 获取即席查询的类型
77
+ * @param reportId 即席查询id
78
+ * @returns 返回类型
79
+ */
80
+ export const getExtendedType = (reportId) => {
81
+ return smartbi('ClientCombinedReportService', 'getExtendedType', [reportId]);
82
+ };
@@ -0,0 +1,83 @@
1
+ import type { NameValuePair, ReportData, SystemConfig } from '../types';
2
+ /**
3
+ * 清空透视分析临时表
4
+ * @returns 无返回值
5
+ */
6
+ export declare const cleanTempTablePool: () => Promise<void>;
7
+ /**
8
+ * 打开透视分析
9
+ * @param reportId 报表Id
10
+ * @param pageId 页面Id
11
+ * @returns 返回JSON对象
12
+ */
13
+ export declare const openQuery: (reportId: string, pageId: string) => Promise<any>;
14
+ /**
15
+ * 获取参数备选值
16
+ * @param panelId 参数面板ClientId
17
+ * @param paramId 参数Id
18
+ * @returns 返回键值对列表
19
+ */
20
+ export declare const getParamStandbyValue: (panelId: string, paramId: string) => Promise<NameValuePair[]>;
21
+ /**
22
+ * 根据参数Id获取参数默认值
23
+ * @param panelId 参数面板ClientId
24
+ * @param paramId 参数Id
25
+ * @returns 返回JSON数组
26
+ */
27
+ export declare const getParamDefaultValueByPID: (panelId: string, paramId: string) => Promise<any[]>;
28
+ /**
29
+ * 设置参数值
30
+ * @param panelId 参数面板ClientId
31
+ * @param paramId 参数Id
32
+ * @param value 参数真实值
33
+ * @param displayValue 参数显示值
34
+ * @returns 无返回值
35
+ */
36
+ export declare const setParamValue: (panelId: string, paramId: string, value: string, displayValue: string) => Promise<void>;
37
+ /**
38
+ * 关闭透视分析
39
+ * @param clientId clientId
40
+ * @returns 无返回值
41
+ */
42
+ export declare const close: (clientId: string) => Promise<void>;
43
+ /**
44
+ * 创建透视分析
45
+ * @param businessViewId 业务查询ID
46
+ * @param name 名称
47
+ * @param alias 别名
48
+ * @param desc 描述
49
+ * @param folderId 保存目录的ID
50
+ * @returns 返回透视分析ID
51
+ */
52
+ export declare const createInsightQuery: (businessViewId: string, name: string, alias: string, desc: string, folderId: string) => Promise<string>;
53
+ /**
54
+ * 重新获取报表对象的当前状态
55
+ * @param clientId clientId
56
+ * @returns 返回查询结果JSON对象
57
+ */
58
+ export declare const getInsightQuery: (clientId: string) => Promise<any>;
59
+ /**
60
+ * 获取透视分析系统选项导出使用缓存默认值
61
+ * @returns 返回systemconfig
62
+ */
63
+ export declare const getExportWithCacheConfig: () => Promise<SystemConfig>;
64
+ /**
65
+ * 获取原始报表数据
66
+ * @param clientId 客户端ID
67
+ * @param pageNum 页码
68
+ * @returns 返回原始报表数据
69
+ */
70
+ export declare const getRawReportData: (clientId: string, pageNum: number) => Promise<ReportData>;
71
+ /**
72
+ * 取得一个表达式的值
73
+ * @param clientId 客户ID
74
+ * @param func 表达式
75
+ * @returns 返回表达式的值
76
+ */
77
+ export declare const getFunctionValue: (clientId: string, func: string) => Promise<string>;
78
+ /**
79
+ * 取得clientConfig
80
+ * @param clientId 客户ID
81
+ * @returns 返回clientConfig
82
+ */
83
+ export declare const getClientConfig: (clientId: string) => Promise<string>;