@arcgis/map-components
Version:
ArcGIS Map Components
84 lines (83 loc) • 4.52 kB
TypeScript
/// <reference path="../../index.d.ts" />
import type MapView from "@arcgis/core/views/MapView.js";
import type { PublicLitElement as LitElement } from "@arcgis/lumina";
import type { ArcgisReferenceElement } from "../types.js";
import type { ScaleBarStyle, ScaleBarUnit } from "./types.js";
import type { T9nMeta } from "@arcgis/lumina/controllers";
/**
* The Scale Bar component displays a scale bar representing the scale of the map.
* It respects various coordinate systems and displays units in metric or imperial values.
* Metric values show either kilometers, meters, centimeters, or millimeters depending on the scale, and likewise, imperial values show miles, feet, or inches depending on the scale.
* When working with Web Mercator or geographic coordinate systems the scale bar takes into account projection distortion and dynamically adjusts the scale bar.
*
* When the scale bar is inside the map, the actual location of the scale bar is used to calculate the scale.
* Otherwise, the center of the map is used to calculate the scale.
*
* **Known limitations**
*
* - This component is not currently supported within a Scene component.
*
* @since 4.28
*/
export abstract class ArcgisScaleBar extends LitElement {
/**
* If true, the component will not be destroyed automatically when it is
* disconnected from the document. This is useful when you want to move the
* component to a different place on the page, or temporarily hide it. If this
* is set, make sure to call the [destroy()](https://developers.arcgis.com/javascript/latest/references/map-components/components/arcgis-scale-bar/#destroy) method when you are done to
* prevent memory leaks.
*
* @default false
*/
accessor autoDestroyDisabled: boolean;
/**
* The style for the scale bar.
* When `unit` is set to `dual`, the style will always be `line`.
*
* @default "line"
*/
accessor barStyle: ScaleBarStyle;
/**
* Icon which represents the component.
* Typically used when the component is controlled by another component (e.g. by the Expand component).
*
* @default "actual-size"
* @see [Calcite Icons](https://developers.arcgis.com/calcite-design-system/icons/)
*/
accessor icon: string | undefined;
/** The component's default label. */
accessor label: string | undefined;
/**
* Replace localized message strings with your own strings.
*
* _**Note**: Individual message keys may change between releases._
*/
accessor messageOverrides: { componentLabel?: string | undefined; };
/** @internal */
protected messages: Partial<{ componentLabel: string; }> & T9nMeta<{ componentLabel: string; }>;
/**
* By assigning the `id` attribute of the Map or Scene component to this property, you can position a child component anywhere in the DOM while still maintaining a connection to the Map or Scene.
*
* @see [Associate components with a Map or Scene component](https://developers.arcgis.com/javascript/latest/programming-patterns/#associate-components-with-a-map-or-scene-component)
*/
accessor referenceElement: ArcgisReferenceElement | string | undefined;
/**
* Units to use for the scale bar.
* When using `dual`, the scale bar displays both metric and imperial units.
* When metric, distances will be shown in either kilometers, meters, centimeters, or millimeters depending on the scale. Similarly, imperial
* units will be shown in either miles, feet, or inches.
*/
accessor unit: ScaleBarUnit | undefined;
/**
* The view associated with the component.
* > **Note:** The recommended approach is to fully migrate applications to use map and scene components and avoid using MapView and SceneView directly. However, if you are migrating a large application from widgets to components, you might prefer a more gradual transition. To support this use case, the SDK includes this `view` property which connects a component to a MapView or SceneView. Ultimately, once migration is complete, the arcgis-scale-bar component will be associated with a map or scene component rather than using the `view` property.
*/
accessor view: MapView | null | undefined;
/** Permanently destroy the component. */
destroy(): Promise<void>;
/** Emitted when the component associated with a map or scene view is ready to be interacted with. */
readonly arcgisReady: import("@arcgis/lumina").TargetedEvent<this, void>;
readonly "@eventTypes": {
arcgisReady: ArcgisScaleBar["arcgisReady"]["detail"];
};
}