warp-grid
    Preparing search index...

    Interface WarpGrid

    Complete grid interface combining manipulation methods with model access.

    interface WarpGrid {
        getPoint: (params: GetPointProps) => Point;
        getIntersections: () => Point[];
        getLinesXAxis: () => Curve[][];
        getLinesYAxis: () => Curve[][];
        getLines: () => LinesByAxis;
        getCellBounds: (
            columnIdx: number,
            rowIdx: number,
            config?: GetCellBoundsConfig,
        ) => BoundingCurves;
        getAllCellBounds: (params?: GetAllCellBoundsProps) => BoundingCurves[];
        model: GridModel;
    }

    Hierarchy (View Summary)

    Index

    Properties

    getPoint getIntersections getLinesXAxis getLinesYAxis getLines getCellBounds getAllCellBounds model

    Properties

    getPoint: (params: GetPointProps) => Point

    Returns a point at the specified grid coordinates. Results are memoized for performance.

    Type declaration

    ValidationError When coordinates are outside valid range.

    getIntersections: () => Point[]

    Returns all points where grid lines intersect. Results are memoized for performance.

    Type declaration

      • (): Point[]

      • Returns Point[]

        Array of intersection points.

    getLinesXAxis: () => Curve[][]

    Returns horizontal grid lines organized in rows from top to bottom. Each array element represents a row containing Bézier curves that form the horizontal grid structure. Lines include top and bottom bounds. Results are memoized for performance.

    getLinesYAxis: () => Curve[][]

    Returns vertical grid lines organized in rows from top to bottom. Each array element represents a column containing Bézier curves that form the vertical grid structure. Lines include left and right bounds. Results are memoized for performance.

    getLines: () => LinesByAxis

    Returns all grid lines organized by axis. The returned object contains arrays of Bézier curves representing horizontal lines (xAxis) and vertical lines (yAxis). Results are memoized for performance.

    getCellBounds: (
        columnIdx: number,
        rowIdx: number,
        config?: GetCellBoundsConfig,
    ) => BoundingCurves

    Returns the bounding curves for a specific cell. Results are memoized for performance.

    Type declaration

    ValidationError When indices are out of bounds.

    getAllCellBounds: (params?: GetAllCellBoundsProps) => BoundingCurves[]

    Returns bounding curves for all cells in the grid. Results are memoized for performance.

    Type declaration

    model: GridModel

    Settings

    On This Page

    Properties