SwitchInput

SwitchInput

SwitchInput 类为二进制开关或切换定义所需的用户界面。在两个选项之间进行选择时，应使用此类。

使用此输入类型时，需要编码值域。

form field element switch input

另参阅：

示例代码：

// 为表单中的字段元素创建新的 Switch 输入
const switchInput = new SwitchInput({
  offValue: "No",
  onValue: "Yes"
});

构造函数

new SwitchInput(properties)

参数：

properties Object

optional

所有可传入构造函数的属性列表，请参见属性。

属性列表

可以设置、检索或监听的任何属性。参见使用属性主题。

展示继承属性

隐藏继承属性

类型	描述	类
String	更多信息类名。	更多信息	Accessor
String\|Number	更多信息关闭开关状态时使用的编码值。	更多信息	SwitchInput
String\|Number	更多信息开关状态打开时使用的编码值。	更多信息	SwitchInput
String	更多信息表单元素输入的类型。	更多信息	SwitchInput

属性详细说明

declaredClass Stringreadonly inherited

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

offValue String|Number

关闭开关状态时使用的编码值。此值可以是 string 或 number。

onValue String|Number

开关状态打开时使用的编码值。此值可以是 string 或 number。

type Stringreadonly

表单元素输入的类型。

对于 SwitchInput，类型始终为 "switch"。

方法列表

名称	返回值类型	描述	类
	*	更多信息创建此类的新实例并使用从 GeoScene 产品生成的 JSON 对象的值对其进行初始化。	更多信息	SwitchInput
	Object	更多信息将此类的实例转换为其 GeoScene portal JSON 格式。	更多信息	SwitchInput

方法详细说明

fromJSON(json){*}static

创建此类的新实例，并使用从 GeoScene 产品生成的 JSON 对象的值对其进行初始化。传递给输入 json 参数的对象通常来自对 REST API 中的查询操作的响应，或者来自另一个 GeoScene 产品的 toJSON() 方法。有关何时以及如何使用此函数的详细信息和示例，请参阅指南中的 fromJSON() 主题。

参数：

json Object

实例的 json 表达式，以 Geoscene 格式显示。

返回值：

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

toJSON(){Object}

将此类的实例转换为 GeoScene portal JSON 格式。有关更多信息，请参阅 fromJSON() 指南主题。