@gooddata/sdk-ui 8.10.0-alpha.3 → 8.10.0-alpha.32

package/dist/sdk-ui.d.ts

@@ -73,8 +73,10 @@ import { WrappedComponentProps } from 'react-intl';
 /**
  * Generate all possible combinations of arrays signatures for the union type.
  *
- * Examples:
- * - IAttribute | IMeasure is resolved as IAttribute[] | IMeasure[] | (IAttribute | IMeasure)[]
+ * @example
+ * ```
+ * IAttribute | IMeasure is resolved as IAttribute[] | IMeasure[] | (IAttribute | IMeasure)[]
+ * ```
  *
  * @public
  */
@@ -96,10 +98,12 @@ export declare type AnyPlaceholder<T = any> = IPlaceholder<T> | IComposedPlaceho
 /**
  * Generate all possible combinations of placeholder signatures for the union type.
  *
- * Examples:
- * - IAttribute | IMeasure is resolved as
- *   AnyPlaceholder\<IAttribute\> | AnyPlaceholder\<IMeasure\> | AnyPlaceholder\<IAttribute | IMeasure\>
- *
+ * @example
+ * ```
+ * IAttribute | IMeasure
+ * is resolved as
+ * AnyPlaceholder\<IAttribute\> | AnyPlaceholder\<IMeasure\> | AnyPlaceholder\<IAttribute | IMeasure\>
+ * ```
  * @public
  */
 export declare type AnyPlaceholderOf<T> = AnyPlaceholder<T> | PlaceholderOf<T>;
