SmartMappingSliderBase

所有智能制图滑块微件的基类。

属性概述

可以设置、检索或侦听任何属性。请参阅使用属性主题。

显示继承属性

隐藏继承属性

类型	描述	类
String\|HTMLElement	包含微件的 DOM 元素的 ID 或节点。更多详情	Widget
String	类的名称。更多详情	Accessor
HistogramConfig	与滑块上表示的数据相关联的 Histogram。更多详情	SmartMappingSliderBase
String	创建微件时分配给微件的唯一 ID。更多详情	Widget
LabelFormatter	用于格式化用户输入的函数。更多详情	SmartMappingSliderBase
InputParser	用于解析由 inputFormatFunction 格式化的滑块输入的函数。更多详情	SmartMappingSliderBase
String	微件的标注。更多详情	Widget
LabelFormatter	Slider.labelFormatFunction 的修改版本，它是一个自定义函数，用于设置拇指、最小值、最大值和平均值上的标注的格式。更多详情	SmartMappingSliderBase
Number	滑块的最大值或上限。更多详情	SmartMappingSliderBase
Number	滑块的最小值或下限。更多详情	SmartMappingSliderBase
Number	定义应如何取整滑块拇指值。更多详情	SmartMappingSliderBase
String	视图模型的状态。更多详情	SmartMappingSliderBase
Boolean	当为 `true` 时，当用户拖动任何段时，所有段都将在更新拇指值时同步更新。更多详情	SmartMappingSliderBase
Boolean	指示微件是否可见。更多详情	Widget
Object	微件中显示的可见元素。更多详情	SmartMappingSliderBase
Object	将滑块轨迹缩放到此属性中提供的边界。更多详情	SmartMappingSliderBase

属性详细信息

container String|HTMLElement inherited

包含微件的 DOM 元素的 ID 或节点。此属性只能设置一次。以下示例都是使用微件时的有效用例。

示例

// 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 Stringreadonly inherited

类的名称。声明的类名称格式化为 geoscene.folder.className。

histogramConfig HistogramConfig

与滑块上表示的数据相关联的 Histogram。条柱通常使用 histogram 统计函数生成。

另请参阅

示例

histogram({
  layer: featureLayer,
  field: "fieldName",
  numBins: 30
}).then(function(histogramResult){
  // set the histogram to the slider
  slider.histogramConfig = {
    bins: histogramResult.bins
  };
});

id String inherited

创建微件时分配给微件的唯一 ID。如果不是由开发人员设置的，它将默认为容器 Id，或者如果没有容器 ID，则将自动生成。

inputFormatFunction LabelFormatter 起始版本：GeoScene Maps SDK for JavaScript 4.14

用于格式化用户输入的函数。与设置拇指标注格式的 labelFormatFunction 相反，当用户开始编辑拇指值时，inputFormatFunction 可格式化输入元素中拇指值。

下图演示了滑块输入值在默认情况下如何类似于相应的滑块值，并且与 labelFormatFunction 中设置的格式不匹配。

无输入格式化器的滑块

如果要格式化滑块输入值，使其与拇指标注相匹配，可以将 labelFormatFunction 中设置的相同函数传递给 inputFormatFunction，以获得一致的格式。

具有输入格式化器的滑块

但是，如果指定了 inputFormatFunction，则还必须编写相应的 inputParseFunction，以将用户输入解析为可理解的滑块值。在大多数情况下，如果指定了 inputFormatFunction，则应将 labelFormatFunction 设置为相同的值，以确保标注和输入之间的一致性。

此属性可覆盖默认的输入格式化程序，该程序通过在输入值上调用 toString() 进行格式化。

另请参阅

inputParseFunction

示例

// Formats the slider input to abbreviated numbers with units
// e.g. a thumb at position 1500 will render with an input label of 1.5k
slider.inputFormatFunction = function(value, type){
  if(value >= 1000000){
    return (value / 1000000).toPrecision(3) + "m"
  }
  if(value >= 100000){
    return (value / 1000).toPrecision(3) + "k"
  }
  if(value >= 1000){
    return (value / 1000).toPrecision(2) + "k"
  }
  return value.toFixed(0);
}

