A RetroSearch Logo

Home - News ( United States | United Kingdom | Italy | Germany ) - Football scores

Search Query:

Showing content from https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-ScaleRangeSlider.html below:

ScaleRangeSlider | API Reference | ArcGIS Maps SDK for JavaScript 4.33

ESM: import ScaleRangeSlider from "@arcgis/core/widgets/ScaleRangeSlider.js";

CDN: const ScaleRangeSlider = await $arcgis.import("@arcgis/core/widgets/ScaleRangeSlider.js");

Class: @arcgis/core/widgets/ScaleRangeSlider

Since: ArcGIS Maps SDK for JavaScript 4.13

The ScaleRangeSlider widget allows the user to set a minimum and maximum scale based on named scale ranges. When a layer is provided to the widget, the minScale and maxScale are set to the scale range of the layer.

The user can update the scale range by dragging thumbs across the slider to update the minScale and maxScale. The user can also change the minScale and maxScale by using the dropdowns underneath the minScaleLimit and maxScaleLimit. The thumbnail shows a preview of the scale based on the region specified.

See also

Example

const scaleRangeSlider = new ScaleRangeSlider({
  view: view,
  layer: featureLayer,  // scale range of this layer sets initial minScale and maxScale
  region: "MX",  // preview thumbnail will be of Mexico
});
view.ui.add(scaleRangeSlider, "bottom-left");

// to update the featureLayer min/max scale based on the slider
reactiveUtils.watch(
  () => [scaleRangeSlider.minScale, scaleRangeSlider.maxScale],
  ([minScale, maxScale]) => {
    featureLayer.minScale = minScale;
    featureLayer.maxScale = maxScale;
  }
);
Constructors
ScaleRangeSlider Constructor new ScaleRangeSlider(properties)

Parameter

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 Watch for changes topic.

Show inherited properties Hide inherited properties

Property Details

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"
});
declaredClass

Inherited

Property declaredClass Stringreadonly

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

When true, sets the widget to a disabled state so the user cannot interact with it.

Since: ArcGIS Maps SDK for JavaScript 4.27 ScaleRangeSlider since 4.13, icon added at 4.27.

Icon displayed in the widget's button.

id

Inherited

Property id String

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.

The widget's default label.

When provided, the initial minScale and maxScale values will match the layer's.

When a tiled layer is used, the slider will be restricted from moving the slider thumbs past the lods of the layer's tiling scheme. Since version 4.28, when a MapImageLayer is used, the slider will be restricted from moving past the min/max scale defined on the map service. The unavailable range will be designated with a dashed line.

maxScale Property maxScale Number

The maximum scale of the active scale range. When the maxScale reaches the maxScaleLimit, the maxScale value becomes 0 and there is no maximum scale set.

maxScaleLimit Property maxScaleLimit Number

The lowest possible maximum scale value on the slider.

minScale Property minScale Number

The minimum scale of the active scale range. When the minScale reaches the minScaleLimit, the minScale value becomes 0 and there is no minimum scale.

minScaleLimit Property minScaleLimit Number

The highest possible minimum scale value on the slider.

Since: ArcGIS Maps SDK for JavaScript 4.29 ScaleRangeSlider since 4.13, mode added at 4.29.

The mode of the widget, indicating which slider thumbs can be adjusted.

Possible Values:"range" |"max-scale-only" |"min-scale-only"

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 ScaleRangeSliderViewModel class to access all properties and methods on the widget.

visible

Inherited

Property visible Boolean

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

Example

// Hides the widget in the view
widget.visible = false;

The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget's display on/off.

Example

scaleRangeSlider.visibleElements = {
  preview: false  // thumbnail preview of map will not be displayed
}
Method Overview

Show inherited methods Hide inherited methods

Method Details
addHandles

Inherited

Method addHandles(handleOrHandles, groupKey)

Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor 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();

Parameters

Handles marked for removal once the object is destroyed.

groupKey *

optional

Key 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

Inherited

Method classes(classNames){String}

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

Returns

Type 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)} />
  );
}
destroy

Inherited

Method destroy()

Destroys the widget instance.

emit

Inherited

Method emit(type, event){Boolean}

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

Parameters

The name of the event.

optional

The event payload.

Returns

Type Description Boolean true if a listener was notified
hasEventListener

Inherited

Method hasEventListener(type){Boolean}

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

Returns

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

Inherited

Method hasHandles(groupKey){Boolean}

Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, hasHandles added at 4.25.

Returns true if a named group of handles exist.

Parameter

groupKey *

optional

A group key.

Returns

Type 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

Inherited

Method isFulfilled(){Boolean}

Since: ArcGIS Maps SDK for JavaScript 4.19 Widget 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.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been fulfilled (either resolved or rejected).
isRejected

Inherited

Method isRejected(){Boolean}

Since: ArcGIS Maps SDK for JavaScript 4.19 Widget 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.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been rejected.
isResolved

Inherited

Method isResolved(){Boolean}

Since: ArcGIS Maps SDK for JavaScript 4.19 Widget 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.

Returns

