Skip to content

Commit

Permalink
Revert "chore(storybook): upgrade GH Action base again to the latest"
Browse files Browse the repository at this point in the history
This reverts commit 5f7627d.
  • Loading branch information
jim-risen committed Dec 18, 2023
1 parent 5f7627d commit f8dfab0
Show file tree
Hide file tree
Showing 5 changed files with 5 additions and 76 deletions.
2 changes: 1 addition & 1 deletion .github/workflows/deploy.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,7 @@ jobs:
runs-on: ubuntu-latest
steps:
- id: build-publish
uses: bitovi/[email protected].2
uses: bitovi/[email protected].1
with:
path: storybook-static
build_command: npm run build-storybook-docs
37 changes: 3 additions & 34 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,3 @@
// TODO
controls
description
required/optional
remove padding

usage with typescript
3d charts

# SciChart.React - Official React Component Wrapper for SciChart.js: High Performance [JavaScript Chart Library](https://www.scichart.com/javascript-chart-features)

SciChart.React requires core [SciChart.js](https://www.npmjs.com/package/scichart) package to work and uses it as a peer dependency.
Expand All @@ -15,9 +6,9 @@ The SciChartReact itself is MIT licensed, find the core library licensing info a

## What does SciChart.React do?

- Neatly wraps up the lifecycle of SciChart.js into a React component to ensure proper initialisation and memory cleanup.
- Provides a number of ways to configure a chart (via JSON config or initialization function)
- Can be used to create complex dashboards linking multiple charts (demos are coming soon!)
- Neatly wraps up the lifecycle of SciChart.js into a React component to ensure proper initialisation and memory cleanup.
- Provides a number of ways to configure a chart (via JSON config or initialization function)
- Can be used to create complex dashboards linking multiple charts (demos are coming soon!)

## Getting Started

Expand Down Expand Up @@ -178,25 +169,3 @@ function App() {
- [Community forums](https://scichart.com/questions)
- [Stackoverflow tag](https://stackoverflow.com/tags/scichart)
- [Contact Us (Technical support or sales)](https://scichart.com/contact-us)

### Project idea

SciChart.js has some prerequisites and specific behavior when working with. A wrapper component for a specific framework, provides a boilerplate with the required setup and simplifies the usage of the core library within the .

There are several points to consider:

- a chart may require a root `div` element to be present in the DOM tree at the moment of initialization
- surfaces should not reference the same root element
- chart initialization is an asynchronous process (refer to [SciChartSurface.create]()/[SciChartSurface.createSingle]()/[SciChart3DSurface.create]()/[SciChart3DSurface.createSingle](), [SciChartPieSurface.create]() )
- chart disposal should be managed explicitly and should be handled properly considering async initialization
- appropriate usage of the chart lifecycle, which could consist of multiple stages: (WASM initialization) -> surface initialization -> chart setup (series, annotations, animations).
To achieve a smooth drawing, it is important to properly control the order of code execution for chart setup, data fetching, displaying fallback, and the chart rendering itself.
- Handling React.StrictMode
- React component fallback
- Context shared with nested elements

- Overview
- Group
- MemoryDebugWrapper

-
2 changes: 1 addition & 1 deletion src/SciChart.tsx
Original file line number Diff line number Diff line change
Expand Up @@ -76,9 +76,9 @@ function SciChartComponent<
};

return () => {
groupContext?.removeChartFromGroup(chartRoot);
// check if chart is already initialized or wait init to finish before deleting it
sciChartSurfaceRef.current ? performCleanup() : initPromise.then(performCleanup);
groupContext?.removeChartFromGroup(chartRoot);
};
}, []);

Expand Down
13 changes: 0 additions & 13 deletions src/stories/server/index.ts

This file was deleted.

27 changes: 0 additions & 27 deletions tsconfig-server.json

This file was deleted.

0 comments on commit f8dfab0

Please sign in to comment.