Skip to content

Latest commit

 

History

History
92 lines (70 loc) · 3.27 KB

README.md

File metadata and controls

92 lines (70 loc) · 3.27 KB
Raw

Introduction

Custom Visualizations for Looker in TypeScript with Highcharts/d3

Build Development Environment

The development environment is built off of Webpack / webpack-dev-server. This means that you will have a node server running in the background so you should have nodejs installed.

Start the server
  1. run npm install
  2. run npm run webpack or start the script labeled webpack-dev-server in the package.json

Developing a Custom Visualization locally

  1. Add a TypeScript file in the visualizations directory
  2. Referencing the Boiler Plate Code below, create your basic Visualization
  3. Add the reference to your newly created custom Visualization file in the webpack.config.js file (follow the same setup for forecasting.ts)
  4. Start the server (See Start the server)

Adding a reference to the locally hosted visualization

  1. Go to the Admin Page in Looker

  2. Go to the Visualizations page and add a new visualization with the local url reference to the file

Build for Production

  1. Add the entry file path to the webpack.config.js (Follow same pattern as forecast.ts entry in webpack.config.js)
  2. run webpack
  3. Upload your custom visualization code (ie: /dist/my-custom-viz.js) to Wherever you store your code. Note that this should be accessable by Looker.
  4. Go to the Admin Page in Looker to add your Visualization
  5. Select the Visualization you want to use in the dropdown on the Explore to use it.

Boiler Plate Code

import { Looker, VisualizationDefinition } from '../common/types';
import { handleErrors } from '../common/utils';

declare var looker: Looker;

interface WhateverNameYouWantVisualization extends VisualizationDefinition {
    elementRef?: HTMLDivElement,
}

const vis: WhateverNameYouWantVisualization = {
    id: 'someId', // id/label not required, but nice for testing and keeping manifests in sync
    label: 'Some Label',
    options: {
        title: {
            type: 'string',
            label: 'Title',
            display: 'text',
            default: 'Some Name'
        }
    },
    // Set up the initial state of the visualization
    create(element, config) {
        this.elementRef = element;
    },
    // Render in response to the data or settings changing
    update(data, element, config, queryResponse) {
        console.log( 'data', data );
        console.log( 'element', element );
        console.log( 'config', config );
        console.log( 'queryResponse', queryResponse );
        const errors = handleErrors(this, queryResponse, {
            min_pivots: 0,
            max_pivots: 0,
            min_dimensions: 1,
            max_dimensions: 1,
            min_measures: 1,
            max_measures: 1
        });
        if (errors) { // errors === true means no errors
            // TODO: Do stuff here
        }
    }
};

looker.plugins.visualizations.add(vis);

General Info