@vertigis/viewer-spec
Version:
VertiGIS Viewer Specification
37 lines (36 loc) • 1.42 kB
TypeScript
import type { DrawModelBaseProperties } from "./DrawModelProperties.js";
/**
* Properties used to create and config a MeasurementModel.
*/
export interface MeasurementModelProperties extends DrawModelBaseProperties {
/**
* The number of decimal places to use in measurement labels. The default is
* 2.
*/
decimalPlaces?: number;
/**
* The units used when creating measurement labels for polylines. When left
* undefined, measurement units will be intelligently assigned based on the
* locale. The default is undefined.
*/
lengthUnits?: LengthMeasurementUnits;
/**
* The units used when creating measurement labels for polygons. When left
* undefined, measurement units will be intelligently assigned based on the
* locale. The default is undefined.
*/
areaUnits?: AreaMeasurementUnits;
/**
* Whether measurements are geodesic. The default is true. If set to false,
* measurements will be planar.
*/
isGeodesic?: boolean;
}
/**
* The units for area measurements supported by ArcGIS.
*/
export type AreaMeasurementUnits = "acres" | "ares" | "hectares" | "square-feet" | "square-meters" | "square-yards" | "square-kilometers" | "square-miles";
/**
* The units for length measurements supported by ArcGIS.
*/
export type LengthMeasurementUnits = "meters" | "feet" | "kilometers" | "miles" | "nautical-miles" | "yards";