mindee/src/parsing/custom/lineItems.d.ts

Mindee Client Library for Node.js

import { BBox, Polygon } from "../../geometry";
import { ListField, ListFieldValue } from "./listField";
export declare class CustomLine {
    /**
     * Number of the current line.
     * Starts at 1.
     */
    rowNumber: number;
    /**
     * List of the fields associated to the current line, identified by their column name.
     */
    fields: Map<string, ListFieldValue>;
    /**
     * The BBox of the entire line, all fields included.
     */
    bbox: BBox;
    constructor(rowNumber: number);
    /**
     * Extends the current bbox of the line with the bbox.
     */
    extendWithBbox(bbox: BBox): void;
    /**
     * Extends the current bbox of the line with the polygon.
     */
    extendWith(polygon: Polygon): void;
    updateField(name: string, fieldValue: ListFieldValue): void;
}
export declare class CustomLines extends Array<CustomLine> {
}
/**
 * Get line items from fields.
 */
export declare function getLineItems(anchorNames: string[], fieldNames: string[], fields: Map<string, ListField>, heightLineTolerance: number): CustomLines;