MultipartColorRamp

字数统计: 1.6k 字
阅读时长: 约 4 分钟
当前版本: 4.29

AMD： require(["geoscene/rest/support/MultipartColorRamp"], (MultipartColorRamp) => { /* code goes here */ });

ESM： import MultipartColorRamp from "@geoscene/core/rest/support/MultipartColorRamp.js";

类： geoscene/rest/support/MultipartColorRamp

继承于：MultipartColorRamp ColorRamp->Accessor

起始版本：GeoScene Maps SDK for JavaScript 4.0

创建多部分色带以组合多个连续色带，以便在栅格渲染器中使用。MultipartColorRamp 将尝试使用每个成员色带中的相等数量的颜色来创建其颜色。

构造函数 ​

MultipartColorRamp ​

new MultipartColorRamp(properties?)

参数

propertiesObject

optional

有关可能传递给构造函数的所有属性的列表，请参见属性。

属性概述 ​

所有属性都可以设置、获取和监听。请参阅使用属性主题。

名称类型描述类
colorRampsAlgorithmicColorRamp[]定义用于生成多部分色带的算法色带数组。MultipartColorRamp
declaredClassString类的名称。Accessor
typeString表示色带类型的字符串值。MultipartColorRamp

属性详细信息 ​

colorRamps ​

colorRamps AlgorithmicColorRamp[]

定义用于生成多部分色带的算法色带数组。

declaredClass ​

declaredClass Stringreadonly

继承自：Accessor

起始版本：GeoScene Maps SDK for JavaScript 4.7

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

type ​

type Stringreadonly

表示色带类型的字符串值。

对于 MultipartColorRamp，类型总是 "multipart"。

默认值multipart

方法概述 ​

名称返回值类值描述类
addHandles()添加一个或多个与对象的生命周期相关联的句柄。Accessor
clone()MultipartColorRamp创建此对象的深度克隆。MultipartColorRamp
fromJSON()*创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。ColorRamp
hasHandles()Boolean如果存在指定的句柄组，则返回 true。Accessor
removeHandles()移除对象拥有的句柄组。Accessor
toJSON()Object将此类的实例转换为其 GeoScene portal JSON 表示。ColorRamp

方法详细说明 ​

addHandles ​

addHandles(handleOrHandles, groupKey?)

继承自：Accessor

起始版本：GeoScene Maps SDK for JavaScript 4.25

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

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

this.addHandles(handle);

// Destroy the object
this.destroy();

参数

handleOrHandlesWatchHandle|WatchHandle[]

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

groupKey*

optional

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

clone ​

clone(){MultipartColorRamp}

创建此对象的深度克隆。

返回

类型描述
MultipartColorRamp调用此方法的 MultipartColorRamp 实例的深度克隆。

fromJSON ​

fromJSON(json){*}static

创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象值对其进行初始化。传入到输入 json 参数的对象通常来自对 REST API 中查询操作的响应或来自另一个 GeoScene 产品的 toJSON() 方法。

参数

jsonObject

GeoScene 格式实例的 JSON 表示。

返回

类型描述
*返回该类的新实例。

hasHandles ​

hasHandles(groupKey?){Boolean}

继承自：Accessor

起始版本：GeoScene Maps SDK for JavaScript 4.25

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

参数

groupKey*

optional

组键。

返回

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

示例

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

removeHandles ​

removeHandles(groupKey?)

继承自：Accessor

起始版本：GeoScene Maps SDK for JavaScript 4.25

移除对象拥有的句柄组。

参数

groupKey*

optional

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

示例

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

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

toJSON ​

toJSON(){Object}

继承自：ColorRamp

将此类的实例转换为其 GeoScene portal JSON 表示。

返回

类型描述
Object此类实例的 GeoScene portal JSON 表示。