require(["esri/widgets/Expand"], (Expand) => { /* code goes here */ });
import Expand from "@arcgis/core/widgets/Expand.js";
esri/widgets/Expand
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
// LayerList
const layerList = new LayerList({
container: document.createElement("div"),
view: view
});
const layerListExpand = new Expand({
expandIcon: "layers", // see https://developers.arcgis.com/calcite-design-system/icons/
// expandTooltip: "Expand LayerList", // optional, defaults to "Expand" for English locale
view: view,
content: layerList
});
view.ui.add(layerListExpand, "top-right");
Constructors
-
Parameterproperties Objectoptional
See the properties for a list of all the properties that may be passed into the constructor.
Property Overview
Name | Type | Summary | Class |
---|---|---|---|
Automatically collapses the expand widget instance when the view's viewpoint updates. | Expand | ||
When true, the Expand widget will close after the Escape key is pressed when the keyboard focus is within its content. | Expand | ||
Calcite icon used to style the Expand button when the content can be collapsed. | Expand | ||
Tooltip to display to indicate Expand widget can be collapsed. | Expand | ||
The ID or node representing the DOM element containing the widget. | Widget | ||
The content to display within the expanded Expand widget. | Expand | ||
The name of the class. | Accessor | ||
Indicates whether the widget is currently expanded or not. | Expand | ||
Calcite icon used when the widget is collapsed. | Expand | ||
Tooltip to display to indicate Expand widget can be expanded. | Expand | ||
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. | Expand | ||
A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices. | Expand | ||
The unique ID assigned to the widget when the widget is created. | Widget | ||
The widget's default label. | Expand | ||
The mode in which the widget displays. | Expand | ||
The placement used by the calcite popover when the widget is expanded. | Expand | ||
Expand | |||
The view model for this widget. | Expand | ||
Indicates whether the widget is visible. | Widget |
Property Details
-
autoCollapse
autoCollapse Boolean
-
Automatically collapses the expand widget instance when the view's viewpoint updates.
- Default Value:false
-
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
Exampleslet 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" } });
-
collapseTooltip
collapseTooltip String
-
Tooltip to display to indicate Expand widget can be collapsed.
- Default Value:"Collapse" (English locale)
-
container
InheritedPropertycontainer String |HTMLElement
Inherited from Widget -
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 case 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" });
-
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({ expandIcon: "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({ expandIcon: "arrow-right", view: view, content: node }); view.ui.add(expand, "top-right");
-
expanded
expanded Boolean
-
Indicates whether the widget is currently expanded or not.
- Default Value:false
-
expandTooltip
expandTooltip String
-
Tooltip to display to indicate Expand widget can be expanded.
- Default Value:"Expand" (English locale)
-
group
group String
Since: ArcGIS Maps SDK for JavaScript 4.6Expand since 4.3, group added at 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 thetop-left
group, then the first instance is collapsed, allowing the content of the second instance to be fully visible.Examplelet expand1 = new Expand({ view: view, content: document.getElementById("bg-gallery"), expandIcon: "basemap", group: "bottom-right" }); let expand2 = new Expand({ view: view, content: document.getElementById("legend"), expandIcon: "key", group: "bottom-right" }); view.ui.add([expand1, expand2], "bottom-right");
-
iconNumber
iconNumber Number
-
A number to display at the corner of the widget to indicate the number of, for example, open issues or unread notices.
-
label
label String
-
The widget's default label.
-
mode
mode String
Since: ArcGIS Maps SDK for JavaScript 4.7Expand since 4.3, mode added at 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"
-
Since: ArcGIS Maps SDK for JavaScript 4.30Expand since 4.3, placement added at 4.30. -
The placement used by the calcite popover when the widget is expanded.
Possible Values:"auto" |"auto-start" |"auto-end" |"top" |"top-start" |"top-end" |"bottom" |"bottom-start" |"bottom-end" |"right" |"right-start" |"right-end" |"left" |"left-start" |"left-end" |"leading-start" |"leading" |"leading-end" |"trailing-end" |"trailing" |"trailing-start"
- Default Value:null
-
viewModel
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.
-
visible
InheritedPropertyvisible Boolean
Inherited from Widget -
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
Name | Return Type | Summary | Class |
---|---|---|---|
Adds one or more handles which are to be tied to the lifecycle of the object. | Accessor | ||
A utility method used for building the value for a widget's | Widget | ||
Collapse the widget. | Expand | ||
Destroys the widget instance. | Widget | ||
Emits an event on the instance. | Widget | ||
Expand the widget. | Expand | ||
Indicates whether there is an event listener on the instance that matches the provided event name. | Widget | ||
Returns true if a named group of handles exist. | Accessor | ||
| Widget | ||
| Widget | ||
| Widget | ||
Registers an event handler on the instance. | Widget | ||
Adds one or more handles which are to be tied to the lifecycle of the widget. | Widget | ||
Executes after widget is ready for rendering. | Widget | ||
Removes a group of handles owned by the object. | Accessor | ||
This method is implemented by subclasses for rendering. | Widget | ||
Renders widget to the DOM immediately. | Widget | ||
Schedules widget rendering. | Widget | ||
Toggle the widget by expanding it if it's collapsed, or collapsing it if it's expanded. | Expand | ||
| Widget |
Method Details
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, addHandles added at 4.25. -
Adds one or more handles which are to be tied to the lifecycle of the object. The handles will be removed when the object is destroyed.
// Manually manage handles const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true } ); this.addHandles(handle); // Destroy the object this.destroy();
ParametershandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the object is destroyed.
groupKey *optionalKey identifying the group to which the handles should be added. All the handles in the group can later be removed with Accessor.removeHandles(). If no key is provided the handles are added to a default group.
-
classes
InheritedMethodclasses(classNames){String}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.7Widget since 4.2, classes added at 4.7. -
A utility method used for building the value for a widget's
class
property. This aids in simplifying css class setup.ReturnsType Description String The computed class name. Example// .tsx syntax showing how to set css classes while rendering the widget render() { const dynamicClasses = { [css.flip]: this.flip, [css.primary]: this.primary }; return ( <div class={classes(css.root, css.mixin, dynamicClasses)} /> ); }
-
Inherited from Widget
-
Destroys the widget instance.
-
emit
InheritedMethodemit(type, event){Boolean}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.5Widget since 4.2, emit added at 4.5. -
Emits an event on the instance. This method should only be used when creating subclasses of this class.
ReturnsType Description Boolean true
if a listener was notified
-
hasEventListener
InheritedMethodhasEventListener(type){Boolean}
Inherited from Widget -
Indicates whether there is an event listener on the instance that matches the provided event name.
Parametertype StringThe name of the event.
ReturnsType Description Boolean Returns true if the class supports the input event.
-
hasHandles
InheritedMethodhasHandles(groupKey){Boolean}
Inherited from AccessorSince: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, hasHandles added at 4.25. -
Returns true if a named group of handles exist.
ParametergroupKey *optionalA group key.
ReturnsType Description Boolean Returns true
if a named group of handles exist.Example// Remove a named group of handles if they exist. if (obj.hasHandles("watch-view-updates")) { obj.removeHandles("watch-view-updates"); }
-
isFulfilled
InheritedMethodisFulfilled(){Boolean}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.19Widget since 4.2, isFulfilled added at 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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
-
isRejected
InheritedMethodisRejected(){Boolean}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.19Widget since 4.2, isRejected added at 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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been rejected.
-
isResolved
InheritedMethodisResolved(){Boolean}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.19Widget since 4.2, isResolved added at 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.ReturnsType Description Boolean Indicates whether creating an instance of the class has been resolved.
-
on
InheritedMethodon(type, listener){Object}
Inherited from Widget -
Registers an event handler on the instance. Call this method to hook an event with a listener.
ParametersReturnsType 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. Exampleview.on("click", function(event){ // event is the event handle returned after the event fires. console.log(event.mapPoint); });
-
Inherited from Widget
Since: ArcGIS Maps SDK for JavaScript 4.24Widget since 4.2, own added at 4.24. Deprecated since 4.28 Use addHandles() instead. -
Adds one or more handles which are to be tied to the lifecycle of the widget. The handles will be removed when the widget is destroyed.
const handle = reactiveUtils.when( () => !view.updating, () => { wkidSelect.disabled = false; }, { once: true} ); this.own(handle); // Handle gets removed when the widget is destroyed.
ParameterhandleOrHandles WatchHandle|WatchHandle[]Handles marked for removal once the widget is destroyed.
-
Inherited from Widget
-
Executes after widget is ready for rendering.
-
Inherited from Accessor
Since: ArcGIS Maps SDK for JavaScript 4.25Accessor since 4.0, removeHandles added at 4.25. -
Removes a group of handles owned by the object.
ParametergroupKey *optionalA group key or an array or collection of group keys to remove.
Exampleobj.removeHandles(); // removes handles from default group obj.removeHandles("handle-group"); obj.removeHandles("other-handle-group");
-
Inherited from Widget
-
Renders widget to the DOM immediately.
-
Inherited from Widget
-
Schedules widget rendering. This method is useful for changes affecting the UI.
-
Toggle the widget by expanding it if it's collapsed, or collapsing it if it's expanded.
-
when
InheritedMethodwhen(callback, errback){Promise}
Inherited from WidgetSince: ArcGIS Maps SDK for JavaScript 4.19Widget since 4.2, when added at 4.19. -
when()
may be leveraged once an instance of the class is created. This method takes two input parameters: acallback
function and anerrback
function. Thecallback
executes when the instance of the class loads. Theerrback
executes if the instance of the class fails to load.ParametersReturnsType Description Promise Returns a new Promise for the result of callback
.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 });