Skip to content

Latest commit

 

History

History
59 lines (46 loc) · 2.13 KB

README.md

File metadata and controls

59 lines (46 loc) · 2.13 KB
Raw

PlayerProto

Santiago Player prototype

Initial implementation and simple demo pages illustrating usage of the following widgets:

  • SVG Widgets
    • LineGraph
    • BarChart
    • LabelGroup
    • Image
    • CaptionedImage
    • Carousel
    • Sketch
    • Markers (still on old framework)
    • Pie Charts (still on old framework)
    • Legends
  • HTML Widgets
    • Button
    • Slider
    • RadioButton
    • Callout

The widgets are implemented in Javascript, and are largely based on the d3 DOM manipulation framework.

Coding Style

Currently we are mostly using google's Javascript Style Guide but with an exception for opening curly braces on their own line rather than at the end of the previous statement (because I (mike) have an extreme preference).

We are also using jsdoc comments sort of a mix of google's closure compiler doc and jsdoc 3.

In addition, declare each local variable w/ its own var, don't declare multiple variables with one var separated by commas. This rule comes from my c++ days, but I think it improves maintainability even in javascript.

Similarly, the then (and else) portion of the if statement should always be on its own line and enclosed in curly braces. The arguments go back and forth, but if it prevents some merge errors it's worth the verbosity.

We do need some framework that will provide OOP but have not selected one yet. In particular our need is to be able to provide base class functionality overridden by derived classes only when necessary.

== Useful references ==