@arcgis/core/widgets/DirectionalPad/VisibleElements.d.ts

ArcGIS Maps SDK for JavaScript: A complete 2D and 3D mapping and data visualization API

import type Accessor from "../../core/Accessor.js";

/** @since 5.0 */
export interface VisibleElementsProperties extends Partial<Pick<VisibleElements, "directionalButtons" | "rotationResetButton" | "rotationSlider">> {}

/**
 * The visible elements that are displayed within the widget.
 * This provides the ability to turn individual elements of the widget's display on/off.
 * Alternatively, developers may also use CSS (e.g. `display: none`) to show/hide elements, such as labels.
 *
 * @since 5.0
 */
export default class VisibleElements extends Accessor {
  constructor(properties?: VisibleElementsProperties);
  /**
   * Indicates whether to display the directional pad buttons.
   *   This can be disabled if only the map rotation slider is needed
   *
   * @default true
   * @since 5.0
   */
  accessor directionalButtons: boolean;
  /**
   * Indicates whether to display the button to reset the rotation
   *   angle. If rotation slider is hidden, rotation reset button will be hidden too.
   *
   * @default false
   * @since 5.0
   */
  accessor rotationResetButton: boolean;
  /**
   * Indicates whether to display the map rotation slider.
   *   This can be disabled if only the directional buttons are needed. Note, this is independent of the
   *   `view.constraints.rotationEnabled` setting.
   *
   * @default false
   * @since 5.0
   */
  accessor rotationSlider: boolean;
}