image-js/lib/extra/draw/draw_text.d.ts

Image processing and manipulation in JavaScript

import type { Image } from '../../Image.ts';
import type { Point } from '../../geometry/index.ts';
export interface DrawTextLabel {
    /**
     * Text of the label.
     */
    content: number | string;
    /**
     * Position to draw the label at.
     */
    position: Point;
    /**
     *  Size and type of font.
     *  If specified, this overrides the general font from DrawTextOptions.
     */
    font?: string;
    /**
     *  Font color. Should be in rgba8 format.
     *  If specified, this overrides the general fontColor from DrawTextOptions.
     */
    fontColor?: number[];
}
export interface DrawTextOptions {
    /**
     *  General size and type of font.
     *  Used as the default when font is not specified in individual text labels.
     */
    font?: string;
    /**
     *  General font color.
     *  Used as the default when fontColor is not specified in individual text labels.
     */
    fontColor?: number[];
    /**
     * Image to which the resulting image has to be put.
     */
    out?: Image;
}
/**
 * Draws text on an image.
 * @param image - Image to write text on.
 * @param text - Text to write on the image.
 * @param options - Out Options
 * @returns Image with drawn text.
 */
export declare function drawText(image: Image, text: DrawTextLabel | DrawTextLabel[], options?: DrawTextOptions): Image;
//# sourceMappingURL=draw_text.d.ts.map