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

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

more details
more detailsExpand
String

Icon font used to style the Expand button.

more details
more detailsExpand
String

Tooltip to display to indicate Expand widget can be collapsed.

more details
more detailsExpand
String | HTMLElement

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

more details
more detailsWidget
Node | String | Widget

The content to display within the expanded Expand widget.

more details
more detailsExpand
String

The name of the class.

more details
more detailsAccessor
Boolean

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

more details
more detailsWidget
Boolean

Whether the widget is currently expanded or not.

more details
more detailsExpand
String

Icon font used to style the Expand button.

more details
more detailsExpand
String

Tooltip to display to indicate Expand widget can be expanded.

more details
more detailsExpand
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 detailsExpand
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 detailsExpand
String

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

more details
more detailsWidget
String

The mode in which the widget displays.

more details
more detailsExpand
MapView | SceneView

A reference to the MapView or SceneView.

more details
more detailsExpand
ExpandViewModel

The view model for this widget.

more details
more detailsExpand

Property Details

autoCollapseBoolean

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

Default Value:false
collapseIconClassString
Since: ArcGIS API for JavaScript 4.4

Icon font used to style the Expand button.

See also:
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.

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");
declaredClassStringreadonly inherited
Since: ArcGIS API for JavaScript 4.7

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

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. Will automatically use the content's iconClass if it has one.

See also:
expandTooltipString

Tooltip to display to indicate Expand widget can be expanded.

Default Value:"Expand" (English locale)
groupString
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");
iconNumberNumber

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.

modeString
Since: ArcGIS API for JavaScript 4.7

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

modedescription
autoThis 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.
floatingUse this mode if you wish to always display the widget as floating regardless of browser size.
drawerUse this mode if you wish to always display the widget in a panel regardless of browser size.
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.

Method Overview

NameReturn TypeSummaryClass
String

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

more details
more detailsWidget

Collapse the widget.

more details
more detailsExpand

Destroys the widget instance.

more details
more detailsWidget

Emits an event on the instance.

more details
more detailsWidget

Expand the widget.

more details
more detailsExpand
Boolean

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

more details
more detailsWidget
Object

Registers an event handler on the instance.

more details
more detailsWidget

Widget teardown helper.

more details
more detailsWidget

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

more details
more detailsWidget
Object

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

more details
more detailsWidget

Renders widget to the DOM immediately.

more details
more detailsWidget

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

more details
more detailsWidget

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

more details
more detailsExpand

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.

Prior to version 4.7, there were various approaches towards setting CSS classes. These were dependant upon variables, such as whether the classes were:

  • a single static class,
  • multiple static classes, or
  • dynamic classes.

This helper method takes all of these approaches into account and simplifies it to use one single pattern to accommodate these multiple approaches.

Parameter:
classNames Array<(String|String[]|Object)>
repeatable

The class names.

Returns:
TypeDescription
StringThe 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)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

The event payload.

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.

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

toggle()

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

API Reference search results

NameTypeModule
Loading...