@gooddata/sdk-ui 8.10.0-alpha.30 → 8.10.0-alpha.33
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.
- package/dist/base/errors/GoodDataSdkError.d.ts +4 -1
- package/dist/base/errors/GoodDataSdkError.d.ts.map +1 -1
- package/dist/base/errors/GoodDataSdkError.js +5 -2
- package/dist/base/errors/GoodDataSdkError.js.map +1 -1
- package/dist/base/errors/errorHandling.d.ts +5 -3
- package/dist/base/errors/errorHandling.d.ts.map +1 -1
- package/dist/base/errors/errorHandling.js +6 -4
- package/dist/base/errors/errorHandling.js.map +1 -1
- package/dist/base/headerMatching/HeaderPredicate.d.ts +5 -1
- package/dist/base/headerMatching/HeaderPredicate.d.ts.map +1 -1
- package/dist/base/headerMatching/HeaderPredicate.js.map +1 -1
- package/dist/base/headerMatching/HeaderPredicateFactory.d.ts +1 -0
- package/dist/base/headerMatching/HeaderPredicateFactory.d.ts.map +1 -1
- package/dist/base/headerMatching/HeaderPredicateFactory.js +1 -0
- package/dist/base/headerMatching/HeaderPredicateFactory.js.map +1 -1
- package/dist/base/headerMatching/MappingHeader.d.ts +2 -0
- package/dist/base/headerMatching/MappingHeader.d.ts.map +1 -1
- package/dist/base/headerMatching/MappingHeader.js +1 -1
- package/dist/base/headerMatching/MappingHeader.js.map +1 -1
- package/dist/base/helpers/CatalogHelper.d.ts +5 -3
- package/dist/base/helpers/CatalogHelper.d.ts.map +1 -1
- package/dist/base/helpers/CatalogHelper.js +5 -3
- package/dist/base/helpers/CatalogHelper.js.map +1 -1
- package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts +4 -0
- package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts.map +1 -1
- package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js +2 -0
- package/dist/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js.map +1 -1
- package/dist/base/react/BackendContext.d.ts +4 -0
- package/dist/base/react/BackendContext.d.ts.map +1 -1
- package/dist/base/react/BackendContext.js +5 -1
- package/dist/base/react/BackendContext.js.map +1 -1
- package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts +4 -1
- package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts.map +1 -1
- package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js +1 -1
- package/dist/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js.map +1 -1
- package/dist/base/react/ErrorComponent.d.ts +4 -2
- package/dist/base/react/ErrorComponent.d.ts.map +1 -1
- package/dist/base/react/ErrorComponent.js +5 -3
- package/dist/base/react/ErrorComponent.js.map +1 -1
- package/dist/base/react/LoadingComponent.d.ts +4 -2
- package/dist/base/react/LoadingComponent.d.ts.map +1 -1
- package/dist/base/react/LoadingComponent.js +5 -3
- package/dist/base/react/LoadingComponent.js.map +1 -1
- package/dist/base/react/WorkspaceContext.d.ts +4 -0
- package/dist/base/react/WorkspaceContext.d.ts.map +1 -1
- package/dist/base/react/WorkspaceContext.js +5 -1
- package/dist/base/react/WorkspaceContext.js.map +1 -1
- package/dist/base/react/placeholders/base.d.ts +75 -41
- package/dist/base/react/placeholders/base.d.ts.map +1 -1
- package/dist/base/react/placeholders/base.js +1 -1
- package/dist/base/react/placeholders/base.js.map +1 -1
- package/dist/base/react/placeholders/factory.d.ts +4 -2
- package/dist/base/react/placeholders/factory.d.ts.map +1 -1
- package/dist/base/react/placeholders/factory.js +1 -1
- package/dist/base/react/placeholders/factory.js.map +1 -1
- package/dist/base/react/placeholders/hooks.d.ts +8 -0
- package/dist/base/react/placeholders/hooks.d.ts.map +1 -1
- package/dist/base/react/placeholders/hooks.js +9 -1
- package/dist/base/react/placeholders/hooks.js.map +1 -1
- package/dist/base/react/useCancelablePromise.d.ts +2 -0
- package/dist/base/react/useCancelablePromise.d.ts.map +1 -1
- package/dist/base/react/useCancelablePromise.js +3 -1
- package/dist/base/react/useCancelablePromise.js.map +1 -1
- package/dist/base/react/useCancelablePromiseUtils.d.ts +2 -0
- package/dist/base/react/useCancelablePromiseUtils.d.ts.map +1 -1
- package/dist/base/react/useCancelablePromiseUtils.js +3 -1
- package/dist/base/react/useCancelablePromiseUtils.js.map +1 -1
- package/dist/base/results/dataAccess.d.ts +29 -8
- package/dist/base/results/dataAccess.d.ts.map +1 -1
- package/dist/base/results/dataAccessConfig.d.ts +4 -1
- package/dist/base/results/dataAccessConfig.d.ts.map +1 -1
- package/dist/base/results/dataAccessConfig.js +4 -1
- package/dist/base/results/dataAccessConfig.js.map +1 -1
- package/dist/base/results/facade.d.ts +8 -2
- package/dist/base/results/facade.d.ts.map +1 -1
- package/dist/base/results/facade.js +9 -3
- package/dist/base/results/facade.js.map +1 -1
- package/dist/base/vis/DrillEvents.d.ts +2 -0
- package/dist/base/vis/DrillEvents.d.ts.map +1 -1
- package/dist/base/vis/DrillEvents.js.map +1 -1
- package/dist/base/vis/VisualizationProps.d.ts +11 -4
- package/dist/base/vis/VisualizationProps.d.ts.map +1 -1
- package/dist/base/vis/VisualizationProps.js +1 -1
- package/dist/execution/Execute.d.ts +34 -18
- package/dist/execution/Execute.d.ts.map +1 -1
- package/dist/execution/Execute.js +6 -4
- package/dist/execution/Execute.js.map +1 -1
- package/dist/execution/ExecuteInsight.d.ts +28 -14
- package/dist/execution/ExecuteInsight.d.ts.map +1 -1
- package/dist/execution/ExecuteInsight.js +1 -1
- package/dist/execution/ExecuteInsight.js.map +1 -1
- package/dist/execution/RawExecute.d.ts +19 -7
- package/dist/execution/RawExecute.d.ts.map +1 -1
- package/dist/execution/RawExecute.js +2 -1
- package/dist/execution/RawExecute.js.map +1 -1
- package/dist/execution/createExecution.d.ts +8 -5
- package/dist/execution/createExecution.d.ts.map +1 -1
- package/dist/execution/createExecution.js.map +1 -1
- package/dist/execution/useDataExport.d.ts +2 -0
- package/dist/execution/useDataExport.d.ts.map +1 -1
- package/dist/execution/useDataExport.js +2 -0
- package/dist/execution/useDataExport.js.map +1 -1
- package/dist/execution/useDataView.d.ts +2 -0
- package/dist/execution/useDataView.d.ts.map +1 -1
- package/dist/execution/useDataView.js +2 -0
- package/dist/execution/useDataView.js.map +1 -1
- package/dist/execution/useExecution.d.ts +14 -8
- package/dist/execution/useExecution.d.ts.map +1 -1
- package/dist/execution/useExecution.js +2 -0
- package/dist/execution/useExecution.js.map +1 -1
- package/dist/execution/useExecutionDataView.d.ts +15 -9
- package/dist/execution/useExecutionDataView.d.ts.map +1 -1
- package/dist/execution/useExecutionDataView.js.map +1 -1
- package/dist/execution/useInsightDataView.d.ts +10 -5
- package/dist/execution/useInsightDataView.d.ts.map +1 -1
- package/dist/execution/useInsightDataView.js.map +1 -1
- package/dist/execution/withExecution.d.ts +5 -4
- package/dist/execution/withExecution.d.ts.map +1 -1
- package/dist/execution/withExecution.js +1 -1
- package/dist/execution/withExecution.js.map +1 -1
- package/dist/execution/withExecutionLoading.d.ts +12 -7
- package/dist/execution/withExecutionLoading.d.ts.map +1 -1
- package/dist/execution/withExecutionLoading.js +1 -1
- package/dist/execution/withExecutionLoading.js.map +1 -1
- package/dist/kpi/Kpi.d.ts +13 -9
- package/dist/kpi/Kpi.d.ts.map +1 -1
- package/dist/kpi/Kpi.js +5 -3
- package/dist/kpi/Kpi.js.map +1 -1
- package/dist/sdk-ui.d.ts +345 -152
- package/esm/base/errors/GoodDataSdkError.d.ts +4 -1
- package/esm/base/errors/GoodDataSdkError.d.ts.map +1 -1
- package/esm/base/errors/GoodDataSdkError.js +5 -2
- package/esm/base/errors/GoodDataSdkError.js.map +1 -1
- package/esm/base/errors/errorHandling.d.ts +5 -3
- package/esm/base/errors/errorHandling.d.ts.map +1 -1
- package/esm/base/errors/errorHandling.js +6 -4
- package/esm/base/errors/errorHandling.js.map +1 -1
- package/esm/base/headerMatching/HeaderPredicate.d.ts +5 -1
- package/esm/base/headerMatching/HeaderPredicate.d.ts.map +1 -1
- package/esm/base/headerMatching/HeaderPredicate.js.map +1 -1
- package/esm/base/headerMatching/HeaderPredicateFactory.d.ts +1 -0
- package/esm/base/headerMatching/HeaderPredicateFactory.d.ts.map +1 -1
- package/esm/base/headerMatching/HeaderPredicateFactory.js +1 -0
- package/esm/base/headerMatching/HeaderPredicateFactory.js.map +1 -1
- package/esm/base/headerMatching/MappingHeader.d.ts +2 -0
- package/esm/base/headerMatching/MappingHeader.d.ts.map +1 -1
- package/esm/base/headerMatching/MappingHeader.js +1 -1
- package/esm/base/headerMatching/MappingHeader.js.map +1 -1
- package/esm/base/helpers/CatalogHelper.d.ts +5 -3
- package/esm/base/helpers/CatalogHelper.d.ts.map +1 -1
- package/esm/base/helpers/CatalogHelper.js +5 -3
- package/esm/base/helpers/CatalogHelper.js.map +1 -1
- package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts +4 -0
- package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.d.ts.map +1 -1
- package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js +2 -0
- package/esm/base/localization/TranslationsCustomizationProvider/TranslationsCustomizationProvider.js.map +1 -1
- package/esm/base/react/BackendContext.d.ts +4 -0
- package/esm/base/react/BackendContext.d.ts.map +1 -1
- package/esm/base/react/BackendContext.js +5 -1
- package/esm/base/react/BackendContext.js.map +1 -1
- package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts +4 -1
- package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.d.ts.map +1 -1
- package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js +1 -1
- package/esm/base/react/ClientWorkspaceContext/ClientWorkspaceContext.js.map +1 -1
- package/esm/base/react/ErrorComponent.d.ts +4 -2
- package/esm/base/react/ErrorComponent.d.ts.map +1 -1
- package/esm/base/react/ErrorComponent.js +5 -3
- package/esm/base/react/ErrorComponent.js.map +1 -1
- package/esm/base/react/LoadingComponent.d.ts +4 -2
- package/esm/base/react/LoadingComponent.d.ts.map +1 -1
- package/esm/base/react/LoadingComponent.js +5 -3
- package/esm/base/react/LoadingComponent.js.map +1 -1
- package/esm/base/react/WorkspaceContext.d.ts +4 -0
- package/esm/base/react/WorkspaceContext.d.ts.map +1 -1
- package/esm/base/react/WorkspaceContext.js +5 -1
- package/esm/base/react/WorkspaceContext.js.map +1 -1
- package/esm/base/react/placeholders/base.d.ts +75 -41
- package/esm/base/react/placeholders/base.d.ts.map +1 -1
- package/esm/base/react/placeholders/base.js +1 -1
- package/esm/base/react/placeholders/base.js.map +1 -1
- package/esm/base/react/placeholders/factory.d.ts +4 -2
- package/esm/base/react/placeholders/factory.d.ts.map +1 -1
- package/esm/base/react/placeholders/factory.js +1 -1
- package/esm/base/react/placeholders/factory.js.map +1 -1
- package/esm/base/react/placeholders/hooks.d.ts +8 -0
- package/esm/base/react/placeholders/hooks.d.ts.map +1 -1
- package/esm/base/react/placeholders/hooks.js +9 -1
- package/esm/base/react/placeholders/hooks.js.map +1 -1
- package/esm/base/react/useCancelablePromise.d.ts +2 -0
- package/esm/base/react/useCancelablePromise.d.ts.map +1 -1
- package/esm/base/react/useCancelablePromise.js +3 -1
- package/esm/base/react/useCancelablePromise.js.map +1 -1
- package/esm/base/react/useCancelablePromiseUtils.d.ts +2 -0
- package/esm/base/react/useCancelablePromiseUtils.d.ts.map +1 -1
- package/esm/base/react/useCancelablePromiseUtils.js +3 -1
- package/esm/base/react/useCancelablePromiseUtils.js.map +1 -1
- package/esm/base/results/dataAccess.d.ts +29 -8
- package/esm/base/results/dataAccess.d.ts.map +1 -1
- package/esm/base/results/dataAccessConfig.d.ts +4 -1
- package/esm/base/results/dataAccessConfig.d.ts.map +1 -1
- package/esm/base/results/dataAccessConfig.js +4 -1
- package/esm/base/results/dataAccessConfig.js.map +1 -1
- package/esm/base/results/facade.d.ts +8 -2
- package/esm/base/results/facade.d.ts.map +1 -1
- package/esm/base/results/facade.js +9 -3
- package/esm/base/results/facade.js.map +1 -1
- package/esm/base/vis/DrillEvents.d.ts +2 -0
- package/esm/base/vis/DrillEvents.d.ts.map +1 -1
- package/esm/base/vis/DrillEvents.js.map +1 -1
- package/esm/base/vis/VisualizationProps.d.ts +11 -4
- package/esm/base/vis/VisualizationProps.d.ts.map +1 -1
- package/esm/base/vis/VisualizationProps.js +1 -1
- package/esm/execution/Execute.d.ts +34 -18
- package/esm/execution/Execute.d.ts.map +1 -1
- package/esm/execution/Execute.js +6 -4
- package/esm/execution/Execute.js.map +1 -1
- package/esm/execution/ExecuteInsight.d.ts +28 -14
- package/esm/execution/ExecuteInsight.d.ts.map +1 -1
- package/esm/execution/ExecuteInsight.js +1 -1
- package/esm/execution/ExecuteInsight.js.map +1 -1
- package/esm/execution/RawExecute.d.ts +19 -7
- package/esm/execution/RawExecute.d.ts.map +1 -1
- package/esm/execution/RawExecute.js +2 -1
- package/esm/execution/RawExecute.js.map +1 -1
- package/esm/execution/createExecution.d.ts +8 -5
- package/esm/execution/createExecution.d.ts.map +1 -1
- package/esm/execution/createExecution.js.map +1 -1
- package/esm/execution/useDataExport.d.ts +2 -0
- package/esm/execution/useDataExport.d.ts.map +1 -1
- package/esm/execution/useDataExport.js +2 -0
- package/esm/execution/useDataExport.js.map +1 -1
- package/esm/execution/useDataView.d.ts +2 -0
- package/esm/execution/useDataView.d.ts.map +1 -1
- package/esm/execution/useDataView.js +2 -0
- package/esm/execution/useDataView.js.map +1 -1
- package/esm/execution/useExecution.d.ts +14 -8
- package/esm/execution/useExecution.d.ts.map +1 -1
- package/esm/execution/useExecution.js +2 -0
- package/esm/execution/useExecution.js.map +1 -1
- package/esm/execution/useExecutionDataView.d.ts +15 -9
- package/esm/execution/useExecutionDataView.d.ts.map +1 -1
- package/esm/execution/useExecutionDataView.js.map +1 -1
- package/esm/execution/useInsightDataView.d.ts +10 -5
- package/esm/execution/useInsightDataView.d.ts.map +1 -1
- package/esm/execution/useInsightDataView.js.map +1 -1
- package/esm/execution/withExecution.d.ts +5 -4
- package/esm/execution/withExecution.d.ts.map +1 -1
- package/esm/execution/withExecution.js +1 -1
- package/esm/execution/withExecution.js.map +1 -1
- package/esm/execution/withExecutionLoading.d.ts +12 -7
- package/esm/execution/withExecutionLoading.d.ts.map +1 -1
- package/esm/execution/withExecutionLoading.js +1 -1
- package/esm/execution/withExecutionLoading.js.map +1 -1
- package/esm/kpi/Kpi.d.ts +13 -9
- package/esm/kpi/Kpi.d.ts.map +1 -1
- package/esm/kpi/Kpi.js +5 -3
- package/esm/kpi/Kpi.js.map +1 -1
- package/package.json +7 -7
|
@@ -16,6 +16,7 @@ export declare type DataPointCoordinates = number[];
|
|
|
16
16
|
* Data Point represents a value computed for particular data series, possibly sliced for additional
|
|
17
17
|
* set of attribute elements OR possibly being a total.
|
|
18
18
|
*
|
|
19
|
+
* @remarks
|
|
19
20
|
* Technically, DataPoint is the raw data value stored in the data view decorated with all the metadata
|
|
20
21
|
* there exists about that value.
|
|
21
22
|
*
|
|
@@ -121,6 +122,7 @@ export declare type DataSeriesDescriptor = DataSeriesHeaders & DataSeriesDescrip
|
|
|
121
122
|
* Data series is a sequence of data points that are all computed from a single measure, optionally scoped for
|
|
122
123
|
* particular attribute elements.
|
|
123
124
|
*
|
|
125
|
+
* @remarks
|
|
124
126
|
* In other words, data series allows iterating over two dimensional data view _along_ the dimension which contains
|
|
125
127
|
* the measures (via inclusion of MeasureGroupIdentifier).
|
|
126
128
|
*
|
|
@@ -151,7 +153,10 @@ export interface IDataSeries extends DataSeriesDescriptorMethods, Iterable<DataP
|
|
|
151
153
|
dataPoints(): DataPoint[];
|
|
152
154
|
}
|
|
153
155
|
/**
|
|
154
|
-
* An iterable collection of data series.
|
|
156
|
+
* An iterable collection of data series.
|
|
157
|
+
*
|
|
158
|
+
* @remarks
|
|
159
|
+
* The collection additionally includes basic information about the
|
|
155
160
|
* origin of the data series that can be iterated - their number, measures they were calculated from and
|
|
156
161
|
* optionally the scoping attributes.
|
|
157
162
|
*
|
|
@@ -165,6 +170,7 @@ export interface IDataSeriesCollection extends Iterable<IDataSeries> {
|
|
|
165
170
|
/**
|
|
166
171
|
* Descriptors of measures that are used in the data series.
|
|
167
172
|
*
|
|
173
|
+
* @remarks
|
|
168
174
|
* Note that the number of measures MAY differ from number of data series - that is because the data series may be
|
|
169
175
|
* created for multiple scopes of each measure (e.g. measure X calculated for attribute element A, then same
|
|
170
176
|
* measure calculated for attribute element B etc)
|
|
@@ -173,6 +179,7 @@ export interface IDataSeriesCollection extends Iterable<IDataSeries> {
|
|
|
173
179
|
/**
|
|
174
180
|
* Definitions of measures which were sent to execution and resulted in the data series.
|
|
175
181
|
*
|
|
182
|
+
* @remarks
|
|
176
183
|
* Order of appearance matches the order of appearance in the `fromMeasures` array.
|
|
177
184
|
*/
|
|
178
185
|
readonly fromMeasuresDef: IMeasure[];
|
|
@@ -184,6 +191,7 @@ export interface IDataSeriesCollection extends Iterable<IDataSeries> {
|
|
|
184
191
|
* Definitions of attributes which were sent to execution and resulted in the data series with scoped
|
|
185
192
|
* measure values.
|
|
186
193
|
*
|
|
194
|
+
* @remarks
|
|
187
195
|
* Order of apperance matches the order of appreance in the `scopingAttributes` array.
|
|
188
196
|
*/
|
|
189
197
|
readonly scopingAttributesDef?: IAttribute[];
|
|
@@ -195,8 +203,10 @@ export interface IDataSeriesCollection extends Iterable<IDataSeries> {
|
|
|
195
203
|
*/
|
|
196
204
|
allForMeasure(localIdOrMeasure: string | IMeasure): Iterable<IDataSeries>;
|
|
197
205
|
/**
|
|
198
|
-
* Returns first-found data series for the provided measure.
|
|
199
|
-
*
|
|
206
|
+
* Returns first-found data series for the provided measure.
|
|
207
|
+
*
|
|
208
|
+
* @remarks
|
|
209
|
+
* This is a 'get-or-die' method and will throw in case data series from the provided measure is not located.
|
|
200
210
|
*
|
|
201
211
|
* @param localIdOrMeasure - local id of measure or measure object to get local id from
|
|
202
212
|
* @returns data series
|
|
@@ -206,6 +216,7 @@ export interface IDataSeriesCollection extends Iterable<IDataSeries> {
|
|
|
206
216
|
/**
|
|
207
217
|
* Returns all data series in an array.
|
|
208
218
|
*
|
|
219
|
+
* @remarks
|
|
209
220
|
* Note: if you are looking for a subset of measures, always prefer using the first-class methods
|
|
210
221
|
* {@link IDataSeriesCollection#allForMeasure} and {@link IDataSeriesCollection#firstForMeasure} in favor of getting the array and filtering yourself.
|
|
211
222
|
*
|
|
@@ -214,8 +225,11 @@ export interface IDataSeriesCollection extends Iterable<IDataSeries> {
|
|
|
214
225
|
toArray(): IDataSeries[];
|
|
215
226
|
}
|
|
216
227
|
/**
|
|
217
|
-
* Data slice name is specified using the result headers.
|
|
218
|
-
*
|
|
228
|
+
* Data slice name is specified using the result headers.
|
|
229
|
+
*
|
|
230
|
+
* @remarks
|
|
231
|
+
* The headers describe attribute elements (title+ID) for the slice. The slice MAY be for a total calculation,
|
|
232
|
+
* in which case the last header will be for the
|
|
219
233
|
* total.
|
|
220
234
|
*
|
|
221
235
|
* @public
|
|
@@ -269,6 +283,7 @@ export declare type DataSliceDescriptor = DataSliceHeaders & DataSliceDescriptor
|
|
|
269
283
|
* Data slice is a sequence of data points that are all computed for a particular attribute elements and/or totals but
|
|
270
284
|
* different data series.
|
|
271
285
|
*
|
|
286
|
+
* @remarks
|
|
272
287
|
* In other words, data slice allows iterating over two dimension data view _across_ the dimension which contains
|
|
273
288
|
* the measures.
|
|
274
289
|
*
|
|
@@ -299,7 +314,10 @@ export interface IDataSlice extends DataSliceDescriptorMethods, Iterable<DataPoi
|
|
|
299
314
|
dataPoints(): DataPoint[];
|
|
300
315
|
}
|
|
301
316
|
/**
|
|
302
|
-
* An iterable collection of data slices.
|
|
317
|
+
* An iterable collection of data slices.
|
|
318
|
+
*
|
|
319
|
+
* @remarks
|
|
320
|
+
* The collection additionally includes basic information about the
|
|
303
321
|
* origin of the data slices that can be iterated - their number and attributes or totals that were used
|
|
304
322
|
* for slicing.
|
|
305
323
|
*
|
|
@@ -325,8 +343,11 @@ export interface IDataSliceCollection extends Iterable<IDataSlice> {
|
|
|
325
343
|
toArray(): IDataSlice[];
|
|
326
344
|
}
|
|
327
345
|
/**
|
|
328
|
-
* Defines methods to access data in the data view.
|
|
329
|
-
*
|
|
346
|
+
* Defines methods to access data in the data view.
|
|
347
|
+
*
|
|
348
|
+
* @remarks
|
|
349
|
+
* These methods and types are recommended in favor of directly accessing the underlying data,
|
|
350
|
+
* headers and descriptors.
|
|
330
351
|
*
|
|
331
352
|
* @public
|
|
332
353
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataAccess.d.ts","sourceRoot":"","sources":["../../../src/base/results/dataAccess.ts"],"names":[],"mappings":"AACA,OAAO,EACH,SAAS,EACT,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,EACrB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAEnE;;GAEG;AACH,oBAAY,YAAY,GAAG,MAAM,CAAC;AAElC;;GAEG;AACH,oBAAY,WAAW,GAAG,MAAM,CAAC;AAEjC;;GAEG;AACH,oBAAY,oBAAoB,GAAG,MAAM,EAAE,CAAC;AAE5C
|
|
1
|
+
{"version":3,"file":"dataAccess.d.ts","sourceRoot":"","sources":["../../../src/base/results/dataAccess.ts"],"names":[],"mappings":"AACA,OAAO,EACH,SAAS,EACT,oBAAoB,EACpB,kBAAkB,EAClB,sBAAsB,EACtB,oBAAoB,EACpB,kBAAkB,EACrB,MAAM,2BAA2B,CAAC;AACnC,OAAO,EAAE,UAAU,EAAE,QAAQ,EAAE,MAAM,EAAE,MAAM,qBAAqB,CAAC;AAEnE;;GAEG;AACH,oBAAY,YAAY,GAAG,MAAM,CAAC;AAElC;;GAEG;AACH,oBAAY,WAAW,GAAG,MAAM,CAAC;AAEjC;;GAEG;AACH,oBAAY,oBAAoB,GAAG,MAAM,EAAE,CAAC;AAE5C;;;;;;;;;GASG;AACH,oBAAY,SAAS,GAAG;IACpB;;OAEG;IACH,QAAQ,CAAC,QAAQ,EAAE,SAAS,CAAC;IAE7B;;;OAGG;IACH,cAAc,IAAI,IAAI,GAAG,MAAM,CAAC;IAEhC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,oBAAoB,CAAC;IAE3C;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;;OAGG;IACH,QAAQ,CAAC,SAAS,CAAC,EAAE,mBAAmB,CAAC;IAEzC;;OAEG;IACH,QAAQ,CAAC,KAAK,CAAC,EAAE,OAAO,CAAC;CAC5B,CAAC;AAMF;;GAEG;AACH,oBAAY,iBAAiB,GAAG;IAC5B;;;OAGG;IACH,QAAQ,CAAC,aAAa,EAAE,oBAAoB,CAAC;IAE7C;;;;;OAKG;IACH,QAAQ,CAAC,gBAAgB,CAAC,EAAE,sBAAsB,EAAE,CAAC;CACxD,CAAC;AAEF;;GAEG;AACH,oBAAY,2BAA2B,GAAG;IACtC;;OAEG;IACH,YAAY,IAAI,MAAM,CAAC;IAEvB;;OAEG;IACH,aAAa,IAAI,MAAM,CAAC;IAExB;;OAEG;IACH,WAAW,IAAI,MAAM,EAAE,CAAC;CAC3B,CAAC;AAEF;;;;GAIG;AACH,oBAAY,oBAAoB,GAAG,iBAAiB,GAChD,2BAA2B,GAAG;IAC1B;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,YAAY,CAAC;IAE1B;;;;OAIG;IACH,QAAQ,CAAC,iBAAiB,EAAE,kBAAkB,CAAC;IAE/C;;OAEG;IACH,QAAQ,CAAC,iBAAiB,EAAE,QAAQ,CAAC;IAErC;;;;OAIG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAEvD;;;;;OAKG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,UAAU,EAAE,CAAC;CAChD,CAAC;AAEN;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,WAAY,SAAQ,2BAA2B,EAAE,QAAQ,CAAC,SAAS,CAAC;IACjF;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,YAAY,CAAC;IAE1B;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,oBAAoB,CAAC;IAE1C;;;OAGG;IACH,OAAO,IAAI,SAAS,EAAE,CAAC;IAEvB;;;;OAIG;IACH,UAAU,IAAI,SAAS,EAAE,CAAC;CAC7B;AAED;;;;;;;;;GASG;AACH,MAAM,WAAW,qBAAsB,SAAQ,QAAQ,CAAC,WAAW,CAAC;IAChE;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB;;;;;;;OAOG;IACH,QAAQ,CAAC,YAAY,EAAE,kBAAkB,EAAE,CAAC;IAE5C;;;;;OAKG;IACH,QAAQ,CAAC,eAAe,EAAE,QAAQ,EAAE,CAAC;IAErC;;OAEG;IACH,QAAQ,CAAC,iBAAiB,CAAC,EAAE,oBAAoB,EAAE,CAAC;IAEpD;;;;;;OAMG;IACH,QAAQ,CAAC,oBAAoB,CAAC,EAAE,UAAU,EAAE,CAAC;IAE7C;;;;;OAKG;IACH,aAAa,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ,GAAG,QAAQ,CAAC,WAAW,CAAC,CAAC;IAE1E;;;;;;;;;OASG;IACH,eAAe,CAAC,gBAAgB,EAAE,MAAM,GAAG,QAAQ,GAAG,WAAW,CAAC;IAElE;;;;;;;;OAQG;IACH,OAAO,IAAI,WAAW,EAAE,CAAC;CAC5B;AAMD;;;;;;;;;GASG;AACH,oBAAY,gBAAgB,GAAG;IAC3B;;OAEG;IACH,QAAQ,CAAC,OAAO,EAAE,KAAK,CAAC,sBAAsB,GAAG,kBAAkB,CAAC,CAAC;IAErE;;OAEG;IACH,QAAQ,CAAC,OAAO,CAAC,EAAE,OAAO,CAAC;CAC9B,CAAC;AAEF;;GAEG;AACH,oBAAY,0BAA0B,GAAG;IACrC;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,MAAM,MAAM,EAAE,CAAC;CACxC,CAAC;AAEF;;;;;GAKG;AACH,oBAAY,mBAAmB,GAAG,gBAAgB,GAC9C,0BAA0B,GAAG;IACzB;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC;IAEzB;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,EAAE,oBAAoB,EAAE,CAAC;IAE7C;;;;;OAKG;IACH,QAAQ,CAAC,WAAW,EAAE,UAAU,EAAE,CAAC;CACtC,CAAC;AAEN;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,UAAW,SAAQ,0BAA0B,EAAE,QAAQ,CAAC,SAAS,CAAC;IAC/E;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,WAAW,CAAC;IAEzB;;OAEG;IACH,QAAQ,CAAC,UAAU,EAAE,mBAAmB,CAAC;IAEzC;;;OAGG;IACH,OAAO,IAAI,SAAS,EAAE,CAAC;IAEvB;;;;OAIG;IACH,UAAU,IAAI,SAAS,EAAE,CAAC;CAC7B;AAED;;;;;;;;;;;;GAYG;AACH,MAAM,WAAW,oBAAqB,SAAQ,QAAQ,CAAC,UAAU,CAAC;IAC9D;;OAEG;IACH,QAAQ,CAAC,KAAK,EAAE,MAAM,CAAC;IAEvB;;OAEG;IACH,QAAQ,CAAC,WAAW,EAAE,KAAK,CAAC,oBAAoB,GAAG,MAAM,CAAC,CAAC;IAE3D;;;;OAIG;IACH,OAAO,IAAI,UAAU,EAAE,CAAC;CAC3B;AAED;;;;;;;;GAQG;AACH,MAAM,WAAW,kBAAkB;IAC/B;;OAEG;IACH,MAAM,IAAI,qBAAqB,CAAC;IAEhC;;OAEG;IACH,MAAM,IAAI,oBAAoB,CAAC;CAClC"}
|
|
@@ -10,7 +10,10 @@ export declare type ValueFormatter = (value: DataValue, format: string) => strin
|
|
|
10
10
|
export declare type HeaderTranslator = (value: string) => string;
|
|
11
11
|
/**
|
|
12
12
|
* Creates value formatter that uses `@gooddata/numberjs` to format raw measure values according
|
|
13
|
-
* to the format string.
|
|
13
|
+
* to the format string.
|
|
14
|
+
*
|
|
15
|
+
* @remarks
|
|
16
|
+
* By default, the format will strip away all the coloring information and
|
|
14
17
|
* just return the value as string.
|
|
15
18
|
*
|
|
16
19
|
* @param separators - number separators to use. if not specified then `numberjs` defaults will be used
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataAccessConfig.d.ts","sourceRoot":"","sources":["../../../src/base/results/dataAccessConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,WAAW,EAA8C,MAAM,oBAAoB,CAAC;AAO7F;;GAEG;AACH,oBAAY,cAAc,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;AAE1E;;GAEG;AACH,oBAAY,gBAAgB,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;AAEzD
|
|
1
|
+
{"version":3,"file":"dataAccessConfig.d.ts","sourceRoot":"","sources":["../../../src/base/results/dataAccessConfig.ts"],"names":[],"mappings":"AACA,OAAO,EAAE,SAAS,EAAE,MAAM,2BAA2B,CAAC;AACtD,OAAO,EAAE,WAAW,EAA8C,MAAM,oBAAoB,CAAC;AAO7F;;GAEG;AACH,oBAAY,cAAc,GAAG,CAAC,KAAK,EAAE,SAAS,EAAE,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC;AAE1E;;GAEG;AACH,oBAAY,gBAAgB,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;AAEzD;;;;;;;;;;GAUG;AACH,wBAAgB,uBAAuB,CAAC,UAAU,CAAC,EAAE,WAAW,GAAG,cAAc,CAShF;AAED;;;;GAIG;AACH,eAAO,MAAM,uBAAuB,EAAE,gBAErC,CAAC;AAEF;;GAEG;AACH,oBAAY,gBAAgB,GAAG;IAC3B;;OAEG;IACH,cAAc,EAAE,cAAc,CAAC;IAE/B;;OAEG;IACH,gBAAgB,CAAC,EAAE,gBAAgB,CAAC;CACvC,CAAC"}
|
|
@@ -9,7 +9,10 @@ var unescape_1 = tslib_1.__importDefault(require("lodash/unescape"));
|
|
|
9
9
|
var customEscape = function (str) { return str && escape_1.default(unescape_1.default(str)); };
|
|
10
10
|
/**
|
|
11
11
|
* Creates value formatter that uses `@gooddata/numberjs` to format raw measure values according
|
|
12
|
-
* to the format string.
|
|
12
|
+
* to the format string.
|
|
13
|
+
*
|
|
14
|
+
* @remarks
|
|
15
|
+
* By default, the format will strip away all the coloring information and
|
|
13
16
|
* just return the value as string.
|
|
14
17
|
*
|
|
15
18
|
* @param separators - number separators to use. if not specified then `numberjs` defaults will be used
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"dataAccessConfig.js","sourceRoot":"","sources":["../../../src/base/results/dataAccessConfig.ts"],"names":[],"mappings":";;;;AAEA,+CAA6F;AAC7F,mEAAqC;AACrC,iEAAmC;AACnC,qEAAuC;AAEvC,IAAM,YAAY,GAAG,UAAC,GAAW,IAAK,OAAA,GAAG,IAAI,gBAAM,CAAC,kBAAQ,CAAC,GAAG,CAAC,CAAC,EAA5B,CAA4B,CAAC;AAYnE
|
|
1
|
+
{"version":3,"file":"dataAccessConfig.js","sourceRoot":"","sources":["../../../src/base/results/dataAccessConfig.ts"],"names":[],"mappings":";;;;AAEA,+CAA6F;AAC7F,mEAAqC;AACrC,iEAAmC;AACnC,qEAAuC;AAEvC,IAAM,YAAY,GAAG,UAAC,GAAW,IAAK,OAAA,GAAG,IAAI,gBAAM,CAAC,kBAAQ,CAAC,GAAG,CAAC,CAAC,EAA5B,CAA4B,CAAC;AAYnE;;;;;;;;;;GAUG;AACH,SAAgB,uBAAuB,CAAC,UAAwB;IAC5D,OAAO,UAAC,KAAgB,EAAE,MAAc;QACpC,IAAM,aAAa,GAAG,KAAK,KAAK,IAAI,IAAI,CAAC,iBAAO,CAAC,MAAM,CAAC,CAAC,CAAC,CAAC,EAAE,CAAC,CAAC,CAAC,UAAU,CAAC,KAAe,CAAC,CAAC;QAE5F,IAAM,cAAc,GAAG,uBAAY,CAAC,aAAa,EAAE,MAAM,EAAE,SAAS,EAAE,UAAU,CAAC,CAAC;QAClF,IAAM,eAAe,GAAkB,wBAAa,CAAC,cAAc,CAAC,CAAC;QAErE,OAAO,YAAY,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;IAC/C,CAAC,CAAC;AACN,CAAC;AATD,0DASC;AAED;;;;GAIG;AACU,QAAA,uBAAuB,GAAqB;IACrD,cAAc,EAAE,uBAAuB,EAAE;CAC5C,CAAC"}
|
|
@@ -6,7 +6,10 @@ import { IResultMetaMethods } from "./internal/resultMetaMethods";
|
|
|
6
6
|
import { IResultDataMethods } from "./internal/resultDataMethods";
|
|
7
7
|
import { IDataAccessMethods } from "./dataAccess";
|
|
8
8
|
/**
|
|
9
|
-
*
|
|
9
|
+
* Wrapper for {@link @gooddata/sdk-backend-spi#IDataView}.
|
|
10
|
+
*
|
|
11
|
+
* @remarks
|
|
12
|
+
* This provides various convenience methods to work with data and metadata stored inside
|
|
10
13
|
* the provided instance of {@link @gooddata/sdk-backend-spi#IDataView}.
|
|
11
14
|
*
|
|
12
15
|
* The facade keeps an ephemeral state - such as calculated indexes on top of the headers in the {@link @gooddata/sdk-backend-spi#IDataView} -
|
|
@@ -37,7 +40,10 @@ export declare class DataViewFacade {
|
|
|
37
40
|
*/
|
|
38
41
|
static for(dataView: IDataView): DataViewFacade;
|
|
39
42
|
/**
|
|
40
|
-
* Creates a DataViewFacade with provided execution result.
|
|
43
|
+
* Creates a DataViewFacade with provided execution result.
|
|
44
|
+
*
|
|
45
|
+
* @remarks
|
|
46
|
+
* Only use this when execution result is unable to load data and some
|
|
41
47
|
* form of DataViewFacade is still needed. Beware that the calculated data view is empty after the creation. Only execution
|
|
42
48
|
* definition and result is defined.
|
|
43
49
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"facade.d.ts","sourceRoot":"","sources":["../../../src/base/results/facade.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACxF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAgC,MAAM,8BAA8B,CAAC;AACzG,OAAO,EAAE,kBAAkB,EAAwB,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAwB,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGlD
|
|
1
|
+
{"version":3,"file":"facade.d.ts","sourceRoot":"","sources":["../../../src/base/results/facade.ts"],"names":[],"mappings":"AACA,OAAO,EAAkB,oBAAoB,EAAE,MAAM,qBAAqB,CAAC;AAC3E,OAAO,EAAE,SAAS,EAAE,gBAAgB,EAAE,cAAc,EAAE,MAAM,2BAA2B,CAAC;AACxF,OAAO,EAAE,gBAAgB,EAAE,MAAM,oBAAoB,CAAC;AACtD,OAAO,EAAE,2BAA2B,EAAgC,MAAM,8BAA8B,CAAC;AACzG,OAAO,EAAE,kBAAkB,EAAwB,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAwB,MAAM,8BAA8B,CAAC;AACxF,OAAO,EAAE,kBAAkB,EAAE,MAAM,cAAc,CAAC;AAGlD;;;;;;;;;;;;;;;;;;GAkBG;AACH,qBAAa,cAAc;aAce,QAAQ,EAAE,SAAS;IAbzD,OAAO,CAAC,MAAM,CAAC,OAAO,CAAgF;IACtG,OAAO,CAAC,MAAM,CAAC,gBAAgB,CAG3B;IAEJ,SAAgB,UAAU,EAAE,oBAAoB,CAAC;IAEjD,OAAO,CAAC,iBAAiB,CAA0C;IACnE,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,iBAAiB,CAAiC;IAC1D,OAAO,CAAC,iBAAiB,CAAiC;IAE1D,SAAS,aAA6B,QAAQ,EAAE,SAAS;IAQzD;;;OAGG;WACW,GAAG,CAAC,QAAQ,EAAE,SAAS,GAAG,cAAc;IAQtD;;;;;;;;;;OAUG;WACW,SAAS,CAAC,MAAM,EAAE,gBAAgB,GAAG,cAAc;IASjE;;;OAGG;IACI,MAAM,IAAI,gBAAgB;IAIjC;;;OAGG;IACI,QAAQ,IAAI,cAAc,EAAE;IAInC;;;;OAIG;IACI,WAAW,IAAI,MAAM;IAI5B;;;OAGG;IACI,IAAI,CAAC,MAAM,CAAC,EAAE,gBAAgB,GAAG,kBAAkB;IAY1D;;;OAGG;IACI,GAAG,IAAI,2BAA2B;IAQzC;;;OAGG;IACI,IAAI,IAAI,kBAAkB;IAQjC;;;OAGG;IACI,OAAO,IAAI,kBAAkB;CAOvC;AAED;;;;;;GAMG;AACH,wBAAgB,sBAAsB,CAAC,MAAM,EAAE,gBAAgB,GAAG,SAAS,CAmB1E"}
|
|
@@ -1,14 +1,17 @@
|
|
|
1
1
|
"use strict";
|
|
2
2
|
Object.defineProperty(exports, "__esModule", { value: true });
|
|
3
3
|
exports.emptyDataViewForResult = exports.DataViewFacade = void 0;
|
|
4
|
-
// (C) 2019-
|
|
4
|
+
// (C) 2019-2022 GoodData Corporation
|
|
5
5
|
var sdk_model_1 = require("@gooddata/sdk-model");
|
|
6
6
|
var definitionMethods_1 = require("./internal/definitionMethods");
|
|
7
7
|
var resultMetaMethods_1 = require("./internal/resultMetaMethods");
|
|
8
8
|
var resultDataMethods_1 = require("./internal/resultDataMethods");
|
|
9
9
|
var dataAccessMethods_1 = require("./internal/dataAccessMethods");
|
|
10
10
|
/**
|
|
11
|
-
*
|
|
11
|
+
* Wrapper for {@link @gooddata/sdk-backend-spi#IDataView}.
|
|
12
|
+
*
|
|
13
|
+
* @remarks
|
|
14
|
+
* This provides various convenience methods to work with data and metadata stored inside
|
|
12
15
|
* the provided instance of {@link @gooddata/sdk-backend-spi#IDataView}.
|
|
13
16
|
*
|
|
14
17
|
* The facade keeps an ephemeral state - such as calculated indexes on top of the headers in the {@link @gooddata/sdk-backend-spi#IDataView} -
|
|
@@ -42,7 +45,10 @@ var DataViewFacade = /** @class */ (function () {
|
|
|
42
45
|
return DataViewFacade.Facades.get(dataView);
|
|
43
46
|
};
|
|
44
47
|
/**
|
|
45
|
-
* Creates a DataViewFacade with provided execution result.
|
|
48
|
+
* Creates a DataViewFacade with provided execution result.
|
|
49
|
+
*
|
|
50
|
+
* @remarks
|
|
51
|
+
* Only use this when execution result is unable to load data and some
|
|
46
52
|
* form of DataViewFacade is still needed. Beware that the calculated data view is empty after the creation. Only execution
|
|
47
53
|
* definition and result is defined.
|
|
48
54
|
*
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"facade.js","sourceRoot":"","sources":["../../../src/base/results/facade.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AACrC,iDAA2E;AAG3E,kEAAyG;AACzG,kEAAwF;AACxF,kEAAwF;AAExF,kEAAoE;AAEpE
|
|
1
|
+
{"version":3,"file":"facade.js","sourceRoot":"","sources":["../../../src/base/results/facade.ts"],"names":[],"mappings":";;;AAAA,qCAAqC;AACrC,iDAA2E;AAG3E,kEAAyG;AACzG,kEAAwF;AACxF,kEAAwF;AAExF,kEAAoE;AAEpE;;;;;;;;;;;;;;;;;;GAkBG;AACH;IAcI,wBAAsC,QAAmB;QAAnB,aAAQ,GAAR,QAAQ,CAAW;QACrD,IAAI,CAAC,UAAU,GAAG,QAAQ,CAAC,UAAU,CAAC;IAC1C,CAAC;IAED,EAAE;IACF,cAAc;IACd,EAAE;IAEF;;;OAGG;IACW,kBAAG,GAAjB,UAAkB,QAAmB;QACjC,IAAI,CAAC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAC,EAAE;YACvC,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,EAAE,IAAI,cAAc,CAAC,QAAQ,CAAC,CAAC,CAAC;SACtE;QAED,OAAO,cAAc,CAAC,OAAO,CAAC,GAAG,CAAC,QAAQ,CAAE,CAAC;IACjD,CAAC;IAED;;;;;;;;;;OAUG;IACW,wBAAS,GAAvB,UAAwB,MAAwB;QAC5C,IAAI,CAAC,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAC,EAAE;YAC9C,IAAM,SAAS,GAAG,sBAAsB,CAAC,MAAM,CAAC,CAAC;YACjD,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,EAAE,IAAI,cAAc,CAAC,SAAS,CAAC,CAAC,CAAC;SAC9E;QAED,OAAO,cAAc,CAAC,gBAAgB,CAAC,GAAG,CAAC,MAAM,CAAE,CAAC;IACxD,CAAC;IAED;;;OAGG;IACI,+BAAM,GAAb;QACI,OAAO,IAAI,CAAC,QAAQ,CAAC,MAAM,CAAC;IAChC,CAAC;IAED;;;OAGG;IACI,iCAAQ,GAAf;;QACI,aAAO,IAAI,CAAC,QAAQ,CAAC,QAAQ,mCAAI,EAAE,CAAC;IACxC,CAAC;IAED;;;;OAIG;IACI,oCAAW,GAAlB;QACI,OAAO,IAAI,CAAC,QAAQ,CAAC,WAAW,EAAE,CAAC;IACvC,CAAC;IAED;;;OAGG;IACI,6BAAI,GAAX,UAAY,MAAyB;QACjC,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,wCAAoB,CAAC,IAAI,CAAC,QAAQ,EAAE,MAAM,CAAC,CAAC;SACxE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED,EAAE;IACF,EAAE;IACF,EAAE;IAEF;;;OAGG;IACI,4BAAG,GAAV;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,gDAA4B,CAAC,IAAI,CAAC,QAAQ,CAAC,UAAU,CAAC,CAAC;SACnF;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,6BAAI,GAAX;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,wCAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAChE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAED;;;OAGG;IACI,gCAAO,GAAd;QACI,IAAI,CAAC,IAAI,CAAC,iBAAiB,EAAE;YACzB,IAAI,CAAC,iBAAiB,GAAG,wCAAoB,CAAC,IAAI,CAAC,QAAQ,CAAC,CAAC;SAChE;QAED,OAAO,IAAI,CAAC,iBAAiB,CAAC;IAClC,CAAC;IAhIc,sBAAO,GAAuC,IAAI,OAAO,EAA6B,CAAC;IACvF,+BAAgB,GAA8C,IAAI,OAAO,EAGrF,CAAC;IA6HR,qBAAC;CAAA,AAlID,IAkIC;AAlIY,wCAAc;AAoI3B;;;;;;GAMG;AACH,SAAgB,sBAAsB,CAAC,MAAwB;IACnD,IAAA,UAAU,GAAK,MAAM,WAAX,CAAY;IAC9B,IAAM,EAAE,GAAG,0BAAc,CAAC,UAAU,CAAC,GAAG,YAAY,CAAC;IAErD,OAAO;QACH,UAAU,YAAA;QACV,MAAM,QAAA;QACN,WAAW,EAAE,EAAE;QACf,IAAI,EAAE,EAAE;QACR,MAAM,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACd,KAAK,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QACb,UAAU,EAAE,CAAC,CAAC,EAAE,CAAC,CAAC;QAClB,WAAW,EAAX;YACI,OAAO,EAAE,CAAC;QACd,CAAC;QACD,MAAM,EAAN,UAAO,KAAgB;YACnB,OAAO,EAAE,KAAK,KAAK,CAAC,WAAW,EAAE,CAAC;QACtC,CAAC;KACJ,CAAC;AACN,CAAC;AAnBD,wDAmBC"}
|
|
@@ -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
|
|
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;
|
|
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
|
|
9
|
-
*
|
|
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
|
|
44
|
-
*
|
|
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
|
|
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"}
|
|
@@ -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
|
-
*
|
|
33
|
+
* Slice all data series by elements of these attributes.
|
|
32
34
|
*/
|
|
33
35
|
slicesBy?: AttributesOrPlaceholders;
|
|
34
36
|
/**
|
|
35
|
-
*
|
|
37
|
+
* Include these totals among the data slices.
|
|
36
38
|
*/
|
|
37
39
|
totals?: TotalsOrPlaceholders;
|
|
38
40
|
/**
|
|
39
|
-
*
|
|
41
|
+
* Filters to apply on server side.
|
|
40
42
|
*/
|
|
41
43
|
filters?: NullableFiltersOrPlaceholders;
|
|
42
44
|
/**
|
|
43
|
-
*
|
|
45
|
+
* Sorting to apply on server side.
|
|
44
46
|
*/
|
|
45
47
|
sortBy?: SortsOrPlaceholders;
|
|
46
48
|
/**
|
|
47
|
-
*
|
|
49
|
+
* Resolution context for composed placeholders.
|
|
48
50
|
*/
|
|
49
51
|
placeholdersResolutionContext?: any;
|
|
50
52
|
/**
|
|
51
|
-
*
|
|
52
|
-
*
|
|
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
|
-
*
|
|
61
|
-
*
|
|
62
|
-
*
|
|
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.
|
|
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.
|
|
84
|
-
*
|
|
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
|
-
*
|
|
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
|
-
*
|
|
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.
|
|
106
|
-
*
|
|
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
|
-
*
|
|
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
|
|
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.
|
|
77
|
-
*
|
|
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
|
-
*
|
|
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,
|
|
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"}
|