Skip to content
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

Purge @finos/perspective-viewer-hypergrid #991

Merged
merged 8 commits into from
Mar 27, 2020
Merged

Purge @finos/perspective-viewer-hypergrid #991

merged 8 commits into from
Mar 27, 2020

Conversation

texodus
Copy link
Member

@texodus texodus commented Mar 27, 2020

This PR principally removes reference to the @finos/perspective-viewer-hypergrid module in the project documentation, website and examples, with two exceptions:

- To mention it exists in a legacy context.
- The editing example (which will also imminently be replaced).

While pursuing this, several improvements were made to @finos/perspective-viewer-datagrid, discovered in due course of trying to reimplement all examples and the website without Hypergrid:

  • Adds the disable-virtual-datagrid attribute, which (for now) allows the developer to disable @finos/perspective-viewer-datagrid viewport virtualization. While this will tank performance for large datasets, it makes it easy to use CSS to change the geometry of the datagrid, such as this IEX Cloud powered transposed grid example.

transpose

  • Fixes scroll position to remain at the same 'virtual' point on schema-preserving changes such as sort.

  • Fixes autosize bug when column group headers are wider than their underlying columns.

  • Fixes an obscure scroll bug when "hidden" sort by columns interplay with column groups.

  • Refactors @finos/perspective-viewer-datagrid into much more manageable modules, and adds quite alot of documentation and ASCII art.

Also - adds a "radical" new README.md "Examples" section.

Copy link
Contributor

@JHawk JHawk left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you - the refactor articulates the new datagrid API in a much more extensible way.
Will update the *** Under Construction *** in upcoming commits.

| `--d3fc-full--gradient`<br/>`--highcharts-full--gradient` | The color gradient for [-, +] ranges on numeric columns. |
| `--d3fc-positive--gradient`<br/>`--highcharts-positive--gradient` | The color gradient for [+, +] ranges on numeric columns. |
| `--d3fc-negative--gradient`<br/>`--highcharts-negative--gradient` | The color gradient for [-, -] ranges on numeric columns. |
*** Under Construction ***
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there anything specific you would like added here?

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes - this API has not been removed, but the new @finos/perspective-viewer-datagrid package has much easier ways to achieve these ends. While the prose documentation for these have not been written, there are a few good examples in the simple example project that will serve as the basis for this section in the future.

}

/**
* Appends the default tbale CSS to `<head>`, should be run once on module
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

tbale typo

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may be interested in this PR/package :) webpack/webpack#10548

@texodus texodus merged commit 92edcd6 into master Mar 27, 2020
@texodus texodus deleted the datagrid-docs branch March 27, 2020 23:39
@texodus texodus added internal Internal refactoring and code quality improvement documentation Improvements/bugs/changes to documentation labels Mar 31, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements/bugs/changes to documentation internal Internal refactoring and code quality improvement
Projects
None yet
Development

Successfully merging this pull request may close these issues.

4 participants