@itwin/core-backend/lib/esm/TextAnnotationGeometry.d.ts

iTwin.js backend components

/** @packageDocumentation
 * @module ElementGeometry
 */
import { TextAnnotation, TextBlockGeometryProps } from "@itwin/core-common";
import { ComputeRangesForTextLayout, FindFontId, FindTextStyle } from "./TextAnnotationLayout";
import { IModelDb } from "./IModelDb";
/** Arguments supplied to [[produceTextAnnotationGeometry]].
 * @beta
 */
export interface ProduceTextAnnotationGeometryArgs {
    /** The annotation from which to produce the geometry. */
    annotation: TextAnnotation;
    /** The iModel from which to obtain fonts and text styles. */
    iModel: IModelDb;
    /** For debugging purposes only, whether to include geometry representing the bounding box and anchor point of the annotation.
     * If true, two red lines indicating the horizontal and vertical extents of the bounding box will be included, intersecting at the anchor point.
     */
    debugAnchorPointAndRange?: boolean;
    /** @internal chiefly for tests */
    computeTextRange?: ComputeRangesForTextLayout;
    /** @internal chiefly for tests */
    findTextStyle?: FindTextStyle;
    /** @internal chiefly for tests */
    findFontId?: FindFontId;
}
/** Produce a geometric representation of a text annotation, with the annotation's anchor point at the origin.
 * The result can be supplied to [GeometryStreamBuilder.appendTextBlock]($common).
 * @see [[TextAnnotation2d.setAnnotation]] and [[TextAnnotation3d.setAnnotation]] to update the annotation, geometry, and placement of an annotation element.
 * @beta
 */
export declare function produceTextAnnotationGeometry(args: ProduceTextAnnotationGeometryArgs): TextBlockGeometryProps;
//# sourceMappingURL=TextAnnotationGeometry.d.ts.map