Expand

require(["esri/widgets/Expand"], function(Expand) { /* code goes here */ });

Class: esri/widgets/Expand

Inheritance: Expand Widget Accessor

Since: ArcGIS API for JavaScript 4.3

The Expand widget acts as a clickable button for opening a widget.

For information about gaining full control of widget styles, see the Styling topic.

See also:

Example:

// LayerList
layerList = new LayerList({
  container: document.createElement("div"),
  view: view
});
layerListExpand = new Expand({
  expandIconClass: "esri-icon-layer-list",  // see https://developers.arcgis.com/javascript/latest/guide/esri-icon-font/
  // expandTooltip: "Expand LayerList", // optional, defaults to "Expand" for English locale
  view: view,
  content: layerList.domNode
});
view.ui.add(layerListExpand, "top-right");

Constructors

new Expand(properties)

Parameter:

properties Object

optional

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

Property Overview

Any properties can be set, retrieved or listened to. See the Working with Properties topic.

Show inherited properties Hide inherited properties

Type	Summary	Class
Boolean	Automatically collapses the expand widget instance when the view's viewpoint updates. more details	more details	Expand
String	Icon font used to style the Expand button. more details	more details	Expand
String	Tooltip to display to indicate Expand widget can be collapsed. more details	more details	Expand
String\|HTMLElement	The ID or node representing the DOM element containing the widget. more details	more details	Widget
Node\|String\|Widget	The content to display within the expanded Expand widget. more details	more details	Expand
String	The name of the class. more details	more details	Accessor
Boolean	When `true`, this property indicates whether the widget has been destroyed. more details	more details	Widget
Boolean	Indicates whether the widget is currently expanded or not. more details	more details	Expand
String	Icon font used to style the Expand button. more details	more details	Expand
String	Tooltip to display to indicate Expand widget can be expanded. more details	more details	Expand
String	This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded. more details	more details	Expand
Number	A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices. more details	more details	Expand
String	The unique ID assigned to the widget when the widget is created. more details	more details	Widget
String	The widget's default label. more details	more details	Expand
String	The mode in which the widget displays. more details	more details	Expand
MapView\|SceneView	A reference to the MapView or SceneView. more details	more details	Expand
ExpandViewModel	The view model for this widget. more details	more details	Expand

Property Details

autoCollapse Boolean

Automatically collapses the expand widget instance when the view's viewpoint updates.

Default Value:false

collapseIconClass String Since: ArcGIS API for JavaScript 4.4

Icon font used to style the Expand button.

See also:

Guide - Esri Icon Font

collapseTooltip String

Tooltip to display to indicate Expand widget can be collapsed.

Default Value:"Collapse" (English locale)

container String|HTMLElement inherited

The ID or node representing the DOM element containing the widget. This property can only be set once. The following examples are all valid use cases when working with widgets.

Examples:

