@vertigis/viewer-spec/app-config/common/RegionModelProperties.d.ts

VertiGIS Viewer Specification

import type { FormatSettingsProperties } from "@vertigis/arcgis-extensions/support/FormatSettings";
import type { ModelProperties } from "./ModelProperties.js";
/**
 * A system used to determine what units should be used for measurement values.
 */
export type MeasurementSystem = "metric" | "imperial";
/**
 * Properties that can be passed into the constructor for {@link RegionSettings}.
 */
export interface RegionModelProperties extends ModelProperties {
    /**
     * The fallback locale to use if the detected locale is not found in the
     * app. This locale should be attempted to be used before 'invariant'.
     */
    fallbackLocale?: string;
    /**
     * The measurement system used to determine what units should be used for
     * measurement values.
     */
    measurementSystem?: MeasurementSystem;
    /**
     * The root format settings for the app.
     */
    formatSettings?: FormatSettingsProperties;
}