PaperCube Reference Documentation

Last updated 11/23/2009 by Peter Bergström (pbergstr@gmail.com)

This is the PaperCube reference documentation. If you are interested in viewing the NodeGraph framework's documentation, please click here. Also, please look at the PaperCube GitHub project.

Overview

Globals
Controllers
Models
Views

Globals

`adaptor.js`	The server communication interface.
`core.js`	Defines the PaperCube namespace.
`main.js`	Starts the PaperCube application.

Controllers

`authorpaper.js`	Controls the display parameters for the Author's Paper view.
`authorstat.js`	Controls the display parameters for the Author Stat view.
`canvas.js`	This controls the canvas, the canvas is a viewport that allows views to be resolution independent. This is done by keeping track of various zooming parameters and communicating this to the zoomView (preview pane) and the core view that is being used.
`circleview.js`	Controls the display parameters for Circle View.
`cite_ref.js`	Controls the display parameters for the Author Cites and References view.
`collaborator.js`	Controls the display parameters for the Collaborators view.
`papergraph.js`	Controls the display parameters for the Paper Graph view.
`papersperyear.js`	Controls the display parameters for the Papers Per Year view.
`papertree.js`	Controls the display parameters for the Paper Tree Map view.
`search.js`	Handles searching of papers and authors.
`view.js`	This controller controls what view is currently being shown. There are two dimensions, the type of object being visualized (ie. Authors or Papers) and the type of view that we're showing (ie. CircleView or TreeView).

Models

`author.js`	The Author content object.
`paper.js`	The Paper content object.

Views

`author_paper.js`	The Author's Paper view implementation that extends the NodeGraph view.
`author_stat.js`	The Author Stat view implementation.
`circleviewhtml.js`	The Circle View implementation.
`cite_ref.js`	The Author Cites and References view implementation that extends the NodeGraph view.
`collaborator.js`	The Collaborators view implementation that extends the NodeGraph view.
`depth_button.js`	The depth slider and buttons for altering the display parameters of a view.
`dropdown.js`	The drop down menu implementation.
`left.js`	The view that contains the left-hand side view that shows the search results and search form.
`link_strength_button.js`	The link strength slider and buttons for altering the display parameters of a view.
`papergraph.js`	The Paper Graph view implementation.
`papers_per_year.js`	The Papers Per Year view implementation.
`paperstat.js`	The Papers Stat view implementation.
`paperstatlist.js`	The list of stats used in the Papers Stat view.
`papertree.js`	Controls the display parameters for the Paper Tree Map view.
`saveditemscollection.js`	The collection view showing the saved items.
`saveditemsitem.js`	The item view for the saved items collection view.
`searchresultscollection.js`	The collection view showing the search results from the server.
`searchresultsitem.js`	The item view for the search results collection view.
`viewselect.js`	The view select drop down. Extends the Papercube.DropDownView.
`zoom.js`	The zoom preview view.
`zoombutton.js`	The zoom button and sliders.

Documentation generated by JsDoc Toolkit 2.0.2 on Sat Nov 21 2009 21:24:40 GMT-0800 (PST)