import { type IBaseWidget } from "./baseWidget.js";
import { type IDashboardObjectIdentity } from "./common.js";
import { type IWidget, type IWidgetDefinition } from "./widget.js";
/**
 * Classification of the screen size according to its size with respect to the set breakpoints.
 *
 * @alpha
 */
export type ScreenSize = "xl" | "lg" | "md" | "sm" | "xs";
/**
 * Widget representing nested layout
 *
 * @public
 */
export interface IDashboardLayoutWidget extends IDashboardLayout<IDashboardWidget>, IBaseWidget, IDashboardObjectIdentity {
    type: "IDashboardLayout";
}
/**
 * Default dashboard widgets - kpi widget, insight widget, or nested layout.
 *
 * @public
 */
export type IDashboardWidget = IWidget | IWidgetDefinition | IDashboardLayoutWidget;
/**
 * Type-guard testing whether the provided object is an instance of {@link IDashboardWidget}.
 * @alpha
 */
export declare const isDashboardWidget: (obj: unknown) => obj is IDashboardWidget;
/**
 * Dashboard layout item - usually contains kpi widget, insight widget or another nested layout.
 * Generic TWidget param is here to support type checking with custom widgets (e.g. in Dashboard component).
 *
 * @public
 */
export interface IDashboardLayoutItem<TWidget = IDashboardWidget> {
    /**
     * Unique type to identify dashboard layout item.
     */
    type: "IDashboardLayoutItem";
    /**
     * Widget data - kpi widget, insight widget, nested layout or custom widget.
     */
    widget?: TWidget;
    /**
     * Item size configuration for each of the screen sizes.
     */
    size: IDashboardLayoutSizeByScreenSize;
}
/**
 * Type-guard testing whether the provided object is an instance of {@link IDashboardLayoutItem}.
 * @alpha
 */
export declare function isDashboardLayoutItem<TWidget>(obj: unknown): obj is IDashboardLayoutItem<TWidget>;
/**
 * Configuration that affects all sections of the layout.
 *
 * @alpha
 */
export interface IDashboardLayoutSectionsConfiguration {
    enableHeader: boolean;
}
/**
 * Represents the possible layout container directions in a dashboard structure.
 *
 * The direction determines how child elements are arranged within a container.
 * - "row": Child elements are arranged horizontally.
 * - "column": Child elements are arranged vertically.
 *
 * @alpha
 */
export type IDashboardLayoutContainerDirection = "row" | "column";
/**
 * Layout configuration.
 *
 * @alpha
 */
export interface IDashboardLayoutConfiguration {
    sections?: IDashboardLayoutSectionsConfiguration;
    /**
     * When not set, the layout will be rendered in a row.
     *
     * @alpha
     */
    direction?: IDashboardLayoutContainerDirection;
}
/**
 * Dashboard layout describes the data to be displayed on the dashboard, and their structure for UI rendering.
 * Generic TWidget param is here to support type checking with custom widgets (e.g. in Dashboard component).
 *
 * @public
 */
export interface IDashboardLayout<TWidget = IDashboardWidget> {
    /**
     * Unique type to identify dashboard layout.
     */
    type: "IDashboardLayout";
    /**
     * Layout sections.
     */
    sections: IDashboardLayoutSection<TWidget>[];
    /**
     * Layout size.
     */
    size?: IDashboardLayoutSize;
    /**
     * Layout configuration.
     *
     * @alpha
     */
    configuration?: IDashboardLayoutConfiguration;
}
/**
 * Type-guard testing whether the provided object is an instance of {@link IDashboardLayout}.
 * @alpha
 */
export declare function isDashboardLayout<TWidget = IDashboardWidget>(obj: unknown): obj is IDashboardLayout<TWidget>;
/**
 * Dashboard layout size configuration, defined by screen type.
 *
 * @public
 */
export interface IDashboardLayoutSizeByScreenSize {
    /**
     * The size configuration to use for a screen with a width less than the set xs breakpoint.
     */
    xs?: IDashboardLayoutSize;
    /**
     * The size configuration to use for a screen larger than the set xs breakpoint,
     * but smaller than the set sm breakpoint.
     */
    sm?: IDashboardLayoutSize;
    /**
     * The size configuration to use for a screen larger than the set sm breakpoint,
     * but smaller than the set md breakpoint.
     */
    md?: IDashboardLayoutSize;
    /**
     * The size configuration to use for a screen larger than the set md breakpoint,
     * but smaller than the set xl breakpoint.
     */
    lg?: IDashboardLayoutSize;
    /**
     * The size configuration to use for a screen larger than the set xl breakpoint.
     * This is also default configuration
     */
    xl: IDashboardLayoutSize;
}
/**
 * Dashboard layout size definition.
 *
 * @public
 */
export interface IDashboardLayoutSize {
    /**
     * Width, defined as a number of grid columns (grid is 12 columns wide by default).
     */
    gridWidth: number;
    /**
     * Height, defined as a number of grid rows.
     */
    gridHeight?: number;
    /**
     * Height defined as the ratio to the width in percent.
     * Examples:
     * - When heightAsRatio is 100, the column has a 1:1 ratio.
     * - When heightAsRatio is 200, the column has a 1:2 ratio.
     * - When heightAsRatio is 50, the column has a 2:1 ratio.
     */
    heightAsRatio?: number;
}
/**
 * Dashboard layout section represents a group of widgets on the dashboard with a title and description.
 * @public
 */
export interface IDashboardLayoutSection<TWidget = IDashboardWidget> {
    /**
     * Unique type to identify dashboard layout section.
     */
    type: "IDashboardLayoutSection";
    /**
     * Section items.
     */
    items: IDashboardLayoutItem<TWidget>[];
    /**
     * Section header with title and description.
     */
    header?: IDashboardLayoutSectionHeader;
}
/**
 * Type-guard testing whether the provided object is an instance of {@link IDashboardLayoutSection}.
 * @alpha
 */
export declare function isDashboardLayoutSection<TWidget>(obj: unknown): obj is IDashboardLayoutSection<TWidget>;
/**
 * Dashboard layout section header definition.
 *
 * @public
 */
export interface IDashboardLayoutSectionHeader {
    /**
     * Section title.
     */
    title?: string;
    /**
     * Section description.
     */
    description?: string;
}
//# sourceMappingURL=layout.d.ts.map