import { RevSchemaField } from '../../common';
import { RevBehavioredColumnSettings } from '../settings';
// eslint-disable-next-line import-x/no-cycle
import { RevSubgrid } from './subgrid';

/**
 * Defines a row in the view layout.
 * @public
 */
export interface RevViewLayoutRow<BCS extends RevBehavioredColumnSettings, SF extends RevSchemaField> {
    /** A back reference to the element's array index in {@link client/components/view/view-layout!RevViewLayout:class#rows}. */
    index: number;
    /** Local vertical row coordinate within the subgrid to which the row belongs. */
    subgridRowIndex: number;
    /** The subgrid to which the row belongs. */
    subgrid: RevSubgrid<BCS, SF>;
    /** Pixel coordinate of the top edge of this row, rounded to nearest integer. */
    top: number;
    /** Pixel coordinate of the bottom edge of this row, rounded to nearest integer. */
    bottomPlus1: number;
    /** Height of this row in pixels, rounded to nearest integer. */
    height: number;
}