inputParseFunction InputParser 起始版本：GeoScene Maps SDK for JavaScript 4.14

用于解析由 inputFormatFunction 格式化的滑块输入的函数。如果设置了 inputFormatFunction，则必须设置此属性。否则，滑块值可能不会更新到其预期位置。

覆盖默认的输入解析，这是一个已解析的浮点数。

另请参阅

inputFormatFunction

示例

// Parses the slider input (a string value) to a number value understandable to the slider
// This assumes the slider was already configured with an inputFormatFunction
// For example, if the input is 1.5k this function will parse
// it to a value of 1500
slider.inputParseFunction = function(value, type, index){
  let charLength = value.length;
  let valuePrefix = parseFloat(value.substring(0,charLength-1));
  let finalChar = value.substring(charLength-1);

  if(parseFloat(finalChar) >= 0){
    return parseFloat(value);
  }
  if(finalChar === "k"){
    return valuePrefix * 1000;
  }
  if(finalChar === "m"){
    return valuePrefix * 1000000;
  }
  return value;
}

label String inherited

微件的标注。

当微件被另一微件控制时 (例如 Expand)，此属性非常有用。

labelFormatFunction LabelFormatter

Slider.labelFormatFunction 的修改版本，它是一个自定义函数，用于设置拇指、最小值、最大值和平均值上的标注的格式。覆盖默认的标注格式化程序。此函数还支持日期格式。

示例

// For thumb values, rounds each label to whole numbers
slider.labelFormatFunction = function(value, type) {
  return (type === "value-change") ? value.toFixed(0): value;
}

max Number

滑块的最大值或上限。如果构造函数 中的最大滑块值大于此属性中设置的 max，则 max 将更新以匹配最大滑块值。

示例

slider.max = 150;

min Number

滑块的最小值或下限。如果构造函数 中的最小滑块值大于此属性中设置的 min，则 min 将更新以匹配最小滑块值。

示例

slider.min = -150;

precision Number 起始版本：GeoScene Maps SDK for JavaScript 4.14

定义应如何取整滑块拇指值。此数字指示滑块拇指值在移动时应舍入到的小数位数。

此值还指示当数据范围小于 10 (即 (max - min) < 10) 时拇指标注的精度。

当数据范围大于 10 时，labels 的显示精度不超过小数点后两位，但实际的滑块拇指值将保持此属性中指定的精度。

例如，给定默认精度 4 和以下滑块配置，拇指的标注将显示两个小数位，但即使用户滑动或移动拇指，实际拇指值的精度也不会丢失。

const slider = new Slider({
  min: 20,
  max: 100,  // data range of 80
  values: [50.4331],
  // thumb label will display 50.43
  // thumb value will maintain precision, so
  // value will remain at 50.4331
  container: "sliderDiv"
});

如果用户手动输入的值的精度高于此属性所指示的精度，则该拇指值的精度将保持不变，直到用户移动该拇指。此时，该值将根据指示的精度进行舍入。

如果拇指标注不可见，则必须使用 labelInputsEnabled 启用它们。

请记住，此属性对拇指值进行舍入，不应专门用于格式设置目的。要格式化拇指 labels，请使用 labelFormatFunction 属性。

默认值：4

示例

slider.precision = 7;

state Stringreadonly

视图模型的状态。

可能的值："ready"|"disabled"

syncedSegmentsEnabled Boolean 起始版本：GeoScene Maps SDK for JavaScript 4.20

当为 true 时，当用户拖动任何段时，所有段都将在更新拇指值时同步更新。这将在拖动任何段时保持所有拇指之间的间隔。仅在 visibleElements.interactiveTrack 为 true 时适用。

