字段

TypeScript

type OverlayField = {
  key: string
  type: OverlayFieldType
  name: string
  defaultValue?: string
  options?: Record<string, string>
}

C#

struct OverlayField
{
    public string Key;
    public OverlayFieldType Type;
    public string Name;
    public string? DefaultValue;
    public Dictionary<string, string>? Options;
}

OverlayField 对象包含以下属性：

键值

这是用于传递字段值到覆盖层的查询参数名称。例如，如果键值是 foo，覆盖层将会收到 ?foo=bar。

类型

TypeScript

type OverlayFieldType =
  | 'string'
  | 'percentage'
  | 'degree'
  | 'number'
  | 'bool'
  | 'color'
  | 'date'
  | 'time'
  | 'option'

C#

enum OverlayFieldType
{
    String,
    Percentage,
    Degree,
    Number,
    Bool,
    Color,
    Date,
    Time,
    Option,
}

这是字段的类型，支持的类型如下：

字符串

一个 string 值。

百分比

一个 number/int 值，范围从 0 到 100。

度数

一个 number/int 值，范围从 0 到 360。

数字

一个 number/float 值。

布尔

一个 bool/boolean 值。

颜色

一个八位十六进制值，格式为 RRGGBBAA。

警告

这个值没有 # 前缀，以防止它被解释为片段。

日期

一个 yyyyMMdd 格式的日期值。

时间

一个 hhmmss 格式的时间值。

名称

字段的名称。

默认值

可选的字段默认值，始终是 string 类型，覆盖层浏览器将根据 type 属性将值转换为正确的类型。

选项

这是一个可选的字段选项 object/Dictionary，其中键会传递给覆盖层，而对应的值作为选项的显示名称。

警告

这个属性仅在 type 为 option 时使用。

参考以下示例：

TypeScript

{
  'bar': 'Bar',
}

C#

{
    { "bar", "Bar" },
}

覆盖层浏览器会显示一个带有 Bar 选项的下拉菜单，其值为 bar。