@gooddata/sdk-ui 8.10.0-alpha.4 → 8.10.0-alpha.42

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 (294) hide show
  1. package/dist/base/errors/GoodDataSdkError.d.ts +4 -1
  2. package/dist/base/errors/GoodDataSdkError.d.ts.map +1 -1
  3. package/dist/base/errors/GoodDataSdkError.js +5 -2
  4. package/dist/base/errors/GoodDataSdkError.js.map +1 -1
  5. package/dist/base/errors/errorHandling.d.ts +5 -3
  6. package/dist/base/errors/errorHandling.d.ts.map +1 -1
  7. package/dist/base/errors/errorHandling.js +6 -4
  8. package/dist/base/errors/errorHandling.js.map +1 -1
  9. package/dist/base/headerMatching/HeaderPredicate.d.ts +5 -1
  10. package/dist/base/headerMatching/HeaderPredicate.d.ts.map +1 -1
  11. package/dist/base/headerMatching/HeaderPredicate.js.map +1 -1
  12. package/dist/base/headerMatching/HeaderPredicateFactory.d.ts +1 -0
  13. package/dist/base/headerMatching/HeaderPredicateFactory.d.ts.map +1 -1
  14. package/dist/base/headerMatching/HeaderPredicateFactory.js +1 -0
  15. package/dist/base/headerMatching/HeaderPredicateFactory.js.map +1 -1
  16. package/dist/base/headerMatching/MappingHeader.d.ts +2 -0
  17. package/dist/base/headerMatching/MappingHeader.d.ts.map +1 -1
  18. package/dist/base/headerMatching/MappingHeader.js +1 -1
  19. package/dist/base/headerMatching/MappingHeader.js.map +1 -1
  20. package/dist/base/helpers/CatalogHelper.d.ts +5 -3
  21. package/dist/base/helpers/CatalogHelper.d.ts.map +1 -1
  22. package/dist/base/helpers/CatalogHelper.js +5 -3
  23. package/dist/base/helpers/CatalogHelper.js.map +1 -1
  24. package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts +4 -0
  25. package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts.map +1 -1
  26. package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js +2 -0
  27. package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js.map +1 -1
  28. package/dist/base/localization/bundles/de-DE.json +12 -1
  29. package/dist/base/localization/bundles/en-US.json +29 -9
  30. package/dist/base/localization/bundles/es-ES.json +12 -1
  31. package/dist/base/localization/bundles/fr-FR.json +12 -1
  32. package/dist/base/localization/bundles/ja-JP.json +12 -1
  33. package/dist/base/localization/bundles/nl-NL.json +12 -1
  34. package/dist/base/localization/bundles/pt-BR.json +12 -1
  35. package/dist/base/localization/bundles/pt-PT.json +12 -1
  36. package/dist/base/localization/bundles/ru-RU.json +12 -1
  37. package/dist/base/localization/bundles/zh-Hans.json +12 -1
  38. package/dist/base/react/BackendContext.d.ts +4 -0
  39. package/dist/base/react/BackendContext.d.ts.map +1 -1
  40. package/dist/base/react/BackendContext.js +5 -1
  41. package/dist/base/react/BackendContext.js.map +1 -1
  42. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts +4 -1
  43. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts.map +1 -1
  44. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js +1 -1
  45. package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js.map +1 -1
  46. package/dist/base/react/ErrorComponent.d.ts +4 -2
  47. package/dist/base/react/ErrorComponent.d.ts.map +1 -1
  48. package/dist/base/react/ErrorComponent.js +5 -3
  49. package/dist/base/react/ErrorComponent.js.map +1 -1
  50. package/dist/base/react/LoadingComponent.d.ts +4 -2
  51. package/dist/base/react/LoadingComponent.d.ts.map +1 -1
  52. package/dist/base/react/LoadingComponent.js +5 -3
  53. package/dist/base/react/LoadingComponent.js.map +1 -1
  54. package/dist/base/react/WorkspaceContext.d.ts +4 -0
  55. package/dist/base/react/WorkspaceContext.d.ts.map +1 -1
  56. package/dist/base/react/WorkspaceContext.js +5 -1
  57. package/dist/base/react/WorkspaceContext.js.map +1 -1
  58. package/dist/base/react/placeholders/base.d.ts +75 -41
  59. package/dist/base/react/placeholders/base.d.ts.map +1 -1
  60. package/dist/base/react/placeholders/base.js +1 -1
  61. package/dist/base/react/placeholders/base.js.map +1 -1
  62. package/dist/base/react/placeholders/factory.d.ts +4 -2
  63. package/dist/base/react/placeholders/factory.d.ts.map +1 -1
  64. package/dist/base/react/placeholders/factory.js +1 -1
  65. package/dist/base/react/placeholders/factory.js.map +1 -1
  66. package/dist/base/react/placeholders/hooks.d.ts +8 -0
  67. package/dist/base/react/placeholders/hooks.d.ts.map +1 -1
  68. package/dist/base/react/placeholders/hooks.js +9 -1
  69. package/dist/base/react/placeholders/hooks.js.map +1 -1
  70. package/dist/base/react/useCancelablePromise.d.ts +17 -11
  71. package/dist/base/react/useCancelablePromise.d.ts.map +1 -1
  72. package/dist/base/react/useCancelablePromise.js +9 -3
  73. package/dist/base/react/useCancelablePromise.js.map +1 -1
  74. package/dist/base/react/useCancelablePromiseUtils.d.ts +4 -2
  75. package/dist/base/react/useCancelablePromiseUtils.d.ts.map +1 -1
  76. package/dist/base/react/useCancelablePromiseUtils.js +5 -3
  77. package/dist/base/react/useCancelablePromiseUtils.js.map +1 -1
  78. package/dist/base/results/dataAccess.d.ts +29 -8
  79. package/dist/base/results/dataAccess.d.ts.map +1 -1
  80. package/dist/base/results/dataAccessConfig.d.ts +4 -1
  81. package/dist/base/results/dataAccessConfig.d.ts.map +1 -1
  82. package/dist/base/results/dataAccessConfig.js +4 -1
  83. package/dist/base/results/dataAccessConfig.js.map +1 -1
  84. package/dist/base/results/facade.d.ts +8 -2
  85. package/dist/base/results/facade.d.ts.map +1 -1
  86. package/dist/base/results/facade.js +9 -3
  87. package/dist/base/results/facade.js.map +1 -1
  88. package/dist/base/results/internal/definitionMethods.d.ts +1 -1
  89. package/dist/base/results/internal/definitionMethods.js +1 -1
  90. package/dist/base/results/internal/resultDataMethods.d.ts +1 -1
  91. package/dist/base/results/internal/resultMetaMethods.d.ts +1 -1
  92. package/dist/base/results/internal/resultMetaMethods.js +1 -1
  93. package/dist/base/vis/DrillEvents.d.ts +2 -0
  94. package/dist/base/vis/DrillEvents.d.ts.map +1 -1
  95. package/dist/base/vis/DrillEvents.js.map +1 -1
  96. package/dist/base/vis/VisualizationProps.d.ts +11 -4
  97. package/dist/base/vis/VisualizationProps.d.ts.map +1 -1
  98. package/dist/base/vis/VisualizationProps.js +1 -1
  99. package/dist/execution/Execute.d.ts +34 -18
  100. package/dist/execution/Execute.d.ts.map +1 -1
  101. package/dist/execution/Execute.js +6 -4
  102. package/dist/execution/Execute.js.map +1 -1
  103. package/dist/execution/ExecuteInsight.d.ts +47 -16
  104. package/dist/execution/ExecuteInsight.d.ts.map +1 -1
  105. package/dist/execution/ExecuteInsight.js +7 -5
  106. package/dist/execution/ExecuteInsight.js.map +1 -1
  107. package/dist/execution/RawExecute.d.ts +19 -7
  108. package/dist/execution/RawExecute.d.ts.map +1 -1
  109. package/dist/execution/RawExecute.js +2 -1
  110. package/dist/execution/RawExecute.js.map +1 -1
  111. package/dist/execution/createExecution.d.ts +8 -5
  112. package/dist/execution/createExecution.d.ts.map +1 -1
  113. package/dist/execution/createExecution.js +3 -5
  114. package/dist/execution/createExecution.js.map +1 -1
  115. package/dist/execution/useDataExport.d.ts +5 -3
  116. package/dist/execution/useDataExport.d.ts.map +1 -1
  117. package/dist/execution/useDataExport.js +3 -1
  118. package/dist/execution/useDataExport.js.map +1 -1
  119. package/dist/execution/useDataView.d.ts +5 -0
  120. package/dist/execution/useDataView.d.ts.map +1 -1
  121. package/dist/execution/useDataView.js +3 -0
  122. package/dist/execution/useDataView.js.map +1 -1
  123. package/dist/execution/useExecution.d.ts +16 -8
  124. package/dist/execution/useExecution.d.ts.map +1 -1
  125. package/dist/execution/useExecution.js +3 -0
  126. package/dist/execution/useExecution.js.map +1 -1
  127. package/dist/execution/useExecutionDataView.d.ts +18 -12
  128. package/dist/execution/useExecutionDataView.d.ts.map +1 -1
  129. package/dist/execution/useExecutionDataView.js +1 -1
  130. package/dist/execution/useExecutionDataView.js.map +1 -1
  131. package/dist/execution/useInsightDataView.d.ts +29 -7
  132. package/dist/execution/useInsightDataView.d.ts.map +1 -1
  133. package/dist/execution/useInsightDataView.js +5 -4
  134. package/dist/execution/useInsightDataView.js.map +1 -1
  135. package/dist/execution/withExecution.d.ts +5 -4
  136. package/dist/execution/withExecution.d.ts.map +1 -1
  137. package/dist/execution/withExecution.js +1 -1
  138. package/dist/execution/withExecution.js.map +1 -1
  139. package/dist/execution/withExecutionLoading.d.ts +12 -7
  140. package/dist/execution/withExecutionLoading.d.ts.map +1 -1
  141. package/dist/execution/withExecutionLoading.js +1 -1
  142. package/dist/execution/withExecutionLoading.js.map +1 -1
  143. package/dist/kpi/Kpi.d.ts +13 -9
  144. package/dist/kpi/Kpi.d.ts.map +1 -1
  145. package/dist/kpi/Kpi.js +5 -3
  146. package/dist/kpi/Kpi.js.map +1 -1
  147. package/dist/sdk-ui.d.ts +414 -178
  148. package/esm/base/errors/GoodDataSdkError.d.ts +4 -1
  149. package/esm/base/errors/GoodDataSdkError.d.ts.map +1 -1
  150. package/esm/base/errors/GoodDataSdkError.js +5 -2
  151. package/esm/base/errors/GoodDataSdkError.js.map +1 -1
  152. package/esm/base/errors/errorHandling.d.ts +5 -3
  153. package/esm/base/errors/errorHandling.d.ts.map +1 -1
  154. package/esm/base/errors/errorHandling.js +6 -4
  155. package/esm/base/errors/errorHandling.js.map +1 -1
  156. package/esm/base/headerMatching/HeaderPredicate.d.ts +5 -1
  157. package/esm/base/headerMatching/HeaderPredicate.d.ts.map +1 -1
  158. package/esm/base/headerMatching/HeaderPredicate.js.map +1 -1
  159. package/esm/base/headerMatching/HeaderPredicateFactory.d.ts +1 -0
  160. package/esm/base/headerMatching/HeaderPredicateFactory.d.ts.map +1 -1
  161. package/esm/base/headerMatching/HeaderPredicateFactory.js +1 -0
  162. package/esm/base/headerMatching/HeaderPredicateFactory.js.map +1 -1
  163. package/esm/base/headerMatching/MappingHeader.d.ts +2 -0
  164. package/esm/base/headerMatching/MappingHeader.d.ts.map +1 -1
  165. package/esm/base/headerMatching/MappingHeader.js +1 -1
  166. package/esm/base/headerMatching/MappingHeader.js.map +1 -1
  167. package/esm/base/helpers/CatalogHelper.d.ts +5 -3
  168. package/esm/base/helpers/CatalogHelper.d.ts.map +1 -1
  169. package/esm/base/helpers/CatalogHelper.js +5 -3
  170. package/esm/base/helpers/CatalogHelper.js.map +1 -1
  171. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts +4 -0
  172. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts.map +1 -1
  173. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js +2 -0
  174. package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js.map +1 -1
  175. package/esm/base/localization/bundles/de-DE.json +12 -1
  176. package/esm/base/localization/bundles/en-US.json +29 -9
  177. package/esm/base/localization/bundles/es-ES.json +12 -1
  178. package/esm/base/localization/bundles/fr-FR.json +12 -1
  179. package/esm/base/localization/bundles/ja-JP.json +12 -1
  180. package/esm/base/localization/bundles/nl-NL.json +12 -1
  181. package/esm/base/localization/bundles/pt-BR.json +12 -1
  182. package/esm/base/localization/bundles/pt-PT.json +12 -1
  183. package/esm/base/localization/bundles/ru-RU.json +12 -1
  184. package/esm/base/localization/bundles/zh-Hans.json +12 -1
  185. package/esm/base/react/BackendContext.d.ts +4 -0
  186. package/esm/base/react/BackendContext.d.ts.map +1 -1
  187. package/esm/base/react/BackendContext.js +5 -1
  188. package/esm/base/react/BackendContext.js.map +1 -1
  189. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts +4 -1
  190. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts.map +1 -1
  191. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js +1 -1
  192. package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js.map +1 -1
  193. package/esm/base/react/ErrorComponent.d.ts +4 -2
  194. package/esm/base/react/ErrorComponent.d.ts.map +1 -1
  195. package/esm/base/react/ErrorComponent.js +5 -3
  196. package/esm/base/react/ErrorComponent.js.map +1 -1
  197. package/esm/base/react/LoadingComponent.d.ts +4 -2
  198. package/esm/base/react/LoadingComponent.d.ts.map +1 -1
  199. package/esm/base/react/LoadingComponent.js +5 -3
  200. package/esm/base/react/LoadingComponent.js.map +1 -1
  201. package/esm/base/react/WorkspaceContext.d.ts +4 -0
  202. package/esm/base/react/WorkspaceContext.d.ts.map +1 -1
  203. package/esm/base/react/WorkspaceContext.js +5 -1
  204. package/esm/base/react/WorkspaceContext.js.map +1 -1
  205. package/esm/base/react/placeholders/base.d.ts +75 -41
  206. package/esm/base/react/placeholders/base.d.ts.map +1 -1
  207. package/esm/base/react/placeholders/base.js +1 -1
  208. package/esm/base/react/placeholders/base.js.map +1 -1
  209. package/esm/base/react/placeholders/factory.d.ts +4 -2
  210. package/esm/base/react/placeholders/factory.d.ts.map +1 -1
  211. package/esm/base/react/placeholders/factory.js +1 -1
  212. package/esm/base/react/placeholders/factory.js.map +1 -1
  213. package/esm/base/react/placeholders/hooks.d.ts +8 -0
  214. package/esm/base/react/placeholders/hooks.d.ts.map +1 -1
  215. package/esm/base/react/placeholders/hooks.js +9 -1
  216. package/esm/base/react/placeholders/hooks.js.map +1 -1
  217. package/esm/base/react/useCancelablePromise.d.ts +17 -11
  218. package/esm/base/react/useCancelablePromise.d.ts.map +1 -1
  219. package/esm/base/react/useCancelablePromise.js +9 -3
  220. package/esm/base/react/useCancelablePromise.js.map +1 -1
  221. package/esm/base/react/useCancelablePromiseUtils.d.ts +4 -2
  222. package/esm/base/react/useCancelablePromiseUtils.d.ts.map +1 -1
  223. package/esm/base/react/useCancelablePromiseUtils.js +5 -3
  224. package/esm/base/react/useCancelablePromiseUtils.js.map +1 -1
  225. package/esm/base/results/dataAccess.d.ts +29 -8
  226. package/esm/base/results/dataAccess.d.ts.map +1 -1
  227. package/esm/base/results/dataAccessConfig.d.ts +4 -1
  228. package/esm/base/results/dataAccessConfig.d.ts.map +1 -1
  229. package/esm/base/results/dataAccessConfig.js +4 -1
  230. package/esm/base/results/dataAccessConfig.js.map +1 -1
  231. package/esm/base/results/facade.d.ts +8 -2
  232. package/esm/base/results/facade.d.ts.map +1 -1
  233. package/esm/base/results/facade.js +9 -3
  234. package/esm/base/results/facade.js.map +1 -1
  235. package/esm/base/results/internal/definitionMethods.d.ts +1 -1
  236. package/esm/base/results/internal/definitionMethods.js +1 -1
  237. package/esm/base/results/internal/resultDataMethods.d.ts +1 -1
  238. package/esm/base/results/internal/resultMetaMethods.d.ts +1 -1
  239. package/esm/base/results/internal/resultMetaMethods.js +1 -1
  240. package/esm/base/vis/DrillEvents.d.ts +2 -0
  241. package/esm/base/vis/DrillEvents.d.ts.map +1 -1
  242. package/esm/base/vis/DrillEvents.js.map +1 -1
  243. package/esm/base/vis/VisualizationProps.d.ts +11 -4
  244. package/esm/base/vis/VisualizationProps.d.ts.map +1 -1
  245. package/esm/base/vis/VisualizationProps.js +1 -1
  246. package/esm/execution/Execute.d.ts +34 -18
  247. package/esm/execution/Execute.d.ts.map +1 -1
  248. package/esm/execution/Execute.js +6 -4
  249. package/esm/execution/Execute.js.map +1 -1
  250. package/esm/execution/ExecuteInsight.d.ts +47 -16
  251. package/esm/execution/ExecuteInsight.d.ts.map +1 -1
  252. package/esm/execution/ExecuteInsight.js +7 -5
  253. package/esm/execution/ExecuteInsight.js.map +1 -1
  254. package/esm/execution/RawExecute.d.ts +19 -7
  255. package/esm/execution/RawExecute.d.ts.map +1 -1
  256. package/esm/execution/RawExecute.js +2 -1
  257. package/esm/execution/RawExecute.js.map +1 -1
  258. package/esm/execution/createExecution.d.ts +8 -5
  259. package/esm/execution/createExecution.d.ts.map +1 -1
  260. package/esm/execution/createExecution.js +4 -6
  261. package/esm/execution/createExecution.js.map +1 -1
  262. package/esm/execution/useDataExport.d.ts +5 -3
  263. package/esm/execution/useDataExport.d.ts.map +1 -1
  264. package/esm/execution/useDataExport.js +3 -1
  265. package/esm/execution/useDataExport.js.map +1 -1
  266. package/esm/execution/useDataView.d.ts +5 -0
  267. package/esm/execution/useDataView.d.ts.map +1 -1
  268. package/esm/execution/useDataView.js +3 -0
  269. package/esm/execution/useDataView.js.map +1 -1
  270. package/esm/execution/useExecution.d.ts +16 -8
  271. package/esm/execution/useExecution.d.ts.map +1 -1
  272. package/esm/execution/useExecution.js +3 -0
  273. package/esm/execution/useExecution.js.map +1 -1
  274. package/esm/execution/useExecutionDataView.d.ts +18 -12
  275. package/esm/execution/useExecutionDataView.d.ts.map +1 -1
  276. package/esm/execution/useExecutionDataView.js +1 -1
  277. package/esm/execution/useExecutionDataView.js.map +1 -1
  278. package/esm/execution/useInsightDataView.d.ts +29 -7
  279. package/esm/execution/useInsightDataView.d.ts.map +1 -1
  280. package/esm/execution/useInsightDataView.js +5 -4
  281. package/esm/execution/useInsightDataView.js.map +1 -1
  282. package/esm/execution/withExecution.d.ts +5 -4
  283. package/esm/execution/withExecution.d.ts.map +1 -1
  284. package/esm/execution/withExecution.js +1 -1
  285. package/esm/execution/withExecution.js.map +1 -1
  286. package/esm/execution/withExecutionLoading.d.ts +12 -7
  287. package/esm/execution/withExecutionLoading.d.ts.map +1 -1
  288. package/esm/execution/withExecutionLoading.js +1 -1
  289. package/esm/execution/withExecutionLoading.js.map +1 -1
  290. package/esm/kpi/Kpi.d.ts +13 -9
  291. package/esm/kpi/Kpi.d.ts.map +1 -1
  292. package/esm/kpi/Kpi.js +5 -3
  293. package/esm/kpi/Kpi.js.map +1 -1
  294. package/package.json +7 -7
