VisibleElements | References | ArcGIS Maps SDK for JavaScript

import SnappingControlsVisibleElements from "@arcgis/core/widgets/support/SnappingControls/VisibleElements.js";

Inheritance:: SnappingControlsVisibleElements→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.0

The visible elements that are displayed within the widget. This provides the ability to toggle visibility for individual elements within the widget.

Example

// Setting visibleElements on SnappingControls
const snappingControls = new SnappingControls({
  view,
  visibleElements: {
    selfEnabledToggle: false,
    gridControlsElements: {
      colorSelection: false,
      gridEnabledToggle: false
    }
  }
});

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`SnappingControlsVisibleElementsProperties`

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
`declaredClass` readonly inherited	`string`	Accessor
`enabledToggle`	`boolean`
`featureEnabledToggle`	`boolean`
`gridControls`	`boolean`
`gridControlsElements`	`GridControlsVisibleElements`
`gridEnabledToggle`	`boolean`
`header`	`boolean`
`layerList`	`boolean`
`layerListToggleLayersButton`	`boolean`
`selfEnabledToggle`	`boolean`

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.

enabledToggle

Property

Type: boolean

Indicates whether to display the enabledToggle (Enable snapping). Default is true. This toggles the SnappingOptions.enabled property.

Note

It is recommended to set SnappingControls.snappingOptions.enabled = true if enabledToggle is set to false. This is because selfEnabledToggle and featureEnabledToggle require snapping globally to be enabled in order to be interactive. Otherwise, these toggles will not be responsive.

Default value: true

featureEnabledToggle

Property

Type: boolean

Indicates whether to display the featureEnabledToggle (Feature to feature). Default is true. This toggles the SnappingOptions.featureEnabled property.

Default value: true

gridControls

Property

Type: boolean

Indicates whether to display the grid controls widget embedded in snapping controls. Default is true.

Default value: true

gridControlsElements

autocast Property

Type: GridControlsVisibleElements

The available GridControls elements within the widget.

gridEnabledToggle

Property

Type: boolean

Indicates whether to display the grid display toggle embedded in grid controls. Default is true.

Default value: true

header

Property

Type: boolean

Indicates whether to display the header. Default is false.

Default value: false

layerList

Property

Type: boolean

Indicates whether to display the FeatureSnappingLayerSource layerList. Default is true. The layerlist provides the available layer sources supported for snapping.

Default value: true

layerListToggleLayersButton

Property

Type: boolean

Indicates whether to display the “Enable all” or “Disable all” button to enable / disable snapping for all the layers in the list.

Default value: true

selfEnabledToggle

Property

Type: boolean

Indicates whether to display the selfEnabledToggle (Geometry guides). Default is true. This toggles the SnappingOptions.selfEnabled property.

Default value: true