跳到主要内容

Field

能够获取表格中的字段列信息

field.Field

配件​

id​

• get id(): string

字段 id, 列的唯一标识

返回值​

string

示例​

console.log(myField.id); // => 'fldxxxxxx'

name​

• get name(): string

列名称, 不同列名称为不重复值

返回值​

string

示例​

console.log(myField.name); // => 'FieldName'

type​

• get type(): FieldType

列类型，列类型为枚举值，具体可参阅 FieldType

返回值​

FieldType

示例​

console.log(myField.type); // => 'SingleLineText'

description​

• get description(): null | string

返回当前字段的描述

返回值​

null | string

示例​

console.log(myField.description);
// => 'This is my field'

property​

• get property(): IOpenFieldProperty

返回字段的属性配置，不同类型的字段有不同的属性配置。 返回 null 则代表这个字段没有属性配置。 具体可参阅 FieldType

返回值​

IOpenFieldProperty

FieldType

示例​

console.log(myField.property.symbol); // => '￥'

isComputed​

• get isComputed(): boolean

判断当前字段是否是“计算字段” “计算字段”的意思是，不允许用户主动写入值的字段类型。（比如：自增数字、公式、神奇引用、修改时间、创建时间、修改人、创建人）

返回值​

boolean

示例​

console.log(mySingleLineTextField.isComputed);
// => false
console.log(myAutoNumberField.isComputed);
// => true

isPrimary​

• get isPrimary(): boolean

返回当前字段是否属于主字段，在维格表中，主字段永远是第一列所在的字段。

返回值​

boolean

示例​

console.log(myField.isPrimary); // => true

方法​

updateDescriptionAsync​

▸ updateDescriptionAsync(description): Promise<void>

更新字段的描述。

如果没有写入权限，该 API 会抛出异常信息。

参数​

NameTypeDescription
descriptionnull | string字段描述

返回值​

Promise<void>

示例​

 await field.updateDescriptionAsync('this is a new description')

updatePropertyAsync​

▸ updatePropertyAsync(property, options?): Promise<void>

更新字段的属性配置，注意，更新属性配置必须全量覆盖。

如果配置格式不正确，或者没有写入权限，该 API 会抛出异常信息。

请先阅读 FieldType【字段属性配置文档】来确定不同字段的写入格式。

参数​

NameTypeDescription
propertyany字段的新属性配置
options?IEffectOption允许会产生副作用的property

返回值​

Promise<void>

示例​

function addOptionToSelectField(selectField, nameForNewOption) {
  const updatedOptions = {
    options: [
      ...selectField.options.choices,
      {name: nameForNewOption},
    ]
  };

  await selectField.updatePropertyAsync(updatedOptions);
}