@spalger/kibana/src/ui/public/Vis/Renderbot.js

Kibana is an open source (Apache Licensed), browser based analytics and search dashboard for Elasticsearch. Kibana is a snap to setup and start using. Kibana strives to be easy to get started with, while also being flexible and powerful, just like Elastic

define(function (require) {
  var _ = require('lodash');

  return function RenderbotFactory(Private) {

    /**
     * "Abstract" renderbot class which just defines the expected API
     *
     * @param {Vis} vis - the vis object that contains all configuration data required to render the vis
     * @param {jQuery<DOMElement>} $el - a jQuery wrapped element to render into
     */
    function Renderbot(vis, $el) {
      this.vis = vis;
      this.$el = $el;
    }

    /**
     * Each renderbot should implement a #render() method which
     * should accept an elasticsearch response and update the underlying visualization
     *
     * @override
     * @param {object} esResp - The raw elasticsearch response
     * @return {undefined}
     */
    Renderbot.prototype.render = function (esResp) {
      throw new Error('not implemented');
    };

    /**
     * Each renderbot should implement the #destroy() method which
     * should tear down the owned element, remove event listeners, etc.
     *
     * @override
     * @return {undefined}
     */
    Renderbot.prototype.destroy = function () {
      throw new Error('not implemented');
    };

    /**
     * Each renderbot can optionally implement the #updateParams() method which
     * is used to pass in new vis params. It should not re-render the vis
     *
     * @override
     * @return {undefined}
     */
    Renderbot.prototype.updateParams = _.noop;

    return Renderbot;
  };
});