在启用了主手柄的滑块中，这允许您禁用 handlesSyncedToPrimary，以使手柄移动独立于中间 (主) 手柄，但仍会为最终用户提供一个选项，以通过滑块拖动事件将手柄与主手柄同步。

默认值：false

另请参阅

visibleElements
handlesSyncedToPrimary

示例

slider.visibleElements = {
  interactiveTrack: true
};
slider.primaryHandleEnabled = true;
slider.handlesSyncedToPrimary = false;
slider.syncedSegmentsEnabled = true;

visible Boolean inherited

指示微件是否可见。

如果为 false，微件将不再呈现在 web 文档中。这可能会影响文档中其他元素或微件的布局。例如，如果此微件是与视图 UI 右上角关联的三个微件中的第一个，则当此微件不可见时，其他微件将重新定位。有关更多信息，请参阅 CSS display 值 "none"。

默认值：true

示例

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

visibleElements Object 起始版本：GeoScene Maps SDK for JavaScript 4.20

微件中显示的可见元素。此属性提供了打开/关闭微件显示的各个元素的能力。

属性

interactiveTrack Boolean

optional

默认值：false

如果为 true，则在轨道上显示交互段，该段保持两个滑块拇指/手柄之间间隔。

另请参阅

syncedSegmentsEnabled
segment-drag event

示例

slider.visibleElements = {
  interactiveTrack: true
};
slider.syncedSegmentsEnabled = true;

zoomOptions Object

将滑块轨迹缩放到此属性中提供的边界。提供最小和/或最大缩放值时，将保留绝对最小和最大滑块值，并在滑块上的典型位置处进行渲染。但是，滑块轨道本身是可缩放的，因此拇指不能移动到提供的最小和最大缩放值的上方或下方。

当滑块处于缩放状态时，轨道的缩放末端将显示锯齿状。在下图中，请注意，即使滑块的最大值为 200，上拇指也无法移过最大缩放值 31。

slider-zoom

要退出缩放状态，用户可单击锯齿线，或者开发人员可以将 zoomOptions 设置为 null。由开发人员确定是否为最终用户提供一个 UI 选项以启用滑块上的缩放。

当滑块与严重偏斜的数据集 (其中由于异常值，直方图仅渲染一个或两个条柱) 相关联时，设置 zoomOptions 很有用。

slider-not-zoomed

您可通过缩放滑块并根据缩放的最小值和最大值重新生成直方图来移除异常值的影响。这将提供更好的数据视图并使滑块对最终用户更有用。

属性

min Number

optional

缩放的下限。

max Number

optional

缩放的上限。

示例

// zooms the slider to so thumbs can only be moved
// to positions between the values of 10 and 25 while
// maintaining the slider's absolute minimum and
// maximum values
slider.zoomOptions = {
  min: 10,
  max: 25
};

// disables zooming on the slider
slider.zoomOptions = null;

// zooms the slider to so thumbs can only be moved
// to positions above the value of 10, while maintaining
// the slider's absolute minimum value
slider.zoomOptions = {
  min: 10
};

// zooms the slider to so thumbs can only be moved
// to positions below the value of 25, while maintaining
// the slider's absolute maximum value
slider.zoomOptions = {
  max: 25
};

// zooms the slider to the handle positions
// with some padding
document.getElementById("zoomInButton").onclick = function() {
  const lowerThumb = slider.values[0];
  const upperThumb = slider.values[1];

  const range = upperThumb - lowerThumb;
  const padding = range * 0.3;

  const zoomMin = (lowerThumb - padding) > slider.min ? (lowerThumb - padding) : slider.min;
  const zoomMax = (upperThumb + padding) < slider.max ? (upperThumb + padding) : slider.max;

  slider.set({ zoomOptions: { min: zoomMin, max: zoomMax } });
};

方法概述

显示继承的方法

隐藏继承的方法

返回值类值	描述	类
	添加一个或多个与对象的生命周期相关联的句柄。更多详情	Accessor
