SliderViewModel

属性概述

属性详细信息

declaredClass Stringreadonly inherited

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

effectiveMax Number

起始版本：GeoScene Maps SDK for JavaScript 4.23

设置后，用户将限制将滑块拇指移动到高于此值的位置。此值应小于滑块的 max。effectiveMax和 effectiveMin 允许您表示数据集中无法使用滑块过滤或选择的值范围。当使用滑块表示具有异常值或不适合图层比例范围的数据集时，这可能很有用。

示例

// slider.viewModel.max = 100
slider.viewModel.effectiveMax = 60;
// now the user cannot slide thumbs above
// 60 even though the slider track displays
// values up to 100.

effectiveMin Number

起始版本：GeoScene Maps SDK for JavaScript 4.23

设置后，用户将限制将滑块拇指移动到小于此值的位置。此值应大于滑块的 min。effectiveMin和 effectiveMax 允许您表示数据集中无法使用滑块过滤或选择的值范围。当使用滑块表示具有异常值或不适合图层比例范围的数据集时，这可能很有用。

示例

// slider.viewModel.min = 0
slider.viewModel.effectiveMin = 4;
// now the user cannot slide thumbs below
// 4 even though the slider track displays
// values down to 0.

inputFormatFunction LabelFormatter

用于格式化用户输入的函数。与设置拇指标注格式的 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

用于解析由 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;
}

labelFormatFunction LabelFormatter

用于格式化标注的函数。覆盖默认的标注格式化程序。

默认情况下，标注的格式如下：

• 当数据范围小于 10 ((max - min) < 10) 时，将根据 precision 属性中设置的值对标注进行舍入。
• 当数据范围大于 10 时，labels 的显示精度不超过小数点后两位，但实际的滑块拇指值将保持 precision 中指定的精度。

使用此属性可覆盖上面定义的行为。

示例

// For thumb values, rounds each label to whole numbers.
// Note the actual value of the thumb continues to be stored
// based on the indicated data `precision` despite this formatting
sliderViewModel.labelFormatFunction = function(value, type) {
  return (type === "value") ? value.toFixed(0) : value;
}

labels String[]readonly

与使用内部标注格式化程序生成的 values 或从 labelFormatFunction 返回的值相关联的字符串数组。

max Number

滑块的最大可能数据/拇指值。在构造函数中，如果值中指定的值之一大于此属性中指定的 max 值，则 max 将更新为 values 中的最大值。

示例

sliderViewModel.max = 100;

min Number

滑块的最小可能数据/拇指值。在构造函数中，如果值中指定的值之一小于此属性中指定的 min 值，则 min 将更新为 values 中的最小值。

示例

sliderViewModel.min = 0;

precision Number

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

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

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

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

const slider = new SliderVM({
  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
});

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

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

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

默认值：4

示例

sliderViewModel.precision = 7;

state Stringreadonly

视图模型的状态。

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

thumbsConstrained Boolean

当为 false 时，用户可以自由地将任何滑块拇指移动到轨道上的任何位置。默认情况下，拇指的位置被限制为相邻拇指的位置，因此您无法将一个拇指移过另一个拇指。将此属性设置为 false 以禁用此约束行为。

默认值：true

示例

// allows the user to freely move slider
// thumbs to any position along the track
slider.viewModel.thumbsConstrained = false;

values Number[]

表示滑块上绝对拇指位置处的数字数组。

另请参阅

• setValue()

示例

const slider = new SliderVM({
  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
});

方法概述

方法详细说明

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() 进行删除。如果未提供键，则句柄将被添加到默认组。

defaultInputFormatFunction(value){String}

默认输入格式函数，可用作自定义格式设置实现中的回退。

参数

value Number 要设置格式的输入值。

返回

类型	描述
String	格式化的输入值。

defaultInputParseFunction(value){Number}

默认输入解析函数，可用作自定义解析实现中的回退。

参数

value String 要分析的拇指值。

返回

类型	描述
Number	解析的拇指值。

defaultLabelFormatFunction(value){String}

默认标注格式函数，可用作自定义格式设置实现中的回退。

参数

value Number 要设置格式的拇指值。

返回

类型	描述
String	格式化的拇指值。

emit(type, event){Boolean}

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

参数

type String 事件的名称。

event Object optional 事件有效负载。

返回

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

getBounds(){Bounds}

起始版本：GeoScene Maps SDK for JavaScript 4.23

返回滑块的有效边界。如果在滑块上设置了 effectiveMin 和 effectiveMax，则将返回这些值。如果未设置，则返回 min 和 max。

返回

类型	描述
Bounds	滑块的有效边界。

getBoundsForValueAtIndex(index){Object}

返回所提供索引处“值”的最小值和最大值边界。还可在内部使用，通过 HTMLElement 属性提供辅助功能信息

参数

index Number 关联值的索引。

返回

类型	描述
Object	返回包含边界信息的简单对象。

getLabelForValue(value, type, index){String}

返回所提供值的格式化标注。

参数

value Number 要从中检索格式化标注的值。

type String optional 标注类型。 可能值："min"|"max"|"tick"|"values"

index Number optional 标注的索引。

返回

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

hasEventListener(type){Boolean}

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

参数

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

on(type, listener){Object}

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

参数

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

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

setValue(index, value)

根据提供的索引更新拇指值。提供的值必须与以前的值不同。提供的值也必须介于 min 和 max 之间。

参数

index Number 关联值数组中拇指值的索引。

value Number 要替换为旧值的新值。

toPrecision(value){String}

起始版本：GeoScene Maps SDK for JavaScript 4.14

将给定值舍入为在视图模型上设置的 precision 属性中指定的小数位数。

参数

value Number 要设置格式的拇指值。

返回

类型	描述
String	输入值四舍五入到精度中指定的位数。

另请参阅

• precision

事件概述

事件详细说明

max-change

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

属性

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

type String 事件的类型。 值通常是 "max"。

value Number 发出事件时滑块的 max 值 (或边界)。

min-change

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

属性

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

type String 事件的类型。 值通常是 "min"。

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