Highcharts Dashboards
    Preparing search index...

    Interface GoogleSheetsConnectorOptions

    Options of the GoogleSheetsConnector.

    interface GoogleSheetsConnectorOptions {
        beforeParse?: GoogleSheetsBeforeParseCallbackFunction;
        dataModifier?:
            | ChainModifierOptions
            | SortModifierOptions
            | FilterModifierOptions
            | RangeModifierOptions
            | InvertModifierOptions
            | MathModifierOptions;
        dataRefreshRate?: number;
        dataTables?: GoogleSheetsDataTableConnectorOptions[];
        enablePolling?: boolean;
        endColumn?: number;
        endRow?: number;
        firstRowAsNames?: boolean;
        googleAPIKey: string;
        googleSpreadsheetKey: string;
        googleSpreadsheetRange?: string;
        id: string;
        metadata?: Metadata;
        startColumn?: number;
        startRow?: number;
        type: "GoogleSheets";
    }

    Hierarchy (View Summary)

    Index

    Properties

    beforeParse? dataModifier? dataRefreshRate? dataTables? enablePolling? endColumn? endRow? firstRowAsNames? googleAPIKey googleSpreadsheetKey googleSpreadsheetRange? id metadata? startColumn? startRow? type

    Properties

    beforeParse?: GoogleSheetsBeforeParseCallbackFunction

    A custom callback function that parses the data before it's being parsed to the data table format inside the converter.

    dataModifier?:
        | ChainModifierOptions
        | SortModifierOptions
        | FilterModifierOptions
        | RangeModifierOptions
        | InvertModifierOptions
        | MathModifierOptions
    dataRefreshRate?: number

    The rate in seconds for polling for live data. Note that polling requires the option enablePolling to be true.

    dataTables?: GoogleSheetsDataTableConnectorOptions[]

    Allows defining multiple data tables within a single connector to adjust options or data parsing in various ways based on the same data source.

    dataPool: {
        connectors: [{
            id: 'data-connector',
            type: 'JSON',
            data: {
                kpis: { a: 1, b: 2 },
                more: {
                    alpha: [1, 2, 3, 4, 5],
                    beta: [10, 20, 30, 40, 50]
                }
            },
            dataTables: [{
                key: 'more',
                beforeParse: function ({ more }) {
                    const keys = Object.keys(more);
                    return [
                        keys,
                        ...more[keys[0]].map((_, index) =>
                            keys.map(key => more[key][index])
                        )
                    ];
                }
            }, {
                key: 'kpis',
                firstRowAsNames: false,
                columnIds: ['a', 'b'],
                beforeParse: function ({ kpis }) {
                    return [[kpis.a, kpis.b]];
                },
                dataModifier: {
                    type: 'Math',
                    columnFormulas: [{
                        column: 'c',
                        formula: 'A1+B1'
                    }]
                }
            }]
        }]
    }
    enablePolling?: boolean

    Whether to enable polling for live data.

    endColumn?: number

    The number of the last column to load.

    endRow?: number

    The number of the last row to load.

    firstRowAsNames?: boolean

    Whether to treat the first row of the data set as series names.

    googleAPIKey: string

    The API key for a Google Spreadsheet (user's credentials). See general information on GS.

    googleSpreadsheetKey: string

    The Google Spreadsheet key that identifies the sheet to use. See general information on googleSpreadsheetKey. The key for a sheet can be extracted from the sheet's URL https://docs.google.com/spreadsheets/d/{key}.

    googleSpreadsheetRange?: string

    The Google Spreadsheet range to use in combination with googleSpreadsheetKey. See developers.google.com for details.

    If given, it takes precedence over startColumn, endColumn, startRow and endRow.

    id: string
    metadata?: Metadata
    startColumn?: number

    The number of the first column to load.

    startRow?: number

    The number of the first row to load.

    type: "GoogleSheets"

    The corresponding connector type.

    Settings

    On This Page

    Properties