// Create the HTML div element programmatically at runtime and set to the widget's container
const basemapGallery = new BasemapGallery({
  view: view,
  container: document.createElement("div")
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// Specify an already-defined HTML div element in the widget's container

const basemapGallery = new BasemapGallery({
  view: view,
  container: basemapGalleryDiv
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

// HTML markup
<body>
  <div id="viewDiv"></div>
  <div id="basemapGalleryDiv"></div>
</body>

// Specify the widget while adding to the view's UI
const basemapGallery = new BasemapGallery({
  view: view
});

// Add the widget to the top-right corner of the view
view.ui.add(basemapGallery, {
  position: "top-right"
});

content Node|String|Widget

The content to display within the expanded Expand widget.

Examples:

// A. specify content with a widget
   var searchWidget = new Search({
     view: view
   });

   var expand = new Expand({
     expandIconClass: "esri-icon-search",
     view: view,
     content: searchWidget
   });
   view.ui.add(expand, "bottom-left");

// B. specify content with a string (of HTML)
   content: "Hi, I can have <input placeholder='HTML'/>!"

// C. specify content with a DOM node
   var node = domConstruct.create("div", {
     innerHTML: "I'm a real node!"
   });

   var expand = new Expand({
     expandIconClass: "esri-icon-right-arrow",
     view: view,
     content: node
   });
   view.ui.add(expand, "top-right");

// D. specify content with a Dijit
   var button = new Button({  // "dijit/form/Button"
     label: "I'm a dijit!"
   });
   button.startup();

   var expand = new Expand({
     expandIconClass: "esri-icon-right-arrow",
     expanded: true,
     view: view,
     content: button
   });
   view.ui.add(expand, "top-left");

declaredClass Stringreadonly inherited Since: ArcGIS API for JavaScript 4.7

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

destroyed Boolean inherited

When true, this property indicates whether the widget has been destroyed.

expanded Boolean

Indicates whether the widget is currently expanded or not.

Default Value:false

expandIconClass String

Icon font used to style the Expand button. Will automatically use the content's iconClass if it has one.

See also:

Guide - Esri Icon Font

expandTooltip String

Tooltip to display to indicate Expand widget can be expanded.

Default Value:"Expand" (English locale)

group String Since: ArcGIS API for JavaScript 4.6

This value associates two or more Expand widget instances with each other, allowing one instance to auto collapse when another instance in the same group is expanded. For auto collapsing to take effect, all instances of the group must be included in the view.ui.

For example, if you place multiple Expand instances in the top-left of the view's ui, you can assign them to a group called top-left. If one Expand instance is expanded and the user clicks on a different instance in the top-left group, then the first instance is collapsed, allowing the content of the second instance to be fully visible.

Example:

var expand1 = new Expand({
  view: view,
  content: document.getElementById("bg-gallery"),
  expandIconClass: "esri-icon-basemap",
  group: "bottom-right"
});
var expand2 = new Expand({
  view: view,
  content: document.getElementById("legend"),
  expandIconClass: "esri-icon-key",
  group: "bottom-right"
});

view.ui.add([expand1, expand2], "bottom-right");

iconNumber Number

A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices.

id String inherited

The unique ID assigned to the widget when the widget is created. If not set by the developer, it will default to the container ID, or if that is not present then it will be automatically generated.

label String

The widget's default label.

mode String Since: ArcGIS API for JavaScript 4.7

The mode in which the widget displays. These modes are listed below.

mode	description
auto	This is the default mode. It is responsive to browser size changes and will update based on whether the widget is viewed in a desktop or mobile application.
floating	Use this mode if you wish to always display the widget as floating regardless of browser size.
drawer	Use this mode if you wish to always display the widget in a panel regardless of browser size.

Default Value:"auto"

view MapView|SceneView

A reference to the MapView or SceneView. Set this to link the widget to a specific view.

viewModel ExpandViewModelautocast

The view model for this widget. This is a class that contains all the logic (properties and methods) that controls this widget's behavior. See the ExpandViewModel class to access all properties and methods on the widget.

Method Overview

Show inherited methods Hide inherited methods

Return Type	Summary	Class
String	A utility method used for building the value for a widget's `class` property. more details	more details	Widget
	Collapse the widget. more details	more details	Expand
	Destroys the widget instance. more details	more details	Widget
Boolean	Emits an event on the instance. more details	more details	Widget
	Expand the widget. more details	more details	Expand
Boolean	Indicates whether there is an event listener on the instance that matches the provided event name. more details	more details	Widget
Object	Registers an event handler on the instance. more details	more details	Widget
	Widget teardown helper. more details	more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
Object	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
	Renders widget to the DOM immediately. more details	more details	Widget
	This method is primarily used by developers when implementing custom widgets. more details	more details	Widget
	Toggle the widget by expanding it if it's collapsed, or collapsing it if it's expanded. more details	more details	Expand

Method Details

classes(classNames){String}inherited Since: ArcGIS API for JavaScript 4.7

A utility method used for building the value for a widget's class property. This aids in simplifying CSS class setup.

Parameter:

classNames Array<(string|Array<string>|Object)>

repeatable

The class names.

Returns:

Type	Description
String	The computed class name.

See also:

Guide - Widget development (rendering)

Example:

// .tsx syntax showing how to set CSS classes while rendering the widget

render() {
  const dynamicIconClasses = {
    [CSS.myIcon]: this.showIcon,
    [CSS.greyIcon]: !this.showIcon
  };

  return (
    <div class={classes(CSS.root, CSS.mixin, dynamicIconClasses)} />
  );
}

collapse()

Collapse the widget.

destroy()inherited

Destroys the widget instance.

emit(type, event){Boolean}inherited Since: ArcGIS API for JavaScript 4.5

Emits an event on the instance. This method should only be used when creating subclasses of this class.

Parameters:

type String

The name of the event.

event Object

optional

The event payload.

Returns:

Type	Description
Boolean	`true` if a listener was notified

expand()

Expand the widget.

hasEventListener(type){Boolean}inherited

Indicates whether there is an event listener on the instance that matches the provided event name.

Parameter:

type String

The name of the event.

Returns:

Type	Description
Boolean	Returns true if the class supports the input event.

on(type, listener){Object}inherited

Registers an event handler on the instance. Call this method to hook an event with a listener.

Parameters:

type String|String []

A event type, or an array of event types, to listen for.

listener Function

The function to call when the event is fired.

Returns:

Type Description

Object

Returns an event handler with a remove() method that can be called to stop listening for the event(s).

Property	Type	Description
remove	Function	When called, removes the listener from the event.

Example:

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own(handles)inherited

Widget teardown helper. Any handles added to it will be automatically removed when the widget is destroyed.

Parameter:

handles WatchHandle|WatchHandle []

Handles marked for removal once the widget is destroyed.

postInitialize()inherited

This method is primarily used by developers when implementing custom widgets. Executes after widget is ready for rendering.

render(){Object}inherited

This method is primarily used by developers when implementing custom widgets. It must be implemented by subclasses for rendering.

Returns:

Type	Description
Object	The rendered virtual node.

renderNow()inherited

Renders widget to the DOM immediately.

scheduleRender()inherited

This method is primarily used by developers when implementing custom widgets. Schedules widget rendering. This method is useful for changes affecting the UI.

toggle()

Toggle the widget by expanding it if it's collapsed, or collapsing it if it's expanded.

	Site wide shortcuts
`?`	Bring up this help dialog
`esc`	Dismiss this help dialog
`gh`	Go to Home
`gg`	Go to Guide
`ga`	Go to API Reference
`gs`	Go to Sample Code
`gt`	Scroll to top of page
`spacebar`	Scroll page down
`shift spacebar`	Scroll page up
`gb`	Scroll to bottom of page

	API Reference
`/`	Focus search
`esc`	Remove search focus
`enter`	Focus first search result
`c`	Go to Constructors
`p`	Go to Properties
`m`	Go to Methods
`t`	Go to Type definitions
`e`	Go to Events

JavaScript API 4.14 API Reference

JavaScript API API Reference

Expand

Expand

Constructors

Property Overview

Property Details

Method Overview

Method Details

JavaScript API 4.14 API Reference

JavaScript API API Reference

Constructors

Property Overview

Property Details

Method Overview

Method Details

API Reference search results