BasemapLayerListVisibleElements | References | ArcGIS Maps SDK for JavaScript

import BasemapLayerListVisibleElements from "@arcgis/core/widgets/BasemapLayerList/BasemapLayerListVisibleElements.js";

Inheritance:: BasemapLayerListVisibleElements→Accessor

Since: ArcGIS Maps SDK for JavaScript 5.0

The visible elements that are displayed within the basemap layer list. This provides the ability to turn on/off individual elements of the basemap layer list.

Constructors

Constructor

Parameters

Parameter	Type	Description	Required
properties	`BasemapLayerListVisibleElementsProperties`

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
`baseLayers`	`boolean`
`closeButton`	`boolean`
`collapseButton`	`boolean`
`declaredClass` readonly inherited	`string`	Accessor
`editTitleButton`	`boolean`
`errors`	`boolean`
`filter`	`boolean`
`flow`	`boolean`
`heading`	`boolean`
`referenceLayers`	`boolean`
`statusIndicators`	`boolean`
`temporaryLayerIndicators`	`boolean`

baseLayers

Property

Type: boolean

Indicates whether to the base layers will be displayed.

Default value: true

closeButton

Property

Type: boolean

Indicates whether to display a close button in the header.

Default value: false

collapseButton

Property

Type: boolean

Indicates whether to display a collapse button in the header.

Default value: false

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.

editTitleButton

Property

Type: boolean

Indicates whether to display a button in the header to edit the basemap title.

Default value: false

errors

Property

Type: boolean

Indicates whether to display layers with load errors.

Default value: false

filter

Property

Type: boolean

Indicates whether to display a filter input box when then number of list items is equal to or greater than the value set in BasemapLayerList.minFilterItems, allowing users to filter layers by their title.

Default value: false

flow

Property

Type: boolean

Determines whether the basemap layer list should be shown within its built-in flow component or if the flow component should be excluded. The basemap layer list will be displayed within its original flow component if set to true. The flow component will be omitted from the basemap layer list if set to false. To place the basemap layer list into an existing Calcite flow component, set this property to false.

Default value: true

heading

Property

Type: boolean

Indicates whether the basemap layer list displays a heading. The heading text is the title of the basemap. The heading level can be set with the BasemapLayerList.headingLevel.

Default value: true

referenceLayers

Property

Type: boolean

Indicates whether to the reference layers will be displayed.

Default value: true

statusIndicators

Property

Type: boolean

Indicates whether the status indicators will be displayed.

Default value: true

temporaryLayerIndicators

Property

Type: boolean

Indicates whether temporary layer indicators will be displayed for layers with Layer.persistenceEnabled set to false. A temporary icon will be displayed on the near side of the layer title.

Default value: false