started new metadata schema

Author: cameron-toy

src/dashboard.tsx

@@ -29,14 +29,15 @@ import { DashboardLayout } from './layout';
 
 import { DashboardWidget } from './widget';
 
-import { WidgetPosition, Widgetstore } from './widgetstore';
+import { Widgetstore, WidgetInfo } from './widgetstore';
 
 import {
   addCellId,
   addNotebookId,
   getNotebookById,
   getCellId,
-  updateMetadata
+  getMetadata,
+  addMetadataView
 } from './utils';
 
 import {
@@ -54,6 +55,8 @@ import { HTMLSelect } from '@jupyterlab/ui-components';
 
 import { UUID } from '@lumino/coreutils';
 
+import * as dbformat from './dbformat';
+
 // HTML element classes
 
 export const DASHBOARD_CLASS = 'pr-JupyterDashboard';
@@ -182,8 +185,8 @@ export class Dashboard extends Widget {
       const pos = { left, top, width, height };
 
       if (oldDashboard === this) {
-        // dragging in same dashboard.ono
-        this.updateWidget(widget, pos);
+        // dragging in same dashboard.
+        this.updateWidget(widget, { pos });
       } else {
         // dragging between dashboards
         const info: Widgetstore.WidgetInfo = {
@@ -284,9 +287,9 @@ export class Dashboard extends Widget {
 
   updateWidget(
     widget: DashboardWidget,
-    pos: Widgetstore.WidgetPosition
+    newInfo: Partial<WidgetInfo>
   ): boolean {
-    return (this.layout as DashboardLayout).updateWidget(widget, pos);
+    return (this.layout as DashboardLayout).updateWidget(widget, newInfo);
   }
 
   /**
@@ -364,7 +367,7 @@ export class Dashboard extends Widget {
     return (this.layout as DashboardLayout).createWidget(info, fit);
   }
 
-  saveToNotebookMetadata(): void {
+  saveToNotebookMetadata(name: string = 'default'): void {
     // Get a list of all notebookIds used in the dashboard.
     const widgets = toArray(this.model.widgetstore.getWidgets());
 
@@ -380,22 +383,64 @@ export class Dashboard extends Widget {
     const notebookTracker = this.model.notebookTracker;
     const notebook = getNotebookById(notebookId, notebookTracker);
 
-    updateMetadata(notebook, { hasDashboard: true });
+    const oldDashboardMetadata = getMetadata(notebook);
+    let dashboardId: string;
+
+    if ((oldDashboardMetadata as Object).hasOwnProperty('views')) {
+      const dashboardIds = Object.keys(oldDashboardMetadata.views);
+      if (dashboardIds.length != 1) {
+        throw new Error(
+          'Multiple dashboards are embedded--currently only a single embedded dashboard is supported.'
+        );
+      }
+      dashboardId = dashboardIds[0];
+    } else {
+      dashboardId = UUID.uuid4();
+    }
+
+    const cellWidth = (this.layout as DashboardLayout).tileSize;
+    // Only square dimensions are currently supported.
+    const cellHeight = cellWidth;
+
+    const dashboardView = {
+      name,
+      cellWidth,
+      cellHeight,
+      dashboardWidth: this.model.width,
+      dashboardHeight: this.model.height
+    };
+    addMetadataView(notebook, dashboardId, dashboardView);
 
     const cells = notebook.content.widgets;
 
-    const widgetMap = new Map<string, WidgetPosition>(
-      widgets.map(widget => [widget.cellId, widget.pos])
+    const widgetMap = new Map<string, WidgetInfo>(
+      widgets.map(widget => [widget.cellId, widget])
     );
 
     each(cells, cell => {
       const cellId = getCellId(cell);
-      const pos = widgetMap.get(cellId);
-      if (pos != null) {
-        updateMetadata(cell, { pos, hidden: false });
-      } else {
-        updateMetadata(cell, { hidden: true });
+      const info = widgetMap.get(cellId);
+      let view: Partial<dbformat.ICellView> = { hidden: true };
+
+      if (info != null) {
+        let { pos, snapToGrid } = info;
+        let { left, top, width, height } = pos;
+        let adjustedPos = !snapToGrid ? pos : {
+          left: left / cellWidth,
+          top: top / cellHeight,
+          width: width / cellWidth,
+          height: height / cellHeight
+        };
+
+        view = {
+          hidden: false,
+          name,
+          pos: adjustedPos,
+          snapToGrid: snapToGrid
+        };
       }
+
+      addMetadataView(cell, dashboardId, view);
     });
 
     notebook.context.save();

src/dbformat.ts

@@ -1,5 +1,7 @@
 import { PartialJSONObject } from '@lumino/coreutils';
 
+import { WidgetPosition } from './widgetstore';
+
 export const DASHBOARD_VERSION = 1;
 
 /**
@@ -55,3 +57,29 @@ export interface IOutputInfo extends PartialJSONObject {
     height: number;
   };
 }
+
+export interface ICellView {
+  name: string;
+  pos: WidgetPosition,
+  hidden: boolean,
+  snapToGrid: boolean,
+}
+
+export interface ICellMetadataFormat {
+  id: string;
+  views: { [id: string]: ICellView }
+}
+
+export interface IDashboardView {
+  name: string;
+  cellWidth: number;
+  cellHeight: number;
+  dashboardWidth: number;
+  dashboardHeight: number;
+}
+
+
+export interface INBMetadataFormat {
+  id: string;
+  views: { [id: string]: IDashboardView }
+}

src/index.ts

@@ -591,7 +591,23 @@ function addCommands(
     execute: args => {
       const notebook = notebookTracker.currentWidget;
       const notebookMetadata = getMetadata(notebook);
+      if (!('views' in notebookMetadata)) {
+        throw new Error('No views in notebook');
+      }
       const notebookId = notebookMetadata.id;
+      let dashboardId: string;
+      if (args.id != null) {
+        dashboardId = args.id as string;
+        if (!(notebookMetadata.views as Object).hasOwnProperty(dashboardId)) {
+          throw new Error(`Dashboard id ${dashboardId} doesn't exist in notebook ${notebookId}`);
+        }
+      } else {
+        dashboardId = Object.keys(notebookMetadata.views)[0]
+      }
+
+      const dashboardView = notebookMetadata.views[dashboardId];
+      const { cellHeight, cellWidth, dashboardHeight, dashboardWidth } = dashboardView;
+
       const cells = notebook.content.widgets;
 
       const widgetstore = new Widgetstore({ id: 0, notebookTracker });
@@ -600,12 +616,23 @@ function addCommands(
 
       for (const cell of cells) {
         const metadata = getMetadata(cell);
-        if (metadata !== undefined && !metadata.hidden) {
+        if (metadata !== undefined && !metadata.views[dashboardId].hidden) {
+          let { pos, snapToGrid } = metadata.views[dashboardId];
+          let { left, top, width, height } = pos;
+
+          let adjustedPos = !snapToGrid ? pos : {
+            left: left * cellWidth,
+            top: top * cellHeight,
+            width: width * cellWidth,
+            height: height * cellHeight
+          };
+
           const widgetInfo: WidgetInfo = {
             widgetId: DashboardWidget.createDashboardWidgetId(),
             notebookId,
             cellId: metadata.id,
-            pos: metadata.pos
+            snapToGrid,
+            pos: adjustedPos
           };
           widgetstore.addWidget(widgetInfo);
         }
@@ -623,6 +650,10 @@ function addCommands(
         model
       });
 
+      dashboard.model.width = dashboardWidth;
+      dashboard.model.height = dashboardHeight;
+      (dashboard.layout as DashboardLayout).setTileSize(cellHeight);
+
       dashboard.updateLayoutFromWidgetstore();
       dashboard.model.mode = 'present';
 
@@ -631,8 +662,8 @@ function addCommands(
     isEnabled: args => {
       const notebook = notebookTracker.currentWidget;
       const metadata = getMetadata(notebook);
-      if (metadata !== undefined && metadata.hasDashboard !== undefined) {
-        return metadata.hasDashboard;
+      if (metadata !== undefined) {
+        return true
       }
       return false;
     }

src/layout.ts

@@ -8,7 +8,7 @@ import { MessageLoop, Message } from '@lumino/messaging';
 
 import { DashboardWidget } from './widget';
 
-import { Widgetstore, WidgetSchema, WidgetPosition } from './widgetstore';
+import { Widgetstore, WidgetSchema, WidgetInfo, WidgetPosition } from './widgetstore';
 
 import { WidgetTracker } from '@jupyterlab/apputils';
 
@@ -240,12 +240,12 @@ export class DashboardLayout extends Layout {
       }
       this.attachWidget(widget);
 
-      const { id, notebookId, cellId } = widget;
+      const { id, notebookId, cellId, snapToGrid } = widget;
 
       const ignore = !this._signalChanges;
 
       widget.ready.connect(() => {
-        this._updateWidget(widget, widget.pos, false);
+        this._updateWidget(widget, { pos: widget.pos }, false);
         this.fixOverlaps(widget);
         this._outputTracker.add(widget);
 
@@ -255,6 +255,7 @@ export class DashboardLayout extends Layout {
           widgetId: id,
           notebookId,
           cellId,
+          snapToGrid,
           ignore
         };
 
@@ -275,14 +276,14 @@ export class DashboardLayout extends Layout {
    */
   updateWidget(
     widget: DashboardWidget,
-    pos: Widgetstore.WidgetPosition
+    newInfo: Partial<WidgetInfo>
   ): boolean {
     const wasInBatch = this.inBatch;
     if (!wasInBatch) {
       this.startBatch();
     }
 
-    const success = this._updateWidgetHelper(widget, pos);
+    const success = this._updateWidgetHelper(widget, newInfo);
 
     if (!wasInBatch) {
       this.endBatch();
@@ -308,14 +309,15 @@ export class DashboardLayout extends Layout {
    */
   private _updateWidgetHelper(
     widget: DashboardWidget,
-    pos: Widgetstore.WidgetPosition,
+    newInfo: Partial<WidgetInfo>,
     fixOverlaps = true
   ): boolean {
-    const success = this._updateWidget(widget, pos, fixOverlaps);
+    const success = this._updateWidget(widget, newInfo, fixOverlaps);
     if (success) {
       const change: IDashboardChange = {
-        type: 'move',
+        type: 'update',
         widgetId: widget.id,
+        snapToGrid: widget.snapToGrid,
         pos: widget.pos
       };
       this.signalChange(change);
@@ -341,7 +343,7 @@ export class DashboardLayout extends Layout {
    */
   private _updateWidget(
     widget: DashboardWidget,
-    pos: Widgetstore.WidgetPosition,
+    newInfo: Partial<WidgetInfo>,
     fixOverlaps = true
   ): boolean {
     // Get the item from the map.
@@ -352,7 +354,12 @@ export class DashboardLayout extends Layout {
       return false;
     }
 
-    let { left, top, width, height } = pos;
+    // Just changing snap-to-grid status.
+    if (newInfo.pos == null) {
+      return true
+    }
+
+    let { left, top, width, height } = newInfo.pos;
 
     // Constrain the widget to the dashboard dimensions.
     if (this._width !== 0 && left + width > this._width) {
@@ -499,7 +506,7 @@ export class DashboardLayout extends Layout {
       }
 
       // Widget was moved or resized; update.
-      this.updateWidget(item.widget as DashboardWidget, pos);
+      this.updateWidget(item.widget as DashboardWidget, { pos });
     }
   }
 
@@ -627,7 +634,7 @@ export class DashboardLayout extends Layout {
       this._expandCanvas(type, widthDiff);
     }
 
-    this._updateWidget(widget, newPos);
+    this._updateWidget(widget, { pos: newPos });
   }
 
   /**
@@ -682,7 +689,7 @@ export class DashboardLayout extends Layout {
           const widget = _widget as DashboardWidget;
           const pos = widget.pos;
           pos.left += amount;
-          this._updateWidgetHelper(widget, pos);
+          this._updateWidgetHelper(widget, { pos });
         });
         break;
       case 'right':
@@ -694,7 +701,7 @@ export class DashboardLayout extends Layout {
           const widget = _widget as DashboardWidget;
           const pos = widget.pos;
           pos.top += amount;
-          this._updateWidgetHelper(widget, pos);
+          this._updateWidgetHelper(widget, { pos });
         });
         break;
       case 'down':
@@ -878,7 +885,7 @@ export class DashboardLayout extends Layout {
     this.startBatch();
     each(this, _widget => {
       const widget = _widget as DashboardWidget;
-      this.updateWidget(widget, widget.pos);
+      this.updateWidget(widget, { pos: widget.pos });
     });
     this.endBatch();
   }
@@ -1016,7 +1023,7 @@ export namespace DashboardLayout {
 /**
  * A type for dashboard changes emitted by the changed signal.
  */
-export type DashboardChangeType = 'add' | 'remove' | 'move';
+export type DashboardChangeType = 'add' | 'remove' | 'update';
 
 /**
  * An interface describing a change that occurs to the dashboard.
@@ -1037,6 +1044,8 @@ export interface IDashboardChange {
 
   cellId?: string;
 
+  snapToGrid?: boolean;
+
   ignore?: boolean;
 }