@arcgis/map-components
Version:
ArcGIS Map Components
84 lines (82 loc) • 3.4 kB
TypeScript
/// <reference types="@arcgis/core/interfaces.d.ts" />
/// <reference types="../../index.d.ts" />
import { Use } from '@arcgis/lumina/controllers';
import { JsxNode, PublicLitElement as LitElement, TargetedEvent } from '@arcgis/lumina';
import { ArcgisReferenceElement } from '../../utils/component-utils';
import { useView } from '../../controllers/useView';
type ExpandDirection = "end" | "start";
type State = "disabled" | "ready";
/**
* Time Zone Label is a component for displaying the current [time zone](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/#timeZone) of a [Map](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-map/).
* The component has two states, collapsed as a small button and expanded displaying the internationalized name of the Map's time zone.
* Users can toggle between these states by clicking the component's expand/collapse button.
* By default the component is collapsed.
*
* When expanding, the component will lengthen inwards when [positioned](#position) within a Map.
* This behavior can be overridden by setting the [expandDirection](#expandDirection) property to either `"start"` or `"end"`.
*
* [Read more...](https://developers.arcgis.com/javascript/latest/references/map-components/arcgis-time-zone-label/)
*/
export declare class ArcgisTimeZoneLabel extends LitElement {
/**
* The state of the component.
*
* @default "disabled"
*/
readonly state: State;
referenceElement?: ArcgisReferenceElement | string;
/** @default "top-left" */
position: __esri.UIPosition;
/**
* When `true`, sets the component to a disabled state so the user cannot interact with it.
*
* @default false
*/
disabled: boolean;
/**
* The direction the component will expand.
*
* By default, the component will expand inward if assigned to a View UI corner. If the component is positioned manually,
* the component will expand towards the "end" which is equivalent to right in a LTR application.
*/
get expandDirection(): ExpandDirection;
set expandDirection(value: ExpandDirection | undefined);
/**
* The expanded state of the component.
*
* @default false
*/
expanded: boolean;
/**
* Replace localized message strings with your own strings.
*
* _**Note**: Individual message keys may change between releases._
*
* @property
* ({ reflect: true })
* icon?: HTMLCalciteIconElement["icon"] = "time-zone";
*
* /**
* @copyDoc
*/
messageOverrides?: typeof this._messages._overrides;
/** The component's default label. */
label?: string;
/** Emitted when the value of a property is changed. Use this to listen to changes to properties. */
readonly arcgisPropertyChange: TargetedEvent<this, {
name: "state";
}>;
/** Emitted when the component associated with a map or scene view is is ready to be interacted with. */
readonly arcgisReady: TargetedEvent<this, void>;
private _messages: {
componentLabel: string;
noAdjustment: string;
} & import('@arcgis/lumina/controllers').T9nMeta<{
componentLabel: string;
noAdjustment: string;
}>;
readonly _setterTypes: {
expandDirection?: ExpandDirection | undefined;
};
}
export {};