charturbo - v0.1.0
    Preparing search index...

    Interface CharturboMessages

    Every built-in string, grouped by the module that shows it.

    interface CharturboMessages {
        a11y: {
            axisBreaks: (
                axis: string,
                title: string | undefined,
                ranges: string,
            ) => string;
            axisRange: (
                axis: string,
                title?: string,
                from?: string,
                to?: string,
            ) => string;
            axisTitle: (axis: string, title: string) => string;
            bandEdges: (name: string, first: string, second: string) => string;
            bandPoint: (
                x: string,
                name: string,
                first: string,
                second: string,
            ) => string;
            barLayout: (categories: string, mode: string) => string;
            barMode: { grouped: string; percent: string; stacked: string };
            barPoint: (x: string, value: string) => string;
            barRange: (
                min: string,
                minLabel: string,
                max: string,
                maxLabel: string,
            ) => string;
            bars: (n: number, count: string) => string;
            barStats: (
                name: string,
                maxLabel: string,
                max: string,
                minLabel: string,
                min: string,
                mean: string,
            ) => string;
            baselineColumn: (name: string) => string;
            candles: (n: number, count: string) => string;
            cell: (row: string, col: string) => string;
            chart: {
                area: string;
                band: string;
                bar: string;
                candlestick: string;
                donut: string;
                errorBar: string;
                groupedBar: string;
                heatmap: string;
                impulse: string;
                line: string;
                ohlc: string;
                percentArea: string;
                percentBar: string;
                pictorialBar: string;
                pie: string;
                scatter: string;
                stackedArea: string;
                stackedBar: string;
                themeRiver: string;
            };
            columns: (n: number, count: string) => string;
            direction: { horizontal: string; vertical: string };
            emptyCells: (n: number, count: string) => string;
            errorBarPoint: (
                x: string,
                name: string,
                value: string,
                low: string,
                high: string,
                direction: string,
            ) => string;
            extraAxis: (title: string | undefined, names: string) => string;
            gridSize: (rows: string, cols: string) => string;
            heatmapColumns: (
                cols: string,
                title?: string,
                from?: string,
                to?: string,
            ) => string;
            heatmapExtremes: (
                label: string,
                min: string,
                minCell: string,
                max: string,
                maxCell: string,
            ) => string;
            heatmapRows: (
                rows: string,
                title?: string,
                from?: string,
                to?: string,
            ) => string;
            hiddenCount: (count: string) => string;
            highColumn: (name: string) => string;
            impulsePoint: (
                x: string,
                name: string,
                value: string,
                baseline: string,
            ) => string;
            join: (sentences: string[]) => string;
            keyboard: {
                bar: string;
                candle: string;
                categories: string;
                default: string;
                heatmap: string;
                ohlc: string;
                pie: string;
                scatter: string;
            };
            labelled: (label: string, text: string) => string;
            lineStats: (
                name: string,
                values: string,
                min: string,
                minAt: string,
                max: string,
                maxAt: string,
                mean: string,
                first: string,
                last: string,
                trend: string,
            ) => string;
            lowColumn: (name: string) => string;
            lowerColumn: (name: string) => string;
            noValues: string;
            ohlcPoint: (
                x: string,
                open: string,
                high: string,
                low: string,
                close: string,
                volume?: string,
            ) => string;
            otherCombines: (name: string, members: string) => string;
            paren: (text: string, note: string) => string;
            percentHeader: string;
            pointEdited: (point: string) => string;
            rings: (n: number, count: string) => string;
            rows: (n: number, count: string) => string;
            sampledColumns: (shown: string, total: string) => string;
            sampledNote: (parts: string[]) => string;
            sampledRows: (shown: string, total: string) => string;
            scatterPoint: (
                name: string,
                xName: string,
                x: string,
                yName: string,
                y: string,
            ) => string;
            scatterRange: (x: string, y: string) => string;
            sentence: (head: string[], details?: string[]) => string;
            seriesNoData: (name: string) => string;
            seriesPoint: (x: string, name: string, value: string) => string;
            seriesRange: (name: string, range: string) => string;
            sliceHeader: string;
            sliceLine: (name: string, value: string, share: string) => string;
            slicePoint: (name: string, value: string, share: string) => string;
            slices: (n: number, count: string) => string;
            tableCaption: (kind: string) => string;
            tableLabel: (caption: string) => string;
            titled: (title: string, text: string) => string;
            total: (value: string) => string;
            totalPoint: (value: string) => string;
            trend: { falling: string; flat: string; rising: string };
            upperColumn: (name: string) => string;
            valueRange: (range: string) => string;
            values: (n: number, count: string) => string;
        };
        box: {
            announce: (
                category: string,
                series: string,
                median: string,
                q1: string,
                q3: string,
                whiskerLo: string,
                whiskerHi: string,
                mean: string,
                samples: string,
                outliers?: string,
            ) => string;
            announceEmpty: (category: string, series: string) => string;
            boxPlot: string;
            hiddenName: (name: string) => string;
            layoutBox: (categories: string, whiskers: string) => string;
            layoutViolin: (categories: string, whiskers: string) => string;
            lowerWhisker: string;
            n: string;
            outlier: string;
            outlierCount: (n: number, count: string) => string;
            outliers: string;
            overview: (
                kind: string,
                categories: string,
                series: string,
                samples: string,
                outliers?: string,
            ) => string;
            q1: string;
            q3: string;
            samples: (n: number, count: string) => string;
            seriesDetail: (
                name: string,
                hiCategory: string,
                hiMedian: string,
                loCategory: string,
                loMedian: string,
                samples: string,
                outliers?: string,
            ) => string;
            seriesEmpty: (name: string) => string;
            seriesMedians: (name: string, range: string) => string;
            seriesNoData: (name: string) => string;
            summary: (
                title: string | undefined,
                overview: string,
                details: string[],
            ) => string;
            upperWhisker: string;
            violinPlot: string;
            whiskers: string;
            whiskersIqr: (factor: string) => string;
            whiskersMinMax: string;
            whiskersPercentile: (
                lo: number,
                hi: number,
                loText: string,
                hiText: string,
            ) => string;
            xAxisTitle: (title: string) => string;
            yAxisTitle: (title: string) => string;
        };
        business: {
            axis: string;
            band: string;
            bandName: (index: string) => string;
            calendarAnnounce: (
                date: string,
                name: string,
                value: string,
                position: string,
            ) => string;
            calendarAnnounceEmpty: (date: string, position: string) => string;
            calendarBlock: (from: string, to: string, withData: string) => string;
            calendarHelp: (vertical: boolean) => string;
            calendarNoData: string;
            calendarSummary: (
                nDays: number,
                days: string,
                from: string,
                to: string,
                withData: string,
                lo: string,
                hi: string,
            ) => string;
            change: string;
            chordAnnounce: (
                flow: string,
                back: string | null,
                position: string,
            ) => string;
            chordCorner: string;
            chordFlow: (from: string, to: string, value: string) => string;
            chordGroup: (i: number) => string;
            chordGroupAnnounce: (
                name: string,
                total: string,
                position: string,
            ) => string;
            chordGroupHidden: (name: string) => string;
            chordGroupHiddenAnnounce: (name: string, position: string) => string;
            chordGroupTotal: (name: string, total: string) => string;
            chordHelp: string;
            chordSummary: (
                nGroups: number,
                groups: string,
                nChords: number,
                chords: string,
                largest: string | null,
            ) => string;
            date: string;
            decrease: string;
            from: string;
            funnelAnnounce: (stage: string, value: string, position: string) => string;
            funnelAnnounceConversion: (
                stage: string,
                value: string,
                ofFirst: string,
                ofPrevious: string,
                position: string,
            ) => string;
            funnelHelp: string;
            funnelShare: (stage: string, percent: string, first: string) => string;
            funnelStage: (stage: string, value: string) => string;
            funnelStageConversion: (
                stage: string,
                value: string,
                ofFirst: string,
                ofPrevious: string,
            ) => string;
            funnelSummary: (
                n: number,
                count: string,
                from: string,
                to: string,
                share: string,
            ) => string;
            gaugeBand: (name: string, from: string, to: string) => string;
            gaugeBandAnnounce: (
                name: string,
                from: string,
                to: string,
                position: string,
            ) => string;
            gaugeHelp: string;
            gaugeSummary: (
                value: string,
                band: string,
                min: string,
                max: string,
                nBands: number,
                bands: string,
            ) => string;
            gaugeValueAnnounce: (
                name: string,
                value: string,
                band: string,
                position: string,
            ) => string;
            increase: string;
            item: string;
            largestDecrease: (label: string, change: string) => string;
            largestIncrease: (label: string, change: string) => string;
            namedValue: (name: string, value: string) => string;
            noValue: string;
            ofFirstStage: string;
            ofPrevious: (percent: string) => string;
            ofPreviousShort: (percent: string) => string;
            ofPreviousStage: string;
            percentOfFirst: string;
            percentOfPrevious: string;
            radarAnnounce: (
                axis: string,
                series: string,
                value: string,
                position: string,
            ) => string;
            radarAxes: (axes: string) => string;
            radarAxisScales: (list: string) => string;
            radarHelp: string;
            radarHiddenSeries: (name: string, values: string) => string;
            radarHighest: (series: string, axis: string, value: string) => string;
            radarSeries: (name: string, values: string) => string;
            radarSharedScale: (max: string) => string;
            radarSummary: (
                nAxes: number,
                axes: string,
                series: string,
                highs: string[],
            ) => string;
            range: string;
            runningTotal: string;
            stage: string;
            status: {
                critical: string;
                good: string;
                serious: string;
                warning: string;
            };
            statusLabel: string;
            titled: (title: string, text: string) => string;
            to: string;
            totalInSentence: string;
            waterfallChange: (label: string, change: string, total: string) => string;
            waterfallChangeAnnounce: (
                label: string,
                change: string,
                total: string,
                position: string,
            ) => string;
            waterfallHelp: string;
            waterfallSummary: (
                items: string,
                end: string,
                highlights: string[],
            ) => string;
            waterfallTotal: (label: string, name: string, value: string) => string;
            waterfallTotalAnnounce: (
                label: string,
                name: string,
                value: string,
                position: string,
            ) => string;
        };
        combo: {
            announce: (x: string, label: string, value: string) => string;
            barMode: { grouped: string; percent: string; stacked: string };
            layout: (categories: string, barMode?: string) => string;
            leftAxisTitle: (title: string) => string;
            onLeftAxis: (type: string) => string;
            onRightAxis: (type: string) => string;
            overview: (
                categories: string,
                series: string,
                groups: string[],
                dual: boolean,
            ) => string;
            pointDescription: (series: string, category: string) => string;
            rightAxisTitle: (title: string) => string;
            seriesDetail: (
                label: string,
                hiX: string,
                hiValue: string,
                loX: string,
                loValue: string,
                mean: string,
            ) => string;
            seriesEmpty: (label: string) => string;
            seriesLabel: (name: string, role: string) => string;
            seriesLabelHidden: (name: string, role: string) => string;
            seriesNoData: (name: string) => string;
            seriesRange: (name: string, range: string) => string;
            summary: (
                title: string | undefined,
                overview: string,
                details: string[],
            ) => string;
            type: { area: string; bar: string; line: string };
            typeGroup: (type: string, names: string) => string;
            xAxisTitle: (title: string) => string;
            yAxisTitle: (title: string) => string;
        };
        common: {
            andMore: (count: string) => string;
            categories: (n: number, count: string) => string;
            category: string;
            close: string;
            dash: string;
            empty: string;
            hidden: string;
            high: string;
            itemName: (index: number) => string;
            items: (n: number, count: string) => string;
            kind: {
                "3d": string;
                area: string;
                band: string;
                bar: string;
                box: string;
                calendar: string;
                candlestick: string;
                chord: string;
                combo: string;
                donut: string;
                errorBar: string;
                funnel: string;
                gauge: string;
                graph: string;
                heatmap: string;
                histogram: string;
                impulse: string;
                line: string;
                ohlc: string;
                parallel: string;
                pie: string;
                polar: string;
                radar: string;
                sankey: string;
                scatter: string;
                sparkline: string;
                sunburst: string;
                tree: string;
                treemap: string;
                violin: string;
                waterfall: string;
            };
            listSeparator: string;
            low: string;
            max: string;
            mean: string;
            median: string;
            min: string;
            noData: string;
            notAvailable: string;
            open: string;
            other: string;
            points: (n: number, count: string) => string;
            position: (i: string, n: string) => string;
            range: (a: string, b: string) => string;
            row: string;
            series: string;
            seriesCount: (_n: number, count: string) => string;
            seriesName: (index: number) => string;
            total: string;
            value: string;
            volume: string;
            xAxis: string;
            yAxis: string;
        };
        core: {
            barCategory2d: string;
            barCategory3d: string;
            barDescription: (label: string) => string;
            baseline: (value: string) => string;
            candleLabel: (x: string) => string;
            candles: (n: number, count: string) => string;
            clickHint: string;
            cluster: string;
            clusterName: (id: string) => string;
            colorScale: (
                title: string,
                lo: string,
                hi: string,
                mid?: string,
            ) => string;
            count: string;
            degree: string;
            density: string;
            groupedBarDescription: (name: string, category: string) => string;
            legend: string;
            lineSampleAt: (name: string, position: string) => string;
            lineSampleAtX: (name: string, x: string) => string;
            loading: string;
            neighbors: string;
            nextLegendPage: string;
            nodeName: (id: string) => string;
            nodePosition: string;
            ohlcBars: (n: number, count: string) => string;
            outlier: string;
            pdfTitle: string;
            peakRatio: string;
            point3d: (name: string, x: string, y: string, z: string) => string;
            pointCloud3d: string;
            prevLegendPage: string;
            price: string;
            r2Unavailable: string;
            ringName: (index: number) => string;
            samples: (n: number, count: string) => string;
            scientificDescription: string;
            scientificHelp: string;
            scientificSummary: (
                kind: string,
                samples: string,
                series: string,
                title?: string,
            ) => string;
            seriesCategory: (kind: string, name: string) => string;
            shareOfTotal: string;
            stepPrefix: string;
            surface3d: string;
            trendFitted: (
                head: string,
                expression: string,
                r2: string,
                points: string,
                skipped: string,
            ) => string;
            trendHead: (series: string, hidden: boolean, kind: string) => string;
            trendKind: (
                type: "linear" | "exponential" | "logarithmic" | "polynomial",
                order: string,
            ) => string;
            trendNoFit: (type: string, points: string, skipped: string) => string;
            trendNotEnough: (head: string, points: string, skipped: string) => string;
            trendSkipped: (points: string, domain: string) => string;
        };
        graph: {
            categories: (n: number, count: string) => string;
            category: string;
            categoryName: (k: number) => string;
            graphName: string;
            help: string;
            item: (
                name: string,
                category: string | null,
                value: string | null,
                links: string,
            ) => string;
            linkedTo: string;
            links: (n: number, count: string) => string;
            linksHeader: string;
            node: string;
            nodeAnnounce: (
                name: string,
                category: string | null,
                value: string | null,
            ) => string;
            position: (
                i: string,
                n: string,
                links: string,
                neighbours: string | null,
                more: string | null,
            ) => string;
            summary: (
                chart: string,
                nodes: string,
                categories: string | null,
                links: string,
                top: string | null,
            ) => string;
            topItem: (name: string, links: string) => string;
        };
        hierarchy: {
            children: (n: number, count: string) => string;
            columns: (n: number, count: string) => string;
            drillHint: (children: string) => string;
            drillPath: string;
            flowItem: (source: string, target: string, value: string) => string;
            inflow: (value: string) => string;
            linkAnnounce: (
                source: string,
                target: string,
                value: string,
                share: string | null,
                i: string,
                n: string,
            ) => string;
            links: (n: number, count: string) => string;
            nodeAnnounce: (
                name: string,
                value: string,
                share: string | null,
                parent: string,
            ) => string;
            nodePosition: (i: string, n: string, level: string) => string;
            nodes: (n: number, count: string) => string;
            ofParent: (share: string) => string;
            ofSource: (share: string, source: string) => string;
            ofTotal: (share: string) => string;
            outflow: (value: string) => string;
            path: string;
            rootLabel: string;
            sankeyHelp: string;
            sankeyName: string;
            sankeyNode: (
                name: string,
                value: string,
                inflow: string,
                outflow: string,
            ) => string;
            sankeySummary: (
                chart: string,
                nodes: string,
                columns: string,
                links: string,
                largest: string | null,
            ) => string;
            sentenceSeparator: string;
            shareOfParent: string;
            shareOfSource: string;
            shareOfTotal: string;
            source: string;
            sunburstName: string;
            target: string;
            titled: (title: string, text: string) => string;
            treeHelp: string;
            treeItem: (
                name: string,
                value: string,
                share: string,
                children: string,
            ) => string;
            treemapName: string;
            treeSummary: (
                chart: string,
                nodes: string,
                total: string,
                at: string | null,
                largest: string,
                more: string | null,
            ) => string;
        };
        parallel: {
            announce: (
                axis: string,
                series: string | null,
                row: string,
                total: string,
                values: string,
                outside: boolean,
            ) => string;
            brushed: (name: string, ranges: string) => string;
            dimCategories: (name: string, count: string, list: string) => string;
            dimEmpty: (name: string) => string;
            dimensions: (n: number, count: string) => string;
            dimRange: (name: string, lo: string, hi: string) => string;
            help: (vertical: boolean) => string;
            pair: (name: string, value: string) => string;
            rowLabel: (series: string | null, row: string) => string;
            rows: (n: number, count: string) => string;
            summary: (
                chart: string,
                rows: string,
                dims: string,
                series: string | null,
                active: string | null,
            ) => string;
        };
        polar: {
            angle: string;
            announce: (series: string, pairs: string, position: string) => string;
            categories: (n: number, count: string) => string;
            help: string;
            pair: (name: string, value: string) => string;
            radius: string;
            range: (lo: string, hi: string) => string;
            seriesHidden: (name: string, type: string) => string;
            seriesName: (i: number) => string;
            seriesText: (
                name: string,
                type: string,
                items: string,
                range: string | null,
            ) => string;
            summary: (
                chart: string,
                series: string,
                angle: string,
                radius: string,
            ) => string;
            type: { bar: string; heatmap: string; line: string; scatter: string };
        };
        sparkline: {
            flat: (value: string) => string;
            flatRange: (value: string, min: string, max: string) => string;
            labelled: (name: string, text: string) => string;
            loss: string;
            losses: (n: number, count: string) => string;
            tie: string;
            ties: (n: number, count: string) => string;
            trendDown: (
                pct: string | null,
                from: string,
                to: string,
                min: string,
                max: string,
            ) => string;
            trendUp: (
                pct: string | null,
                from: string,
                to: string,
                min: string,
                max: string,
            ) => string;
            win: string;
            winLossLast: (tally: string, last: string) => string;
            wins: (n: number, count: string) => string;
        };
        tree: {
            collapsed: string;
            depth: string;
            expanded: string;
            help: string;
            item: (name: string, value: string | null, children: string) => string;
            leaf: string;
            levels: (n: number, count: string) => string;
            nodeAnnounce: (
                name: string,
                value: string | null,
                state: string | null,
            ) => string;
            state: (state: string, children: string) => string;
            stateHeader: string;
            summary: (
                chart: string,
                nodes: string,
                levels: string,
                shown: string,
                root: string,
                top: string | null,
                more: string | null,
            ) => string;
            toggleHint: (expanded: boolean) => string;
            treeName: string;
        };
    }
    Index
    a11y: {
        axisBreaks: (
            axis: string,
            title: string | undefined,
            ranges: string,
        ) => string;
        axisRange: (
            axis: string,
            title?: string,
            from?: string,
            to?: string,
        ) => string;
        axisTitle: (axis: string, title: string) => string;
        bandEdges: (name: string, first: string, second: string) => string;
        bandPoint: (
            x: string,
            name: string,
            first: string,
            second: string,
        ) => string;
        barLayout: (categories: string, mode: string) => string;
        barMode: { grouped: string; percent: string; stacked: string };
        barPoint: (x: string, value: string) => string;
        barRange: (
            min: string,
            minLabel: string,
            max: string,
            maxLabel: string,
        ) => string;
        bars: (n: number, count: string) => string;
        barStats: (
            name: string,
            maxLabel: string,
            max: string,
            minLabel: string,
            min: string,
            mean: string,
        ) => string;
        baselineColumn: (name: string) => string;
        candles: (n: number, count: string) => string;
        cell: (row: string, col: string) => string;
        chart: {
            area: string;
            band: string;
            bar: string;
            candlestick: string;
            donut: string;
            errorBar: string;
            groupedBar: string;
            heatmap: string;
            impulse: string;
            line: string;
            ohlc: string;
            percentArea: string;
            percentBar: string;
            pictorialBar: string;
            pie: string;
            scatter: string;
            stackedArea: string;
            stackedBar: string;
            themeRiver: string;
        };
        columns: (n: number, count: string) => string;
        direction: { horizontal: string; vertical: string };
        emptyCells: (n: number, count: string) => string;
        errorBarPoint: (
            x: string,
            name: string,
            value: string,
            low: string,
            high: string,
            direction: string,
        ) => string;
        extraAxis: (title: string | undefined, names: string) => string;
        gridSize: (rows: string, cols: string) => string;
        heatmapColumns: (
            cols: string,
            title?: string,
            from?: string,
            to?: string,
        ) => string;
        heatmapExtremes: (
            label: string,
            min: string,
            minCell: string,
            max: string,
            maxCell: string,
        ) => string;
        heatmapRows: (
            rows: string,
            title?: string,
            from?: string,
            to?: string,
        ) => string;
        hiddenCount: (count: string) => string;
        highColumn: (name: string) => string;
        impulsePoint: (
            x: string,
            name: string,
            value: string,
            baseline: string,
        ) => string;
        join: (sentences: string[]) => string;
        keyboard: {
            bar: string;
            candle: string;
            categories: string;
            default: string;
            heatmap: string;
            ohlc: string;
            pie: string;
            scatter: string;
        };
        labelled: (label: string, text: string) => string;
        lineStats: (
            name: string,
            values: string,
            min: string,
            minAt: string,
            max: string,
            maxAt: string,
            mean: string,
            first: string,
            last: string,
            trend: string,
        ) => string;
        lowColumn: (name: string) => string;
        lowerColumn: (name: string) => string;
        noValues: string;
        ohlcPoint: (
            x: string,
            open: string,
            high: string,
            low: string,
            close: string,
            volume?: string,
        ) => string;
        otherCombines: (name: string, members: string) => string;
        paren: (text: string, note: string) => string;
        percentHeader: string;
        pointEdited: (point: string) => string;
        rings: (n: number, count: string) => string;
        rows: (n: number, count: string) => string;
        sampledColumns: (shown: string, total: string) => string;
        sampledNote: (parts: string[]) => string;
        sampledRows: (shown: string, total: string) => string;
        scatterPoint: (
            name: string,
            xName: string,
            x: string,
            yName: string,
            y: string,
        ) => string;
        scatterRange: (x: string, y: string) => string;
        sentence: (head: string[], details?: string[]) => string;
        seriesNoData: (name: string) => string;
        seriesPoint: (x: string, name: string, value: string) => string;
        seriesRange: (name: string, range: string) => string;
        sliceHeader: string;
        sliceLine: (name: string, value: string, share: string) => string;
        slicePoint: (name: string, value: string, share: string) => string;
        slices: (n: number, count: string) => string;
        tableCaption: (kind: string) => string;
        tableLabel: (caption: string) => string;
        titled: (title: string, text: string) => string;
        total: (value: string) => string;
        totalPoint: (value: string) => string;
        trend: { falling: string; flat: string; rising: string };
        upperColumn: (name: string) => string;
        valueRange: (range: string) => string;
        values: (n: number, count: string) => string;
    }

    Type Declaration

    • axisBreaks: (axis: string, title: string | undefined, ranges: string) => string

      Axis break ranges (ranges: already joined common.range texts)

    • axisRange: (axis: string, title?: string, from?: string, to?: string) => string

      Axis with optional title and value span

    • axisTitle: (axis: string, title: string) => string

      axis is common.xAxis / common.yAxis

    • bandEdges: (name: string, first: string, second: string) => string

      Standalone band series: range of each edge (or common.noData)

    • bandPoint: (x: string, name: string, first: string, second: string) => string
    • barLayout: (categories: string, mode: string) => string

      Category count and multi-series bar layout

    • barMode: { grouped: string; percent: string; stacked: string }

      Multi-series bar layout inside a description sentence

    • barPoint: (x: string, value: string) => string

      Single-series bar

    • barRange: (min: string, minLabel: string, max: string, maxLabel: string) => string

      Single-series bar extremes with their categories

    • bars: (n: number, count: string) => string

      OHLC bars

    • barStats: (
          name: string,
          maxLabel: string,
          max: string,
          minLabel: string,
          min: string,
          mean: string,
      ) => string

      Highest / lowest category of a bar series (name may be the category count)

    • baselineColumn: (name: string) => string
    • candles: (n: number, count: string) => string
    • cell: (row: string, col: string) => string

      Row and column label of a heatmap cell

    • chart: {
          area: string;
          band: string;
          bar: string;
          candlestick: string;
          donut: string;
          errorBar: string;
          groupedBar: string;
          heatmap: string;
          impulse: string;
          line: string;
          ohlc: string;
          percentArea: string;
          percentBar: string;
          pictorialBar: string;
          pie: string;
          scatter: string;
          stackedArea: string;
          stackedBar: string;
          themeRiver: string;
      }

      Full chart names that open a summary

    • columns: (n: number, count: string) => string
    • direction: { horizontal: string; vertical: string }

      Error bar direction in announcements

    • emptyCells: (n: number, count: string) => string
    • errorBarPoint: (
          x: string,
          name: string,
          value: string,
          low: string,
          high: string,
          direction: string,
      ) => string
    • extraAxis: (title: string | undefined, names: string) => string

      Extra y axis (axes.extraY) with the series names on it

    • gridSize: (rows: string, cols: string) => string

      Rows × columns of a heatmap

    • heatmapColumns: (cols: string, title?: string, from?: string, to?: string) => string
    • heatmapExtremes: (
          label: string,
          min: string,
          minCell: string,
          max: string,
          maxCell: string,
      ) => string
    • heatmapRows: (rows: string, title?: string, from?: string, to?: string) => string
    • hiddenCount: (count: string) => string
    • highColumn: (name: string) => string
    • impulsePoint: (x: string, name: string, value: string, baseline: string) => string
    • join: (sentences: string[]) => string

      Joins whole sentences (description, announcement + position)

    • keyboard: {
          bar: string;
          candle: string;
          categories: string;
          default: string;
          heatmap: string;
          ohlc: string;
          pie: string;
          scatter: string;
      }

      Keyboard help per chart kind

    • labelled: (label: string, text: string) => string

      label: text.

    • lineStats: (
          name: string,
          values: string,
          min: string,
          minAt: string,
          max: string,
          maxAt: string,
          mean: string,
          first: string,
          last: string,
          trend: string,
      ) => string
    • lowColumn: (name: string) => string

      Table / CSV columns of error bars, impulse baselines and range bands

    • lowerColumn: (name: string) => string
    • noValues: string
    • ohlcPoint: (
          x: string,
          open: string,
          high: string,
          low: string,
          close: string,
          volume?: string,
      ) => string

      Live announcement of a candle; volume only when the chart has volumes

    • otherCombines: (name: string, members: string) => string

      The "Other" slice and the slices it folds

    • paren: (text: string, note: string) => string

      text (note), e.g. a hidden series or empty cell count

    • percentHeader: string

      Pie table / CSV column of the share

    • pointEdited: (point: string) => string

      Live text after a keyboard point edit (point = the point announcement)

    • rings: (n: number, count: string) => string

      Ring count of a multi-ring (nested) pie

    • rows: (n: number, count: string) => string
    • sampledColumns: (shown: string, total: string) => string
    • sampledNote: (parts: string[]) => string

      Note under a downsampled table (parts: sampledRows / sampledColumns)

    • sampledRows: (shown: string, total: string) => string
    • scatterPoint: (name: string, xName: string, x: string, yName: string, y: string) => string

      xName / yName: axis titles, else x / y

    • scatterRange: (x: string, y: string) => string

      Scatter x / y extents

    • sentence: (head: string[], details?: string[]) => string

      One sentence: leading clauses, then detail clauses

    • seriesNoData: (name: string) => string
    • seriesPoint: (x: string, name: string, value: string) => string

      Multi-series bar / line / area

    • seriesRange: (name: string, range: string) => string
    • sliceHeader: string

      Pie table / CSV column of the slice name

    • sliceLine: (name: string, value: string, share: string) => string

      Pie slice line: value and share (or common.hidden)

    • slicePoint: (name: string, value: string, share: string) => string

      Live announcement of a pie slice (share already has its %)

    • slices: (n: number, count: string) => string
    • tableCaption: (kind: string) => string

      Data table caption without a chart title (kind: common.kind name)

    • tableLabel: (caption: string) => string

      aria-label of the data table region

    • titled: (title: string, text: string) => string

      Chart title before a summary

    • total: (value: string) => string
    • totalPoint: (value: string) => string

      Stack total after a stacked point

    • trend: { falling: string; flat: string; rising: string }

      Overall direction of a line series (first vs last value)

    • upperColumn: (name: string) => string
    • valueRange: (range: string) => string

      Value range of a heatmap

    • values: (n: number, count: string) => string
    box: {
        announce: (
            category: string,
            series: string,
            median: string,
            q1: string,
            q3: string,
            whiskerLo: string,
            whiskerHi: string,
            mean: string,
            samples: string,
            outliers?: string,
        ) => string;
        announceEmpty: (category: string, series: string) => string;
        boxPlot: string;
        hiddenName: (name: string) => string;
        layoutBox: (categories: string, whiskers: string) => string;
        layoutViolin: (categories: string, whiskers: string) => string;
        lowerWhisker: string;
        n: string;
        outlier: string;
        outlierCount: (n: number, count: string) => string;
        outliers: string;
        overview: (
            kind: string,
            categories: string,
            series: string,
            samples: string,
            outliers?: string,
        ) => string;
        q1: string;
        q3: string;
        samples: (n: number, count: string) => string;
        seriesDetail: (
            name: string,
            hiCategory: string,
            hiMedian: string,
            loCategory: string,
            loMedian: string,
            samples: string,
            outliers?: string,
        ) => string;
        seriesEmpty: (name: string) => string;
        seriesMedians: (name: string, range: string) => string;
        seriesNoData: (name: string) => string;
        summary: (
            title: string | undefined,
            overview: string,
            details: string[],
        ) => string;
        upperWhisker: string;
        violinPlot: string;
        whiskers: string;
        whiskersIqr: (factor: string) => string;
        whiskersMinMax: string;
        whiskersPercentile: (
            lo: number,
            hi: number,
            loText: string,
            hiText: string,
        ) => string;
        xAxisTitle: (title: string) => string;
        yAxisTitle: (title: string) => string;
    }

    Type Declaration

    • announce: (
          category: string,
          series: string,
          median: string,
          q1: string,
          q3: string,
          whiskerLo: string,
          whiskerHi: string,
          mean: string,
          samples: string,
          outliers?: string,
      ) => string

      Live-region text of a focused group; outliers is omitted for violins

    • announceEmpty: (category: string, series: string) => string
    • boxPlot: string
    • hiddenName: (name: string) => string
    • layoutBox: (categories: string, whiskers: string) => string
    • layoutViolin: (categories: string, whiskers: string) => string
    • lowerWhisker: string
    • n: string

      Sample count label (tooltip row, table column)

    • outlier: string

      Tooltip row of a hovered outlier point

    • outlierCount: (n: number, count: string) => string
    • outliers: string
    • overview: (
          kind: string,
          categories: string,
          series: string,
          samples: string,
          outliers?: string,
      ) => string

      Summary overview, e.g. Box plot, 3 categories, 2 series, 50 samples (3 outliers)

    • q1: string
    • q3: string
    • samples: (n: number, count: string) => string
    • seriesDetail: (
          name: string,
          hiCategory: string,
          hiMedian: string,
          loCategory: string,
          loMedian: string,
          samples: string,
          outliers?: string,
      ) => string

      Description line of a series; outliers is omitted for violins

    • seriesEmpty: (name: string) => string
    • seriesMedians: (name: string, range: string) => string
    • seriesNoData: (name: string) => string
    • summary: (title: string | undefined, overview: string, details: string[]) => string

      Summary sentence: optional title, overview, per-series details

    • upperWhisker: string
    • violinPlot: string
    • whiskers: string
    • whiskersIqr: (factor: string) => string

      Tukey whisker rule, e.g. 1.5 IQR

    • whiskersMinMax: string

      Whisker rule 'minmax'

    • whiskersPercentile: (lo: number, hi: number, loText: string, hiText: string) => string

      Percentile whisker rule; raw percentiles pick the ordinal suffix

    • xAxisTitle: (title: string) => string
    • yAxisTitle: (title: string) => string
    business: {
        axis: string;
        band: string;
        bandName: (index: string) => string;
        calendarAnnounce: (
            date: string,
            name: string,
            value: string,
            position: string,
        ) => string;
        calendarAnnounceEmpty: (date: string, position: string) => string;
        calendarBlock: (from: string, to: string, withData: string) => string;
        calendarHelp: (vertical: boolean) => string;
        calendarNoData: string;
        calendarSummary: (
            nDays: number,
            days: string,
            from: string,
            to: string,
            withData: string,
            lo: string,
            hi: string,
        ) => string;
        change: string;
        chordAnnounce: (
            flow: string,
            back: string | null,
            position: string,
        ) => string;
        chordCorner: string;
        chordFlow: (from: string, to: string, value: string) => string;
        chordGroup: (i: number) => string;
        chordGroupAnnounce: (
            name: string,
            total: string,
            position: string,
        ) => string;
        chordGroupHidden: (name: string) => string;
        chordGroupHiddenAnnounce: (name: string, position: string) => string;
        chordGroupTotal: (name: string, total: string) => string;
        chordHelp: string;
        chordSummary: (
            nGroups: number,
            groups: string,
            nChords: number,
            chords: string,
            largest: string | null,
        ) => string;
        date: string;
        decrease: string;
        from: string;
        funnelAnnounce: (stage: string, value: string, position: string) => string;
        funnelAnnounceConversion: (
            stage: string,
            value: string,
            ofFirst: string,
            ofPrevious: string,
            position: string,
        ) => string;
        funnelHelp: string;
        funnelShare: (stage: string, percent: string, first: string) => string;
        funnelStage: (stage: string, value: string) => string;
        funnelStageConversion: (
            stage: string,
            value: string,
            ofFirst: string,
            ofPrevious: string,
        ) => string;
        funnelSummary: (
            n: number,
            count: string,
            from: string,
            to: string,
            share: string,
        ) => string;
        gaugeBand: (name: string, from: string, to: string) => string;
        gaugeBandAnnounce: (
            name: string,
            from: string,
            to: string,
            position: string,
        ) => string;
        gaugeHelp: string;
        gaugeSummary: (
            value: string,
            band: string,
            min: string,
            max: string,
            nBands: number,
            bands: string,
        ) => string;
        gaugeValueAnnounce: (
            name: string,
            value: string,
            band: string,
            position: string,
        ) => string;
        increase: string;
        item: string;
        largestDecrease: (label: string, change: string) => string;
        largestIncrease: (label: string, change: string) => string;
        namedValue: (name: string, value: string) => string;
        noValue: string;
        ofFirstStage: string;
        ofPrevious: (percent: string) => string;
        ofPreviousShort: (percent: string) => string;
        ofPreviousStage: string;
        percentOfFirst: string;
        percentOfPrevious: string;
        radarAnnounce: (
            axis: string,
            series: string,
            value: string,
            position: string,
        ) => string;
        radarAxes: (axes: string) => string;
        radarAxisScales: (list: string) => string;
        radarHelp: string;
        radarHiddenSeries: (name: string, values: string) => string;
        radarHighest: (series: string, axis: string, value: string) => string;
        radarSeries: (name: string, values: string) => string;
        radarSharedScale: (max: string) => string;
        radarSummary: (
            nAxes: number,
            axes: string,
            series: string,
            highs: string[],
        ) => string;
        range: string;
        runningTotal: string;
        stage: string;
        status: {
            critical: string;
            good: string;
            serious: string;
            warning: string;
        };
        statusLabel: string;
        titled: (title: string, text: string) => string;
        to: string;
        totalInSentence: string;
        waterfallChange: (label: string, change: string, total: string) => string;
        waterfallChangeAnnounce: (
            label: string,
            change: string,
            total: string,
            position: string,
        ) => string;
        waterfallHelp: string;
        waterfallSummary: (
            items: string,
            end: string,
            highlights: string[],
        ) => string;
        waterfallTotal: (label: string, name: string, value: string) => string;
        waterfallTotalAnnounce: (
            label: string,
            name: string,
            value: string,
            position: string,
        ) => string;
    }

    Type Declaration

    • axis: string

      Data table header of the radar axis column

    • band: string

      Tooltip header of a hovered band

    • bandName: (index: string) => string

      Default name of the index-th gauge band (1-based)

    • calendarAnnounce: (date: string, name: string, value: string, position: string) => string
    • calendarAnnounceEmpty: (date: string, position: string) => string
    • calendarBlock: (from: string, to: string, withData: string) => string

      One calendar (range) of several

    • calendarHelp: (vertical: boolean) => string

      vertical: weeks run down (Left / Right step days)

    • calendarNoData: string

      Tooltip value of a day without data

    • calendarSummary: (
          nDays: number,
          days: string,
          from: string,
          to: string,
          withData: string,
          lo: string,
          hi: string,
      ) => string

      from / to: dates; withData: days with a value; lo / hi: value range ('' = no data)

    • change: string

      Default name of the waterfall changes

    • chordAnnounce: (flow: string, back: string | null, position: string) => string

      back: the reverse flow (null = none)

    • chordCorner: string

      Corner cell of the flow matrix table (rows = from, columns = to)

    • chordFlow: (from: string, to: string, value: string) => string
    • chordGroup: (i: number) => string

      Chord diagram (chart-chord.ts): default group name (1-based)

    • chordGroupAnnounce: (name: string, total: string, position: string) => string
    • chordGroupHidden: (name: string) => string
    • chordGroupHiddenAnnounce: (name: string, position: string) => string
    • chordGroupTotal: (name: string, total: string) => string
    • chordHelp: string
    • chordSummary: (
          nGroups: number,
          groups: string,
          nChords: number,
          chords: string,
          largest: string | null,
      ) => string

      largest: the biggest flows, joined (null = none)

    • date: string

      Calendar heatmap (chart-calendar.ts): data table header of the date column

    • decrease: string
    • from: string
    • funnelAnnounce: (stage: string, value: string, position: string) => string
    • funnelAnnounceConversion: (
          stage: string,
          value: string,
          ofFirst: string,
          ofPrevious: string,
          position: string,
      ) => string
    • funnelHelp: string
    • funnelShare: (stage: string, percent: string, first: string) => string

      stage is percent of the first stage

    • funnelStage: (stage: string, value: string) => string
    • funnelStageConversion: (stage: string, value: string, ofFirst: string, ofPrevious: string) => string
    • funnelSummary: (n: number, count: string, from: string, to: string, share: string) => string

      share: funnelShare of the last stage ('' = single stage)

    • gaugeBand: (name: string, from: string, to: string) => string
    • gaugeBandAnnounce: (name: string, from: string, to: string, position: string) => string
    • gaugeHelp: string
    • gaugeSummary: (
          value: string,
          band: string,
          min: string,
          max: string,
          nBands: number,
          bands: string,
      ) => string

      band: name of the band containing the value ('' = none)

    • gaugeValueAnnounce: (name: string, value: string, band: string, position: string) => string
    • increase: string

      Default waterfall kind names (the total kind uses common.total)

    • item: string

      Data table columns of a gauge (name, then the value column common.value, band start, band end)

    • largestDecrease: (label: string, change: string) => string
    • largestIncrease: (label: string, change: string) => string
    • namedValue: (name: string, value: string) => string

      One name value entry of a list (radar axis maxima, series values per axis)

    • noValue: string

      Gauge without a value

    • ofFirstStage: string

      Tooltip rows of the conversion rates

    • ofPrevious: (percent: string) => string

      Stage label: conversion from the previous stage

    • ofPreviousShort: (percent: string) => string

      Compact ofPrevious under the narrow stages of a horizontal funnel

    • ofPreviousStage: string
    • percentOfFirst: string

      Data table / CSV columns of the conversion rates

    • percentOfPrevious: string
    • radarAnnounce: (axis: string, series: string, value: string, position: string) => string
    • radarAxes: (axes: string) => string
    • radarAxisScales: (list: string) => string

      list: namedValue entries (axis, its maximum)

    • radarHelp: string
    • radarHiddenSeries: (name: string, values: string) => string
    • radarHighest: (series: string, axis: string, value: string) => string

      Summary clause: the axis where a series peaks

    • radarSeries: (name: string, values: string) => string
    • radarSharedScale: (max: string) => string
    • radarSummary: (nAxes: number, axes: string, series: string, highs: string[]) => string

      series: count phrase (common seriesCount); highs: radarHighest clauses

    • range: string

      Tooltip row of the gauge range

    • runningTotal: string
    • stage: string

      Data table header of the funnel stage column

    • status: { critical: string; good: string; serious: string; warning: string }

      Names of the reserved gauge status bands

    • statusLabel: string

      Tooltip row of the band containing the value

    • titled: (title: string, text: string) => string

      Chart title before a summary sentence

    • to: string
    • totalInSentence: string

      Default total name inside a description sentence

    • waterfallChange: (label: string, change: string, total: string) => string
    • waterfallChangeAnnounce: (label: string, change: string, total: string, position: string) => string
    • waterfallHelp: string
    • waterfallSummary: (items: string, end: string, highlights: string[]) => string

      items: count phrase (common items); end: final running total ('' = no items)

    • waterfallTotal: (label: string, name: string, value: string) => string
    • waterfallTotalAnnounce: (label: string, name: string, value: string, position: string) => string
    combo: {
        announce: (x: string, label: string, value: string) => string;
        barMode: { grouped: string; percent: string; stacked: string };
        layout: (categories: string, barMode?: string) => string;
        leftAxisTitle: (title: string) => string;
        onLeftAxis: (type: string) => string;
        onRightAxis: (type: string) => string;
        overview: (
            categories: string,
            series: string,
            groups: string[],
            dual: boolean,
        ) => string;
        pointDescription: (series: string, category: string) => string;
        rightAxisTitle: (title: string) => string;
        seriesDetail: (
            label: string,
            hiX: string,
            hiValue: string,
            loX: string,
            loValue: string,
            mean: string,
        ) => string;
        seriesEmpty: (label: string) => string;
        seriesLabel: (name: string, role: string) => string;
        seriesLabelHidden: (name: string, role: string) => string;
        seriesNoData: (name: string) => string;
        seriesRange: (name: string, range: string) => string;
        summary: (
            title: string | undefined,
            overview: string,
            details: string[],
        ) => string;
        type: { area: string; bar: string; line: string };
        typeGroup: (type: string, names: string) => string;
        xAxisTitle: (title: string) => string;
        yAxisTitle: (title: string) => string;
    }

    Type Declaration

    • announce: (x: string, label: string, value: string) => string

      Live-region text of a focused point, e.g. Q3, Margin (line) 15%.

    • barMode: { grouped: string; percent: string; stacked: string }

      Bar layout of 2+ bar series (description)

    • layout: (categories: string, barMode?: string) => string

      Category count plus the bar layout when there are 2+ bar series

    • leftAxisTitle: (title: string) => string
    • onLeftAxis: (type: string) => string

      Series role on a dual-axis chart, e.g. bars, left axis

    • onRightAxis: (type: string) => string
    • overview: (categories: string, series: string, groups: string[], dual: boolean) => string

      Summary overview, e.g. Combo chart, 12 categories, 3 series (bars: Revenue, Cost; line: Margin), two y axes

    • pointDescription: (series: string, category: string) => string

      Details description of a point

    • rightAxisTitle: (title: string) => string
    • seriesDetail: (
          label: string,
          hiX: string,
          hiValue: string,
          loX: string,
          loValue: string,
          mean: string,
      ) => string
    • seriesEmpty: (label: string) => string
    • seriesLabel: (name: string, role: string) => string

      Series name with its role, e.g. Margin (line, right axis)

    • seriesLabelHidden: (name: string, role: string) => string
    • seriesNoData: (name: string) => string
    • seriesRange: (name: string, range: string) => string
    • summary: (title: string | undefined, overview: string, details: string[]) => string

      Summary sentence: optional title, overview, per-series details

    • type: { area: string; bar: string; line: string }

      Series kind words in the summary / roles (bars: Revenue, Cost, line, right axis)

    • typeGroup: (type: string, names: string) => string

      Series of one kind in the overview, e.g. bars: Revenue, Cost

    • xAxisTitle: (title: string) => string
    • yAxisTitle: (title: string) => string
    common: {
        andMore: (count: string) => string;
        categories: (n: number, count: string) => string;
        category: string;
        close: string;
        dash: string;
        empty: string;
        hidden: string;
        high: string;
        itemName: (index: number) => string;
        items: (n: number, count: string) => string;
        kind: {
            "3d": string;
            area: string;
            band: string;
            bar: string;
            box: string;
            calendar: string;
            candlestick: string;
            chord: string;
            combo: string;
            donut: string;
            errorBar: string;
            funnel: string;
            gauge: string;
            graph: string;
            heatmap: string;
            histogram: string;
            impulse: string;
            line: string;
            ohlc: string;
            parallel: string;
            pie: string;
            polar: string;
            radar: string;
            sankey: string;
            scatter: string;
            sparkline: string;
            sunburst: string;
            tree: string;
            treemap: string;
            violin: string;
            waterfall: string;
        };
        listSeparator: string;
        low: string;
        max: string;
        mean: string;
        median: string;
        min: string;
        noData: string;
        notAvailable: string;
        open: string;
        other: string;
        points: (n: number, count: string) => string;
        position: (i: string, n: string) => string;
        range: (a: string, b: string) => string;
        row: string;
        series: string;
        seriesCount: (_n: number, count: string) => string;
        seriesName: (index: number) => string;
        total: string;
        value: string;
        volume: string;
        xAxis: string;
        yAxis: string;
    }

    Type Declaration

    • andMore: (count: string) => string

      Tail of a truncated list

    • categories: (n: number, count: string) => string
    • category: string
    • close: string
    • dash: string

      Shown for a missing value

    • empty: string
    • hidden: string
    • high: string
    • itemName: (index: number) => string

      Default label of the index-th item / category (1-based)

    • items: (n: number, count: string) => string
    • kind: {
          "3d": string;
          area: string;
          band: string;
          bar: string;
          box: string;
          calendar: string;
          candlestick: string;
          chord: string;
          combo: string;
          donut: string;
          errorBar: string;
          funnel: string;
          gauge: string;
          graph: string;
          heatmap: string;
          histogram: string;
          impulse: string;
          line: string;
          ohlc: string;
          parallel: string;
          pie: string;
          polar: string;
          radar: string;
          sankey: string;
          scatter: string;
          sparkline: string;
          sunburst: string;
          tree: string;
          treemap: string;
          violin: string;
          waterfall: string;
      }

      Chart kind names (data table captions, summaries)

    • listSeparator: string

      Joins list items

    • low: string
    • max: string
    • mean: string
    • median: string
    • min: string
    • noData: string
    • notAvailable: string
    • open: string
    • other: string
    • points: (n: number, count: string) => string

      count + noun in the right plural form

    • position: (i: string, n: string) => string

      Position of an item in a sequence, e.g. a keyboard announcement

    • range: (a: string, b: string) => string

      a to b as a compact range

    • row: string
    • series: string
    • seriesCount: (_n: number, count: string) => string
    • seriesName: (index: number) => string

      Default name of the index-th series (1-based)

    • total: string
    • value: string
    • volume: string
    • xAxis: string
    • yAxis: string
    core: {
        barCategory2d: string;
        barCategory3d: string;
        barDescription: (label: string) => string;
        baseline: (value: string) => string;
        candleLabel: (x: string) => string;
        candles: (n: number, count: string) => string;
        clickHint: string;
        cluster: string;
        clusterName: (id: string) => string;
        colorScale: (title: string, lo: string, hi: string, mid?: string) => string;
        count: string;
        degree: string;
        density: string;
        groupedBarDescription: (name: string, category: string) => string;
        legend: string;
        lineSampleAt: (name: string, position: string) => string;
        lineSampleAtX: (name: string, x: string) => string;
        loading: string;
        neighbors: string;
        nextLegendPage: string;
        nodeName: (id: string) => string;
        nodePosition: string;
        ohlcBars: (n: number, count: string) => string;
        outlier: string;
        pdfTitle: string;
        peakRatio: string;
        point3d: (name: string, x: string, y: string, z: string) => string;
        pointCloud3d: string;
        prevLegendPage: string;
        price: string;
        r2Unavailable: string;
        ringName: (index: number) => string;
        samples: (n: number, count: string) => string;
        scientificDescription: string;
        scientificHelp: string;
        scientificSummary: (
            kind: string,
            samples: string,
            series: string,
            title?: string,
        ) => string;
        seriesCategory: (kind: string, name: string) => string;
        shareOfTotal: string;
        stepPrefix: string;
        surface3d: string;
        trendFitted: (
            head: string,
            expression: string,
            r2: string,
            points: string,
            skipped: string,
        ) => string;
        trendHead: (series: string, hidden: boolean, kind: string) => string;
        trendKind: (
            type: "linear" | "exponential" | "logarithmic" | "polynomial",
            order: string,
        ) => string;
        trendNoFit: (type: string, points: string, skipped: string) => string;
        trendNotEnough: (head: string, points: string, skipped: string) => string;
        trendSkipped: (points: string, domain: string) => string;
    }

    Type Declaration

    • barCategory2d: string

      Default category of single-series bars (2D / 3D)

    • barCategory3d: string
    • barDescription: (label: string) => string

      Node details description of a single-series bar

    • baseline: (value: string) => string

      Tooltip: impulse baseline next to the value

    • candleLabel: (x: string) => string

      Node details label of a candle / OHLC bar

    • candles: (n: number, count: string) => string

      Tooltip: aggregated candles / OHLC bars behind one bucket

    • clickHint: string

      Graph node tooltip: shown when a click highlights the node's neighbors

    • cluster: string

      Graph node tooltip rows

    • clusterName: (id: string) => string

      Default category of a graph node: its layout cluster

    • colorScale: (title: string, lo: string, hi: string, mid?: string) => string

      Heatmap colorbar aria-label; mid: diverging midpoint

    • count: string
    • degree: string
    • density: string

      Histogram value names (density / count mode)

    • groupedBarDescription: (name: string, category: string) => string

      Node details description of a grouped / stacked bar

    • legend: string

      aria-label of the chart legend

    • lineSampleAt: (name: string, position: string) => string

      Node details description of a line sample by 1-based position

    • lineSampleAtX: (name: string, x: string) => string

      Node details description of a line sample at a numeric / time x

    • loading: string

      Default text of the loading indicator (showLoading)

    • neighbors: string
    • nextLegendPage: string
    • nodeName: (id: string) => string

      Default label of a graph node without metadata

    • nodePosition: string
    • ohlcBars: (n: number, count: string) => string
    • outlier: string

      Marks a box plot outlier in node details

    • pdfTitle: string

      Default PDF document title

    • peakRatio: string
    • point3d: (name: string, x: string, y: string, z: string) => string

      Keyboard announcement of a 3D sample

    • pointCloud3d: string

      3D chart kind names (summary, data table caption)

    • prevLegendPage: string

      Legend pager buttons

    • price: string

      Candlestick / OHLC series name

    • r2Unavailable: string
    • ringName: (index: number) => string

      Default name of the index-th ring of a multi-ring pie (1-based)

    • samples: (n: number, count: string) => string
    • scientificDescription: string
    • scientificHelp: string
    • scientificSummary: (kind: string, samples: string, series: string, title?: string) => string

      3D chart summary; samples / series are already counted phrases

    • seriesCategory: (kind: string, name: string) => string

      Node details category of a line / band / error bar / impulse sample; kind is a common.kind name

    • shareOfTotal: string

      Single-bar tooltip rows (shareOfTotal / peakRatio attributes)

    • stepPrefix: string

      Line x label prefix without x values (T+12)

    • surface3d: string
    • trendFitted: (
          head: string,
          expression: string,
          r2: string,
          points: string,
          skipped: string,
      ) => string
    • trendHead: (series: string, hidden: boolean, kind: string) => string

      Subject of the accessible trendline sentence

    • trendKind: (
          type: "linear" | "exponential" | "logarithmic" | "polynomial",
          order: string,
      ) => string

      Scatter trendlines: model name (order only for polynomials)

    • trendNoFit: (type: string, points: string, skipped: string) => string

      Legend text of a model without a fit

    • trendNotEnough: (head: string, points: string, skipped: string) => string
    • trendSkipped: (points: string, domain: string) => string

      ; 2 points with y ≤ 0 skipped (points from common.points, domain like y ≤ 0)

    graph: {
        categories: (n: number, count: string) => string;
        category: string;
        categoryName: (k: number) => string;
        graphName: string;
        help: string;
        item: (
            name: string,
            category: string | null,
            value: string | null,
            links: string,
        ) => string;
        linkedTo: string;
        links: (n: number, count: string) => string;
        linksHeader: string;
        node: string;
        nodeAnnounce: (
            name: string,
            category: string | null,
            value: string | null,
        ) => string;
        position: (
            i: string,
            n: string,
            links: string,
            neighbours: string | null,
            more: string | null,
        ) => string;
        summary: (
            chart: string,
            nodes: string,
            categories: string | null,
            links: string,
            top: string | null,
        ) => string;
        topItem: (name: string, links: string) => string;
    }

    Type Declaration

    • categories: (n: number, count: string) => string
    • category: string
    • categoryName: (k: number) => string

      Default name of category k (1-based) when the input has no categories

    • graphName: string

      Summary chart name

    • help: string
    • item: (
          name: string,
          category: string | null,
          value: string | null,
          links: string,
      ) => string

      Description sentence per node (the most linked first)

    • linkedTo: string
    • links: (n: number, count: string) => string
    • linksHeader: string
    • node: string
    • nodeAnnounce: (name: string, category: string | null, value: string | null) => string

      Focused node: category / value null without one

    • position: (
          i: string,
          n: string,
          links: string,
          neighbours: string | null,
          more: string | null,
      ) => string

      Position and links of the focused node; neighbours null without links, more null when all listed

    • summary: (
          chart: string,
          nodes: string,
          categories: string | null,
          links: string,
          top: string | null,
      ) => string

      Summary: categories null without any, top = the most linked nodes (null without links)

    • topItem: (name: string, links: string) => string

      One of the most linked nodes

    hierarchy: {
        children: (n: number, count: string) => string;
        columns: (n: number, count: string) => string;
        drillHint: (children: string) => string;
        drillPath: string;
        flowItem: (source: string, target: string, value: string) => string;
        inflow: (value: string) => string;
        linkAnnounce: (
            source: string,
            target: string,
            value: string,
            share: string | null,
            i: string,
            n: string,
        ) => string;
        links: (n: number, count: string) => string;
        nodeAnnounce: (
            name: string,
            value: string,
            share: string | null,
            parent: string,
        ) => string;
        nodePosition: (i: string, n: string, level: string) => string;
        nodes: (n: number, count: string) => string;
        ofParent: (share: string) => string;
        ofSource: (share: string, source: string) => string;
        ofTotal: (share: string) => string;
        outflow: (value: string) => string;
        path: string;
        rootLabel: string;
        sankeyHelp: string;
        sankeyName: string;
        sankeyNode: (
            name: string,
            value: string,
            inflow: string,
            outflow: string,
        ) => string;
        sankeySummary: (
            chart: string,
            nodes: string,
            columns: string,
            links: string,
            largest: string | null,
        ) => string;
        sentenceSeparator: string;
        shareOfParent: string;
        shareOfSource: string;
        shareOfTotal: string;
        source: string;
        sunburstName: string;
        target: string;
        titled: (title: string, text: string) => string;
        treeHelp: string;
        treeItem: (
            name: string,
            value: string,
            share: string,
            children: string,
        ) => string;
        treemapName: string;
        treeSummary: (
            chart: string,
            nodes: string,
            total: string,
            at: string | null,
            largest: string,
            more: string | null,
        ) => string;
    }

    Type Declaration

    • children: (n: number, count: string) => string
    • columns: (n: number, count: string) => string
    • drillHint: (children: string) => string
    • drillPath: string

      aria-label of the breadcrumb

    • flowItem: (source: string, target: string, value: string) => string

      One flow in the sankey summary

    • inflow: (value: string) => string

      Tooltip / description inflow and outflow of a sankey node

    • linkAnnounce: (
          source: string,
          target: string,
          value: string,
          share: string | null,
          i: string,
          n: string,
      ) => string

      Focused link: share of the source node (null when undefined), position among links

    • links: (n: number, count: string) => string
    • nodeAnnounce: (name: string, value: string, share: string | null, parent: string) => string

      Focused node: share of parent (null at a root)

    • nodePosition: (i: string, n: string, level: string) => string

      Position of the focused node among its siblings and its depth

    • nodes: (n: number, count: string) => string
    • ofParent: (share: string) => string

      Tooltip shares of a treemap / sunburst node

    • ofSource: (share: string, source: string) => string

      Tooltip share of a sankey link, after its value

    • ofTotal: (share: string) => string
    • outflow: (value: string) => string
    • path: string
    • rootLabel: string

      Default name of the synthetic root above several roots (rootLabel)

    • sankeyHelp: string
    • sankeyName: string
    • sankeyNode: (name: string, value: string, inflow: string, outflow: string) => string
    • sankeySummary: (
          chart: string,
          nodes: string,
          columns: string,
          links: string,
          largest: string | null,
      ) => string

      Sankey summary; largest = the top flows (null without links)

    • sentenceSeparator: string

      Joins the sentences of an announcement

    • shareOfParent: string
    • shareOfSource: string
    • shareOfTotal: string
    • source: string
    • sunburstName: string
    • target: string
    • titled: (title: string, text: string) => string

      Chart title before the summary

    • treeHelp: string
    • treeItem: (name: string, value: string, share: string, children: string) => string

      One child of the current root: value, share of the root, child count

    • treemapName: string

      Summary chart names

    • treeSummary: (
          chart: string,
          nodes: string,
          total: string,
          at: string | null,
          largest: string,
          more: string | null,
      ) => string

      Treemap / sunburst summary: at = drilled path (null at the top), largest = the top children with shares, more = count of the other children (null when none)

    parallel: {
        announce: (
            axis: string,
            series: string | null,
            row: string,
            total: string,
            values: string,
            outside: boolean,
        ) => string;
        brushed: (name: string, ranges: string) => string;
        dimCategories: (name: string, count: string, list: string) => string;
        dimEmpty: (name: string) => string;
        dimensions: (n: number, count: string) => string;
        dimRange: (name: string, lo: string, hi: string) => string;
        help: (vertical: boolean) => string;
        pair: (name: string, value: string) => string;
        rowLabel: (series: string | null, row: string) => string;
        rows: (n: number, count: string) => string;
        summary: (
            chart: string,
            rows: string,
            dims: string,
            series: string | null,
            active: string | null,
        ) => string;
    }

    Type Declaration

    • announce: (
          axis: string,
          series: string | null,
          row: string,
          total: string,
          values: string,
          outside: boolean,
      ) => string

      Focused row: the focused axis value first, then every dimension

    • brushed: (name: string, ranges: string) => string

      Description sentence of the brush on one dimension (ranges joined)

    • dimCategories: (name: string, count: string, list: string) => string

      Description sentence of a category dimension (list = the first names)

    • dimEmpty: (name: string) => string
    • dimensions: (n: number, count: string) => string
    • dimRange: (name: string, lo: string, hi: string) => string

      Description sentence of a value / time dimension

    • help: (vertical: boolean) => string
    • pair: (name: string, value: string) => string

      name value pair of a dimension

    • rowLabel: (series: string | null, row: string) => string

      Row label: series null for one series

    • rows: (n: number, count: string) => string
    • summary: (
          chart: string,
          rows: string,
          dims: string,
          series: string | null,
          active: string | null,
      ) => string

      Summary: series null for one series, active null without a brush

    polar: {
        angle: string;
        announce: (series: string, pairs: string, position: string) => string;
        categories: (n: number, count: string) => string;
        help: string;
        pair: (name: string, value: string) => string;
        radius: string;
        range: (lo: string, hi: string) => string;
        seriesHidden: (name: string, type: string) => string;
        seriesName: (i: number) => string;
        seriesText: (
            name: string,
            type: string,
            items: string,
            range: string | null,
        ) => string;
        summary: (
            chart: string,
            series: string,
            angle: string,
            radius: string,
        ) => string;
        type: { bar: string; heatmap: string; line: string; scatter: string };
    }

    Type Declaration

    • angle: string
    • announce: (series: string, pairs: string, position: string) => string
    • categories: (n: number, count: string) => string
    • help: string
    • pair: (name: string, value: string) => string

      name value pair

    • radius: string
    • range: (lo: string, hi: string) => string
    • seriesHidden: (name: string, type: string) => string
    • seriesName: (i: number) => string
    • seriesText: (name: string, type: string, items: string, range: string | null) => string

      Description sentence of a series (range null without data)

    • summary: (chart: string, series: string, angle: string, radius: string) => string
    • type: { bar: string; heatmap: string; line: string; scatter: string }

      Series type names (description)

    sparkline: {
        flat: (value: string) => string;
        flatRange: (value: string, min: string, max: string) => string;
        labelled: (name: string, text: string) => string;
        loss: string;
        losses: (n: number, count: string) => string;
        tie: string;
        ties: (n: number, count: string) => string;
        trendDown: (
            pct: string | null,
            from: string,
            to: string,
            min: string,
            max: string,
        ) => string;
        trendUp: (
            pct: string | null,
            from: string,
            to: string,
            min: string,
            max: string,
        ) => string;
        win: string;
        winLossLast: (tally: string, last: string) => string;
        wins: (n: number, count: string) => string;
    }

    Type Declaration

    • flat: (value: string) => string

      Single value, or first = last

    • flatRange: (value: string, min: string, max: string) => string
    • labelled: (name: string, text: string) => string

      name: text (the aria-label head)

    • loss: string
    • losses: (n: number, count: string) => string
    • tie: string
    • ties: (n: number, count: string) => string
    • trendDown: (
          pct: string | null,
          from: string,
          to: string,
          min: string,
          max: string,
      ) => string
    • trendUp: (
          pct: string | null,
          from: string,
          to: string,
          min: string,
          max: string,
      ) => string

      Rising / falling trend; pct is the absolute change without % (null when undefined)

    • win: string
    • winLossLast: (tally: string, last: string) => string

      Win / loss tally followed by the latest result

    • wins: (n: number, count: string) => string
    tree: {
        collapsed: string;
        depth: string;
        expanded: string;
        help: string;
        item: (name: string, value: string | null, children: string) => string;
        leaf: string;
        levels: (n: number, count: string) => string;
        nodeAnnounce: (
            name: string,
            value: string | null,
            state: string | null,
        ) => string;
        state: (state: string, children: string) => string;
        stateHeader: string;
        summary: (
            chart: string,
            nodes: string,
            levels: string,
            shown: string,
            root: string,
            top: string | null,
            more: string | null,
        ) => string;
        toggleHint: (expanded: boolean) => string;
        treeName: string;
    }

    Type Declaration

    • collapsed: string
    • depth: string
    • expanded: string
    • help: string
    • item: (name: string, value: string | null, children: string) => string

      Description sentence per top-level child

    • leaf: string
    • levels: (n: number, count: string) => string
    • nodeAnnounce: (name: string, value: string | null, state: string | null) => string

      Focused node: value null without one, state = expanded / collapsed with its children (null for leaves)

    • state: (state: string, children: string) => string

      State with the child count, e.g. collapsed, 3 children

    • stateHeader: string
    • summary: (
          chart: string,
          nodes: string,
          levels: string,
          shown: string,
          root: string,
          top: string | null,
          more: string | null,
      ) => string

      Summary: shown = visible node count, top = the root's first children (null for none), more = the others (null when none)

    • toggleHint: (expanded: boolean) => string
    • treeName: string

      Summary chart name