@checksub_team/peaks_timeline 1.4.17

package/src/segment.js

@@ -0,0 +1,229 @@
+/**
+ * @file
+ *
+ * Defines the {@link Segment} class.
+ *
+ * @module segment
+ */
+
+define([
+  './utils'
+], function(Utils) {
+  'use strict';
+
+  function validateSegment(peaks, options, context) {
+    if (!Utils.isValidTime(options.startTime)) {
+      // eslint-disable-next-line max-len
+      throw new TypeError('peaks.segments.' + context + ': startTime should be a valid number');
+    }
+
+    if (!Utils.isValidTime(options.endTime)) {
+      // eslint-disable-next-line max-len
+      throw new TypeError('peaks.segments.' + context + ': endTime should be a valid number');
+    }
+
+    options.startTime = Utils.roundTime(options.startTime);
+    options.endTime = Utils.roundTime(options.endTime);
+
+    if (options.startTime < 0) {
+      options.startTime = 0;
+    }
+
+    if (options.endTime < 0) {
+      options.endTime = 0;
+    }
+    else if (options.endTime < options.startTime + peaks.options.minSegmentSize) {
+      options.endTime = options.startTime + peaks.options.minSegmentSize;
+    }
+
+    options.startTime = Utils.roundTime(options.startTime);
+    options.endTime = Utils.roundTime(options.endTime);
+
+    // if (options.endTime <= options.startTime) {
+    //   // eslint-disable-next-line max-len
+    //   throw new RangeError(
+    //     'peaks.segments.' + context + ': endTime should be greater than startTime'
+    //   );
+    // }
+
+    if (options.opacity < 0 || options.opacity > 1) {
+      // eslint-disable-next-line max-len
+      throw new RangeError('peaks.segments.' + context + ': opacity should be between 0 and 1');
+    }
+
+    if (Utils.isNullOrUndefined(options.labelText)) {
+      // Set default label text
+      options.labelText = '';
+    }
+    else if (!Utils.isString(options.labelText)) {
+      throw new TypeError('peaks.segments.' + context + ': labelText must be a string');
+    }
+  }
+
+  /**
+   * A segment is a region of time, with associated label and color.
+   *
+   * @class
+   * @alias Segment
+   *
+   * @param {Peaks} peaks A reference to the Peaks instance.
+   * @param {String} id A unique identifier for the segment.
+   * @param {Number} startTime Segment start time, in seconds.
+   * @param {Number} endTime Segment end time, in seconds.
+   * @param {String} labelText Segment label text.
+   * @param {String} color Segment waveform color.
+   * @param {Number} opacity Segment waveform opacity.
+   * @param {Boolean} editable If <code>true</code> the segment start and
+   *   end times can be adjusted via the user interface.
+   */
+
+  function Segment(peaks, id, startTime, endTime, labelText, color,
+    textColor, handleTextColor, opacity, editable) {
+    var opts = {
+      startTime:       startTime,
+      endTime:         endTime,
+      labelText:       labelText,
+      color:           color,
+      textColor:       textColor,
+      handleTextColor: handleTextColor,
+      opacity:         opacity,
+      editable:        editable
+    };
+
+    validateSegment(peaks, opts, 'add()');
+
+    this._peaks           = peaks;
+    this._id              = id;
+    this._startTime       = opts.startTime;
+    this._endTime         = opts.endTime;
+    this._labelText       = opts.labelText;
+    this._color           = opts.color;
+    this._selectedColor   = Utils.shadeColor(color, 20);
+    this._textColor       = opts.textColor;
+    this._handleTextColor = opts.handleTextColor;
+    this._opacity         = opts.opacity;
+    this._editable        = opts.editable;
+    this._minSize         = peaks.options.minSegmentSize;
+  }
+
+  Object.defineProperties(Segment.prototype, {
+    id: {
+      enumerable: true,
+      get: function() {
+        return this._id;
+      }
+    },
+    startTime: {
+      enumerable: true,
+      get: function() {
+        return this._startTime;
+      },
+
+      set: function(time) {
+        this._startTime = Utils.roundTime(time);
+      }
+    },
+    endTime: {
+      enumerable: true,
+      get: function() {
+        return this._endTime;
+      },
+
+      set: function(time) {
+        this._endTime = Utils.roundTime(time);
+      }
+    },
+    labelText: {
+      enumerable: true,
+      get: function() {
+        return this._labelText;
+      }
+    },
+    color: {
+      enumerable: true,
+      get: function() {
+        return this._color;
+      }
+    },
+    selectedColor: {
+      enumerable: true,
+      get: function() {
+        return this._selectedColor;
+      }
+    },
+    textColor: {
+      enumerable: true,
+      get: function() {
+        return this._textColor;
+      }
+    },
+    handleTextColor: {
+      enumerable: true,
+      get: function() {
+        return this._handleTextColor;
+      }
+    },
+    opacity: {
+      enumerable: true,
+      get: function() {
+        return this._opacity;
+      }
+    },
+    editable: {
+      enumerable: true,
+      get: function() {
+        return this._editable;
+      }
+    },
+    minSize: {
+      enumerable: true,
+      get: function() {
+        return this._minSize;
+      }
+    }
+  });
+
+  Segment.prototype.update = function(options) {
+    var opts = {
+      startTime:       this.startTime,
+      endTime:         this.endTime,
+      labelText:       this.labelText,
+      color:           this.color,
+      textColor:       this.textColor,
+      handleTextColor: this.handleTextColor,
+      opacity:         this.opacity,
+      editable:        this.editable
+    };
+
+    Utils.extend(opts, options);
+
+    validateSegment(this._peaks, opts, 'update()');
+
+    this._startTime       = opts.startTime;
+    this._endTime         = opts.endTime;
+    this._labelText       = opts.labelText;
+    this._color           = opts.color;
+    this._textColor       = opts.textColor;
+    this._handleTextColor = opts.handleTextColor;
+    this._opacity         = opts.opacity;
+    this._editable        = opts.editable;
+
+    this._peaks.emit('segment.updated', this);
+  };
+
+  /**
+   * Returns <code>true</code> if the segment overlaps a given time region.
+   *
+   * @param {Number} startTime The start of the time region, in seconds.
+   * @param {Number} endTime The end of the time region, in seconds.
+   * @returns {Boolean}
+   *
+   * @see http://wiki.c2.com/?TestIfDateRangesOverlap
+   */
+
+  Segment.prototype.isVisible = function(startTime, endTime) {
+    return this.startTime < endTime && startTime < this.endTime;
+  };
+
+  return Segment;
+});