Per-field metadata that indicates whether in-place editing is allowed, which in-place editor should be used, etc.
Methods
(static) _prefixFieldID(fieldID) → {string}
Prefix the field id.
Parameters:
Name | Type | Description |
---|---|---|
fieldID |
string | The field id to prefix. |
Returns:
A prefixed field id.
- Type
- string
(static) _unprefixFieldID(fieldID) → {string}
Unprefix the field id.
Parameters:
Name | Type | Description |
---|---|---|
fieldID |
string | The field id to unprefix. |
Returns:
An unprefixed field id.
- Type
- string
(static) add(fieldID, metadata)
Add metadata to a field id.
Parameters:
Name | Type | Description |
---|---|---|
fieldID |
string | The field ID to add data to. |
metadata |
object | Metadata to add. |
(static) get(fieldID, keyopt) → {object|*}
Get a key from a field id.
Parameters:
Name | Type | Attributes | Description |
---|---|---|---|
fieldID |
string | The field ID to check. |
|
key |
string |
<optional> |
The key to check. If empty, will return all metadata. |
Returns:
The value for the key, if defined. Otherwise will return all metadata for the specified field id.
- Type
- object | *
(static) has(fieldID) → {bool}
Check if a field exists in storage.
Parameters:
Name | Type | Description |
---|---|---|
fieldID |
string | The field id to check. |
Returns:
Whether it was found or not.
- Type
- bool
(static) intersection(fieldIDs) → {Array}
Intersection calculation.
Parameters:
Name | Type | Description |
---|---|---|
fieldIDs |
Array | An array of field ids to compare to prefix field id. |
Returns:
The intersection found.
- Type
- Array