Interface IRichData

A complex object type. This allows for more complex data types to be stored in a cell.

interface IRichData {
    get isIRichData(): true;
    getProperty(name: string): Scalar;
    getType(): string;
    toJSON?(): IRichData.JSON | Promise<IRichData.JSON>;
    toString(): string;
}

Index

Accessors

Methods

getProperty getType toJSON? toString

Accessors

isIRichData

get isIRichData(): true

For runtime type checking.

Returns true

Methods

getProperty

getProperty(name: string): Scalar
Parameters
- name: string
  The name of the property to retrieve.
Returns Scalar

getType

getType(): string
Reference to either a known typename or a JSON Type Definition.
- https://jsontypedef.com/
Returns string

`Optional`toJSON

toJSON?(): IRichData.JSON | Promise<IRichData.JSON>

Indicates this is an IRichData type.

Returns IRichData.JSON | Promise<IRichData.JSON>

toString

toString(): string

For clients that don't support IRichData.

Returns string

Remarks
toString() can used when a Rich Data is not supported for example clipboard and sorting.