src/js/widgets/sparklineWidget.js
author hamidouk
Tue, 27 Dec 2011 10:26:02 +0100
branchpopcorn-port
changeset 532 5249bb0cd964
parent 529 3ebf62837492
child 600 4e669328ab6d
permissions -rw-r--r--
cosmetical change - moved css code from jquery.css to the stylesheet.
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
523
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
     1
/** @class The constructor for the sparkline widget */
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
     2
IriSP.SparklineWidget = function(Popcorn, config, Serializer) {
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
     3
  IriSP.Widget.call(this, Popcorn, config, Serializer);
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
     4
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
     5
  this._oldAnnotation = null;
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
     6
  
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
     7
};
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
     8
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
     9
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    10
IriSP.SparklineWidget.prototype = new IriSP.Widget();
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    11
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    12
IriSP.SparklineWidget.prototype.clear = function() {
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    13
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    14
};
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    15
524
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    16
/** draw the sparkline using jquery sparkline */
523
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    17
IriSP.SparklineWidget.prototype.draw = function() {
524
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    18
  var templ = Mustache.to_html(IriSP.SparklineWidget_template, {width: this.width, height: this.height});
523
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    19
  /** this widget uses three divs -
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    20
    the first is the sparkline, which is generated by jquery sparkline,
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    21
    the second is an overlay div to display the progression in the video,
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    22
    and the third is a div to react to clicks
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    23
  */
524
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    24
    
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    25
  /* we suppose that a column is 5 pixels wide */
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    26
  var num_columns = (this.selector.width()) / 10;
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    27
  var duration = +this._serializer.currentMedia().meta["dc:duration"];
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    28
  var time_step = duration / num_columns; /* the time interval between two columns */
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    29
  var results = [];
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    30
  var i = 0; /* the index in the loop */
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    31
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    32
  /* this algorithm makes one assumption : that the array is sorted 
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    33
     (it's done for us by the JSONSerializer). We go through the array 
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    34
     and count how many comments fall within a peculiar time piece.
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    35
     As i is preserved between each iteration, it's O(n).
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    36
  */
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    37
  for(var j = 0; j < num_columns; j++) {
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    38
    var count = 0;
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    39
    
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    40
    var annotation_begin = +(this._serializer._data.annotations[i].begin);
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    41
    
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    42
    while(annotation_begin >= j * time_step && annotation_begin <= (j + 1) * time_step ) {
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    43
      count++;
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    44
      i++;
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    45
      if (i >= this._serializer._data.annotations.length)
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    46
        break;
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    47
        
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    48
      annotation_begin = +(this._serializer._data.annotations[i].begin);
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    49
      
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    50
    }
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    51
    
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    52
    results.push(count);
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    53
  }
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    54
  
523
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    55
  this.selector.append(templ);
524
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    56
  this.selector.find(".Ldt-sparkLine").css("background", "#c7c8cc");
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    57
  this.selector.find(".Ldt-sparkLine").sparkline(results, {lineColor: "#7492b4", fillColor: "#aeaeb8",
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    58
                                                           spotColor: "#b70056",
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    59
                                                           width: this.width, height: this.height});
523
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    60
  this._Popcorn.listen("timeupdate", IriSP.wrap(this, this.timeUpdateHandler));
532
5249bb0cd964 cosmetical change - moved css code from jquery.css to the stylesheet.
hamidouk
parents: 529
diff changeset
    61
  IriSP.jQuery(".Ldt-sparkLineClickOverlay").click(IriSP.wrap(this, this.clickHandler));  
523
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    62
};
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    63
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    64
/** react to a timeupdate event */
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    65
IriSP.SparklineWidget.prototype.timeUpdateHandler = function() {
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    66
  var currentTime = this._Popcorn.currentTime();  
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    67
  var duration = +this._serializer.currentMedia().meta["dc:duration"] / 1000;
524
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    68
  var proportion = ((currentTime / duration) * 100).toFixed(4);
a06527b99f22 the sparklineWidget height and width are now parametrable.
hamidouk
parents: 523
diff changeset
    69
  
523
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    70
  IriSP.jQuery(".Ldt-sparkLinePositionMarker").css("width", proportion + "%");                                    
8dfeaec4724b first version of the sparkline widget.
hamidouk
parents:
diff changeset
    71
}
529
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    72
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    73
/** handle clicks on the widget */
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    74
IriSP.SparklineWidget.prototype.clickHandler = function(event) {
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    75
  /* this piece of code is a little bit convoluted - here's how it works :
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    76
     we want to handle clicks on the progress bar and convert those to seeks in the media.
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    77
     However, jquery only gives us a global position, and we want a number of pixels relative
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    78
     to our container div, so we get the parent position, and compute an offset to this position,
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    79
     and finally compute the progress ratio in the media.
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    80
     Finally we multiply this ratio with the duration to get the correct time
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    81
  */
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    82
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    83
  var parentOffset = this.selector.offset();
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    84
  var width = this.selector.width();
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    85
  var relX = event.pageX - parentOffset.left;
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    86
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    87
  var duration = this._serializer.currentMedia().meta["dc:duration"] / 1000;
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    88
  var newTime = ((relX / width) * duration).toFixed(2);
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    89
  
532
5249bb0cd964 cosmetical change - moved css code from jquery.css to the stylesheet.
hamidouk
parents: 529
diff changeset
    90
  
5249bb0cd964 cosmetical change - moved css code from jquery.css to the stylesheet.
hamidouk
parents: 529
diff changeset
    91
  this._Popcorn.trigger("IriSP.SparklineWidget.clicked", newTime);
529
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    92
  this._Popcorn.currentTime(newTime);                                 
3ebf62837492 react to clicks on the curve.
hamidouk
parents: 524
diff changeset
    93
};