Merge pull request #1 from metrica-sports/fran/add-frame-support

Add frame support
metrica-sports · Jun 24, 2023 · 00d8c61 · 00d8c61
2 parents f289fc9 + b1b1405
commit 00d8c61
Show file tree

Hide file tree

Showing 14 changed files with 322 additions and 35 deletions.
diff --git a/.vscode/launch.json b/.vscode/launch.json
@@ -34,6 +34,23 @@
         ],
         "console": "integratedTerminal",
         "internalConsoleOptions": "neverOpen"
-    }
+    },
+    {
+      "type": "node",
+      "request": "launch",
+      "name": "Test",
+      "program": "${workspaceFolder}/node_modules/mocha/bin/_mocha",
+      "args": [
+          "--exit",
+          "--timeout",
+          "999999",
+          "--colors",
+          "--require",
+          "vis-dev-utils/babel-register",
+          "${workspaceFolder}/test"
+      ],
+      "console": "integratedTerminal",
+      "internalConsoleOptions": "neverOpen"
+  }
   ]
 }
diff --git a/docs/graph2d/index.html b/docs/graph2d/index.html
@@ -867,6 +867,7 @@ <h3 id="timelineOptions">Timeline Options</h3>
       <pre class="prettyprint lang-js">{
   minorLabels: {
     millisecond:'SSS',
+    frame:      'SSS',
     second:     's',
     minute:     'HH:mm',
     hour:       'HH:mm',
@@ -878,6 +879,7 @@ <h3 id="timelineOptions">Timeline Options</h3>
   },
   majorLabels: {
     millisecond:'HH:mm:ss',
+    frame:      'HH:mm:ss,
     second:     'D MMMM HH:mm',
     minute:     'ddd D MMMM',
     hour:       'ddd D MMMM',

diff --git a/docs/timeline/index.html b/docs/timeline/index.html
@@ -640,6 +640,7 @@ <h2 id="Configuration_Options">Configuration Options</h2>
       <pre class="prettyprint lang-js">{
   minorLabels: {
     millisecond:'SSS',
+    frame:      'SSS',
     second:     's',
     minute:     'HH:mm',
     hour:       'HH:mm',
@@ -651,6 +652,7 @@ <h2 id="Configuration_Options">Configuration Options</h2>
   },
   majorLabels: {
     millisecond:'HH:mm:ss',
+    frame:      'HH:mm:ss',
     second:     'D MMMM HH:mm',
     minute:     'ddd D MMMM',
     hour:       'ddd D MMMM',

diff --git a/lib/timeline/Graph2d.js b/lib/timeline/Graph2d.js
@@ -81,6 +81,10 @@ function Graph2d (container, items, groups, options) {
       getStep() {
         return me.timeAxis.step.step;
       },
+      getMillisecondsPerFrame() {
+        return me.timeAxis.step.millisecondsPerFrame;
+      },
+
 
       toScreen: me._toScreen.bind(me),
       toGlobalScreen: me._toGlobalScreen.bind(me), // this refers to the root.width
@@ -362,6 +366,45 @@ Graph2d.prototype.getEventProperties = function (event) {
   }
 };
 
+/**
+   * Convert a datetime (Date object) into a position on the screen
+   * @param {Date}   time A date
+   * @return {int}   x    The position on the screen in pixels which corresponds
+   *                      with the given date.
+   */
+Graph2d.prototype.toScreen = function (time) {
+  return this.body.util.toScreen(time)
+};
+
+/**
+ * Convert a datetime (Date object) into a position on the root
+ * This is used to get the pixel density estimate for the screen, not the center panel
+ * @param {Date}   time A date
+ * @return {int}   x    The position on root in pixels which corresponds
+ *                      with the given date.
+ */
+Graph2d.prototype.toGlobalScreen = function (time) {
+  return this.body.util.toGlobalScreen(time)
+};
+
+/**
+ * Convert a position on screen (pixels) to a datetime
+ * @param {int}     x    Position on the screen in pixels
+ * @return {Date}   time The datetime the corresponds with given position x
+ */
+Graph2d.prototype.toTime = function (x) {
+  return this.body.util.toTime(x)
+};
+
+/**
+ * Convert a position on the global screen (pixels) to a datetime
+ * @param {int}     x    Position on the screen in pixels
+ * @return {Date}   time The datetime the corresponds with given position x
+ */
+Graph2d.prototype.toGlobalTime = function (x) {
+  return this.body.util.toGlobalTime(x)
+};
+
 /**
  * Load a configurator
  * @return {Object}