import { Attribute, DataSource, Filter, FilterRelationsJaql, Measure, QueryResultData } from '@sisense/sdk-data'; import { type ClientApplication } from '../../../../infra/app/types.js'; import { executeQuery as executeQueryFunction } from '../../../query-execution/core/execute-query.js'; import { BoxplotChartCustomDataOptions, BoxplotChartDataOptionsInternal } from '../../core/chart-data-options/types.js'; /** * Processes box whisker data and outliers data to combine them into a single data set. * * @param {QueryResultData} boxWhiskerData - The data for the box whisker. * @param {QueryResultData} outliersData - The data for the outliers. * @param {BoxplotChartDataOptionsInternal} [dataOptions] - Optional data options for customizing data processing. * @returns {QueryResultData} The combined data with outliers included in the box whisker plot. */ export declare const boxWhiskerProcessResultInternal: (boxWhiskerData: QueryResultData, outliersData: QueryResultData, dataOptions?: BoxplotChartDataOptionsInternal) => QueryResultData; /** * Processes box whisker data and outliers data to combine them into a single data set. * * @example * Without custom `dataOptions`, the category is expected at column index 0, and the whisker * min/max at columns 4 and 5, matching the query shape used internally by * {@link @sisense/sdk-ui!BoxplotChart | `BoxplotChart`}. * * ```ts * import { boxWhiskerProcessResult } from '@sisense/sdk-ui'; * * const boxWhiskerData = { * columns: [ * { name: 'Category' }, * { name: 'Median' }, * { name: 'Q1' }, * { name: 'Q3' }, * { name: 'Min' }, * { name: 'Max' }, * ], * rows: [[{ data: 'A' }, { data: 30 }, { data: 20 }, { data: 40 }, { data: 10 }, { data: 50 }]], * }; * const outliersData = { * columns: [{ name: 'Category' }, { name: 'Value' }], * rows: [[{ data: 'A' }, { data: 75 }]], * }; * * // Each result row gains an extra cell listing outlier values outside the whisker range. * const combined = boxWhiskerProcessResult(boxWhiskerData, outliersData); * ``` * * @param boxWhiskerData - The data for the box whisker. * @param outliersData - The data for the outliers. * @param dataOptions - Optional data options for customizing data processing. * @returns The combined data with outliers included in the box whisker plot. * @shortDescription Utility function that combines box whisker data and outliers data * @group Charts */ export declare function boxWhiskerProcessResult(boxWhiskerData: QueryResultData, outliersData: QueryResultData, dataOptions?: BoxplotChartCustomDataOptions): QueryResultData; export declare const executeBoxplotQuery: ({ app, chartDataOptions, dataSource, attributes, measures, filters, filterRelations, highlights, }: { app: ClientApplication; chartDataOptions: BoxplotChartDataOptionsInternal; dataSource?: DataSource | undefined; attributes: Attribute[]; measures: Measure[]; filters?: Filter[] | undefined; filterRelations?: FilterRelationsJaql | undefined; highlights?: Filter[] | undefined; }, executeQuery: typeof executeQueryFunction) => Promise;