Documentation


popoto

Popoto.js is a JavaScript library built with D3.js providing a graph based search interface generated in HTML and SVG usable on any modern browser. This library generates an interactive graph query builder into any website or web based application to create dynamic queries on Neo4j databases and display the results.

Copyright (C) 2014 - 2015 Frederic Ciminera

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see <http://www.gnu.org/licenses/>.

contact@popotojs.com

popoto is the root JavaScript object containing all of Popoto.js library features:
cypherviewer, graph, logger, provider, query, queryviewer, rest, result, taxonomy, tools


popoto.start (label)

Main function to call to use Popoto.js. This function will create all the HTML content based on the IDs available in the page.

The IDs expected in the page are defined in the following properties shown with their default values:

popoto.graph.containerId: "popoto-graph" for the graph query builder.
popoto.taxonomy.containerId: "popoto-taxonomy" for the taxonomy filter.
popoto.queryviewer.containerId: "popoto-query" for the query viewer.
popoto.cypherviewer.containerId: "popoto-cypher" for the cypher query viewer.
popoto.result.containerId: "popoto-results" for the result list.

@param label{string}: root label to use in the graph query builder.

Usage example:
/**
 * Start popoto.js generation using label "person" as root element in graph.
 */
popoto.start("person");

popoto.update ()

Function to call to update all the generated elements including svg graph, query viewer and generated results.


popoto.updateGraph ()

Function to call to update the graph only