import { type Identifier } from "../../objRef/index.js";
import { type IAttribute } from "../attribute/index.js";
import { type ITotal } from "./totals.js";
/**
 * Dimensions specify how to organize the results of an execution in a data view.
 *
 * @remarks
 * Imagine an attribute in columns vs. rows.
 * Each dimension requires the itemIdentifiers property, which is an array of items. These items could be attributes' localIdentifiers
 * or a special 'measureGroup' identifier.
 *
 * The 'measureGroup' can be used to specify that all measures in the execution definition should be
 * included in the dimension.
 *
 * @public
 */
export interface IDimension {
    /**
     * List of localIdentifier's of attribute to put in this dimension.
     */
    itemIdentifiers: Identifier[];
    /**
     * List of totals to include in this dimension.
     */
    totals?: ITotal[];
}
/**
 * Measure Group is a pseudo-identifier which can be used in an execution dimension and indicates
 * that this dimension MUST contain all the measures.
 *
 * @public
 */
export declare const MeasureGroupIdentifier = "measureGroup";
/**
 * Determine if a given item is a measure group.
 *
 * @public
 */
export declare const isMeasureGroupIdentifier: (itemOrTotal: DimensionItem) => itemOrTotal is "measureGroup";
/**
 * Type guard checking whether object is of IDimension type.
 *
 * @public
 */
export declare function isDimension(obj: unknown): obj is IDimension;
/**
 * Gets totals defined in the provided dimension
 *
 * @param dim - dimension to work with
 * @returns totals in the dimension or empty array if none
 * @public
 */
export declare function dimensionTotals(dim: IDimension): ITotal[];
/**
 * Creates a new dimension which has same items as the provided dimension but different totals.
 *
 * @param dim - dimension to inherit item identifiers from
 * @param totals - totals to have in the new dimension
 * @returns new dimension
 * @public
 */
export declare function dimensionSetTotals(dim: IDimension, totals?: ITotal[]): IDimension;
/**
 * Defines union of items that can be placed into a dimension.
 *
 * @remarks
 * Identifier can be attribute localId or the special {@link MeasureGroupIdentifier}. Attribute `localId` can be
 * also specified by value of IAttribute.
 *
 * @public
 */
export type DimensionItem = Identifier | IAttribute | ITotal;
/**
 * Creates new two dimensional specification where each dimension will have the provided set of
 * identifiers.
 *
 * @remarks
 * The 'measureGroup' identifier MAY be specified in only one of the dimensions.
 *
 * @param dim1Input - items to put into the first dimension, this can be item identifiers or totals
 * @param dim2Input - items to put into the second dimension, this can be item identifiers or totals
 * @returns array with exactly two dimensions
 * @public
 */
export declare function newTwoDimensional(dim1Input: DimensionItem[], dim2Input: DimensionItem[]): IDimension[];
/**
 * Creates new single-dimensional specification where the dimension will have the provided set of identifiers.
 *
 * @param items - allows for mix of item identifiers, attributes and total definitions to have in the new dimension
 * @param totals - additional totals to add to the dimension
 * @returns single dimension
 * @public
 */
export declare function newDimension(items?: DimensionItem[], totals?: ITotal[]): IDimension;
/**
 * Result of search of item among list of dimensions.
 *
 * @public
 */
export type ItemInDimension = {
    /**
     * Content of dimension where the item was found.
     */
    dim: IDimension;
    /**
     * Index of dimension where the item was found.
     */
    dimIdx: number;
    /**
     * Index of the item within the dimension where it was found.
     */
    itemIdx: number;
};
/**
 * Looks for item with the provided local identifier among the dimensions.
 *
 * @param dims - list of dimensions to look in
 * @param localId - local identifier to find among item identifiers
 * @returns list of items in dimensions, empty if not found, may contain more than one entry if
 *  item is in multiple dimensions
 * @public
 */
export declare function dimensionsFindItem(dims: IDimension[], localId: string): ItemInDimension[];
//# sourceMappingURL=dimension.d.ts.map