Expand

AMD: require(["esri/widgets/Expand"], (Expand) => { /* code goes here */ });
ESM: import Expand from "@arcgis/core/widgets/Expand";
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.

If adding a Slider, HistogramRangeSlider, or TimeSlider as content to the Expand widget, the container or parent container of the widget must have a width set in CSS for it to render inside the Expand widget.

If setting the width on the slider's container, then set the slider.container as the content of the expand rather than the slider itself.

expand.content = slider.container

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
});
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
Name Type Summary Class
Booleanmore details

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

more detailsExpand
Boolean|Functionmore details

When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content.

more detailsExpand
Stringmore details

Icon font used to style the Expand button.

more detailsExpand
Stringmore details

Tooltip to display to indicate Expand widget can be collapsed.

more detailsExpand
String|HTMLElementmore details

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

more detailsWidget
Node|String|Widgetmore details

The content to display within the expanded Expand widget.

more detailsExpand
Stringmore details

The name of the class.

more detailsAccessor
Booleanmore details

Indicates whether the widget is currently expanded or not.

more detailsExpand
Stringmore details

Icon font used to style the Expand button.

more detailsExpand
Stringmore details

Tooltip to display to indicate Expand widget can be expanded.

more detailsExpand
Stringmore details

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 detailsExpand
Numbermore details

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

more detailsExpand
Stringmore details

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

more detailsWidget
Stringmore details

The widget's default label.

more detailsExpand
Stringmore details

The mode in which the widget displays.

more detailsExpand
MapView|SceneViewmore details

A reference to the MapView or SceneView.

more detailsExpand
ExpandViewModelmore details

The view model for this widget.

more detailsExpand
Booleanmore details

Indicates whether the widget is visible.

more detailsWidget

Property Details

autoCollapse Boolean

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

Default Value:false
closeOnEsc Boolean|Function

When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content. This property can also be set to a function that returns a boolean, allowing for more customization for when to allow the Expand widget to be closed from the esc key.

Default Value:true
Examples:
let expand = new Expand({
   view: view,
   content: searchWidget,
   // widget will not be able to be closed from the ESC key
   closeOnEsc: false
});
let expand = new Expand({
   view: view,
   content: searchWidget,
   // widget will close on ESC when the search widget has no active menu
   closeOnEsc: function() {
     return searchWidget.activeMenu === "none"
   }
});
collapseIconClass String
Since: ArcGIS API for JavaScript 4.4

Icon font used to style the Expand button.

See also:
collapseTooltip String

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

If adding a Slider, HistogramRangeSlider, or TimeSlider as content to the Expand widget, the container or parent container of the widget must have a width set in CSS for it to render inside the Expand widget.

If setting the width on the slider's container (rather than a parent container), then set the slider.container as the content of the expand rather than the slider itself.

expand.content = slider.container

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

   let 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
   let node = domConstruct.create("div", {
     innerHTML: "I'm a real node!"
   });

   let expand = new Expand({
     expandIconClass: "esri-icon-right-arrow",
     view: view,
     content: node
   });
   view.ui.add(expand, "top-right");
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.

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:
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:
let expand1 = new Expand({
  view: view,
  content: document.getElementById("bg-gallery"),
  expandIconClass: "esri-icon-basemap",
  group: "bottom-right"
});
let 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.

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.

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.

Possible Values:"auto"|"floating"|"drawer"

Default Value:"auto"

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.

visible Boolean inherited

Indicates whether the widget is visible.

If false, the widget will no longer be rendered in the web document. This may affect the layout of other elements or widgets in the document. For example, if this widget is the first of three widgets associated to the upper right hand corner of the view UI, then the other widgets will reposition when this widget is made invisible. For more information, refer to the CSS display value of "none".

Default Value:true
Example:
// Hides the widget in the view
widget.visible = false;

Method Overview

Show inherited methods Hide inherited methods
Name Return Type Summary Class
Stringmore details

A utility method used for building the value for a widget's class property.

more detailsWidget
more details

Collapse the widget.

more detailsExpand
more details

Destroys the widget instance.

more detailsWidget
Booleanmore details

Emits an event on the instance.

more detailsWidget
more details

Expand the widget.

more detailsExpand
Booleanmore details

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

more detailsWidget
Booleanmore details

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected).

more detailsWidget
Booleanmore details

isRejected() may be used to verify if creating an instance of the class is rejected.

more detailsWidget
Booleanmore details

isResolved() may be used to verify if creating an instance of the class is resolved.

more detailsWidget
Objectmore details

Registers an event handler on the instance.

more detailsWidget
more details

Widget teardown helper.

more detailsWidget
more details

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

more detailsWidget
Objectmore details

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

more detailsWidget
more details

Renders widget to the DOM immediately.

more detailsWidget
more details

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

more detailsWidget
more details

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

more detailsExpand
Promisemore details

when() may be leveraged once an instance of the class is created.

more detailsWidget

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 String|String[]|Object
repeatable

The class names.

Returns:
Type Description
String The computed class name.
See also:
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.
isFulfilled(){Boolean}inherited
Since: ArcGIS API for JavaScript 4.19

isFulfilled() may be used to verify if creating an instance of the class is fulfilled (either resolved or rejected). If it is fulfilled, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected(){Boolean}inherited
Since: ArcGIS API for JavaScript 4.19

isRejected() may be used to verify if creating an instance of the class is rejected. If it is rejected, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been rejected.
isResolved(){Boolean}inherited
Since: ArcGIS API for JavaScript 4.19

isResolved() may be used to verify if creating an instance of the class is resolved. If it is resolved, true will be returned.

Returns:
Type Description
Boolean Indicates whether creating an instance of the class has been resolved.
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 supported events.

Parameters:

An event or an array of events to listen for.

listener Function

The function to call when the event fires.

Returns:
Type Description
Object Returns an event handler with a remove() method that should 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 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.

when(callback, errback){Promise}inherited
Since: ArcGIS API for JavaScript 4.19

when() may be leveraged once an instance of the class is created. This method takes two input parameters: a callback function and an errback function. The callback executes when the instance of the class loads. The errback executes if the instance of the class fails to load.

Parameters:
callback Function
optional

The function to call when the promise resolves.

errback Function
optional

The function to execute when the promise fails.

Returns:
Type Description
Promise Returns a new promise for the result of callback that may be used to chain additional functions.
Example:
// Although this example uses the BasemapGallery widget, any class instance that is a promise may use when() in the same way
let bmGallery = new BasemapGallery();
bmGallery.when(function(){
  // This function will execute once the promise is resolved
}, function(error){
  // This function will execute if the promise is rejected due to an error
});

Your browser is no longer supported. Please upgrade your browser for the best experience. See our browser deprecation post for more details.