String	用于为微件的 `class` 属性构建值的实用方法。更多详情	Widget
	销毁微件实例。更多详情	Widget
Boolean	在实例上触发事件。更多详情	Widget
Boolean	指示实例上是否存在与提供的事件名称相匹配的事件监听器。更多详情	Widget
Boolean	如果存在指定的句柄组，则返回 true。更多详情	Accessor
Boolean	`isFulfilled()` 可用于验证创建类的实例是否已完成 (已解决或已拒绝)。更多详情	Widget
Boolean	`isRejected()` 可用于验证创建类的实例是否被拒绝。更多详情	Widget
Boolean	`isResolved()` 可用于验证创建类的实例是否已解决。更多详情	Widget
Object	在实例上注册事件处理程序。更多详情	Widget
	添加一个或多个与微件的生命周期相关联的句柄。更多详情	Widget
	此方法主要由开发人员在实现自定义微件时使用。更多详情	Widget
	移除对象拥有的句柄组。更多详情	Accessor
Object	此方法主要由开发人员在实现自定义微件时使用。更多详情	Widget
	立即将微件渲染到 DOM。更多详情	Widget
	此方法主要由开发人员在实现自定义微件时使用。更多详情	Widget
Promise	一旦创建了类的实例，就可以使用`when()` 。更多详情	Widget

方法详细说明

addHandles(handleOrHandles, groupKey)inherited 起始版本：GeoScene Maps SDK for JavaScript 4.25

添加一个或多个与对象的生命周期相关联的句柄。当对象被销毁时，将移除句柄。

// Manually manage handles
const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true }
);

// Handle gets removed when the object is destroyed.
this.addHandles(handle);

参数

handleOrHandles WatchHandle|WatchHandle []

对象销毁后，标记为要移除的句柄。

groupKey *

optional

标识句柄应添加到的组的键。组中的所有句柄稍后都可使用 Accessor.removeHandles() 进行删除。如果未提供键，则句柄将被添加到默认组。

classes(classNames){String}inherited

用于为微件的 class 属性构建值的实用方法。这有助于简化 CSS 类设置。

参数

classNames String|String []|Object

repeatable

类名称。

类型	描述
String	计算的类名。

另请参阅

指南 - 微件开发 (渲染器)

示例

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

destroy()inherited

销毁微件实例。

emit(type, event){Boolean}inherited

在实例上触发事件。仅当创建此类的子类时，才应使用此方法。

参数

type String

事件的名称。

event Object

optional

事件有效负载。

类型	描述
Boolean	如果监听器收到通知，则为`true`

hasEventListener(type){Boolean}inherited

指示实例上是否存在与提供的事件名称相匹配的事件监听器。

参数

type String

事件的名称。

类型	描述
Boolean	如果类支持输入事件，则返回 true。

