require(["esri/widgets/Expand"], function(Expand) { /* code goes here */ });
Class: esri/widgets/Expand
Inheritance: Expand Widget Accessor
Since: ArcGIS API for JavaScript 4.3
beta

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.
NameTypeSummary
String

Tooltip to display to indicate Expand widget can be collapsed.

more details
more details
String | HTMLElement

The ID or node representing the DOM element containing the widget.

more details
more details
Dijit | Node | String | Widget

The content to display within the expanded Expand widget.

more details
more details
String

The name of the class.

more details
more details
Boolean

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

more details
more details
Boolean

Whether the widget is currently expanded or not.

more details
more details
String

Icon font used to style the Expand button.

more details
more details
String

Tooltip to display to indicate Expand widget can be expanded.

more details
more details
String

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
String

The unique ID assigned to the widget when the widget is created.

more details
more details
MapView | SceneView

A reference to the MapView or SceneView.

more details
more details
ExpandViewModel

The view model for this widget.

more details
more details

Property Details

collapseTooltipString

Tooltip to display to indicate Expand widget can be collapsed.

Default Value: "Collapse" (English locale)

The ID or node representing the DOM element containing the widget. This property can only be set once.

contentDijit|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 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");

declaredClassStringreadonly

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

destroyedBoolean

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

expandedBooleanreadonly

Whether the widget is currently expanded or not.

Default Value: false

expandIconClassString

Icon font used to style the Expand button.

See also:

expandTooltipString

Tooltip to display to indicate Expand widget can be expanded.

Default Value: "Expand" (English locale)

iconNumberString

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

expand widget icon number

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.

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

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

NameReturn TypeSummary

Collapse the widget.

more details
more details

Destroys the widget instance.

more details
more details

Expand the widget.

more details
more details
Boolean

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

more details
more details
Object

Registers an event handler on the instance.

more details
more details

Widget teardown helper.

more details
more details

This method is primarily used by developers when implementing custom widgets.

more details
more details
Object

This method is primarily used by developers when implementing custom widgets.

more details
more details

Renders widget to the DOM immediately.

more details
more details

This method is primarily used by developers when implementing custom widgets.

more details
more details

Finalizes the creation of the widget.

more details
more details

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

more details
more details

Method Details

collapse()

Collapse the widget.

destroy()inherited

Destroys the widget instance.

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:
TypeDescription
BooleanReturns 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. See the Events summary table for a list of listened events.

Parameters:
type String

The name of event to listen for.

listener Function

The function to call when the event is fired.

Returns:
TypeDescription
ObjectReturns an event handler with a remove() method that can be called to stop listening for the event.
PropertyTypeDescription
removeFunctionWhen called, removes the listener from the event.
See also:
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 Handle[]

@type - handles to remove when 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:
TypeDescription
ObjectThe 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.

startup()inherited

Deprecated
  • since version 4.2.

Finalizes the creation of the widget.

toggle()

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

API Reference search results

NameTypeModule

There were no match results from your search criteria.