Type Description Boolean Indicates whether creating an instance of the class has been resolved.
on

Inherited

Method on(type, listener){Object}

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

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);
});
postInitialize

Inherited

Method postInitialize()

Executes after widget is ready for rendering.

removeHandles

Inherited

Method removeHandles(groupKey)

Since: ArcGIS Maps SDK for JavaScript 4.25 Accessor since 4.0, removeHandles added at 4.25.

Removes a group of handles owned by the object.

Parameter

groupKey *

optional

A group key or an array or collection of group keys to remove.

Example

obj.removeHandles(); // removes handles from default group

obj.removeHandles("handle-group");
obj.removeHandles("other-handle-group");
render

Inherited

Method render(){Object}

This method is implemented by subclasses for rendering.

Returns

Type Description Object The rendered virtual node.
renderNow

Inherited

Method renderNow()

Renders widget to the DOM immediately.

scheduleRender

Inherited

Method scheduleRender()

Schedules widget rendering. This method is useful for changes affecting the UI.

when

Inherited

Method when(callback, errback){Promise}

Since: ArcGIS Maps SDK for JavaScript 4.19 Widget 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: 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

optional

The function to call when the promise resolves.

optional

The function to execute when the promise fails.

Returns

Type 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
});
Type Definitions
SupportedRegion Type Definition SupportedRegion String

The region that the scale thumbnails will focus on. Each region comes from the ISO 3166-1 alpha-2 code.

Code Region AE United Arab Emirates AR Argentina AT Austria AU Australia BE Belgium BG Bulgaria BO Bolivia BR Brazil CA Canada CH Switzerland CI Cote D'Ivoire CL Chile CN China CO Colombia CR Costa Rica CZ Czech Republic DE Germany DK Denmark EE Estonia EG Egypt ES Spain FI Finland FR France GB Great Britain GL Greenland GR Greece GT Guatemala HK Hong Kong ID Indonesia IE Ireland IL Israel IN India IQ Iraq IS Iceland IT Italy JP Japan KE Kenya KR South Korea KW Kuwait LI Liechtenstein LT Lithuania LU Luxembourg LV Latvia MA Morocco MG Madagascar ML Mali MO Macao MX Mexico MY Malaysia NI Nicaragua NL Netherlands NO Norway NZ New Zealand PE Peru PL Poland PR Puerto Rico PT Portugal RO Romania RU Russia RW Rwanda SE Sweden SG Singapore SK Slovakia SR Suriname SV El Salvador TH Thailand TN Tunisia TW Taiwan US United States VE Venezuela VI U.S. Virgin Islands ZA South Africa

Possible Values:"AE" |"AR" |"AT" |"AU" |"BE" |"BG" |"BO" |"BR" |"CA" |"CH" |"CI" |"CL" |"CN" |"CO" |"CR" |"CZ" |"DE" |"DK" |"EE" |"EG" |"ES" |"FI" |"FR" |"GB" |"GL" |"GR" |"GT" |"HK" |"ID" |"IE" |"IL" |"IN" |"IQ" |"IS" |"IT" |"JP" |"KE" |"KR" |"KW" |"LI" |"LT" |"LU" |"LV" |"MA" |"MG" |"ML" |"MO" |"MX" |"MY" |"NI" |"NL" |"NO" |"NZ" |"PE" |"PL" |"PR" |"PT" |"RO" |"RU" |"RW" |"SE" |"SG" |"SK" |"SR" |"SV" |"TH" |"TN" |"TW" |"US" |"VE" |"VI" |"ZA" |"ae" |"ar" |"at" |"au" |"be" |"bg" |"bo" |"br" |"ca" |"ch" |"ci" |"cl" |"cn" |"co" |"cr" |"cz" |"de" |"dk" |"ee" |"eg" |"es" |"fi" |"fr" |"gb" |"gl" |"gr" |"gt" |"hk" |"id" |"ie" |"il" |"in" |"iq" |"is" |"it" |"jp" |"ke" |"kr" |"kw" |"li" |"lt" |"lu" |"lv" |"ma" |"mg" |"ml" |"mo" |"mx" |"my" |"ni" |"nl" |"no" |"nz" |"pe" |"pl" |"pr" |"pt" |"ro" |"ru" |"rw" |"se" |"sg" |"sk" |"sr" |"sv" |"th" |"tn" |"tw" |"us" |"ve" |"vi" |"za"

VisibleElements Type Definition VisibleElements

The visible elements that are displayed within the widget. This provides the ability to turn individual elements of the widget's display on/off.

Properties
optional

Indicates whether the preview thumbnail of the scale is visible. Default value is true.

optional

Since 4.24 Indicates whether the scale dropdown menus are visible.

Specification
optional

Indicates whether the minimum scale dropdown menu is visible. Default value is true.

optional

Indicates whether the maximum scale dropdown menu is visible. Default value is true.


RetroSearch is an open source project built by @garambo | Open a GitHub Issue

Search and Browse the WWW like it's 1997 | Search results from DuckDuckGo

HTML: 3.2 | Encoding: UTF-8 | Version: 0.7.4