@@ -2,7 +2,7 @@ import { IAttribute, IBucket, IExecutionDefinition, IMeasure } from "@gooddata/s
2
2
  /**
3
3
  * Methods to work with execution definition.
4
4
  *
5
- * @alpha
5
+ * @public
6
6
  */
7
7
  export interface IExecutionDefinitionMethods {
8
8
  /**
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.newExecutionDefinitonMethods = void 0;
4
4
  var tslib_1 = require("tslib");
5
- // (C) 2019-2021 GoodData Corporation
5
+ // (C) 2019-2022 GoodData Corporation
6
6
  var sdk_model_1 = require("@gooddata/sdk-model");
7
7
  var findIndex_1 = tslib_1.__importDefault(require("lodash/findIndex"));
8
8
  function buildBucketIndex(definition) {
@@ -2,7 +2,7 @@ import { DataValue, IDataView } from "@gooddata/sdk-backend-spi";
2
2
  /**
3
3
  * Methods to access data and totals in a result.
4
4
  *
5
- * @alpha
5
+ * @public
6
6
  */
7
7
  export interface IResultDataMethods {
8
8
  /**
@@ -3,7 +3,7 @@ import { ISortItem } from "@gooddata/sdk-model";
3
3
  /**
4
4
  * Methods to access result metadata - dimension descriptors and result headers.
5
5
  *
6
- * @alpha
6
+ * @public
7
7
  */
8
8
  export interface IResultMetaMethods {
9
9
  /**
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.newResultMetaMethods = void 0;
4
4
  var tslib_1 = require("tslib");
5
- // (C) 2019-2021 GoodData Corporation
5
+ // (C) 2019-2022 GoodData Corporation
6
6
  var flatMap_1 = tslib_1.__importDefault(require("lodash/flatMap"));
7
7
  var sdk_backend_spi_1 = require("@gooddata/sdk-backend-spi");
8
8
  var sdk_model_1 = require("@gooddata/sdk-model");
@@ -3,6 +3,8 @@ import { ChartElementType, ChartType, HeadlineElementType, HeadlineType, TableEl
3
3
  import { IHeaderPredicate } from "../headerMatching/HeaderPredicate";
4
4
  /**
5
5
  * Drillable item reference or predicate that enables insight / kpi drilling if it matches some attribute or measure of the insight / kpi.
6
+ *
7
+ * @remarks
6
8
  * You can use {@link @gooddata/sdk-ui#HeaderPredicates} factory functions to create predicates,
7
9
  * or specify reference to the identifier / uri of the target attribute / measure using {@link @gooddata/sdk-ui#IDrillableItem} definition.
8
10
  *
@@ -1 +1 @@
1
- {"version":3,"file":"DrillEvents.d.ts","sourceRoot":"","sources":["../../../src/base/vis/DrillEvents.ts"],"names":[],"mappings":"AACA,OAAO,EACH,oBAAoB,EACpB,SAAS,EACT,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EACnB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACH,gBAAgB,EAChB,SAAS,EACT,mBAAmB,EACnB,YAAY,EACZ,gBAAgB,EAChB,SAAS,EACT,cAAc,EACd,OAAO,EACP,QAAQ,EACX,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,gBAAgB,EAAqB,MAAM,mCAAmC,CAAC;AAExF;;;;;;GAMG;AACH,oBAAY,aAAa,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE9D;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,aAAa,CAElE;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,oBAAY,cAAc,GACpB,iBAAiB,GACjB,wBAAwB,GACxB,CAAC,iBAAiB,GAAG,wBAAwB,CAAC,CAAC;AAErD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,iBAAiB,CAE3E;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,wBAAwB,CAEzF;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,cAAc,CAErE;AAED;;GAEG;AACH,oBAAY,mBAAmB,GAAG,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GAAG,OAAO,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,oBAAoB,EAAE,sBAAsB;CAAG;AAExG;;GAEG;AACH,wBAAgB,gCAAgC,CAC5C,MAAM,EAAE,mCAAmC,GAC5C,MAAM,IAAI,+BAA+B,CAE3C;AAED;;GAEG;AACH,oBAAY,mCAAmC,GACzC,oBAAoB,GACpB,kBAAkB,GAClB,gBAAgB,GAChB,+BAA+B,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC3C,MAAM,EAAE,mCAAmC,CAAC;CAC/C;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,GAAG,EAAE,CAAC;IACX,YAAY,EAAE,8BAA8B,EAAE,CAAC;CAClD;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,8BAA8B,EAAE,CAAC;CAClD;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,mBAAmB,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,8BAA8B,EAAE,CAAC;CAClD;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,gBAAgB,CAAC,EAAE,SAAS,CAAC;IAC7B,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,8BAA8B,EAAE,CAAC;CAClD;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IACxB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,YAAY,EAAE,8BAA8B,EAAE,CAAC;IAC/C,IAAI,CAAC,EAAE,SAAS,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACpC,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,MAAM,EAAE,WAAW,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,cAAc,CAAC;IACxB,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IAGf,YAAY,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAEhD,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,QAAQ,EAAE,SAAS,CAAC;IACpB,YAAY,EAAE,kBAAkB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,GAAG,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC,IAAI,EAAE,qBAAqB,CAAC;CAC/B;AAED;;GAEG;AACH,oBAAY,iBAAiB,GAAG,mBAAmB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,QAAQ,EAAE,SAAS,CAAC;IACpB,OAAO,EAAE,iBAAiB,CAAC;CAC9B"}
1
+ {"version":3,"file":"DrillEvents.d.ts","sourceRoot":"","sources":["../../../src/base/vis/DrillEvents.ts"],"names":[],"mappings":"AACA,OAAO,EACH,oBAAoB,EACpB,SAAS,EACT,kBAAkB,EAClB,sBAAsB,EACtB,gBAAgB,EACnB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EACH,gBAAgB,EAChB,SAAS,EACT,mBAAmB,EACnB,YAAY,EACZ,gBAAgB,EAChB,SAAS,EACT,cAAc,EACd,OAAO,EACP,QAAQ,EACX,MAAM,sBAAsB,CAAC;AAE9B,OAAO,EAAE,gBAAgB,EAAqB,MAAM,mCAAmC,CAAC;AAExF;;;;;;;;GAQG;AACH,oBAAY,aAAa,GAAG,cAAc,GAAG,gBAAgB,CAAC;AAE9D;;GAEG;AACH,wBAAgB,eAAe,CAAC,GAAG,EAAE,OAAO,GAAG,GAAG,IAAI,aAAa,CAElE;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAC9B,GAAG,EAAE,MAAM,CAAC;CACf;AAED;;GAEG;AACH,MAAM,WAAW,wBAAwB;IACrC,UAAU,EAAE,MAAM,CAAC;CACtB;AAED;;GAEG;AACH,oBAAY,cAAc,GACpB,iBAAiB,GACjB,wBAAwB,GACxB,CAAC,iBAAiB,GAAG,wBAAwB,CAAC,CAAC;AAErD;;GAEG;AACH,wBAAgB,kBAAkB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,iBAAiB,CAE3E;AAED;;GAEG;AACH,wBAAgB,yBAAyB,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,wBAAwB,CAEzF;AAED;;GAEG;AACH,wBAAgB,eAAe,CAAC,IAAI,EAAE,OAAO,GAAG,IAAI,IAAI,cAAc,CAErE;AAED;;GAEG;AACH,oBAAY,mBAAmB,GAAG,CAAC,KAAK,EAAE,WAAW,KAAK,IAAI,GAAG,OAAO,CAAC;AAEzE;;GAEG;AACH,MAAM,WAAW,+BAAgC,SAAQ,oBAAoB,EAAE,sBAAsB;CAAG;AAExG;;GAEG;AACH,wBAAgB,gCAAgC,CAC5C,MAAM,EAAE,mCAAmC,GAC5C,MAAM,IAAI,+BAA+B,CAE3C;AAED;;GAEG;AACH,oBAAY,mCAAmC,GACzC,oBAAoB,GACpB,kBAAkB,GAClB,gBAAgB,GAChB,+BAA+B,CAAC;AAEtC;;GAEG;AACH,MAAM,WAAW,8BAA8B;IAC3C,MAAM,EAAE,mCAAmC,CAAC;CAC/C;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,WAAW,EAAE,MAAM,CAAC;IACpB,QAAQ,EAAE,MAAM,CAAC;IACjB,GAAG,EAAE,GAAG,EAAE,CAAC;IACX,YAAY,EAAE,8BAA8B,EAAE,CAAC;CAClD;AAED;;;;GAIG;AACH,MAAM,WAAW,0BAA0B;IACvC,IAAI,EAAE,YAAY,CAAC;IACnB,OAAO,EAAE,mBAAmB,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,8BAA8B,EAAE,CAAC;CAClD;AAED;;;;GAIG;AACH,MAAM,WAAW,sBAAsB;IACnC,IAAI,EAAE,QAAQ,CAAC;IACf,OAAO,EAAE,mBAAmB,CAAC;IAC7B,KAAK,EAAE,MAAM,CAAC;IACd,YAAY,EAAE,8BAA8B,EAAE,CAAC;CAClD;AAED;;;;GAIG;AACH,MAAM,WAAW,uBAAuB;IACpC,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,gBAAgB,CAAC,EAAE,SAAS,CAAC;IAC7B,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,KAAK,CAAC,EAAE,MAAM,CAAC;IACf,YAAY,EAAE,8BAA8B,EAAE,CAAC;CAClD;AAED;;;;GAIG;AACH,MAAM,WAAW,WAAW;IACxB,CAAC,EAAE,MAAM,CAAC;IACV,CAAC,EAAE,MAAM,CAAC;IACV,YAAY,EAAE,8BAA8B,EAAE,CAAC;IAC/C,IAAI,CAAC,EAAE,SAAS,CAAC;CACpB;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACpC,IAAI,EAAE,SAAS,CAAC;IAChB,OAAO,EAAE,gBAAgB,CAAC;IAC1B,MAAM,EAAE,WAAW,EAAE,CAAC;CACzB;AAED;;;GAGG;AACH,MAAM,WAAW,kBAAkB;IAC/B,IAAI,EAAE,OAAO,CAAC;IACd,OAAO,EAAE,cAAc,CAAC;IACxB,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,CAAC,CAAC,EAAE,MAAM,CAAC;IACX,WAAW,CAAC,EAAE,MAAM,CAAC;IACrB,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,GAAG,CAAC,EAAE,GAAG,EAAE,CAAC;IACZ,KAAK,CAAC,EAAE,MAAM,CAAC;IAGf,YAAY,CAAC,EAAE,8BAA8B,EAAE,CAAC;IAEhD,MAAM,CAAC,EAAE,WAAW,EAAE,CAAC;CAC1B;AAED;;GAEG;AACH,MAAM,WAAW,WAAW;IACxB,QAAQ,EAAE,SAAS,CAAC;IACpB,YAAY,EAAE,kBAAkB,CAAC;CACpC;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IAClC,MAAM,EAAE,MAAM,CAAC;IACf,OAAO,EAAE,MAAM,CAAC;IAChB,KAAK,EAAE,GAAG,CAAC;CACd;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACtC,IAAI,EAAE,qBAAqB,CAAC;CAC/B;AAED;;GAEG;AACH,oBAAY,iBAAiB,GAAG,mBAAmB,CAAC;AAEpD;;GAEG;AACH,MAAM,WAAW,YAAY;IACzB,QAAQ,EAAE,SAAS,CAAC;IACpB,OAAO,EAAE,iBAAiB,CAAC;CAC9B"}
@@ -1 +1 @@
1
- {"version":3,"file":"DrillEvents.js","sourceRoot":"","sources":["../../../src/base/vis/DrillEvents.ts"],"names":[],"mappings":";;;;AAmBA,mEAAqC;AACrC,qEAAwF;AAWxF;;GAEG;AACH,SAAgB,eAAe,CAAC,GAAY;IACxC,OAAO,CAAC,eAAe,EAAE,mCAAiB,CAAC,CAAC,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,GAAG,CAAC,EAAT,CAAS,CAAC,CAAC;AAC1E,CAAC;AAFD,0CAEC;AAwBD;;GAEG;AACH,SAAgB,kBAAkB,CAAC,IAAa;IAC5C,OAAO,CAAC,iBAAO,CAAC,IAAI,CAAC,IAAK,IAA0B,CAAC,GAAG,KAAK,SAAS,CAAC;AAC3E,CAAC;AAFD,gDAEC;AAED;;GAEG;AACH,SAAgB,yBAAyB,CAAC,IAAa;IACnD,OAAO,CAAC,iBAAO,CAAC,IAAI,CAAC,IAAK,IAAiC,CAAC,UAAU,KAAK,SAAS,CAAC;AACzF,CAAC;AAFD,8DAEC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,IAAa;IACzC,OAAO,CAAC,kBAAkB,EAAE,yBAAyB,CAAC,CAAC,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,IAAI,CAAC,EAAV,CAAU,CAAC,CAAC;AACtF,CAAC;AAFD,0CAEC;AAYD;;GAEG;AACH,SAAgB,gCAAgC,CAC5C,MAA2C;IAE3C,OAAO,CAAC,iBAAO,CAAC,MAAM,CAAC,IAAK,MAA0C,CAAC,mBAAmB,KAAK,SAAS,CAAC;AAC7G,CAAC;AAJD,4EAIC"}
1
+ {"version":3,"file":"DrillEvents.js","sourceRoot":"","sources":["../../../src/base/vis/DrillEvents.ts"],"names":[],"mappings":";;;;AAmBA,mEAAqC;AACrC,qEAAwF;AAaxF;;GAEG;AACH,SAAgB,eAAe,CAAC,GAAY;IACxC,OAAO,CAAC,eAAe,EAAE,mCAAiB,CAAC,CAAC,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,GAAG,CAAC,EAAT,CAAS,CAAC,CAAC;AAC1E,CAAC;AAFD,0CAEC;AAwBD;;GAEG;AACH,SAAgB,kBAAkB,CAAC,IAAa;IAC5C,OAAO,CAAC,iBAAO,CAAC,IAAI,CAAC,IAAK,IAA0B,CAAC,GAAG,KAAK,SAAS,CAAC;AAC3E,CAAC;AAFD,gDAEC;AAED;;GAEG;AACH,SAAgB,yBAAyB,CAAC,IAAa;IACnD,OAAO,CAAC,iBAAO,CAAC,IAAI,CAAC,IAAK,IAAiC,CAAC,UAAU,KAAK,SAAS,CAAC;AACzF,CAAC;AAFD,8DAEC;AAED;;GAEG;AACH,SAAgB,eAAe,CAAC,IAAa;IACzC,OAAO,CAAC,kBAAkB,EAAE,yBAAyB,CAAC,CAAC,IAAI,CAAC,UAAC,IAAI,IAAK,OAAA,IAAI,CAAC,IAAI,CAAC,EAAV,CAAU,CAAC,CAAC;AACtF,CAAC;AAFD,0CAEC;AAYD;;GAEG;AACH,SAAgB,gCAAgC,CAC5C,MAA2C;IAE3C,OAAO,CAAC,iBAAO,CAAC,MAAM,CAAC,IAAK,MAA0C,CAAC,mBAAmB,KAAK,SAAS,CAAC;AAC7G,CAAC;AAJD,4EAIC"}
@@ -5,8 +5,10 @@ import { ILoadingProps } from "../react/LoadingComponent";
5
5
  import { IPushData, OnError, OnExportReady, OnLoadingChanged } from "./Events";
6
6
  import { IPreparedExecution } from "@gooddata/sdk-backend-spi";
7
7
  /**
8
- * Super-interface for all visualization props; charts, tables or anything else - all should have these
9
- * basic props.
8
+ * Super-interface for all visualization props.
9
+ *
10
+ * @remarks
11
+ * Charts, tables or anything else - all should have these basic props.
10
12
  *
11
13
  * @public
12
14
  */
@@ -14,12 +16,14 @@ export interface IVisualizationProps {
14
16
  /**
15
17
  * Set Locale for visualization localization.
16
18
  *
19
+ * @remarks
17
20
  * Note: This locale will be used for everything EXCEPT the data being visualized.
18
21
  */
19
22
  locale?: string;
20
23
  /**
21
24
  * Set title to use for exported files.
22
25
  *
26
+ * @remarks
23
27
  * Note: you can also specify export file name as parameters to the export function which you
24
28
  * receive in the onExportReady. If you do not specify title here and neither as input to export function,
25
29
  * the the name will default to name of the visualization component.
@@ -40,8 +44,10 @@ export interface IVisualizationProps {
40
44
  LoadingComponent?: React.ComponentType<ILoadingProps>;
41
45
  }
42
46
  /**
43
- * Super-interface for all visualization callbacks; all visualizations SHOULD have at least these callbacks
44
- * defined.
47
+ * Super-interface for all visualization callbacks.
48
+ *
49
+ * @remarks
50
+ * All visualizations SHOULD have at least these callbacks defined.
45
51
  *
46
52
  * @public
47
53
  */
@@ -74,6 +80,7 @@ export interface IVisualizationCallbacks {
74
80
  /**
75
81
  * Common props for visualization of data computed by the analytical backend.
76
82
  *
83
+ * @remarks
77
84
  * Data visualization contains prepared execution which will return data that needs to be visualized.
78
85
  *
79
86
  * @public
@@ -1 +1 @@
1
- {"version":3,"file":"VisualizationProps.d.ts","sourceRoot":"","sources":["../../../src/base/vis/VisualizationProps.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACjE,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D;;;;;GAKG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;;OAIG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IAEjC;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IAElD;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;CACzD;AAED;;;;;GAKG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;CACxC;AAED;;;;;;GAMG;AACH,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB,EAAE,uBAAuB;IACzF;;OAEG;IACH,SAAS,EAAE,kBAAkB,CAAC;CACjC"}
1
+ {"version":3,"file":"VisualizationProps.d.ts","sourceRoot":"","sources":["../../../src/base/vis/VisualizationProps.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,aAAa,EAAE,iBAAiB,EAAE,MAAM,eAAe,CAAC;AACjE,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,WAAW,EAAE,MAAM,yBAAyB,CAAC;AACtD,OAAO,EAAE,aAAa,EAAE,MAAM,2BAA2B,CAAC;AAC1D,OAAO,EAAE,SAAS,EAAE,OAAO,EAAE,aAAa,EAAE,gBAAgB,EAAE,MAAM,UAAU,CAAC;AAC/E,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D;;;;;;;GAOG;AACH,MAAM,WAAW,mBAAmB;IAChC;;;;;OAKG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,cAAc,CAAC,EAAE,aAAa,EAAE,CAAC;IAEjC;;;OAGG;IACH,cAAc,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,WAAW,CAAC,CAAC;IAElD;;OAEG;IACH,gBAAgB,CAAC,EAAE,KAAK,CAAC,aAAa,CAAC,aAAa,CAAC,CAAC;CACzD;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,uBAAuB;IACpC;;OAEG;IACH,OAAO,CAAC,EAAE,OAAO,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,aAAa,CAAC;IAE9B;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;IAEpC;;OAEG;IACH,OAAO,CAAC,EAAE,iBAAiB,CAAC;IAE5B;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,IAAI,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,EAAE,CAAC,IAAI,EAAE,SAAS,KAAK,IAAI,CAAC;CACxC;AAED;;;;;;;GAOG;AACH,MAAM,WAAW,uBAAwB,SAAQ,mBAAmB,EAAE,uBAAuB;IACzF;;OAEG;IACH,SAAS,EAAE,kBAAkB,CAAC;CACjC"}
@@ -1,4 +1,4 @@
1
1
  "use strict";
2
- // (C) 2019-2021 GoodData Corporation
2
+ // (C) 2019-2022 GoodData Corporation
3
3
  Object.defineProperty(exports, "__esModule", { value: true });
4
4
  //# sourceMappingURL=VisualizationProps.js.map
@@ -11,6 +11,7 @@ export interface IExecuteProps extends IWithLoadingEvents<IExecuteProps> {
11
11
  /**
12
12
  * Backend to execute against.
13
13
  *
14
+ * @remarks
14
15
  * Note: the backend must come either from this property or from BackendContext. If you do not specify
15
16
  * backend here, then the executor MUST be rendered within an existing BackendContext.
16
17
  */
@@ -18,6 +19,7 @@ export interface IExecuteProps extends IWithLoadingEvents<IExecuteProps> {
18
19
  /**
19
20
  * Workspace in whose context to perform the execution.
20
21
  *
22
+ * @remarks
21
23
  * Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify
22
24
  * workspace here, then the executor MUST be rendered within an existing WorkspaceContext.
23
25
  */
@@ -28,28 +30,30 @@ export interface IExecuteProps extends IWithLoadingEvents<IExecuteProps> {
28
30
  */
29
31
  seriesBy: AttributesMeasuresOrPlaceholders;
30
32
  /**
31
- * Optionally slice all data series by elements of these attributes.
33
+ * Slice all data series by elements of these attributes.
32
34
  */
33
35
  slicesBy?: AttributesOrPlaceholders;
34
36
  /**
35
- * Optionally include these totals among the data slices.
37
+ * Include these totals among the data slices.
36
38
  */
37
39
  totals?: TotalsOrPlaceholders;
38
40
  /**
39
- * Optional filters to apply on server side.
41
+ * Filters to apply on server side.
40
42
  */
41
43
  filters?: NullableFiltersOrPlaceholders;
42
44
  /**
43
- * Optional sorting to apply on server side.
45
+ * Sorting to apply on server side.
44
46
  */
45
47
  sortBy?: SortsOrPlaceholders;
46
48
  /**
47
- * Optional resolution context for composed placeholders.
49
+ * Resolution context for composed placeholders.
48
50
  */
49
51
  placeholdersResolutionContext?: any;
50
52
  /**
51
- * Optional name to use for files exported from this component. If you do not specify this, then
52
- * the componentName will be used instead.
53
+ * Name to use for files exported from this component.
54
+ *
55
+ * @remarks
56
+ * If you do not specify this, then the componentName will be used instead.
53
57
  *
54
58
  * Note: it is also possible to pass custom name to the export function that will be sent via the
55
59
  * onExportReady callback. That approach is preferred if you need to assign the names in an ad-hoc
@@ -57,16 +61,21 @@ export interface IExecuteProps extends IWithLoadingEvents<IExecuteProps> {
57
61
  */
58
62
  exportTitle?: string;
59
63
  /**
60
- * Optional informative name of the component. This value is sent as telemetry information together
61
- * with the actual execution request. We recommend to set this because it can be useful for diagnostic
62
- * purposes.
64
+ * Informative name of the component.
65
+ *
66
+ * @remarks
67
+ * This value is sent as telemetry information together with the actual execution request.
68
+ * We recommend to set this because it can be useful for diagnostic purposes.
63
69
  *
64
70
  * Defaults 'Execute'.
65
71
  */
66
72
  componentName?: string;
67
73
  /**
68
74
  * Specifies whether {@link Execute} should trigger execution and loading right after it is
69
- * mounted. If not specified defaults to `true`.
75
+ * mounted.
76
+ *
77
+ * @remarks
78
+ * If not specified defaults to `true`.
70
79
  *
71
80
  * If set to `false`, then the {@link WithLoadingResult#reload} function needs to be called
72
81
  * to trigger the execution and loading.
@@ -76,34 +85,41 @@ export interface IExecuteProps extends IWithLoadingEvents<IExecuteProps> {
76
85
  * Specifies whether {@link Execute} should load all data from backend or just a particular window - specified by
77
86
  * offset and size of the window.
78
87
  *
88
+ * @remarks
79
89
  * If not specified, all data will be loaded.
80
90
  */
81
91
  window?: DataViewWindow;
82
92
  /**
83
- * Child component to which rendering is delegated. This is a function that will be called
84
- * every time state of execution and data loading changes.
93
+ * Child component to which rendering is delegated.
94
+ *
95
+ * @remarks
96
+ * This is a function that will be called every time state of execution and data loading changes.
85
97
  *
86
98
  * @param executionResult - execution result, indicating state and/or results
87
99
  */
88
100
  children: (executionResult: WithLoadingResult) => React.ReactElement | null;
89
101
  /**
90
- * Optionally provide component for rendering of the loading state.
102
+ * Provide component for rendering of the loading state.
91
103
  *
104
+ * @remarks
92
105
  * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
93
106
  * will be called only with a successful result.
94
107
  */
95
108
  LoadingComponent?: IExecuteLoadingComponent;
96
109
  /**
97
- * Optionally provide component for rendering of the error state.
110
+ * Provide component for rendering of the error state.
98
111
  *
112
+ * @remarks
99
113
  * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
100
114
  * will be called only with a successful result.
101
115
  */
102
116
  ErrorComponent?: IExecuteErrorComponent;
103
117
  }
104
118
  /**
105
- * The executor provides a more curated experience to obtain and work with data from backends. It is aligned
106
- * with the `DataAccess` infrastructure which exposes the underlying data as data series that can be
119
+ * The executor provides a more curated experience to obtain and work with data from backends.
120
+ *
121
+ * @remarks
122
+ * It is aligned with the `DataAccess` infrastructure which exposes the underlying data as data series that can be
107
123
  * optionally sliced by additional attributes.
108
124
  *
109
125
  * Once the executor finishes, the {@link DataViewFacade.data} method will expose the data as series and
@@ -111,7 +127,7 @@ export interface IExecuteProps extends IWithLoadingEvents<IExecuteProps> {
111
127
  * Note that if the resulting data is empty this will NOT throw a NoDataError. It is the responsibility
112
128
  * of the child component to handle that if they need to.
113
129
  *
114
- * @remarks see {@link IDataAccessMethods} for additional documentation
130
+ * See {@link IDataAccessMethods} for additional documentation
115
131
  * @public
116
132
  */
117
133
  export declare const Execute: (props: IExecuteProps) => JSX.Element;
@@ -1 +1 @@
1
- {"version":3,"file":"Execute.d.ts","sourceRoot":"","sources":["../../src/execution/Execute.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE/F,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D,OAAO,EAGH,gCAAgC,EAChC,wBAAwB,EACxB,oBAAoB,EACpB,6BAA6B,EAC7B,mBAAmB,EACtB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAEhF;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,kBAAkB,CAAC,aAAa,CAAC;IACpE;;;;;OAKG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,gCAAgC,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,6BAA6B,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAE7B;;OAEG;IACH,6BAA6B,CAAC,EAAE,GAAG,CAAC;IAEpC;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;;OAKG;IACH,QAAQ,EAAE,CAAC,eAAe,EAAE,iBAAiB,KAAK,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5E;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;IAE5C;;;;;OAKG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CAC3C;AA4FD;;;;;;;;;;;;GAYG;AACH,eAAO,MAAM,OAAO,UAAW,aAAa,gBAO3C,CAAC"}
1
+ {"version":3,"file":"Execute.d.ts","sourceRoot":"","sources":["../../src/execution/Execute.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAE/F,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D,OAAO,EAGH,gCAAgC,EAChC,wBAAwB,EACxB,oBAAoB,EACpB,6BAA6B,EAC7B,mBAAmB,EACtB,MAAM,SAAS,CAAC;AAEjB,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAEhF;;;GAGG;AACH,MAAM,WAAW,aAAc,SAAQ,kBAAkB,CAAC,aAAa,CAAC;IACpE;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;;OAGG;IACH,QAAQ,EAAE,gCAAgC,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,EAAE,wBAAwB,CAAC;IAEpC;;OAEG;IACH,MAAM,CAAC,EAAE,oBAAoB,CAAC;IAE9B;;OAEG;IACH,OAAO,CAAC,EAAE,6BAA6B,CAAC;IAExC;;OAEG;IACH,MAAM,CAAC,EAAE,mBAAmB,CAAC;IAE7B;;OAEG;IACH,6BAA6B,CAAC,EAAE,GAAG,CAAC;IAEpC;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;;;;OAOG;IACH,QAAQ,EAAE,CAAC,eAAe,EAAE,iBAAiB,KAAK,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5E;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;IAE5C;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CAC3C;AA4FD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,OAAO,UAAW,aAAa,gBAO3C,CAAC"}
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.Execute = void 0;
4
4
  var tslib_1 = require("tslib");
5
- // (C) 2019 GoodData Corporation
5
+ // (C) 2019-2022 GoodData Corporation
6
6
  var react_1 = tslib_1.__importDefault(require("react"));
7
7
  var withExecution_1 = require("./withExecution");
8
8
  var isEqual_1 = tslib_1.__importDefault(require("lodash/isEqual"));
@@ -73,8 +73,10 @@ var WrappedExecute = base_1.withContexts(withExecution_1.withExecution({
73
73
  window: function (props) { return props.window; },
74
74
  })(CoreExecute));
75
75
  /**
76
- * The executor provides a more curated experience to obtain and work with data from backends. It is aligned
77
- * with the `DataAccess` infrastructure which exposes the underlying data as data series that can be
76
+ * The executor provides a more curated experience to obtain and work with data from backends.
77
+ *
78
+ * @remarks
79
+ * It is aligned with the `DataAccess` infrastructure which exposes the underlying data as data series that can be
78
80
  * optionally sliced by additional attributes.
79
81
  *
80
82
  * Once the executor finishes, the {@link DataViewFacade.data} method will expose the data as series and
@@ -82,7 +84,7 @@ var WrappedExecute = base_1.withContexts(withExecution_1.withExecution({
82
84
  * Note that if the resulting data is empty this will NOT throw a NoDataError. It is the responsibility
83
85
  * of the child component to handle that if they need to.
84
86
  *
85
- * @remarks see {@link IDataAccessMethods} for additional documentation
87
+ * See {@link IDataAccessMethods} for additional documentation
86
88
  * @public
87
89
  */
88
90
  exports.Execute = function (props) {
@@ -1 +1 @@
1
- {"version":3,"file":"Execute.js","sourceRoot":"","sources":["../../src/execution/Execute.tsx"],"names":[],"mappings":";;;;AAAA,gCAAgC;AAChC,wDAA0B;AAC1B,iDAAgD;AAIhD,mEAAqC;AACrC,gCAQiB;AACjB,qDAAoD;AAsHpD,IAAM,WAAW,GAAoB,UAAC,KAAY;IACtC,IAAA,QAAQ,GAAyE,KAAK,SAA9E,EAAE,KAAK,GAAkE,KAAK,MAAvE,EAAE,SAAS,GAAuD,KAAK,UAA5D,EAAE,MAAM,GAA+C,KAAK,OAApD,EAAE,MAAM,GAAuC,KAAK,OAA5C,EAAE,gBAAgB,GAAqB,KAAK,iBAA1B,EAAE,cAAc,GAAK,KAAK,eAAV,CAAW;IAE/F,IAAI,cAAc,IAAI,KAAK,EAAE;QACzB,OAAO,8BAAC,cAAc,IAAC,KAAK,EAAE,KAAK,GAAI,CAAC;KAC3C;IAED,IAAI,gBAAgB,IAAI,SAAS,EAAE;QAC/B,OAAO,8BAAC,gBAAgB,OAAG,CAAC;KAC/B;IAED,IAAI,gBAAgB,IAAI,cAAc,IAAI,CAAC,MAAM,EAAE;QAC/C,OAAO,IAAI,CAAC;KACf;IAED,OAAO,QAAQ,CAAC;QACZ,KAAK,OAAA;QACL,SAAS,WAAA;QACT,MAAM,QAAA;QACN,MAAM,QAAA;KACT,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,SAAS,aAAa,CAAC,KAAoB;IACvC,OAAO,KAAK,CAAC,aAAa,IAAI,SAAS,CAAC;AAC5C,CAAC;AAED,SAAS,WAAW,CAAC,KAAoB;IACrC,OAAO,KAAK,CAAC,WAAW,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC;AAED,IAAM,cAAc,GAAG,mBAAY,CAC/B,6BAAa,CAAgB;IACzB,WAAW,aAAA;IACX,SAAS,EAAE,UAAC,KAAK;QACL,IAAA,QAAQ,GAAwC,KAAK,SAA7C,EAAE,QAAQ,GAA8B,KAAK,SAAnC,EAAE,MAAM,GAAsB,KAAK,OAA3B,EAAE,OAAO,GAAa,KAAK,QAAlB,EAAE,MAAM,GAAK,KAAK,OAAV,CAAW;QAC9D,OAAO,iCAAe,uCACf,KAAK,KACR,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,EACnC,QAAQ,EAAE,QAAiC,EAC3C,QAAQ,EAAE,QAAwB,EAClC,MAAM,EAAE,MAAkB,EAC1B,OAAO,EAAE,OAA4B,EACrC,MAAM,EAAE,MAAqB,IAC/B,CAAC;IACP,CAAC;IACD,MAAM,EAAE,UAAC,KAAoB;QACjB,IAAA,OAAO,GAAuE,KAAK,QAA5E,EAAE,gBAAgB,GAAqD,KAAK,iBAA1D,EAAE,eAAe,GAAoC,KAAK,gBAAzC,EAAE,cAAc,GAAoB,KAAK,eAAzB,EAAE,aAAa,GAAK,KAAK,cAAV,CAAW;QAE5F,OAAO;YACH,OAAO,SAAA;YACP,gBAAgB,kBAAA;YAChB,eAAe,iBAAA;YACf,cAAc,gBAAA;YACd,aAAa,eAAA;SAChB,CAAC;IACN,CAAC;IACD,aAAa,EAAE,UAAC,SAAwB,EAAE,SAAwB;QAC9D,IAAM,aAAa,GAA+B;YAC9C,SAAS;YACT,kBAAkB;YAClB,iBAAiB;YACjB,gBAAgB;SACnB,CAAC;QAEF,IAAM,sBAAsB,GAA+B;YACvD,UAAU;YACV,UAAU;YACV,QAAQ;YACR,SAAS;YACT,QAAQ;YACR,QAAQ;SACX,CAAC;QAEF,OAAO,CACH,aAAa,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,SAAS,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,QAAQ,CAAC,EAA3C,CAA2C,CAAC;YAC7E,sBAAsB,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,CAAC,iBAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAlD,CAAkD,CAAC,CAChG,CAAC;IACN,CAAC;IACD,WAAW,EAAE,UAAC,KAAqB;QACvB,IAAA,MAAuB,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,aAAhB,EAAlB,WAAW,mBAAG,IAAI,KAAA,CAAiB;QAE3C,OAAO,WAAW,CAAC;IACvB,CAAC;IACD,MAAM,EAAE,UAAC,KAAoB,IAAK,OAAA,KAAK,CAAC,MAAM,EAAZ,CAAY;CACjD,CAAC,CAAC,WAAW,CAAC,CAClB,CAAC;AAEF;;;;;;;;;;;;GAYG;AACU,QAAA,OAAO,GAAG,UAAC,KAAoB;IAClC,IAAA,KAAA,eAAgD,uCAAgC,CAClF,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,EAC3E,KAAK,CAAC,6BAA6B,CACtC,IAAA,EAHM,QAAQ,QAAA,EAAE,QAAQ,QAAA,EAAE,MAAM,QAAA,EAAE,OAAO,QAAA,EAAE,MAAM,QAGjD,CAAC;IAEF,OAAO,8BAAC,cAAc,uBAAK,KAAK,EAAM,EAAE,QAAQ,UAAA,EAAE,QAAQ,UAAA,EAAE,MAAM,QAAA,EAAE,OAAO,SAAA,EAAE,MAAM,QAAA,EAAE,EAAI,CAAC;AAC9F,CAAC,CAAC"}
1
+ {"version":3,"file":"Execute.js","sourceRoot":"","sources":["../../src/execution/Execute.tsx"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,wDAA0B;AAC1B,iDAAgD;AAIhD,mEAAqC;AACrC,gCAQiB;AACjB,qDAAoD;AAoIpD,IAAM,WAAW,GAAoB,UAAC,KAAY;IACtC,IAAA,QAAQ,GAAyE,KAAK,SAA9E,EAAE,KAAK,GAAkE,KAAK,MAAvE,EAAE,SAAS,GAAuD,KAAK,UAA5D,EAAE,MAAM,GAA+C,KAAK,OAApD,EAAE,MAAM,GAAuC,KAAK,OAA5C,EAAE,gBAAgB,GAAqB,KAAK,iBAA1B,EAAE,cAAc,GAAK,KAAK,eAAV,CAAW;IAE/F,IAAI,cAAc,IAAI,KAAK,EAAE;QACzB,OAAO,8BAAC,cAAc,IAAC,KAAK,EAAE,KAAK,GAAI,CAAC;KAC3C;IAED,IAAI,gBAAgB,IAAI,SAAS,EAAE;QAC/B,OAAO,8BAAC,gBAAgB,OAAG,CAAC;KAC/B;IAED,IAAI,gBAAgB,IAAI,cAAc,IAAI,CAAC,MAAM,EAAE;QAC/C,OAAO,IAAI,CAAC;KACf;IAED,OAAO,QAAQ,CAAC;QACZ,KAAK,OAAA;QACL,SAAS,WAAA;QACT,MAAM,QAAA;QACN,MAAM,QAAA;KACT,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,SAAS,aAAa,CAAC,KAAoB;IACvC,OAAO,KAAK,CAAC,aAAa,IAAI,SAAS,CAAC;AAC5C,CAAC;AAED,SAAS,WAAW,CAAC,KAAoB;IACrC,OAAO,KAAK,CAAC,WAAW,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC;AAED,IAAM,cAAc,GAAG,mBAAY,CAC/B,6BAAa,CAAgB;IACzB,WAAW,aAAA;IACX,SAAS,EAAE,UAAC,KAAK;QACL,IAAA,QAAQ,GAAwC,KAAK,SAA7C,EAAE,QAAQ,GAA8B,KAAK,SAAnC,EAAE,MAAM,GAAsB,KAAK,OAA3B,EAAE,OAAO,GAAa,KAAK,QAAlB,EAAE,MAAM,GAAK,KAAK,OAAV,CAAW;QAC9D,OAAO,iCAAe,uCACf,KAAK,KACR,aAAa,EAAE,aAAa,CAAC,KAAK,CAAC,EACnC,QAAQ,EAAE,QAAiC,EAC3C,QAAQ,EAAE,QAAwB,EAClC,MAAM,EAAE,MAAkB,EAC1B,OAAO,EAAE,OAA4B,EACrC,MAAM,EAAE,MAAqB,IAC/B,CAAC;IACP,CAAC;IACD,MAAM,EAAE,UAAC,KAAoB;QACjB,IAAA,OAAO,GAAuE,KAAK,QAA5E,EAAE,gBAAgB,GAAqD,KAAK,iBAA1D,EAAE,eAAe,GAAoC,KAAK,gBAAzC,EAAE,cAAc,GAAoB,KAAK,eAAzB,EAAE,aAAa,GAAK,KAAK,cAAV,CAAW;QAE5F,OAAO;YACH,OAAO,SAAA;YACP,gBAAgB,kBAAA;YAChB,eAAe,iBAAA;YACf,cAAc,gBAAA;YACd,aAAa,eAAA;SAChB,CAAC;IACN,CAAC;IACD,aAAa,EAAE,UAAC,SAAwB,EAAE,SAAwB;QAC9D,IAAM,aAAa,GAA+B;YAC9C,SAAS;YACT,kBAAkB;YAClB,iBAAiB;YACjB,gBAAgB;SACnB,CAAC;QAEF,IAAM,sBAAsB,GAA+B;YACvD,UAAU;YACV,UAAU;YACV,QAAQ;YACR,SAAS;YACT,QAAQ;YACR,QAAQ;SACX,CAAC;QAEF,OAAO,CACH,aAAa,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,SAAS,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,QAAQ,CAAC,EAA3C,CAA2C,CAAC;YAC7E,sBAAsB,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,CAAC,iBAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAlD,CAAkD,CAAC,CAChG,CAAC;IACN,CAAC;IACD,WAAW,EAAE,UAAC,KAAqB;QACvB,IAAA,MAAuB,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,aAAhB,EAAlB,WAAW,mBAAG,IAAI,KAAA,CAAiB;QAE3C,OAAO,WAAW,CAAC;IACvB,CAAC;IACD,MAAM,EAAE,UAAC,KAAoB,IAAK,OAAA,KAAK,CAAC,MAAM,EAAZ,CAAY;CACjD,CAAC,CAAC,WAAW,CAAC,CAClB,CAAC;AAEF;;;;;;;;;;;;;;GAcG;AACU,QAAA,OAAO,GAAG,UAAC,KAAoB;IAClC,IAAA,KAAA,eAAgD,uCAAgC,CAClF,CAAC,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,QAAQ,EAAE,KAAK,CAAC,MAAM,EAAE,KAAK,CAAC,OAAO,EAAE,KAAK,CAAC,MAAM,CAAC,EAC3E,KAAK,CAAC,6BAA6B,CACtC,IAAA,EAHM,QAAQ,QAAA,EAAE,QAAQ,QAAA,EAAE,MAAM,QAAA,EAAE,OAAO,QAAA,EAAE,MAAM,QAGjD,CAAC;IAEF,OAAO,8BAAC,cAAc,uBAAK,KAAK,EAAM,EAAE,QAAQ,UAAA,EAAE,QAAQ,UAAA,EAAE,MAAM,QAAA,EAAE,OAAO,SAAA,EAAE,MAAM,QAAA,EAAE,EAAI,CAAC;AAC9F,CAAC,CAAC"}
@@ -5,12 +5,13 @@ import { IAnalyticalBackend } from "@gooddata/sdk-backend-spi";
5
5
  import { IExecuteErrorComponent, IExecuteLoadingComponent } from "./interfaces";
6
6
  /**
7
7
  * Props of the {@link ExecuteInsight} component.
8
- * @beta
8
+ * @public
9
9
  */
10
10
  export interface IExecuteInsightProps extends IWithLoadingEvents<IExecuteInsightProps> {
11
11
  /**
12
12
  * Backend to execute against.
13
13
  *
14
+ * @remarks
14
15
  * Note: the backend must come either from this property or from BackendContext. If you do not specify
15
16
  * backend here, then the executor MUST be rendered within an existing BackendContext.
16
17
  */
@@ -18,6 +19,7 @@ export interface IExecuteInsightProps extends IWithLoadingEvents<IExecuteInsight
18
19
  /**
19
20
  * Workspace in whose context to perform the execution.
20
21
  *
22
+ * @remarks
21
23
  * Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify
22
24
  * workspace here, then the executor MUST be rendered within an existing WorkspaceContext.
23
25
  */
@@ -27,24 +29,26 @@ export interface IExecuteInsightProps extends IWithLoadingEvents<IExecuteInsight
27
29
  */
28
30
  insight: ObjRef;
29
31
  /**
30
- * Optionally modify sorts on prepared insight execution, before it's executed.
32
+ * Modify sorts on prepared insight execution, before it's executed.
31
33
  */
32
34
  sorts?: ISortItem[] | ((def: IExecutionDefinition, props: IExecuteInsightProps) => ISortItem[]);
33
35
  /**
34
- * Optionally modify dimensions on prepared insight execution, before it's executed.
36
+ * Modify dimensions on prepared insight execution, before it's executed.
35
37
  */
36
38
  dimensions?: IDimension[] | ((def: IExecutionDefinition, props: IExecuteInsightProps) => IDimension[]);
37
39
  /**
38
- * Optionally modify date formatting on prepared insight execution, before it's executed.
40
+ * Modify date formatting on prepared insight execution, before it's executed.
39
41
  */
40
42
  dateFormat?: string | ((def: IExecutionDefinition, props: IExecuteInsightProps) => string);
41
43
  /**
42
- * Optional filters to apply on server side.
44
+ * Filters to apply on server side.
43
45
  */
44
46
  filters?: INullableFilter[];
45
47
  /**
46
- * Optional name to use for files exported from this component. If you do not specify this, then
47
- * the componentName will be used instead.
48
+ * Name to use for files exported from this component.
49
+ *
50
+ * @remarks
51
+ * If you do not specify this, then the componentName will be used instead.
48
52
  *
49
53
  * Note: it is also possible to pass custom name to the export function that will be sent via the
50
54
  * onExportReady callback. That approach is preferred if you need to assign the names in an ad-hoc
@@ -52,16 +56,21 @@ export interface IExecuteInsightProps extends IWithLoadingEvents<IExecuteInsight
52
56
  */
53
57
  exportTitle?: string;
54
58
  /**
55
- * Optional informative name of the component. This value is sent as telemetry information together
56
- * with the actual execution request. We recommend to set this because it can be useful for diagnostic
57
- * purposes.
59
+ * Informative name of the component.
60
+ *
61
+ * @remarks
62
+ * This value is sent as telemetry information together with the actual execution request. We recommend to set this
63
+ * because it can be useful for diagnostic purposes.
58
64
  *
59
65
  * Defaults 'Execute'.
60
66
  */
61
67
  componentName?: string;
62
68
  /**
63
69
  * Specifies whether `Execute` should trigger execution and loading right after it is
64
- * mounted. If not specified defaults to `true`.
70
+ * mounted.
71
+ *
72
+ * @remarks
73
+ * If not specified defaults to `true`.
65
74
  *
66
75
  * If set to `false`, then the {@link WithLoadingResult#reload} function needs to be called
67
76
  * to trigger the execution and loading.
@@ -71,26 +80,48 @@ export interface IExecuteInsightProps extends IWithLoadingEvents<IExecuteInsight
71
80
  * Specifies whether `Execute` should load all data from backend or just a particular window - specified by
72
81
  * offset and size of the window.
73
82
  *
83
+ * @remarks
74
84
  * If not specified, all data will be loaded.
75
85
  */
76
86
  window?: DataViewWindow;
77
87
  /**
78
- * Child component to which rendering is delegated. This is a function that will be called
79
- * every time state of execution and data loading changes.
88
+ * Indicates that the execution to obtain the data for the insight should be an 'execution by reference'.
89
+ *
90
+ * Execution by reference means that the ExecuteInsight will ask analytical backend to compute results for an insight
91
+ * which is stored on the backend by specifying link to the insight, additional filters and description how
92
+ * to organize the data.
93
+ *
94
+ * Otherwise, a freeform execution is done, in which the InsightView will send to backend the full execution
95
+ * definition of what to compute.
96
+ *
97
+ * This distinction is in place because some backends MAY want to prohibit users from doing freeform executions
98
+ * and only allow computing data for set of insights created by admins.
99
+ *
100
+ * Note: the need for execute by reference is rare. You will typically be notified by the solution admin to use
101
+ * this mode.
102
+ */
103
+ executeByReference?: boolean;
104
+ /**
105
+ * Child component to which rendering is delegated.
106
+ *
107
+ * @remarks
108
+ * This is a function that will be called every time state of execution and data loading changes.
80
109
  *
81
110
  * @param executionResult - execution result, indicating state and/or results
82
111
  */
83
112
  children: (executionResult: WithLoadingResult) => React.ReactElement | null;
84
113
  /**
85
- * Optionally provide component for rendering of the loading state.
114
+ * Provide component for rendering of the loading state.
86
115
  *
116
+ * @remarks
87
117
  * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
88
118
  * will be called only with a successful result.
89
119
  */
90
120
  LoadingComponent?: IExecuteLoadingComponent;
91
121
  /**
92
- * Optionally provide component for rendering of the error state.
122
+ * Provide component for rendering of the error state.
93
123
  *
124
+ * @remarks
94
125
  * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
95
126
  * will be called only with a successful result.
96
127
  */
@@ -99,7 +130,7 @@ export interface IExecuteInsightProps extends IWithLoadingEvents<IExecuteInsight
99
130
  /**
100
131
  * Gets data for a specific stored insight.
101
132
  *
102
- * @beta
133
+ * @public
103
134
  */
104
135
  export declare const ExecuteInsight: React.ComponentType<IExecuteInsightProps>;
105
136
  //# sourceMappingURL=ExecuteInsight.d.ts.map
@@ -1 +1 @@
1
- {"version":3,"file":"ExecuteInsight.d.ts","sourceRoot":"","sources":["../../src/execution/ExecuteInsight.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC/F,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC3G,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAG/D,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAGhF;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB,CAAC,oBAAoB,CAAC;IAClF;;;;;OAKG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;OAKG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,oBAAoB,EAAE,KAAK,EAAE,oBAAoB,KAAK,SAAS,EAAE,CAAC,CAAC;IAEhG;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,oBAAoB,EAAE,KAAK,EAAE,oBAAoB,KAAK,UAAU,EAAE,CAAC,CAAC;IAEvG;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,oBAAoB,EAAE,KAAK,EAAE,oBAAoB,KAAK,MAAM,CAAC,CAAC;IAE3F;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAE5B;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;OAKG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;;OAKG;IACH,QAAQ,EAAE,CAAC,eAAe,EAAE,iBAAiB,KAAK,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5E;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;IAE5C;;;;;OAKG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CAC3C;AAmCD;;;;GAIG;AACH,eAAO,MAAM,cAAc,2CA4E1B,CAAC"}
1
+ {"version":3,"file":"ExecuteInsight.d.ts","sourceRoot":"","sources":["../../src/execution/ExecuteInsight.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAE1B,OAAO,EAAE,cAAc,EAAE,kBAAkB,EAAE,iBAAiB,EAAE,MAAM,wBAAwB,CAAC;AAC/F,OAAO,EAAE,UAAU,EAAE,oBAAoB,EAAE,eAAe,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAC3G,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAG/D,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAGhF;;;GAGG;AACH,MAAM,WAAW,oBAAqB,SAAQ,kBAAkB,CAAC,oBAAoB,CAAC;IAClF;;;;;;OAMG;IACH,OAAO,CAAC,EAAE,kBAAkB,CAAC;IAE7B;;;;;;OAMG;IACH,SAAS,CAAC,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,KAAK,CAAC,EAAE,SAAS,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,oBAAoB,EAAE,KAAK,EAAE,oBAAoB,KAAK,SAAS,EAAE,CAAC,CAAC;IAEhG;;OAEG;IACH,UAAU,CAAC,EAAE,UAAU,EAAE,GAAG,CAAC,CAAC,GAAG,EAAE,oBAAoB,EAAE,KAAK,EAAE,oBAAoB,KAAK,UAAU,EAAE,CAAC,CAAC;IAEvG;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,GAAG,EAAE,oBAAoB,EAAE,KAAK,EAAE,oBAAoB,KAAK,MAAM,CAAC,CAAC;IAE3F;;OAEG;IACH,OAAO,CAAC,EAAE,eAAe,EAAE,CAAC;IAE5B;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;OAQG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;;;;;;;;;;;;OAeG;IACH,kBAAkB,CAAC,EAAE,OAAO,CAAC;IAE7B;;;;;;;OAOG;IACH,QAAQ,EAAE,CAAC,eAAe,EAAE,iBAAiB,KAAK,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5E;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;IAE5C;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CAC3C;AAmCD;;;;GAIG;AACH,eAAO,MAAM,cAAc,2CA4F1B,CAAC"}
@@ -2,7 +2,7 @@
2
2
  Object.defineProperty(exports, "__esModule", { value: true });
3
3
  exports.ExecuteInsight = void 0;
4
4
  var tslib_1 = require("tslib");
5
- // (C) 2019 GoodData Corporation
5
+ // (C) 2019-2022 GoodData Corporation
6
6
  var react_1 = tslib_1.__importDefault(require("react"));
7
7
  var withExecution_1 = require("./withExecution");
8
8
  var isEqual_1 = tslib_1.__importDefault(require("lodash/isEqual"));
@@ -35,22 +35,24 @@ function exportTitle(props) {
35
35
  /**
36
36
  * Gets data for a specific stored insight.
37
37
  *
38
- * @beta
38
+ * @public
39
39
  */
40
40
  exports.ExecuteInsight = base_1.withContexts(withExecution_1.withExecution({
41
41
  exportTitle: exportTitle,
42
42
  execution: function (props) { return tslib_1.__awaiter(void 0, void 0, void 0, function () {
43
- var insightRef, filters, sorts, dimensions, dateFormat, backend, workspace, insight, insightExecution, resolvedSorts, resolvedDimensions, resolvedDateFormat;
43
+ var insightRef, filters, sorts, dimensions, dateFormat, backend, workspace, executeByReference, insight, executionFactory, executeFn, insightExecution, resolvedSorts, resolvedDimensions, resolvedDateFormat;
44
44
  return tslib_1.__generator(this, function (_a) {
45
45
  switch (_a.label) {
46
46
  case 0:
47
- insightRef = props.insight, filters = props.filters, sorts = props.sorts, dimensions = props.dimensions, dateFormat = props.dateFormat, backend = props.backend, workspace = props.workspace;
47
+ insightRef = props.insight, filters = props.filters, sorts = props.sorts, dimensions = props.dimensions, dateFormat = props.dateFormat, backend = props.backend, workspace = props.workspace, executeByReference = props.executeByReference;
48
48
  ts_invariant_1.default(backend, "The backend in ExecuteInsight must be defined. Either pass it as a prop or make sure there is a BackendProvider up the component tree.");
49
49
  ts_invariant_1.default(workspace, "The workspace in ExecuteInsight must be defined. Either pass it as a prop or make sure there is a WorkspaceProvider up the component tree.");
50
50
  return [4 /*yield*/, backend.workspace(workspace).insights().getInsight(insightRef)];
51
51
  case 1:
52
52
  insight = _a.sent();
53
- insightExecution = backend.workspace(workspace).execution().forInsightByRef(insight, filters);
53
+ executionFactory = backend.workspace(workspace).execution();
54
+ executeFn = (executeByReference ? executionFactory.forInsightByRef : executionFactory.forInsight).bind(executionFactory);
55
+ insightExecution = executeFn(insight, filters);
54
56
  if (sorts) {
55
57
  resolvedSorts = typeof sorts === "function" ? sorts(insightExecution.definition, props) : sorts;
56
58
  insightExecution = insightExecution.withSorting.apply(insightExecution, tslib_1.__spread(resolvedSorts));
@@ -1 +1 @@
1
- {"version":3,"file":"ExecuteInsight.js","sourceRoot":"","sources":["../../src/execution/ExecuteInsight.tsx"],"names":[],"mappings":";;;;AAAA,gCAAgC;AAChC,wDAA0B;AAC1B,iDAAgD;AAIhD,mEAAqC;AACrC,gCAAuC;AAEvC,sEAAqC;AA+GrC,IAAM,WAAW,GAAoB,UAAC,KAAY;IACtC,IAAA,QAAQ,GAAyE,KAAK,SAA9E,EAAE,KAAK,GAAkE,KAAK,MAAvE,EAAE,SAAS,GAAuD,KAAK,UAA5D,EAAE,MAAM,GAA+C,KAAK,OAApD,EAAE,MAAM,GAAuC,KAAK,OAA5C,EAAE,gBAAgB,GAAqB,KAAK,iBAA1B,EAAE,cAAc,GAAK,KAAK,eAAV,CAAW;IAE/F,IAAI,cAAc,IAAI,KAAK,EAAE;QACzB,OAAO,8BAAC,cAAc,IAAC,KAAK,EAAE,KAAK,GAAI,CAAC;KAC3C;IAED,IAAI,gBAAgB,IAAI,SAAS,EAAE;QAC/B,OAAO,8BAAC,gBAAgB,OAAG,CAAC;KAC/B;IAED,IAAI,gBAAgB,IAAI,cAAc,IAAI,CAAC,MAAM,EAAE;QAC/C,OAAO,IAAI,CAAC;KACf;IAED,OAAO,QAAQ,CAAC;QACZ,KAAK,OAAA;QACL,SAAS,WAAA;QACT,MAAM,QAAA;QACN,MAAM,QAAA;KACT,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,SAAS,aAAa,CAAC,KAA2B;IAC9C,OAAO,KAAK,CAAC,aAAa,IAAI,gBAAgB,CAAC;AACnD,CAAC;AAED,SAAS,WAAW,CAAC,KAA2B;IAC5C,OAAO,KAAK,CAAC,WAAW,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACU,QAAA,cAAc,GAAG,mBAAY,CACtC,6BAAa,CAAuB;IAChC,WAAW,aAAA;IACX,SAAS,EAAE,UAAO,KAAK;;;;;oBACF,UAAU,GAAiE,KAAK,QAAtE,EAAE,OAAO,GAAwD,KAAK,QAA7D,EAAE,KAAK,GAAiD,KAAK,MAAtD,EAAE,UAAU,GAAqC,KAAK,WAA1C,EAAE,UAAU,GAAyB,KAAK,WAA9B,EAAE,OAAO,GAAgB,KAAK,QAArB,EAAE,SAAS,GAAK,KAAK,UAAV,CAAW;oBAClG,sBAAS,CACL,OAAO,EACP,wIAAwI,CAC3I,CAAC;oBACF,sBAAS,CACL,SAAS,EACT,4IAA4I,CAC/I,CAAC;oBAEc,qBAAM,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAA;;oBAA9E,OAAO,GAAG,SAAoE;oBAChF,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC,eAAe,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBAElG,IAAI,KAAK,EAAE;wBACD,aAAa,GACf,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;wBACpF,gBAAgB,GAAG,gBAAgB,CAAC,WAAW,OAA5B,gBAAgB,mBAAgB,aAAa,EAAC,CAAC;qBACrE;oBACD,IAAI,UAAU,EAAE;wBACN,kBAAkB,GACpB,OAAO,UAAU,KAAK,UAAU;4BAC5B,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC;4BAChD,CAAC,CAAC,UAAU,CAAC;wBACrB,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,OAA/B,gBAAgB,mBAAmB,kBAAkB,EAAC,CAAC;qBAC7E;oBACD,IAAI,UAAU,EAAE;wBACN,kBAAkB,GACpB,OAAO,UAAU,KAAK,UAAU;4BAC5B,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC;4BAChD,CAAC,CAAC,UAAU,CAAC;wBACrB,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;qBAC1E;oBAED,sBAAO,gBAAgB,EAAC;;;SAC3B;IACD,MAAM,EAAE,UAAC,KAA2B;QACxB,IAAA,OAAO,GAAuE,KAAK,QAA5E,EAAE,gBAAgB,GAAqD,KAAK,iBAA1D,EAAE,eAAe,GAAoC,KAAK,gBAAzC,EAAE,cAAc,GAAoB,KAAK,eAAzB,EAAE,aAAa,GAAK,KAAK,cAAV,CAAW;QAE5F,OAAO;YACH,OAAO,SAAA;YACP,gBAAgB,kBAAA;YAChB,eAAe,iBAAA;YACf,cAAc,gBAAA;YACd,aAAa,eAAA;SAChB,CAAC;IACN,CAAC;IACD,aAAa,EAAE,UAAC,SAA+B,EAAE,SAA+B;QAC5E,IAAM,aAAa,GAAsC;YACrD,SAAS;YACT,kBAAkB;YAClB,iBAAiB;YACjB,gBAAgB;SACnB,CAAC;QAEF,IAAM,sBAAsB,GAAsC;YAC9D,SAAS;YACT,SAAS;YACT,QAAQ;SACX,CAAC;QAEF,OAAO,CACH,aAAa,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,SAAS,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,QAAQ,CAAC,EAA3C,CAA2C,CAAC;YAC7E,sBAAsB,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,CAAC,iBAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAlD,CAAkD,CAAC,CAChG,CAAC;IACN,CAAC;IACD,WAAW,EAAE,UAAC,KAA4B;QAC9B,IAAA,MAAuB,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,aAAhB,EAAlB,WAAW,mBAAG,IAAI,KAAA,CAAiB;QAE3C,OAAO,WAAW,CAAC;IACvB,CAAC;IACD,MAAM,EAAE,UAAC,KAA2B,IAAK,OAAA,KAAK,CAAC,MAAM,EAAZ,CAAY;CACxD,CAAC,CAAC,WAAW,CAAC,CAClB,CAAC"}
1
+ {"version":3,"file":"ExecuteInsight.js","sourceRoot":"","sources":["../../src/execution/ExecuteInsight.tsx"],"names":[],"mappings":";;;;AAAA,qCAAqC;AACrC,wDAA0B;AAC1B,iDAAgD;AAIhD,mEAAqC;AACrC,gCAAuC;AAEvC,sEAAqC;AA+IrC,IAAM,WAAW,GAAoB,UAAC,KAAY;IACtC,IAAA,QAAQ,GAAyE,KAAK,SAA9E,EAAE,KAAK,GAAkE,KAAK,MAAvE,EAAE,SAAS,GAAuD,KAAK,UAA5D,EAAE,MAAM,GAA+C,KAAK,OAApD,EAAE,MAAM,GAAuC,KAAK,OAA5C,EAAE,gBAAgB,GAAqB,KAAK,iBAA1B,EAAE,cAAc,GAAK,KAAK,eAAV,CAAW;IAE/F,IAAI,cAAc,IAAI,KAAK,EAAE;QACzB,OAAO,8BAAC,cAAc,IAAC,KAAK,EAAE,KAAK,GAAI,CAAC;KAC3C;IAED,IAAI,gBAAgB,IAAI,SAAS,EAAE;QAC/B,OAAO,8BAAC,gBAAgB,OAAG,CAAC;KAC/B;IAED,IAAI,gBAAgB,IAAI,cAAc,IAAI,CAAC,MAAM,EAAE;QAC/C,OAAO,IAAI,CAAC;KACf;IAED,OAAO,QAAQ,CAAC;QACZ,KAAK,OAAA;QACL,SAAS,WAAA;QACT,MAAM,QAAA;QACN,MAAM,QAAA;KACT,CAAC,CAAC;AACP,CAAC,CAAC;AAEF,SAAS,aAAa,CAAC,KAA2B;IAC9C,OAAO,KAAK,CAAC,aAAa,IAAI,gBAAgB,CAAC;AACnD,CAAC;AAED,SAAS,WAAW,CAAC,KAA2B;IAC5C,OAAO,KAAK,CAAC,WAAW,IAAI,aAAa,CAAC,KAAK,CAAC,CAAC;AACrD,CAAC;AAED;;;;GAIG;AACU,QAAA,cAAc,GAAG,mBAAY,CACtC,6BAAa,CAAuB;IAChC,WAAW,aAAA;IACX,SAAS,EAAE,UAAO,KAAK;;;;;oBAEN,UAAU,GAQnB,KAAK,QARc,EACnB,OAAO,GAOP,KAAK,QAPE,EACP,KAAK,GAML,KAAK,MANA,EACL,UAAU,GAKV,KAAK,WALK,EACV,UAAU,GAIV,KAAK,WAJK,EACV,OAAO,GAGP,KAAK,QAHE,EACP,SAAS,GAET,KAAK,UAFI,EACT,kBAAkB,GAClB,KAAK,mBADa,CACZ;oBACV,sBAAS,CACL,OAAO,EACP,wIAAwI,CAC3I,CAAC;oBACF,sBAAS,CACL,SAAS,EACT,4IAA4I,CAC/I,CAAC;oBAEc,qBAAM,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,QAAQ,EAAE,CAAC,UAAU,CAAC,UAAU,CAAC,EAAA;;oBAA9E,OAAO,GAAG,SAAoE;oBAE9E,gBAAgB,GAAG,OAAO,CAAC,SAAS,CAAC,SAAS,CAAC,CAAC,SAAS,EAAE,CAAC;oBAE5D,SAAS,GAAG,CACd,kBAAkB,CAAC,CAAC,CAAC,gBAAgB,CAAC,eAAe,CAAC,CAAC,CAAC,gBAAgB,CAAC,UAAU,CACtF,CAAC,IAAI,CAAC,gBAAgB,CAAC,CAAC;oBAErB,gBAAgB,GAAG,SAAS,CAAC,OAAO,EAAE,OAAO,CAAC,CAAC;oBAEnD,IAAI,KAAK,EAAE;wBACD,aAAa,GACf,OAAO,KAAK,KAAK,UAAU,CAAC,CAAC,CAAC,KAAK,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC,CAAC,CAAC,CAAC,KAAK,CAAC;wBACpF,gBAAgB,GAAG,gBAAgB,CAAC,WAAW,OAA5B,gBAAgB,mBAAgB,aAAa,EAAC,CAAC;qBACrE;oBACD,IAAI,UAAU,EAAE;wBACN,kBAAkB,GACpB,OAAO,UAAU,KAAK,UAAU;4BAC5B,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC;4BAChD,CAAC,CAAC,UAAU,CAAC;wBACrB,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,OAA/B,gBAAgB,mBAAmB,kBAAkB,EAAC,CAAC;qBAC7E;oBACD,IAAI,UAAU,EAAE;wBACN,kBAAkB,GACpB,OAAO,UAAU,KAAK,UAAU;4BAC5B,CAAC,CAAC,UAAU,CAAC,gBAAgB,CAAC,UAAU,EAAE,KAAK,CAAC;4BAChD,CAAC,CAAC,UAAU,CAAC;wBACrB,gBAAgB,GAAG,gBAAgB,CAAC,cAAc,CAAC,kBAAkB,CAAC,CAAC;qBAC1E;oBAED,sBAAO,gBAAgB,EAAC;;;SAC3B;IACD,MAAM,EAAE,UAAC,KAA2B;QACxB,IAAA,OAAO,GAAuE,KAAK,QAA5E,EAAE,gBAAgB,GAAqD,KAAK,iBAA1D,EAAE,eAAe,GAAoC,KAAK,gBAAzC,EAAE,cAAc,GAAoB,KAAK,eAAzB,EAAE,aAAa,GAAK,KAAK,cAAV,CAAW;QAE5F,OAAO;YACH,OAAO,SAAA;YACP,gBAAgB,kBAAA;YAChB,eAAe,iBAAA;YACf,cAAc,gBAAA;YACd,aAAa,eAAA;SAChB,CAAC;IACN,CAAC;IACD,aAAa,EAAE,UAAC,SAA+B,EAAE,SAA+B;QAC5E,IAAM,aAAa,GAAsC;YACrD,SAAS;YACT,kBAAkB;YAClB,iBAAiB;YACjB,gBAAgB;SACnB,CAAC;QAEF,IAAM,sBAAsB,GAAsC;YAC9D,SAAS;YACT,SAAS;YACT,QAAQ;SACX,CAAC;QAEF,OAAO,CACH,aAAa,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,SAAS,CAAC,QAAQ,CAAC,KAAK,SAAS,CAAC,QAAQ,CAAC,EAA3C,CAA2C,CAAC;YAC7E,sBAAsB,CAAC,IAAI,CAAC,UAAC,QAAQ,IAAK,OAAA,CAAC,iBAAO,CAAC,SAAS,CAAC,QAAQ,CAAC,EAAE,SAAS,CAAC,QAAQ,CAAC,CAAC,EAAlD,CAAkD,CAAC,CAChG,CAAC;IACN,CAAC;IACD,WAAW,EAAE,UAAC,KAA4B;QAC9B,IAAA,MAAuB,KAAK,aAAL,KAAK,cAAL,KAAK,GAAI,EAAE,aAAhB,EAAlB,WAAW,mBAAG,IAAI,KAAA,CAAiB;QAE3C,OAAO,WAAW,CAAC;IACvB,CAAC;IACD,MAAM,EAAE,UAAC,KAA2B,IAAK,OAAA,KAAK,CAAC,MAAM,EAAZ,CAAY;CACxD,CAAC,CAAC,WAAW,CAAC,CAClB,CAAC"}
@@ -15,12 +15,15 @@ export interface IRawExecuteProps extends IWithLoadingEvents<IRawExecuteProps> {
15
15
  * Specifies whether {@link RawExecute} should load all data from backend or just a particular window - specified by
16
16
  * offset and size of the window.
17
17
  *
18
+ * @remarks
18
19
  * If not specified, all data will be loaded.
19
20
  */
20
21
  window?: DataViewWindow;
21
22
  /**
22
- * Optional name to use for files exported from this component. If you do not specify this, then
23
- * the 'RawExecute' will be used instead.
23
+ * Name to use for files exported from this component.
24
+ *
25
+ * @remarks
26
+ * If you do not specify this, then the 'RawExecute' will be used instead.
24
27
  *
25
28
  * Note: it is also possible to pass custom name to the export function that will be sent via the
26
29
  * onExportReady callback. That approach is preferred if you need to assign the names in an ad-hoc
@@ -29,28 +32,36 @@ export interface IRawExecuteProps extends IWithLoadingEvents<IRawExecuteProps> {
29
32
  exportTitle?: string;
30
33
  /**
31
34
  * Indicates whether the executor should trigger execution and loading right after it is
32
- * mounted. If not specified defaults to `true`.
35
+ * mounted.
36
+ *
37
+ * @remarks
38
+ * If not specified defaults to `true`.
33
39
  *
34
40
  * If set to `false`, then the {@link WithLoadingResult#reload} function needs to be called
35
41
  * to trigger the execution and loading.
36
42
  */
37
43
  loadOnMount?: boolean;
38
44
  /**
39
- * Child component to which rendering is delegated. This is a function that will be called
40
- * every time state of execution and data loading changes.
45
+ * Child component to which rendering is delegated.
46
+ *
47
+ * @remarks
48
+ * This is a function that will be called every time state of execution and data loading changes.
41
49
  *
42
50
  * @param executionResult - execution result, indicating state and/or results
43
51
  */
44
52
  children: (executionResult: WithLoadingResult) => React.ReactElement | null;
45
53
  /**
46
- * Optionally provide component for rendering of the loading state.
54
+ * Provide component for rendering of the loading state.
47
55
  *
56
+ * @remarks
48
57
  * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
49
58
  * will be called only with a successful result.
50
59
  */
51
60
  LoadingComponent?: IExecuteLoadingComponent;
52
61
  /**
53
- * Optionally provide component for rendering of the error state.
62
+ * Provide component for rendering of the error state.
63
+ *
64
+ * @remarks
54
65
  * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
55
66
  * will be called only with a successful result.
56
67
  */
@@ -60,6 +71,7 @@ export interface IRawExecuteProps extends IWithLoadingEvents<IRawExecuteProps> {
60
71
  * Raw executor is the most basic React component to drive custom executions to obtain
61
72
  * data from backends.
62
73
  *
74
+ * @remarks
63
75
  * The component accepts an instance of prepared execution and drives all the necessary
64
76
  * APIs and boilerplate needed to obtain a {@link DataViewFacade}.
65
77
  * Note that if the resulting data is empty this will NOT throw a {@link @gooddata/sdk-backend-spi#NoDataError}.
@@ -1 +1 @@
1
- {"version":3,"file":"RawExecute.d.ts","sourceRoot":"","sources":["../../src/execution/RawExecute.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE/F,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAEhF;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB,CAAC,gBAAgB,CAAC;IAC1E;;OAEG;IACH,SAAS,EAAE,kBAAkB,CAAC;IAE9B;;;;;OAKG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;;;;OAOG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;OAMG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;OAKG;IACH,QAAQ,EAAE,CAAC,eAAe,EAAE,iBAAiB,KAAK,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5E;;;;;OAKG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;IAE5C;;;;OAIG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CAC3C;AA+BD;;;;;;;;;;;;;GAaG;AACH,eAAO,MAAM,UAAU,6CAoCP,CAAC"}
1
+ {"version":3,"file":"RawExecute.d.ts","sourceRoot":"","sources":["../../src/execution/RawExecute.tsx"],"names":[],"mappings":"AACA,OAAO,KAAK,MAAM,OAAO,CAAC;AAC1B,OAAO,EAAE,kBAAkB,EAAE,MAAM,2BAA2B,CAAC;AAE/D,OAAO,EAAE,iBAAiB,EAAE,kBAAkB,EAAE,cAAc,EAAE,MAAM,wBAAwB,CAAC;AAE/F,OAAO,EAAE,sBAAsB,EAAE,wBAAwB,EAAE,MAAM,cAAc,CAAC;AAEhF;;;GAGG;AACH,MAAM,WAAW,gBAAiB,SAAQ,kBAAkB,CAAC,gBAAgB,CAAC;IAC1E;;OAEG;IACH,SAAS,EAAE,kBAAkB,CAAC;IAE9B;;;;;;OAMG;IACH,MAAM,CAAC,EAAE,cAAc,CAAC;IAExB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;;;;;;;;OASG;IACH,WAAW,CAAC,EAAE,OAAO,CAAC;IAEtB;;;;;;;OAOG;IACH,QAAQ,EAAE,CAAC,eAAe,EAAE,iBAAiB,KAAK,KAAK,CAAC,YAAY,GAAG,IAAI,CAAC;IAE5E;;;;;;OAMG;IACH,gBAAgB,CAAC,EAAE,wBAAwB,CAAC;IAE5C;;;;;;OAMG;IACH,cAAc,CAAC,EAAE,sBAAsB,CAAC;CAC3C;AA+BD;;;;;;;;;;;;;;GAcG;AACH,eAAO,MAAM,UAAU,6CAoCP,CAAC"}