-
Notifications
You must be signed in to change notification settings - Fork 1.3k
CSV/JSON renderer in JupyterLab #832
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,249 @@ | ||
| import {ActivityMonitor} from '@jupyterlab/coreutils'; | ||
| import {ILayoutRestorer, JupyterFrontEnd, JupyterFrontEndPlugin} from '@jupyterlab/application'; | ||
| import {IThemeManager, WidgetTracker, Dialog, showDialog} from '@jupyterlab/apputils'; | ||
| import {ABCWidgetFactory, DocumentRegistry, IDocumentWidget, DocumentWidget} from '@jupyterlab/docregistry'; | ||
| import {PerspectiveWidget} from "@finos/perspective-phosphor"; | ||
|
|
||
| /** | ||
| * The name of the factories that creates widgets. | ||
| */ | ||
| const FACTORY_CSV = 'CSVPerspective'; | ||
| const FACTORY_JSON = 'JSONPerspective'; | ||
|
|
||
| const RENDER_TIMEOUT = 1000; | ||
|
|
||
| type IPerspectiveDocumentType = "csv" | "json"; | ||
|
|
||
| // create here to reuse for exception handling | ||
| const baddialog = () => { | ||
| showDialog({ | ||
| body: "Perspective could not render the data", | ||
| buttons: [Dialog.okButton({ label: "Dismiss" })], | ||
| focusNodeSelector: "input", | ||
| title: "Error"}); | ||
| }; | ||
|
|
||
|
|
||
| export class PerspectiveDocumentWidget extends DocumentWidget<PerspectiveWidget> { | ||
| constructor(options: DocumentWidget.IOptionsOptionalContent<PerspectiveWidget>, | ||
| type: IPerspectiveDocumentType = "csv") { | ||
| super({ content: new PerspectiveWidget("test"), context: options.context, reveal: options.reveal}); | ||
|
|
||
| this._psp = this.content; | ||
| this._type = type; | ||
| this._context = options.context; | ||
|
|
||
| this._context.ready.then(() => { | ||
| this._update(); | ||
| this._monitor = new ActivityMonitor({ | ||
| signal: this.context.model.contentChanged, | ||
| timeout: RENDER_TIMEOUT | ||
| }); | ||
| this._monitor.activityStopped.connect(this._update, this); | ||
| }); | ||
| } | ||
|
|
||
| private _update() { | ||
| try { | ||
| if(this._type === "csv") { | ||
| // load csv directly | ||
| const data: string = this._context.model.toString(); | ||
| this._psp._update(data); | ||
| } else if (this._type === "json") { | ||
| const data = this._context.model.toJSON() as any; | ||
|
|
||
| if (Array.isArray(data) && data.length > 0) { | ||
| // already is records form, load directly | ||
| this._psp._update(data); | ||
|
|
||
| } else { | ||
| throw "Not handled"; | ||
| // TODO | ||
| // if (Object.keys(data).length > 0){ | ||
| // // valid | ||
| // const keys = Object.keys(data); | ||
|
|
||
| // if(Array.isArray(data[keys[0]])) { | ||
| // // convert from columns to records | ||
| // const records = []; | ||
| // let i = 0; | ||
| // while(i < data[keys[0]].length){ | ||
| // let obj = {} as {[key: string]: any}; | ||
| // for(let k of keys){ | ||
| // obj[k] = data[k][i]; | ||
| // } | ||
| // records.push(obj); | ||
| // i++; | ||
| // } | ||
| // this._psp._update(records); | ||
|
|
||
| // } else { | ||
| // // single record, wrap as array | ||
| // this._psp._update([data]); | ||
| // } | ||
| // } else { | ||
| // // invalid | ||
| // throw "Not handled"; | ||
| // } | ||
| } | ||
| } else { | ||
| // don't handle other mimetypes for now | ||
| throw "Not handled"; | ||
| } | ||
| } catch { | ||
| baddialog(); | ||
| } | ||
|
|
||
| // pickup theme from env | ||
| this._psp.dark = (document.body.getAttribute("data-jp-theme-light") === "false"); | ||
| } | ||
|
|
||
| dispose(): void { | ||
| if (this._monitor) { | ||
| this._monitor.dispose(); | ||
| } | ||
| super.dispose(); | ||
| } | ||
|
|
||
| public get psp() : PerspectiveWidget { | ||
| return this._psp; | ||
| } | ||
|
|
||
| private _type: IPerspectiveDocumentType; | ||
| private _context: DocumentRegistry.Context; | ||
| private _psp: PerspectiveWidget; | ||
| private _monitor: ActivityMonitor<DocumentRegistry.IModel, void> | null = null; | ||
| } | ||
|
|
||
|
|
||
| /** | ||
| * A widget factory for CSV widgets. | ||
| */ | ||
| export class PerspectiveCSVFactory extends ABCWidgetFactory<IDocumentWidget<PerspectiveWidget> > { | ||
| protected createNewWidget(context: DocumentRegistry.Context): IDocumentWidget<PerspectiveWidget> { | ||
| return new PerspectiveDocumentWidget({context}, "csv"); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * A widget factory for JSON widgets. | ||
| */ | ||
| export class PerspectiveJSONFactory extends ABCWidgetFactory<IDocumentWidget<PerspectiveWidget> > { | ||
| protected createNewWidget(context: DocumentRegistry.Context): IDocumentWidget<PerspectiveWidget> { | ||
| return new PerspectiveDocumentWidget({context}, "json"); | ||
| } | ||
| } | ||
|
|
||
| /** | ||
| * The perspective extension for files | ||
| */ | ||
| export | ||
| const perspectiveRenderers: JupyterFrontEndPlugin<void> = { | ||
| activate: activate, | ||
| id: '@finos/perspective-jupyterlab:renderers', | ||
| requires: [], | ||
| optional: [ | ||
| ILayoutRestorer, | ||
| IThemeManager | ||
| ], | ||
| autoStart: true | ||
| }; | ||
|
|
||
| /** | ||
| * Activate cssviewer extension for CSV files | ||
| */ | ||
| function activate( | ||
| app: JupyterFrontEnd, | ||
| restorer: ILayoutRestorer | null, | ||
| themeManager: IThemeManager | null | ||
| ): void { | ||
|
|
||
| const factorycsv = new PerspectiveCSVFactory({ | ||
| name: FACTORY_CSV, | ||
| fileTypes: ['csv'], | ||
| defaultFor: ['csv'], | ||
| readOnly: true | ||
| }); | ||
|
|
||
| const factoryjson = new PerspectiveJSONFactory({ | ||
| name: FACTORY_JSON, | ||
| fileTypes: ['json', 'jsonl'], | ||
| defaultFor: ['json', 'jsonl'], | ||
| readOnly: true | ||
| }); | ||
|
|
||
|
|
||
| const trackercsv = new WidgetTracker<IDocumentWidget<PerspectiveWidget>>({ | ||
| namespace: 'csvperspective' | ||
| }); | ||
|
|
||
| const trackerjson = new WidgetTracker<IDocumentWidget<PerspectiveWidget>>({ | ||
| namespace: 'jsonperspective' | ||
| }); | ||
|
|
||
| if (restorer) { | ||
| // Handle state restoration. | ||
| void restorer.restore(trackercsv, { | ||
| command: 'docmanager:open', | ||
| args: widget => ({ path: widget.context.path, factory: FACTORY_CSV }), | ||
| name: widget => widget.context.path | ||
| }); | ||
|
|
||
| void restorer.restore(trackerjson, { | ||
| command: 'docmanager:open', | ||
| args: widget => ({ path: widget.context.path, factory: FACTORY_JSON }), | ||
| name: widget => widget.context.path | ||
| }); | ||
| } | ||
|
|
||
| app.docRegistry.addWidgetFactory(factorycsv); | ||
| app.docRegistry.addWidgetFactory(factoryjson); | ||
|
|
||
| let ftcsv = app.docRegistry.getFileType('csv'); | ||
| let ftjson = app.docRegistry.getFileType('json'); | ||
|
|
||
| factorycsv.widgetCreated.connect((sender, widget) => { | ||
| // Track the widget. | ||
| void trackercsv.add(widget); | ||
| // Notify the widget tracker if restore data needs to update. | ||
| widget.context.pathChanged.connect(() => { | ||
| void trackercsv.save(widget); | ||
| }); | ||
|
|
||
| if (ftcsv) { | ||
| widget.title.iconClass = ftcsv.iconClass!; | ||
| widget.title.iconLabel = ftcsv.iconLabel!; | ||
| } | ||
| }); | ||
|
|
||
| factoryjson.widgetCreated.connect((sender, widget) => { | ||
| // Track the widget. | ||
| void trackerjson.add(widget); | ||
| // Notify the widget tracker if restore data needs to update. | ||
| widget.context.pathChanged.connect(() => { | ||
| void trackerjson.save(widget); | ||
| }); | ||
|
|
||
| if (ftjson) { | ||
| widget.title.iconClass = ftjson.iconClass!; | ||
| widget.title.iconLabel = ftjson.iconLabel!; | ||
| } | ||
| }); | ||
|
|
||
|
|
||
| // Keep the themes up-to-date. | ||
| const updateThemes = () => { | ||
| const isLight = themeManager && themeManager.theme ? themeManager.isLight(themeManager.theme) : true; | ||
| trackercsv.forEach((pspDocWidget: PerspectiveDocumentWidget) => { | ||
| pspDocWidget.psp.dark = !isLight; | ||
| }); | ||
| trackerjson.forEach((pspDocWidget: PerspectiveDocumentWidget) => { | ||
| pspDocWidget.psp.dark = !isLight; | ||
| }); | ||
| }; | ||
|
|
||
| if (themeManager) { | ||
| themeManager.themeChanged.connect(updateThemes); | ||
| } | ||
| } | ||
|
|
||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.