SheetXL - v1.0.2
    Preparing search index...

    Interface IRichType

    The kind of a rich value: its class. A kind is a static set of typed property definitions, and every value of a kind shares the one IRichType its IRichData.getKind returns.

    For introspection: a renderer, a card, a formula editor offering A1. completions, or a function reading a field asks the value's kind which properties it has. What a value reads as where a primitive is consumed is the value's own answer (IRichData.toPrimitive).

    interface IRichType {
        getDisplayProperty(): string | null;
        getLabel(): string;
        getMeta(): IRichMeta | null;
        getName(): string;
        getProperties(): readonly Property[];
        getProperty(name: string): Property | null;
    }
    Index
    getDisplayProperty getLabel getMeta getName getProperties getProperty

    • The property whose value is the text a cell shows for a value of this kind, or null when the kind shows none (an image).

      Returns string | null

    • The name a UI shows for the kind, such as in a list of what can be inserted. The name when the kind has no label of its own.

      Returns string

    • The kind's own presentation (a card, an icon, a provider), or null for none.

      Returns IRichMeta | null

    • The kind's name: what a value's JSON names as its type.

      Returns string

    • The kind's properties, in the order the kind declares them.

      Returns readonly Property[]

    • The property name, or null when the kind has none by that name.

      Parameters

      • name: string

      Returns Property | null

    Settings
    Member Visibility

    On This Page
    Methods