Module options 

Plugin options: the keys a report’s config block for a plugin may hold (a format’s output: keys, a destination entry’s keys), declared once by the plugin and checked by the SDK.

A plugin lists its options as OptionFields. describe publishes them, and check tests a config block against them: unknown keys, types, allowed values and bounds. Rules the declaration can’t express go in the plugin’s own validate, which runs as well.

Structs

OptionField

One option a plugin takes.

Enums

FormulaPart

A piece of a formula from YAML.

NumFormatClass

What an Excel number format code displays, from check_num_format.

OptionType

What a value must be.

Constants

COLUMN_OPTION_KEYS

The keys a column may set in a columns: map.

TOTAL_FUNCTIONS

The functions a total: can name, and the Excel function each writes.

Functions

check

Check options against the declared fields of the kind plugin name.

check_num_format

A light syntax check of an Excel number format code (the text of Excel’s Format Cells → Custom dialog), and what it displays. Not a full grammar: conditions, colours and locale tags inside [] are accepted without being interpreted.

check_row_formula

A row formula: {name} references only, since a row can’t see the whole column’s extent.

check_total

A total:: a function name, or a formula with {name:*} references only.

is_template

Whether a string holds Jinja that core renders before the plugin sees it (destination options). Its final value is unknown, so only its presence is checked.

parse_columns

Parse a columns: map (column name → column options), collecting every problem as a sentence naming the column. Used by core for query entries and by the xlsx plugin for its output-level columns option.

parse_formula

Split a formula into text and {name} / {name:*} references. {{ and }} are literal braces. The formula must start with =.