Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@nteract/data-explorer

nteract62.7kBSD-3-Clause8.2.12TypeScript support: included

Transform for data resource JSON

readme

nteract Data Explorer

Binder Node.js CI CodeQL npm version Commitizen friendly

An automatic data visualization tool.

Interactive Documentation

Explore the documentation.

Data Explorer Examples

Creating Data Explorer

Read Elijah Meeks's post on designing the data explorer.

Using the Data Explorer

To use Data Explorer in your project, use the following approach.

yarn add @nteract/data-explorer

Install react and styled-components if you are not already using them.

yarn add react styled-components

The data prop must be a tabular data resource application/vnd.dataresource+json

// Default import complete with right side toolbar
import DataExplorer from "@nteract/data-explorer";

<DataExplorer data={data} />;

Or, with custom Toolbar position:

// Individual components as named imports
import { DataExplorer, Toolbar, Viz } from "@nteract/data-explorer";

<DataExplorer data={data}>
  <Toolbar />
  <Viz />
</DataExplorer>;

// Toolbar is optional
<DataExplorer data={data}>
  <Viz />
</DataExplorer>;

How do I contribute to this repo?

If you are interested in contributing to nteract, please read the contribution guidelines for information on how to set up your nteract repo for development, how to update documentation, and how to submit your code changes for review on GitHub.

changelog

v8.2.12 (Wed Jul 14 2021)

🐛 Bug Fix

  • fix: handle empty data in column cells gracefully to avoid viz-switching runtime errors #71 (@hydrosquall)
  • chore: apply eslint + prettier auto-fixes to whole codebase #70 (@hydrosquall)
  • chore: pre-commit hooks for code style and commit message quality #66 (@hydrosquall)

📝 Documentation

  • chore: set up + document commitizen-cli for authoring clear commit messages #68 (@hydrosquall)

🔩 Dependency Updates

Authors: 1


v8.2.11 (Thu Jul 01 2021)

🐛 Bug Fix

  • fix: Correctly display complex datatypes (objects) in table cells #65 (@hydrosquall)

Authors: 1


v8.2.10 (Tue Jun 29 2021)

:tada: This release contains work from new contributors! :tada:

Thanks for all your work!

:heart: Cameron Yick (@hydrosquall)

:heart: Carol Willing (@willingc)

🐛 Bug Fix

⚠️ Pushed to main

🔩 Dependency Updates

Authors: 4


Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

Unreleased

Added

  • Add Code of Conduct file
  • Add auto to automate versioning and deployment #63

Changed

  • Update Semiotic
  • Move to GH-Actions
  • Bugfix for string columns #41 (@hydrosquall)

Removed

v8.2.8 - 2021-08-01

Latest release.

v8.0.0 - 2020-01-20

Initial release.