Type Alias PerseusMeasurerWidgetOptions

Options for the measurer widget. A virtual ruler and/or protractor.

type PerseusMeasurerWidgetOptions = {
    box: [number, number];
    image: PerseusImageBackground;
    rulerLabel: string;
    rulerLength: number;
    rulerPixels: number;
    rulerTicks: number;
    showProtractor: boolean;
    showRuler: boolean;
}

Properties

box: [number, number]

Containing area [width, height]

The image that the user is meant to measure

rulerLabel: string

The unit to show on the ruler. e.g. "mm", "cm", "m", "km", "in", "ft", "yd", "mi"

rulerLength: number

The number of units to display on the ruler

rulerPixels: number

The number of image pixels per unit (label)

rulerTicks: number

How many ticks to show on the ruler. e.g. 1, 2, 4, 8, 10, 16

showProtractor: boolean

Whether to show the Protractor tool overlayed on top of the image

showRuler: boolean

Whether to show the Ruler tool overlayed on top of the image