SheetXL - v0.8.0-beta.9+sites.210.e2d420901
    Preparing search index...

    Interface IDescriptor

    Locale-specific, user-facing metadata: display name, summary, category, and parameter descriptions shown in the formula bar and autocomplete UI. Separate from IDeclaration, which carries the type-system metadata the engine uses for coercion and broadcasting.

    interface IDescriptor {
        getCategory(): string;
        getEnums(): Readonly<Record<string, IEnumDescription>>;
        getLinks(): readonly [url: string, text?: string][];
        getName(): string;
        getNameLocal(): string;
        getParameters(): Readonly<
            Record<
                string,
                { defaultValue?: Scalar; description?: string; example?: string },
            >,
        >;
        getSummary(): string;
        isDeprecated(): string | boolean;
    }
    Index
    getCategory getEnums getLinks getName getNameLocal getParameters getSummary isDeprecated

    • A category or group to which the function belongs.

      Returns string

    • Describe each enum the function's parameters are limited to.

      Returns Readonly<Record<string, IEnumDescription>>

      The keys are enum ids (see IEnum.getId), and within one the member names (see IEnumMember.getName). Every enum a parameter declares has an entry and every member has one within it, so a caller can read a label without checking: nameLocal falls back to the declared name. Values are never localized — they are on the declaration.

    • An array of links associated with the value.

      Returns readonly [url: string, text?: string][]

    • The canonical name of the function, matching IDeclaration.getName.

      Returns string

      A descriptor may override the name; when it does not, this is the name of the function in code. Use getNameLocal for display.

    • The function's name in the user's language (the active spreadsheet-language pack), e.g. SUMME for SUM in German — Excel's getXxxLocal() convention (getFormulaLocal/getNumberFormatLocal). Falls back to the canonical getName when the active language does not translate it (English is always accepted). getName stays the canonical identity; only display uses this.

      Returns string

    • Describe each parameter in the function.

      Returns Readonly<
          Record<
              string,
              { defaultValue?: Scalar; description?: string; example?: string },
          >,
      >

      Each field is optional — a parameter may declare only a description, only an example, or nothing. The keys are the declaration parameter names (see IParameterType.getName).

    • A description of the function's purpose and usage.

      Returns string

    • If true the function is available but will not be returned in search results unless hidden is specifically requested.

      Returns string | boolean

      'null'
      • If this is a string it can be used to provide a deprecated label.
      • This is useful for functions that are in beta or deprecated.

    Settings
    Member Visibility

    On This Page
    Methods