Hypertable Client Library / Exports / HypField

Interface: HypField

The definition of a field within a collection.

Hierarchy

• ClientLibField

  ↳ HypField

Table of contents

Properties

• description
• id
• key
• name
• type

Properties

description

• Readonly description: string

An optional longer description of the field

Overrides

ClientLibField.description

---

id

• Readonly id: string

The unique ID of the field

Overrides

ClientLibField.id

---

key

• Readonly key: string

The optional key of the field

Overrides

ClientLibField.key

---

name

• Readonly name: string

The name of the field

Overrides

ClientLibField.name

---

type

• Readonly type: string

The "type" of the field. This specifies how Hypertable displays the field, how the field can be edited by users, and how the field may be used in other ways (for example, as a Kanban grouping field, as a Calendar field, etc.)

Overrides

ClientLibField.type