hasHandles(groupKey){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.25

如果存在指定的句柄组，则返回 true。

参数

groupKey *

optional

组键。

类型	描述
Boolean	如果存在指定的句柄组，则返回 `true`。

示例

// Remove a named group of handles if they exist.
if (obj.hasHandles("watch-view-updates")) {
  obj.removeHandles("watch-view-updates");
}

isFulfilled(){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.19

isFulfilled() 可用于验证创建类的实例是否已完成 (已解决或已拒绝)。如果满足，则返回 true。

类型	描述
Boolean	指示创建类的实例是否已完成 (已解决或已拒绝)。

isRejected(){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.19

isRejected() 可用于验证创建类的实例是否被拒绝。如果被拒绝，则返回 true。

类型	描述
Boolean	指示创建类的实例是否已被拒绝。

isResolved(){Boolean}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.19

isResolved() 可用于验证创建类的实例是否已解决。如果已解决，则返回 true。

类型	描述
Boolean	指示创建类的实例是否已解决。

on(type, listener){Object}inherited

在实例上注册事件处理程序。调用此方法将事件与监听器挂钩。

参数

type String|String []

要侦听的事件或者事件数组。

listener Function

事件触发时要调用的函数。

类型描述

Object

返回具有 remove() 方法的事件处理程序，可调用该方法来停止侦听事件。

属性	类型	描述
remove	Function	调用时，从事件中移除侦听器。

示例

view.on("click", function(event){
  // event is the event handle returned after the event fires.
  console.log(event.mapPoint);
});

own(handleOrHandles)inherited 起始版本：GeoScene Maps SDK for JavaScript 4.24

添加一个或多个与微件的生命周期相关联的句柄。当微件被销毁时，将移除句柄。

const handle = reactiveUtils.when(
  () => !view.updating,
  () => {
    wkidSelect.disabled = false;
  },
  { once: true}
);

this.own(handle); // Handle gets removed when the widget is destroyed.

参数

handleOrHandles WatchHandle|WatchHandle []

微件销毁后，标记为要移除的句柄。

postInitialize()inherited

此方法主要由开发人员在实现自定义微件时使用。在微件准备好渲染后执行。

removeHandles(groupKey)inherited 起始版本：GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数

groupKey *

optional

要移除的组键或组键的数组或集合。

示例

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

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

render(){Object}inherited

此方法主要由开发人员在实现自定义微件时使用。它必须由子类实现以进行渲染。

类型	描述
Object	渲染的虚拟节点。

renderNow()inherited

立即将微件渲染到 DOM。

scheduleRender()inherited

此方法主要由开发人员在实现自定义微件时使用。计划微件渲染。此方法对于影响 UI 的更改非常有用。

when(callback, errback){Promise}inherited 起始版本：GeoScene Maps SDK for JavaScript 4.19

一旦创建了类的实例，就可以使用when() 。此方法接受两个输入参数：callback 函数和 errback 函数。callback 在类的实例加载时执行。errback 在类的实例无法加载时执行。

参数

callback Function

optional

当 promise 解决时调用的函数。

errback Function

optional

当 promise 失败时执行的函数。

类型	描述
Promise	为 `callback` 结果返回一个新的 promise。

示例

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

类型定义

HistogramConfig

用于定义滑块 Histogram 的配置选项。

属性

average Number

optional

指示数据集的平均值。设置后，直方图上的实线将在平均值的位置处呈现，标注默认为此处设置的值。

barCreatedFunction BarCreatedFunction

optional

用于样式化表示直方图的条柱的函数。这可用于设置条柱的样式或向其添加自定义交互。例如，可以使用此函数为与滑块轨迹上的颜色相匹配的条柱着色。

bins Bin []

optional

直方图的条柱。这是一个对象数组，指示每个条柱中数据的范围和计数。此值通常从 histogram 函数检索。

dataLines Object []

optional

设置后，将在直方图上渲染向最终用户指示重要或有意义的值的线条。

规范

value Number

optional

直方图数据轴上的值，将在其中渲染线。

label String|Number

optional

与线相关联的标注。

dataLineCreatedFunction DataLineCreatedFunction

optional

每次创建数据线时触发的函数。您可使用它来样式化数据轴上各个 dataLines。

standardDeviation Number

optional

指示数据集的标准偏差。设置后，数据线位于直方图上高于和低于 average 的标准偏差位置。

standardDeviationCount Number

optional

指示数据集的标准偏差。设置后，数据线位于直方图上高于和低于 average 的标准偏差位置。

LabelFormatter(value, type, index){String}

用于格式化拇指标注的函数。此函数应设置为 labelFormatFunction 属性。每次在滑块上创建或更新标注时，都会触发此函数。

参数

value Number

拇指值。

type String

optional

标注类型。有效类型包括 average、min、max 和 value。

可能值："average"|"min"|"max"|"value"

index Number

optional

拇指的索引 (或值)。

类型	描述
String	标注的格式化值。

事件概述

类型	描述	类
{oldValue: Number,type: "max-change",value: Number}	当用户更改滑块的最大值时触发。更多详情	SmartMappingSliderBase
{oldValue: Number,type: "min-change",value: Number}	当用户更改滑块的最小值时触发。更多详情	SmartMappingSliderBase
{index: Number,state: "start","drag",type: "segment-drag",thumbIndices: Number []}	当用户拖动滑块的段时触发。更多详情	SmartMappingSliderBase
{index: Number,oldValue: Number,type: "thumb-change",value: Number}	当用户通过箭头键和键盘编辑微件上的标注来更改拇指值时，将触发。更多详情	SmartMappingSliderBase
{index: Number,state: "start","drag",type: "thumb-drag",value: Number}	当用户在微件上拖动拇指时触发。更多详情	SmartMappingSliderBase

事件详细说明

max-change

当用户更改滑块的最大值时触发。

属性

oldValue Number

滑块以前的最大值 (或界限)。

type String

事件的类型。

值总是 "max-change"。

value Number

发出事件时滑块的最大值 (或边界)。

示例

slider.on("max-change", function() {
  const renderer = layer.renderer.clone();
  const visualVariable = renderer.visualVariables[0].clone();
  colorVariable.stops = slider.stops;
  renderer.visualVariables = [ visualVariable ];
  layer.renderer = renderer;
});

min-change

当用户更改滑块的最小值时触发。

属性

oldValue Number

滑块以前的最小值 (或界限)。

type String

事件的类型。

值总是 "min-change"。

value Number

发出事件时滑块的最小值 (或边界)。

示例

slider.on("min-change", function() {
  const renderer = layer.renderer.clone();
  const visualVariable = renderer.visualVariables[0].clone();
  colorVariable.stops = slider.stops;
  renderer.visualVariables = [ visualVariable ];
  layer.renderer = renderer;
});

segment-drag 起始版本：GeoScene Maps SDK for JavaScript 4.20

当用户拖动滑块的段时触发。段是位于两个拇指之间的轨道的一部分。这仅在 visibleElements.interactiveTrack 为 true 时适用。

属性

index Number

滑块中段的基于 1 的索引。

state String

拖动的状态。

可能值："start"|"drag"

type String

事件的类型。

值通常是 "segment-drag"。

thumbIndices Number []

段两端的拇指索引。

另请参阅

visibleElements

示例

slider.on("segment-drag", () => {
  const renderer = layer.renderer.clone();
  const visualVariable = renderer.visualVariables[0].clone();
  colorVariable.stops = slider.stops;
  renderer.visualVariables = [ visualVariable ];
  layer.renderer = renderer;
});

thumb-change

当用户通过箭头键和键盘编辑微件上的标注来更改拇指值时，将触发。

属性

index Number

触发事件的拇指的从 0 开始的索引。

oldValue Number

进行更改之前拇指的先前值。

type String

事件的类型。

值总是 "thumb-change"。

value Number

触发事件时的拇指值。

示例

slider.on("thumb-change", function() {
  const renderer = layer.renderer.clone();
  const visualVariable = renderer.visualVariables[0].clone();
  colorVariable.stops = slider.stops;
  renderer.visualVariables = [ visualVariable ];
  layer.renderer = renderer;
});

thumb-drag

当用户在微件上拖动拇指时触发。

属性

index Number

触发事件的拇指的从 0 开始的索引。

state String

拖动的状态。

可能值："start"|"drag"

type String

事件的类型。

值总是 "thumb-drag"。

value Number

触发事件时的拇指值。

示例

slider.on("thumb-drag", function() {
  const renderer = layer.renderer.clone();
  const visualVariable = renderer.visualVariables[0].clone();
  colorVariable.stops = slider.stops;
  renderer.visualVariables = [ visualVariable ];
  layer.renderer = renderer;
});

GeoScene Maps SDK for JavaScript参考手册

属性概述

属性详细信息

方法概述

方法详细说明

类型定义

事件概述

事件详细说明