VisibleElements | References | ArcGIS Maps SDK for JavaScript

import VisibleElements from "@arcgis/core/widgets/Sketch/VisibleElements.js";

const VisibleElements = await $arcgis.import("@arcgis/core/widgets/Sketch/VisibleElements.js");

Inheritance: VisibleElements→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.0

The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.

Examples

// This hides the lasso selection tools
sketch.visibleElements = {
  selectionTools: {
    "lasso-selection": false
  }
}

// This removes the feature enabled snapping toggle and the layerlist.
sketch.visibleElements = {
  snappingControlsElements: {
    featureEnabledToggle: false,
    layerList: false
  }
}

// This hides the undo/redo tools
sketch.visibleElements = {
  undoRedoMenu: false
}

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	VisibleElementsProperties

See the properties table for a list of all the properties that may be passed into the constructor.

Properties

Any properties can be set, retrieved or listened to. See the Watch for changes topic.

Property	Type	Class
createTools	CreateToolVisibilityMap
declaredClass readonly inherited	string	Accessor
deleteButton	boolean
duplicateButton	boolean
geometrySimplificationActivityIndicator	boolean
labelsToggle	boolean
selectionCountLabel	boolean
selectionTools	SelectionToolVisibilityMap
settingsMenu	boolean
snappingControls	boolean
snappingControlsElements	SnappingControlsVisibleElements
tooltipsToggle	boolean
undoRedoMenu	boolean

createTools

autocast Property

Type: CreateToolVisibilityMap

The available sketch tools within the widget.

declaredClass

readonlyinherited Property

Type: string

Inherited from: Accessor

Since: ArcGIS Maps SDK for JavaScript 4.7

The name of the class. The declared class name is formatted as esri.folder.className.

deleteButton

Property

Type: boolean

Indicates whether to display the 'delete' button while a graphic is selected. Default is true. Do not hide this button without giving users on touch devices another way to delete selected geometries.

Default value: true

duplicateButton

Property

Type: boolean

Indicates whether to display the 'duplicate' button while a graphic is selected. Default is true.

Default value: true

geometrySimplificationActivityIndicator

Property

Type: boolean

Since: ArcGIS Maps SDK for JavaScript 5.1

Indicates whether to display the geometry simplification progress indicator while geometry simplification is in progress. Default value is true.

When set to false, the progress indicator is not shown. You can use SketchViewModel.geometrySimplificationInProgress to detect this state and implement alternative UI.