@@ -137,9 +141,10 @@ export declare class ArithmeticMeasureTitleFactory {
 /**
  * Wrap each member of union type in the array.
  *
- * Examples:
- * - IAttribute | IMeasure | IFilter is resolved as IAttribute[] | IMeasure[] | IFilter[]
- *
+ * @example
+ * ```
+ * IAttribute | IMeasure | IFilter is resolved as IAttribute[] | IMeasure[] | IFilter[]
+ * ```
  * @public
  */
 export declare type ArrayOf<T> = T extends any ? T[] : never;
@@ -252,11 +257,13 @@ export declare class CancelledSdkError extends GoodDataSdkError {
 }
 
 /**
- * CatalogHelper
- * is a tool that exposes API that to look up measures, attributes, visualizations and other metadata elements
- * example usage:
+ * Tool that exposes API that to look up measures, attributes, visualizations and other metadata elements
+ *
+ * @example
+ * ```
  *  import catalog from './catalog.json';
  *  const C = new CatalogHelper(catalog);
+ * ```
  *
  * @deprecated catalog helper is deprecated in favor of code-based catalog that can be generated by catalog-export tool
  * @public
@@ -339,8 +346,10 @@ export declare function composedFromUri(uri: string): IHeaderPredicate;
 /**
  * Get composed placeholder resolution context type.
  *
- * Examples:
- * - IComposedPlaceholder\<any, any, IResolutionContext\> is resolved as IResolutionContext
+ * @example
+ * ```
+ * IComposedPlaceholder\<any, any, IResolutionContext\> is resolved as IResolutionContext
+ * ```
  *
  * @public
  */
@@ -352,9 +361,11 @@ export declare type ComposedPlaceholderResolutionContext<T> = T extends ICompose
 export declare function convertDrillableItemsToPredicates(drillableItems: ExplicitDrill[]): IHeaderPredicate[];
 
 /**
- * Converts any error into an instance of {@link GoodDataSdkError}. The conversion logic right now
- * focuses mostly on errors that are contractually specified in Analytical Backend SPI. All other unexpected
- * errors are wrapped into an exception with the generic 'UNKNOWN_ERROR' code.
+ * Converts any error into an instance of {@link GoodDataSdkError}.
+ *
+ * @remarks
+ * The conversion logic right now focuses mostly on errors that are contractually specified in Analytical Backend SPI.
+ * All other unexpected errors are wrapped into an exception with the generic 'UNKNOWN_ERROR' code.
  *
  * Instances of GoodDataSdkError are returned as-is and are not subject to any processing.
  *
@@ -390,7 +401,10 @@ export declare function createIntlMock(customMessages?: {}, locale?: string): In
 
 /**
  * Creates value formatter that uses `@gooddata/numberjs` to format raw measure values according
- * to the format string. By default, the format will strip away all the coloring information and
+ * to the format string.
+ *
+ * @remarks
+ * By default, the format will strip away all the coloring information and
  * just return the value as string.
  *
  * @param separators - number separators to use. if not specified then `numberjs` defaults will be used
@@ -416,6 +430,7 @@ export declare type DataAccessConfig = {
  * Data Point represents a value computed for particular data series, possibly sliced for additional
  * set of attribute elements OR possibly being a total.
  *
+ * @remarks
  * Technically, DataPoint is the raw data value stored in the data view decorated with all the metadata
  * there exists about that value.
  *
@@ -569,8 +584,11 @@ export declare type DataSliceDescriptorMethods = {
 };
 
 /**
- * Data slice name is specified using the result headers. The headers describe attribute elements (title+ID)
- * for the slice. The slice MAY be for a total calculation, in which case the last header will be for the
+ * Data slice name is specified using the result headers.
+ *
+ * @remarks
+ * The headers describe attribute elements (title+ID) for the slice. The slice MAY be for a total calculation,
+ * in which case the last header will be for the
  * total.
  *
  * @public
@@ -611,7 +629,10 @@ export declare class DataTooLargeToDisplaySdkError extends GoodDataSdkError {
 }
 
 /**
- * This wrapper for {@link @gooddata/sdk-backend-spi#IDataView} provides various convenience methods to work with data and metadata stored inside
+ * Wrapper for {@link @gooddata/sdk-backend-spi#IDataView}.
+ *
+ * @remarks
+ * This provides various convenience methods to work with data and metadata stored inside
  * the provided instance of {@link @gooddata/sdk-backend-spi#IDataView}.
  *
  * The facade keeps an ephemeral state - such as calculated indexes on top of the headers in the {@link @gooddata/sdk-backend-spi#IDataView} -
@@ -642,7 +663,10 @@ export declare class DataViewFacade {
      */
     static for(dataView: IDataView): DataViewFacade;
     /**
-     * Creates a DataViewFacade with provided execution result. Only use this when execution result is unable to load data and some
+     * Creates a DataViewFacade with provided execution result.
+     *
+     * @remarks
+     * Only use this when execution result is unable to load data and some
      * form of DataViewFacade is still needed. Beware that the calculated data view is empty after the creation. Only execution
      * definition and result is defined.
      *
@@ -793,8 +817,10 @@ export declare const ErrorCodes: {
 };
 
 /**
- * {@link http://sdk.gooddata.com/gooddata-ui/docs/error_component.html | ErrorComponent}
- * is a component that renders a default error message.
+ * Component that renders a default error message.
+ *
+ * @remarks
+ * See {@link http://sdk.gooddata.com/gooddata-ui/docs/error_component.html | ErrorComponent}
  *
  * @public
  */
@@ -804,8 +830,10 @@ export declare class ErrorComponent extends React_2.Component<IErrorProps> {
 }
 
 /**
- * The executor provides a more curated experience to obtain and work with data from backends. It is aligned
- * with the `DataAccess` infrastructure which exposes the underlying data as data series that can be
+ * The executor provides a more curated experience to obtain and work with data from backends.
+ *
+ * @remarks
+ * It is aligned with the `DataAccess` infrastructure which exposes the underlying data as data series that can be
  * optionally sliced by additional attributes.
  *
  * Once the executor finishes, the {@link DataViewFacade.data} method will expose the data as series and
@@ -813,7 +841,7 @@ export declare class ErrorComponent extends React_2.Component<IErrorProps> {
  * Note that if the resulting data is empty this will NOT throw a NoDataError. It is the responsibility
  * of the child component to handle that if they need to.
  *
- * @remarks see {@link IDataAccessMethods} for additional documentation
+ * See {@link IDataAccessMethods} for additional documentation
  * @public
  */
 export declare const Execute: (props: IExecuteProps) => JSX.Element;
@@ -827,6 +855,8 @@ export declare const ExecuteInsight: React_2.ComponentType<IExecuteInsightProps>
 
 /**
  * Drillable item reference or predicate that enables insight / kpi drilling if it matches some attribute or measure of the insight / kpi.
+ *
+ * @remarks
  * You can use {@link @gooddata/sdk-ui#HeaderPredicates} factory functions to create predicates,
  * or specify reference to the identifier / uri of the target attribute / measure using {@link @gooddata/sdk-ui#IDrillableItem} definition.
  *
@@ -887,14 +917,17 @@ export declare function fireDrillEvent(drillEventFunction: IDrillEventCallback,
 
 /**
  * Flatten array type.
+ *
+ * @remarks
  * If the type is not an array, return the same type.
  * Works only for 1 level, nested array types are not recursively flattened.
  *
- * Examples:
- * - number[] is resolved as number
- * - string[][] is resolved as string[]
- * - string is resolved as string
- *
+ * @example
+ * ```
+ * number[] is resolved as number
+ * string[][] is resolved as string[]
+ * string is resolved as string
+ * ```
  * @public
  */
 export declare type Flatten<T> = T extends Array<infer A> ? A : T;
@@ -998,7 +1031,10 @@ export declare abstract class GoodDataSdkError extends Error {
      */
     getCause(): any | undefined;
     /**
-     * Error code for this exception. This can be used to identify exact type of exception.
+     * Error code for this exception.
+     *
+     * @remarks
+     * This can be used to identify exact type of exception.
      */
     getErrorCode(): string;
 }
@@ -1162,8 +1198,9 @@ export declare interface IClientWorkspaceIdentifiers {
  */
 export declare interface IClientWorkspaceProviderCoreProps {
     /**
-     * Optionally specify an instance of the analytical backend instance to work with.
+     * Specify an instance of the analytical backend instance to work with.
      *
+     * @remarks
      * Note: if you do not have a BackendProvider above in the component tree, then you MUST specify the backend.
      */
     backend?: IAnalyticalBackend;
@@ -1186,6 +1223,7 @@ export declare interface IClientWorkspaceProviderWithClientAndDataProductProps e
     /**
      * Specify the data product identifier to use to obtain the LCM context.
      *
+     * @remarks
      * Note: another option is to specify workspace prop, and then data product identifier will be resolved from it.
      */
     dataProduct: string;
@@ -1204,6 +1242,7 @@ export declare interface IClientWorkspaceProviderWithWorkspaceProps extends ICli
     /**
      * Specify the workspace to use to obtain the LCM context.
      *
+     * @remarks
      * Note: another option is to specify dataProduct and client props, and then workspace will be resolved from them.
      */
     workspace: string;
@@ -1227,6 +1266,8 @@ export declare interface IColorsData {
 
 /**
  * Represents placeholder composed from other placeholders.
+ *
+ * @remarks
  * You can perform computation on top of resolved placeholder values.
  * Composed placeholders accepts also other composed placeholders as an input.
  *
@@ -1245,8 +1286,11 @@ export declare interface IComposedPlaceholder<TReturn, TValue extends any[], TCo
 }
 
 /**
- * Defines methods to access data in the data view. These methods and types are recommended
- * in favor of directly accessing the underlying data, headers and descriptors.
+ * Defines methods to access data in the data view.
+ *
+ * @remarks
+ * These methods and types are recommended in favor of directly accessing the underlying data,
+ * headers and descriptors.
  *
  * @public
  */
@@ -1265,6 +1309,7 @@ export declare interface IDataAccessMethods {
  * Data series is a sequence of data points that are all computed from a single measure, optionally scoped for
  * particular attribute elements.
  *
+ * @remarks
  * In other words, data series allows iterating over two dimensional data view _along_ the dimension which contains
  * the measures (via inclusion of MeasureGroupIdentifier).
  *
@@ -1296,7 +1341,10 @@ export declare interface IDataSeries extends DataSeriesDescriptorMethods, Iterab
 }
 
 /**
- * An iterable collection of data series. The collection additionally includes basic information about the
+ * An iterable collection of data series.
+ *
+ * @remarks
+ * The collection additionally includes basic information about the
  * origin of the data series that can be iterated - their number, measures they were calculated from and
  * optionally the scoping attributes.
  *
@@ -1310,6 +1358,7 @@ export declare interface IDataSeriesCollection extends Iterable<IDataSeries> {
     /**
      * Descriptors of measures that are used in the data series.
      *
+     * @remarks
      * Note that the number of measures MAY differ from number of data series - that is because the data series may be
      * created for multiple scopes of each measure (e.g. measure X calculated for attribute element A, then same
      * measure calculated for attribute element B etc)
@@ -1318,6 +1367,7 @@ export declare interface IDataSeriesCollection extends Iterable<IDataSeries> {
     /**
      * Definitions of measures which were sent to execution and resulted in the data series.
      *
+     * @remarks
      * Order of appearance matches the order of appearance in the `fromMeasures` array.
      */
     readonly fromMeasuresDef: IMeasure[];
@@ -1329,6 +1379,7 @@ export declare interface IDataSeriesCollection extends Iterable<IDataSeries> {
      * Definitions of attributes which were sent to execution and resulted in the data series with scoped
      * measure values.
      *
+     * @remarks
      * Order of apperance matches the order of appreance in the `scopingAttributes` array.
      */
     readonly scopingAttributesDef?: IAttribute[];
@@ -1340,8 +1391,10 @@ export declare interface IDataSeriesCollection extends Iterable<IDataSeries> {
      */
     allForMeasure(localIdOrMeasure: string | IMeasure): Iterable<IDataSeries>;
     /**
-     * Returns first-found data series for the provided measure. This is a 'get-or-die' method and will throw
-     * in case data series from the provided measure is not located.
+     * Returns first-found data series for the provided measure.
+     *
+     * @remarks
+     * This is a 'get-or-die' method and will throw in case data series from the provided measure is not located.
      *
      * @param localIdOrMeasure - local id of measure or measure object to get local id from
      * @returns data series
@@ -1351,6 +1404,7 @@ export declare interface IDataSeriesCollection extends Iterable<IDataSeries> {
     /**
      * Returns all data series in an array.
      *
+     * @remarks
      * Note: if you are looking for a subset of measures, always prefer using the first-class methods
      * {@link IDataSeriesCollection#allForMeasure} and {@link IDataSeriesCollection#firstForMeasure} in favor of getting the array and filtering yourself.
      *
@@ -1373,6 +1427,7 @@ export declare interface IDataSet {
  * Data slice is a sequence of data points that are all computed for a particular attribute elements and/or totals but
  * different data series.
  *
+ * @remarks
  * In other words, data slice allows iterating over two dimension data view _across_ the dimension which contains
  * the measures.
  *
@@ -1404,7 +1459,10 @@ export declare interface IDataSlice extends DataSliceDescriptorMethods, Iterable
 }
 
 /**
- * An iterable collection of data slices. The collection additionally includes basic information about the
+ * An iterable collection of data slices.
+ *
+ * @remarks
+ * The collection additionally includes basic information about the
  * origin of the data slices that can be iterated - their number and attributes or totals that were used
  * for slicing.
  *
@@ -1433,6 +1491,7 @@ export declare interface IDataSliceCollection extends Iterable<IDataSlice> {
 /**
  * Common props for visualization of data computed by the analytical backend.
  *
+ * @remarks
  * Data visualization contains prepared execution which will return data that needs to be visualized.
  *
  * @public
@@ -1671,6 +1730,7 @@ export declare interface IExecuteInsightProps extends IWithLoadingEvents<IExecut
     /**
      * Backend to execute against.
      *
+     * @remarks
      * Note: the backend must come either from this property or from BackendContext. If you do not specify
      * backend here, then the executor MUST be rendered within an existing BackendContext.
      */
@@ -1678,6 +1738,7 @@ export declare interface IExecuteInsightProps extends IWithLoadingEvents<IExecut
     /**
      * Workspace in whose context to perform the execution.
      *
+     * @remarks
      * Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify
      * workspace here, then the executor MUST be rendered within an existing WorkspaceContext.
      */
@@ -1687,24 +1748,26 @@ export declare interface IExecuteInsightProps extends IWithLoadingEvents<IExecut
      */
     insight: ObjRef;
     /**
-     * Optionally modify sorts on prepared insight execution, before it's executed.
+     * Modify sorts on prepared insight execution, before it's executed.
      */
     sorts?: ISortItem[] | ((def: IExecutionDefinition, props: IExecuteInsightProps) => ISortItem[]);
     /**
-     * Optionally modify dimensions on prepared insight execution, before it's executed.
+     * Modify dimensions on prepared insight execution, before it's executed.
      */
     dimensions?: IDimension[] | ((def: IExecutionDefinition, props: IExecuteInsightProps) => IDimension[]);
     /**
-     * Optionally modify date formatting on prepared insight execution, before it's executed.
+     * Modify date formatting on prepared insight execution, before it's executed.
      */
     dateFormat?: string | ((def: IExecutionDefinition, props: IExecuteInsightProps) => string);
     /**
-     * Optional filters to apply on server side.
+     * Filters to apply on server side.
      */
     filters?: INullableFilter[];
     /**
-     * Optional name to use for files exported from this component. If you do not specify this, then
-     * the componentName will be used instead.
+     * Name to use for files exported from this component.
+     *
+     * @remarks
+     * If you do not specify this, then the componentName will be used instead.
      *
      * Note: it is also possible to pass custom name to the export function that will be sent via the
      * onExportReady callback. That approach is preferred if you need to assign the names in an ad-hoc
@@ -1712,16 +1775,21 @@ export declare interface IExecuteInsightProps extends IWithLoadingEvents<IExecut
      */
     exportTitle?: string;
     /**
-     * Optional informative name of the component. This value is sent as telemetry information together
-     * with the actual execution request. We recommend to set this because it can be useful for diagnostic
-     * purposes.
+     * Informative name of the component.
+     *
+     * @remarks
+     * This value is sent as telemetry information together with the actual execution request. We recommend to set this
+     * because it can be useful for diagnostic purposes.
      *
      * Defaults 'Execute'.
      */
     componentName?: string;
     /**
      * Specifies whether `Execute` should trigger execution and loading right after it is
-     * mounted. If not specified defaults to `true`.
+     * mounted.
+     *
+     * @remarks
+     * If not specified defaults to `true`.
      *
      * If set to `false`, then the {@link WithLoadingResult#reload} function needs to be called
      * to trigger the execution and loading.
@@ -1731,26 +1799,31 @@ export declare interface IExecuteInsightProps extends IWithLoadingEvents<IExecut
      * Specifies whether `Execute` should load all data from backend or just a particular window - specified by
      * offset and size of the window.
      *
+     * @remarks
      * If not specified, all data will be loaded.
      */
     window?: DataViewWindow;
     /**
-     * Child component to which rendering is delegated. This is a function that will be called
-     * every time state of execution and data loading changes.
+     * Child component to which rendering is delegated.
+     *
+     * @remarks
+     * This is a function that will be called every time state of execution and data loading changes.
      *
      * @param executionResult - execution result, indicating state and/or results
      */
     children: (executionResult: WithLoadingResult) => React_2.ReactElement | null;
     /**
-     * Optionally provide component for rendering of the loading state.
+     * Provide component for rendering of the loading state.
      *
+     * @remarks
      * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
      * will be called only with a successful result.
      */
     LoadingComponent?: IExecuteLoadingComponent;
     /**
-     * Optionally provide component for rendering of the error state.
+     * Provide component for rendering of the error state.
      *
+     * @remarks
      * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
      * will be called only with a successful result.
      */
@@ -1771,6 +1844,7 @@ export declare interface IExecuteProps extends IWithLoadingEvents<IExecuteProps>
     /**
      * Backend to execute against.
      *
+     * @remarks
      * Note: the backend must come either from this property or from BackendContext. If you do not specify
      * backend here, then the executor MUST be rendered within an existing BackendContext.
      */
@@ -1778,6 +1852,7 @@ export declare interface IExecuteProps extends IWithLoadingEvents<IExecuteProps>
     /**
      * Workspace in whose context to perform the execution.
      *
+     * @remarks
      * Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify
      * workspace here, then the executor MUST be rendered within an existing WorkspaceContext.
      */
@@ -1788,28 +1863,30 @@ export declare interface IExecuteProps extends IWithLoadingEvents<IExecuteProps>
      */
     seriesBy: AttributesMeasuresOrPlaceholders;
     /**
-     * Optionally slice all data series by elements of these attributes.
+     * Slice all data series by elements of these attributes.
      */
     slicesBy?: AttributesOrPlaceholders;
     /**
-     * Optionally include these totals among the data slices.
+     * Include these totals among the data slices.
      */
     totals?: TotalsOrPlaceholders;
     /**
-     * Optional filters to apply on server side.
+     * Filters to apply on server side.
      */
     filters?: NullableFiltersOrPlaceholders;
     /**
-     * Optional sorting to apply on server side.
+     * Sorting to apply on server side.
      */
     sortBy?: SortsOrPlaceholders;
     /**
-     * Optional resolution context for composed placeholders.
+     * Resolution context for composed placeholders.
      */
     placeholdersResolutionContext?: any;
     /**
-     * Optional name to use for files exported from this component. If you do not specify this, then
-     * the componentName will be used instead.
+     * Name to use for files exported from this component.
+     *
+     * @remarks
+     * If you do not specify this, then the componentName will be used instead.
      *
      * Note: it is also possible to pass custom name to the export function that will be sent via the
      * onExportReady callback. That approach is preferred if you need to assign the names in an ad-hoc
@@ -1817,16 +1894,21 @@ export declare interface IExecuteProps extends IWithLoadingEvents<IExecuteProps>
      */
     exportTitle?: string;
     /**
-     * Optional informative name of the component. This value is sent as telemetry information together
-     * with the actual execution request. We recommend to set this because it can be useful for diagnostic
-     * purposes.
+     * Informative name of the component.
+     *
+     * @remarks
+     * This value is sent as telemetry information together with the actual execution request.
+     * We recommend to set this because it can be useful for diagnostic purposes.
      *
      * Defaults 'Execute'.
      */
     componentName?: string;
     /**
      * Specifies whether {@link Execute} should trigger execution and loading right after it is
-     * mounted. If not specified defaults to `true`.
+     * mounted.
+     *
+     * @remarks
+     * If not specified defaults to `true`.
      *
      * If set to `false`, then the {@link WithLoadingResult#reload} function needs to be called
      * to trigger the execution and loading.
@@ -1836,26 +1918,31 @@ export declare interface IExecuteProps extends IWithLoadingEvents<IExecuteProps>
      * Specifies whether {@link Execute} should load all data from backend or just a particular window - specified by
      * offset and size of the window.
      *
+     * @remarks
      * If not specified, all data will be loaded.
      */
     window?: DataViewWindow;
     /**
-     * Child component to which rendering is delegated. This is a function that will be called
-     * every time state of execution and data loading changes.
+     * Child component to which rendering is delegated.
+     *
+     * @remarks
+     * This is a function that will be called every time state of execution and data loading changes.
      *
      * @param executionResult - execution result, indicating state and/or results
      */
     children: (executionResult: WithLoadingResult) => React_2.ReactElement | null;
     /**
-     * Optionally provide component for rendering of the loading state.
+     * Provide component for rendering of the loading state.
      *
+     * @remarks
      * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
      * will be called only with a successful result.
      */
     LoadingComponent?: IExecuteLoadingComponent;
     /**
-     * Optionally provide component for rendering of the error state.
+     * Provide component for rendering of the error state.
      *
+     * @remarks
      * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
      * will be called only with a successful result.
      */
@@ -1872,29 +1959,31 @@ export declare interface IExecutionConfiguration {
      */
     seriesBy: AttributesMeasuresOrPlaceholders;
     /**
-     * Optionally slice all data series by elements of these attributes.
+     * Slice all data series by elements of these attributes.
      */
     slicesBy?: AttributesOrPlaceholders;
     /**
-     * Optionally include these totals among the data slices.
+     * Include these totals among the data slices.
      */
     totals?: TotalsOrPlaceholders;
     /**
-     * Optional filters to apply on server side.
+     * Filters to apply on server side.
      */
     filters?: NullableFiltersOrPlaceholders;
     /**
-     * Optional sorting to apply on server side.
+     * Sorting to apply on server side.
      */
     sortBy?: SortsOrPlaceholders;
     /**
-     * Optional resolution context for composed placeholders.
+     * Resolution context for composed placeholders.
      */
     placeholdersResolutionContext?: any;
     /**
-     * Optional informative name of the component. This value is sent as telemetry information together
-     * with the actual execution request. We recommend to set this because it can be useful for diagnostic
-     * purposes.
+     * Informative name of the component.
+     *
+     * @remarks
+     * This value is sent as telemetry information together with the actual execution request.
+     * We recommend to set this because it can be useful for diagnostic purposes.
      *
      * Defaults 'Execute'.
      */
@@ -2015,8 +2104,12 @@ export declare interface IExtendedExportConfig extends IExportConfig {
 export declare function ignoreTitlesForSimpleMeasures<T extends IInsightDefinition>(insight: T): T;
 
 /**
- * A function called for {@link IMappingHeader} instances. When the function returns true, it means the IMappingHeader is matched.
+ * A function called for {@link IMappingHeader} instances.
+ *
+ * @remarks
+ * When the function returns true, it means the IMappingHeader is matched.
  * See {@link https://sdk.gooddata.com/gooddata-ui/docs/ht_create_predicates.html | documentation} for more information.
+ *
  * @public
  */
 export declare type IHeaderPredicate = (header: IMappingHeader, context: IHeaderPredicateContext) => boolean;
@@ -2068,14 +2161,16 @@ export declare interface IIntlWrapperProps {
  */
 export declare interface IKpiProps extends IWithLoadingEvents<IRawExecuteProps> {
     /**
-     * Optionally specify an instance of analytical backend instance to work with.
+     * Specify an instance of analytical backend instance to work with.
      *
+     * @remarks
      * Note: if you do not have a BackendProvider above in the component tree, then you MUST specify the backend.
      */
     backend?: IAnalyticalBackend;
     /**
-     * Optionally specify workspace to work with.
+     * Specify workspace to work with.
      *
+     * @remarks
      * Note: if you do not have a WorkspaceProvider above in the component tree, then you MUST specify the workspace.
      */
     workspace?: string;
@@ -2084,24 +2179,24 @@ export declare interface IKpiProps extends IWithLoadingEvents<IRawExecuteProps>
      */
     measure: IMeasure;
     /**
-     * Optionally specify filters to apply during calculation
+     * Specify filters to apply during calculation
      */
     filters?: INullableFilter[];
     /**
-     * Optionally specify number separators to use when rendering (segment delimiters, decimal point character)
+     * Specify number separators to use when rendering (segment delimiters, decimal point character)
      */
     separators?: ISeparators_2;
     /**
-     * Optionally specify locale to use for strings that the Kpi component may render (for instance when encountering
+     * Specify locale to use for strings that the Kpi component may render (for instance when encountering
      * errors).
      */
     locale?: string;
     /**
-     * Optionally specify react component to render while the data is loading.
+     * Specify react component to render while the data is loading.
      */
     LoadingComponent?: React_2.ComponentType<ILoadingProps>;
     /**
-     * Optionally specify react component to render if execution fails.
+     * Specify react component to render if execution fails.
      */
     ErrorComponent?: React_2.ComponentType<IErrorProps>;
 }
@@ -2171,7 +2266,9 @@ export declare interface ILoadingState {
 export declare type ILocale = "en-US" | "de-DE" | "es-ES" | "fr-FR" | "ja-JP" | "nl-NL" | "pt-BR" | "pt-PT" | "zh-Hans" | "ru-RU";
 
 /**
+ * @privateRemarks
  * TODO: SDK8: remove this, replace with something more meaningful
+ *
  * @public
  */
 export declare type IMappingHeader = IAttributeDescriptor | IResultAttributeHeader | IMeasureDescriptor | ITotalDescriptor;
@@ -2201,9 +2298,11 @@ export declare const IntlWrapper: React_2.FC<IIntlWrapperProps>;
 
 /**
  * Placeholder represents a reference to a specific part of the execution - attribute(s), measure(s), filter(s), sort(s) or total(s),
- * that may change the value at runtime. Then you can provide it to visualizations
- * instead of the attributes/measures/filters/sorts/totals themselves - placeholders will be replaced
- * with the actual values on the background.
+ * that may change the value at runtime.
+ *
+ * @remarks
+ * You can provide it to visualizations instead of the attributes/measures/filters/sorts/totals themselves,
+ * placeholders will be replaced with the actual values on the background.
  *
  * This allows you:
  * - share a reference to the same execution elements across multiple components.
@@ -2213,9 +2312,13 @@ export declare const IntlWrapper: React_2.FC<IIntlWrapperProps>;
  *
  * Placeholder values are living in React context and you can obtain/set their values by the following hooks:
  * - {@link usePlaceholder}
+ *
  * - {@link usePlaceholders}
+ *
  * - {@link useComposedPlaceholder}
+ *
  * - {@link useResolveValueWithPlaceholders}
+ *
  * - {@link useResolveValuesWithPlaceholders}
  *
  * Note:
@@ -2240,12 +2343,14 @@ export declare type IPlaceholder<T> = {
 export declare interface IPlaceholderOptions<T> {
     /**
      * By default, each placeholder has a unique generated id.
-     * You can optionally provide id of the placeholder which can be useful for debugging.
+     *
+     * @remarks
+     * You can provide id of the placeholder which can be useful for debugging.
      * Please note that the id should be unique for all your placeholders.
      */
     id?: string;
     /**
-     * Optionally provide function to validate the placeholder value.
+     * Provide function to validate the placeholder value.
      */
     validate?: (value?: T) => void;
 }
@@ -2289,12 +2394,15 @@ export declare interface IRawExecuteProps extends IWithLoadingEvents<IRawExecute
      * Specifies whether {@link RawExecute} should load all data from backend or just a particular window - specified by
      * offset and size of the window.
      *
+     * @remarks
      * If not specified, all data will be loaded.
      */
     window?: DataViewWindow;
     /**
-     * Optional name to use for files exported from this component. If you do not specify this, then
-     * the 'RawExecute' will be used instead.
+     * Name to use for files exported from this component.
+     *
+     * @remarks
+     * If you do not specify this, then the 'RawExecute' will be used instead.
      *
      * Note: it is also possible to pass custom name to the export function that will be sent via the
      * onExportReady callback. That approach is preferred if you need to assign the names in an ad-hoc
@@ -2303,28 +2411,36 @@ export declare interface IRawExecuteProps extends IWithLoadingEvents<IRawExecute
     exportTitle?: string;
     /**
      * Indicates whether the executor should trigger execution and loading right after it is
-     * mounted. If not specified defaults to `true`.
+     * mounted.
+     *
+     * @remarks
+     * If not specified defaults to `true`.
      *
      * If set to `false`, then the {@link WithLoadingResult#reload} function needs to be called
      * to trigger the execution and loading.
      */
     loadOnMount?: boolean;
     /**
-     * Child component to which rendering is delegated. This is a function that will be called
-     * every time state of execution and data loading changes.
+     * Child component to which rendering is delegated.
+     *
+     * @remarks
+     * This is a function that will be called every time state of execution and data loading changes.
      *
      * @param executionResult - execution result, indicating state and/or results
      */
     children: (executionResult: WithLoadingResult) => React_2.ReactElement | null;
     /**
-     * Optionally provide component for rendering of the loading state.
+     * Provide component for rendering of the loading state.
      *
+     * @remarks
      * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
      * will be called only with a successful result.
      */
     LoadingComponent?: IExecuteLoadingComponent;
     /**
-     * Optionally provide component for rendering of the error state.
+     * Provide component for rendering of the error state.
+     *
+     * @remarks
      * Note: When you provide both LoadingComponent and ErrorComponent, the children function with the execution result
      * will be called only with a successful result.
      */
@@ -2680,6 +2796,7 @@ export declare interface ITranslationsCustomizationProviderProps {
     /**
      * Analytical backend, from which the ThemeProvider will obtain selected theme object
      *
+     * @remarks
      * If you do not specify instance of analytical backend using this prop, then you MUST have
      * BackendProvider up in the component tree.
      */
@@ -2687,6 +2804,7 @@ export declare interface ITranslationsCustomizationProviderProps {
     /**
      * Identifier of analytical workspace, from which the ThemeProvider will obtain the selected theme identifier
      *
+     * @remarks
      * If you do not specify workspace identifier, then you MUST have WorkspaceProvider up in the
      * component tree.
      */
@@ -2721,29 +2839,31 @@ export declare interface IUseExecutionConfig {
      */
     seriesBy: AttributesMeasuresOrPlaceholders;
     /**
-     * Optionally slice all data series by elements of these attributes.
+     * Slice all data series by elements of these attributes.
      */
     slicesBy?: AttributesOrPlaceholders;
     /**
-     * Optionally include these totals among the data slices.
+     * Include these totals among the data slices.
      */
     totals?: TotalsOrPlaceholders;
     /**
-     * Optional filters to apply on server side.
+     * Filters to apply on server side.
      */
     filters?: NullableFiltersOrPlaceholders;
     /**
-     * Optional sorting to apply on server side.
+     * Sorting to apply on server side.
      */
     sortBy?: SortsOrPlaceholders;
     /**
-     * Optional resolution context for composed placeholders.
+     * Resolution context for composed placeholders.
      */
     placeholdersResolutionContext?: any;
     /**
-     * Optional informative name of the component. This value is sent as telemetry information together
-     * with the actual execution request. We recommend to set this because it can be useful for diagnostic
-     * purposes.
+     * Informative name of the component.
+     *
+     * @remarks
+     * This value is sent as telemetry information together with the actual execution request.
+     * We recommend to set this because it can be useful for diagnostic purposes.
      *
      * Defaults 'Execute'.
      */
@@ -2751,6 +2871,7 @@ export declare interface IUseExecutionConfig {
     /**
      * Backend to work with.
      *
+     * @remarks
      * Note: the backend must come either from this property or from BackendContext. If you do not specify
      * backend here, then the executor MUST be rendered within an existing BackendContext.
      */
@@ -2758,6 +2879,7 @@ export declare interface IUseExecutionConfig {
     /**
      * Workspace where execution should be executed.
      *
+     * @remarks
      * Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify
      * workspace here, then the executor MUST be rendered within an existing WorkspaceContext.
      */
@@ -2773,13 +2895,16 @@ export declare interface IUseExecutionDataViewConfig {
      */
     execution?: IPreparedExecution | IExecutionConfiguration;
     /**
-     * Optionally, you can define only a specific "window" of data to load.
+     * You can define only a specific "window" of data to load.
+     *
+     * @remarks
      * This is useful if you want to page data.
      */
     window?: DataViewWindow;
     /**
      * Backend to work with.
      *
+     * @remarks
      * Note: the backend must come either from this property or from BackendContext. If you do not specify
      * backend here, then the executor MUST be rendered within an existing BackendContext.
      */
@@ -2787,6 +2912,7 @@ export declare interface IUseExecutionDataViewConfig {
     /**
      * Workspace where execution should be executed.
      *
+     * @remarks
      * Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify
      * workspace here, then the executor MUST be rendered within an existing WorkspaceContext.
      */
@@ -2800,33 +2926,37 @@ export declare interface IUseInsightDataViewConfig {
     /**
      * Reference to the insight for which you want to get the data view.
      *
+     * @remarks
      * Note: When the reference or identifier is not provided, hook is locked in a "pending" state.
      */
     insight?: ObjRef;
     /**
-     * Optionally modify sorts on prepared insight execution, before it's executed.
+     * Modify sorts on prepared insight execution, before it's executed.
      */
     sorts?: ISortItem[] | ((def: IExecutionDefinition) => ISortItem[]);
     /**
-     * Optionally modify dimensions on prepared insight execution, before it's executed.
+     * Modify dimensions on prepared insight execution, before it's executed.
      */
     dimensions?: IDimension[] | ((def: IExecutionDefinition) => IDimension[]);
     /**
-     * Optionally modify date formatting on prepared insight execution, before it's executed.
+     * Modify date formatting on prepared insight execution, before it's executed.
      */
     dateFormat?: string | ((def: IExecutionDefinition) => string);
     /**
-     * Optionally specify filters to merge with filters already defined in the insight.
+     * Specify filters to merge with filters already defined in the insight.
      */
     filters?: INullableFilter[];
     /**
-     * Optionally, you can define only a specific "window" of data to load.
+     * You can define only a specific "window" of data to load.
+     *
+     * @remarks
      * This is useful if you want to page data.
      */
     window?: DataViewWindow;
     /**
      * Backend to work with.
      *
+     * @remarks
      * Note: the backend must come either from this property or from BackendContext. If you do not specify
      * backend here, then the executor MUST be rendered within an existing BackendContext.
      */
@@ -2834,6 +2964,7 @@ export declare interface IUseInsightDataViewConfig {
     /**
      * Workspace where execution should be executed.
      *
+     * @remarks
      * Note: the workspace must come either from this property or from WorkspaceContext. If you do not specify
      * workspace here, then the executor MUST be rendered within an existing WorkspaceContext.
      */
@@ -2865,8 +2996,10 @@ PlaceholderValue<T> | undefined,
 ];
 
 /**
- * Super-interface for all visualization callbacks; all visualizations SHOULD have at least these callbacks
- * defined.
+ * Super-interface for all visualization callbacks.
+ *
+ * @remarks
+ * All visualizations SHOULD have at least these callbacks defined.
  *
  * @public
  */
@@ -2898,8 +3031,10 @@ export declare interface IVisualizationCallbacks {
 }
 
 /**
- * Super-interface for all visualization props; charts, tables or anything else - all should have these
- * basic props.
+ * Super-interface for all visualization props.
+ *
+ * @remarks
+ * Charts, tables or anything else - all should have these basic props.
  *
  * @public
  */
@@ -2907,12 +3042,14 @@ export declare interface IVisualizationProps {
     /**
      * Set Locale for visualization localization.
      *
+     * @remarks
      * Note: This locale will be used for everything EXCEPT the data being visualized.
      */
     locale?: string;
     /**
      * Set title to use for exported files.
      *
+     * @remarks
      * Note: you can also specify export file name as parameters to the export function which you
      * receive in the onExportReady. If you do not specify title here and neither as input to export function,
      * the the name will default to name of the visualization component.
@@ -2954,24 +3091,25 @@ export declare interface IWithExecution<T> {
      */
     exportTitle: string | ((props: T) => string);
     /**
-     * Optionally customize data window to load.
+     * Customize data window to load.
      *
      * By default the HOC loads all the data available in the execution's result.
      */
     window?: DataViewWindow | ((props: T) => DataViewWindow | undefined);
     /**
-     * Optionally specify event callbacks which the HOC will trigger in different situations.
+     * Specify event callbacks which the HOC will trigger in different situations.
      */
     events?: IWithLoadingEvents<T> | ((props: T) => IWithLoadingEvents<T>);
     /**
-     * Optionally customize, whether execution & data loading should start as soon as component is mounted.
+     * Customize, whether execution & data loading should start as soon as component is mounted.
      *
+     * @remarks
      * Default is true. When not loading on mount, the wrapped component can trigger the load by calling the
      * reload() function which the HOC injects into its props.
      */
     loadOnMount?: boolean | ((props: T) => boolean);
     /**
-     * Optionally specify function that will be called during component prop updates and will be used to
+     * Specify function that will be called during component prop updates and will be used to
      * determine whether execution should be re-run and data reloaded.
      *
      * @param prevProps - previous props
@@ -2981,8 +3119,11 @@ export declare interface IWithExecution<T> {
 }
 
 /**
- * Configuration for the withLoading HOC. All configuration parameters can be either actual parameter values
- * or functions to obtain them from the wrapped component props.
+ * Configuration for the {@link withExecutionLoading} HOC.
+ *
+ * @remarks
+ * All configuration parameters can be either actual parameter values or functions to obtain them
+ * from the wrapped component props.
  *
  * If functions are specified, the HOC will call them with the wrapped component props as parameter and then use
  * the resulting values as if they were passed directly.
@@ -3007,23 +3148,25 @@ export declare interface IWithExecutionLoading<TProps> {
      */
     promiseFactory: (props: TProps, window?: DataViewWindow) => Promise<DataViewFacade>;
     /**
-     * Optionally specify data view window to retrieve from backend. If specified as function, the function
-     * can return undefined in case all data must be retrieved.
+     * Specify data view window to retrieve from backend.
+     *
+     * @remarks
+     * If specified as function, the function can return undefined in case all data must be retrieved.
      */
     window?: DataViewWindow | ((props: TProps) => DataViewWindow | undefined);
     /**
-     * Optionally specify event callbacks which the HOC will trigger in different situations.
+     * Specify event callbacks which the HOC will trigger in different situations.
      */
     events?: IWithLoadingEvents<TProps> | ((props: TProps) => IWithLoadingEvents<TProps>);
     /**
-     * Optionally customize, whether execution & data loading should start as soon as component is mounted.
+     * Customize, whether execution & data loading should start as soon as component is mounted.
      *
      * Default is true. When not loading on mount, the wrapped component can trigger the load by calling the
      * reload() function which the HOC injects into its props.
      */
     loadOnMount?: boolean | ((props: TProps) => boolean);
     /**
-     * Optionally specify function that will be called during component prop updates and will be used to
+     * Specify function that will be called during component prop updates and will be used to
      * determine whether execution should be re-run and data reloaded.
      *
      * @param prevProps - previous props
@@ -3085,8 +3228,10 @@ export declare interface IWorkspaceProviderProps {
 }
 
 /**
- * Kpi is a simple component which calculates and renders a single formatted measure value. The the value
- * is rendered inside a <span> element.
+ * Kpi is a simple component which calculates and renders a single formatted measure value.
+ *
+ * @remarks
+ * The the value is rendered inside a <span> element.
  *
  * Kpi component is useful for instance for embedding data values into text paragraphs.
  *
@@ -3097,8 +3242,10 @@ export declare interface IWorkspaceProviderProps {
 export declare const Kpi: React_2.ComponentType<IKpiProps>;
 
 /**
- * {@link http://sdk.gooddata.com/gooddata-ui/docs/loading_component.html | LoadingComponent }
- * is a component that renders a default loading indicator.
+ * Component that renders a default loading indicator.
+ *
+ * @remarks
+ * See {@link http://sdk.gooddata.com/gooddata-ui/docs/loading_component.html | LoadingComponent }
  *
  * @public
  */
@@ -3132,7 +3279,7 @@ export declare function makeCancelable<T>(promise: Promise<T>): ICancelablePromi
 /**
  * Generate union of measures from union of measure definitions.
  *
- * Examples:
+ * @example
  * - IMeasureDefinition | IArithmeticMeasureDefinition is resolved as
  *   IMeasure\<IMeasureDefinition\> | IMeasure\<IArithmeticMeasureDefinition\>
  *
@@ -3232,6 +3379,7 @@ export declare type NullableFiltersOrPlaceholders = Array<FilterOrMultiValuePlac
  * Creates a new predicate that returns true for any header that belongs to either attribute or measure matching
  * the provided object.
  *
+ * @remarks
  * If the object is empty or is not attribute, simple measure or object reference, the function returns predicate
  * that is always falsy.
  *
@@ -3302,8 +3450,10 @@ export declare const pickCorrectWording: (translations: Record<string, string>,
 /**
  * Wrap each member of the union type in AnyPlaceholder.
  *
- * Examples:
- * - IAttribute | IMeasure is resolved as AnyPlaceholder\<IAttribute\> | AnyPlaceholder\<IMeasure\>
+ * @example
+ * ```
+ * IAttribute | IMeasure is resolved as AnyPlaceholder\<IAttribute\> | AnyPlaceholder\<IMeasure\>
+ * ```
  *
  * @public
  */
@@ -3311,15 +3461,19 @@ export declare type PlaceholderOf<T> = T extends any ? AnyPlaceholder<T> : never
 
 /**
  * Convert any value that may contain placeholders to its resolved value type.
+ *
+ * @remarks
  * Nested array placeholders resolved value types are flattened.
  * If the type is not a placeholder, return the same type.
  *
- * Examples:
- * - IPlaceholder\<IAttribute\> is resolved as IAttribute
- * - IPlaceholder\<IAttribute\>[] is resolved as IAttribute[]
- * - IPlaceholder\<IAttribute[]\> is resolved as IAttribute[]
- * - [IPlaceholder\<IAttribute[]\>, IPlaceholder\<IMeasure[]\>] is resolved as (IAttribute | IMeasure)[]
- * - null is resolved as null
+ * @example
+ * ```
+ * IPlaceholder\<IAttribute\> is resolved as IAttribute
+ * IPlaceholder\<IAttribute\>[] is resolved as IAttribute[]
+ * IPlaceholder\<IAttribute[]\> is resolved as IAttribute[]
+ * [IPlaceholder\<IAttribute[]\>, IPlaceholder\<IMeasure[]\>] is resolved as (IAttribute | IMeasure)[]
+ * null is resolved as null
+ * ```
  *
  * @public
  */
@@ -3336,10 +3490,13 @@ export declare function PlaceholdersProvider(props: IPlaceholdersProviderProps):
 /**
  * Convert tuple of values that may contain placeholders to tuple of their respective resolved value types.
  *
- * Examples:
- * - [IPlaceholder\<IAttribute\>, IPlaceholder\<IAttribute[]\>] is resolved as [IAttribute, IAttribute[]]
- * - [IPlaceholder\<IMeasure\>, IMeasure] is resolved as [IMeasure, IMeasure]
+ * @example
+ * ```
+ * [IPlaceholder\<IAttribute\>, IPlaceholder\<IAttribute[]\>] is resolved as [IAttribute, IAttribute[]]
+ * [IPlaceholder\<IMeasure\>, IMeasure] is resolved as [IMeasure, IMeasure]
+ * ```
  *
+ * @remarks
  * Check mapped tuple types for more details:
  * https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-1.html#mapped-types-on-tuples-and-arrays
  *
@@ -3352,9 +3509,10 @@ export declare type PlaceholdersResolvedValues<Tuple extends any[]> = {
 /**
  * Convert tuple of placeholders to tuple of their respective value types.
  *
- * Examples:
- * - [IPlaceholder\<IAttribute\>, IPlaceholder\<IAttribute[]\>] is resolved as [IAttribute, IAttribute[]]
+ * @example
+ * [IPlaceholder\<IAttribute\>, IPlaceholder\<IAttribute[]\>] is resolved as [IAttribute, IAttribute[]]
  *
+ * @remarks
  * Check mapped tuple types for more details:
  * https://www.typescriptlang.org/docs/handbook/release-notes/typescript-3-1.html#mapped-types-on-tuples-and-arrays
  *
@@ -3366,13 +3524,17 @@ export declare type PlaceholdersValues<Tuple extends [...any[]]> = {
 
 /**
  * Get placeholder value type.
+ *
+ * @remarks
  * If the type is not a placeholder, return the same type.
  *
- * Examples:
- * - IPlaceholder\<IAttribute\> is resolved as IAttribute
- * - IPlaceholder\<IAttribute[]\> is resolved as IAttribute[]
- * - IComposedPlaceholder\<IMeasure\> is resolved as IMeasure
- * - null is resolved as null
+ * @example
+ * ```
+ * IPlaceholder\<IAttribute\> is resolved as IAttribute
+ * IPlaceholder\<IAttribute[]\> is resolved as IAttribute[]
+ * IComposedPlaceholder\<IMeasure\> is resolved as IMeasure
+ * null is resolved as null
+ * ```
  *
  * @public
  */
@@ -3392,6 +3554,7 @@ export declare class ProtectedReportSdkError extends GoodDataSdkError {
  * Raw executor is the most basic React component to drive custom executions to obtain
  * data from backends.
  *
+ * @remarks
  * The component accepts an instance of prepared execution and drives all the necessary
  * APIs and boilerplate needed to obtain a {@link DataViewFacade}.
  * Note that if the resulting data is empty this will NOT throw a {@link @gooddata/sdk-backend-spi#NoDataError}.
@@ -3449,6 +3612,7 @@ export declare function resolveLCMWorkspaceIdentifiers(backend: any, clientWorks
 /**
  * Resolve error of multiple {@link useCancelablePromise} hooks - gets first error in the sequence of cancelable promise states.
  *
+ * @remarks
  * This is useful for useCancelablePromise composition - when you want to wrap multiple useCancelablePromise hooks in another hook,
  * and keep the return value shape of the hook same as for useCancelablePromise.
  *
@@ -3461,6 +3625,7 @@ export declare function resolveUseCancelablePromisesError<TError>(states: UseCan
 /**
  * Resolve status of multiple {@link useCancelablePromise} hooks.
  *
+ * @remarks
  * This is useful for useCancelablePromise composition - when you want to wrap multiple useCancelablePromise hooks in another hook,
  * and keep the return value shape of the hook same as for useCancelablePromise.
  *
@@ -3525,6 +3690,8 @@ export declare const TranslationsCustomizationContextProvider: React_2.FC<ITrans
 
 /**
  * This provider is here because of the need for customization of translations.
+ *
+ * @remarks
  * If you need to change translations based on some setting flag,
  * use this provider at the top of you your react tree.
  *
@@ -3565,9 +3732,11 @@ export declare class UnexpectedSdkError extends GoodDataSdkError {
 /**
  * Convert union type to intersection type.
  *
- * Examples:
- * - number | string | boolean is resolved as number & string & boolean
- * - Type1 | Type2 | Type3 is resolved as Type1 & Type2 & Type3
+ * @example
+ * ```
+ * number | string | boolean is resolved as number & string & boolean
+ * Type1 | Type2 | Type3 is resolved as Type1 & Type2 & Type3
+ * ```
  *
  * @public
  */
@@ -3583,6 +3752,8 @@ export declare function uriMatch(uri: string): IHeaderPredicate;
 
 /**
  * Hook to get analytical backend instance provided to {@link BackendProvider}.
+ *
+ * @remarks
  * You can optionally set a backend override that will be returned if defined.
  * This makes the usage more ergonomic (see the following example).
  *
@@ -3604,6 +3775,8 @@ export declare const useBackend: (backend?: IAnalyticalBackend | undefined) => I
 
 /**
  * Hook to get analytical backend instance provided to {@link BackendProvider}.
+ *
+ * @remarks
  * You can optionally set a backend override that will be returned if defined.
  * This makes the usage more ergonomic (see the following example).
  *
@@ -3627,6 +3800,8 @@ export declare const useBackendStrict: (backend?: IAnalyticalBackend | undefined
 
 /**
  * This hook provides easy way to work with Promise.
+ *
+ * @remarks
  * You can:
  * - watch it's status (pending/loading/success/error)
  * - get it's result/error when the Promise is resolved/rejected,
@@ -3754,6 +3929,8 @@ export declare function useComposedPlaceholder<TContext, TPlaceholder extends IC
 
 /**
  * This hook provides easy way to export data in your preferred format (csv/xlsx/raw) for the provided {@link @gooddata/sdk-backend-spi#IPreparedExecution}.
+ *
+ * @remarks
  * As a result, you will receive a string with uri, so you can easily create a download link.
  * Be aware that execution is re-executed only on dependency list change, not on execution/exportConfig/callbacks change.
  *
@@ -3778,6 +3955,8 @@ export declare type UseDataExportState = UseCancelablePromiseState<string, GoodD
 
 /**
  * This hook provides easy way to get data for the provided {@link @gooddata/sdk-backend-spi#IPreparedExecution}.
+ *
+ * @remarks
  * You can use it to create custom visualizations on top of GoodData platform.
  * Be aware that execution is re-executed only on dependency list change, not on execution/window/callbacks change.
  *
@@ -3802,6 +3981,8 @@ export declare type UseDataViewState = UseCancelablePromiseState<DataViewFacade,
 
 /**
  * This hook provides a simplified interface for creating executions.
+ *
+ * @remarks
  * It builds the execution on top of the backend passed to the BackendProvider, and workspace passed to the WorkspaceProvider.
  *
  * @beta
@@ -3830,6 +4011,8 @@ export declare function usePagedResource<TParams, TItem>(resourceFactory: (param
 
 /**
  * React hook to obtain/set placeholder value.
+ *
+ * @remarks
  * See {@link IPlaceholder}.
  *
  * Note: When placeholder is not provided, setting its value will result in the error.
@@ -3843,6 +4026,8 @@ PlaceholderValue<T> | undefined,
 
 /**
  * React hook to obtain/set multiple placeholder values at once.
+ *
+ * @remarks
  * This is useful to perform placeholders atomic change.
  * See {@link IPlaceholder}.
  * @public
@@ -3859,6 +4044,8 @@ export declare const usePrevious: <T>(props: T) => T;
 
 /**
  * React hook that resolves multiple value(s) that can possibly contain also placeholder(s) to actual value(s).
+ *
+ * @remarks
  * Optionally provide custom context for the composed placeholders resolution.
  *
  * @public
@@ -3867,6 +4054,8 @@ export declare function useResolveValuesWithPlaceholders<T extends any[], C>(val
 
 /**
  * React hook that resolves any value(s) that can possibly contain also placeholder(s) to actual value(s).
+ *
+ * @remarks
  * Optionally provide custom context for the composed placeholders resolution.
  *
  * @public
@@ -3875,6 +4064,8 @@ export declare function useResolveValueWithPlaceholders<T, C>(value: T, resoluti
 
 /**
  * Hook to get workspace instance provided to {@link WorkspaceProvider}.
+ *
+ * @remarks
  * You can optionally set a workspace override that will be returned if defined.
  * This makes the usage more ergonomic (see the following example).
  *
@@ -3896,6 +4087,8 @@ export declare const useWorkspace: (workspace?: string | undefined) => string |
 
 /**
  * Hook to get workspace instance provided to {@link WorkspaceProvider}.
+ *
+ * @remarks
  * You can optionally set a workspace override that will be returned if defined.
  * This makes the usage more ergonomic (see the following example).
  *