From 06e8f71f7106556b266f6f59b1194abd9002c4e7 Mon Sep 17 00:00:00 2001 From: Saad <38024451+sdadn@users.noreply.github.com> Date: Tue, 16 Apr 2024 08:05:37 -0500 Subject: [PATCH 01/11] added more examples for reflow --- .../graph/CoreConcepts.b/Reflow.e.graph.mdx | 24 +++- .../examples/reflow/BasicReflowExample.jsx | 10 +- .../reflow/DynamicallyUpdatingData.jsx | 130 ++++++++++++++++++ .../examples/reflow/PanningExample.jsx | 2 +- 4 files changed, 157 insertions(+), 9 deletions(-) create mode 100644 packages/terra-graphs-docs/src/terra-dev-site/graph/CoreConcepts.b/examples/reflow/DynamicallyUpdatingData.jsx diff --git a/packages/terra-graphs-docs/src/terra-dev-site/graph/CoreConcepts.b/Reflow.e.graph.mdx b/packages/terra-graphs-docs/src/terra-dev-site/graph/CoreConcepts.b/Reflow.e.graph.mdx index 98bcebfb3..72ab44f9c 100644 --- a/packages/terra-graphs-docs/src/terra-dev-site/graph/CoreConcepts.b/Reflow.e.graph.mdx +++ b/packages/terra-graphs-docs/src/terra-dev-site/graph/CoreConcepts.b/Reflow.e.graph.mdx @@ -1,10 +1,24 @@ -import BasicReflowExample from './examples/reflow/BasicReflowExample'; -import PanningExample from './examples/reflow/PanningExample'; +import {Notice} from '@cerner/terra-docs' +import BasicReflowExample from './examples/reflow/BasicReflowExample?dev-site-example'; +import PanningExample from './examples/reflow/PanningExample?dev-site-example'; +import DynamicallyUpdatingDataExample from './examples/reflow/DynamicallyUpdatingData?dev-site-example'; # Reflow -Reflow can be used to dynamically update a graph. +Reflow can be used to dynamically update a graph without causing a full redraw from scratch. +It can be invoked by using the `GraphInstance.reflowMultipleDatasets` method. + +```js +const graphInstance = Carbon.api.graph(graphConfig); +graphInstance.reflowMultipleDatasets(); +``` + + + +The original reflow method, `GraphInstance.reflow()`, is depreacted. + + ## Overview @@ -14,3 +28,7 @@ Reflow can be used to dynamically update a graph. ### Panning + +### Dynamic Data + + diff --git a/packages/terra-graphs-docs/src/terra-dev-site/graph/CoreConcepts.b/examples/reflow/BasicReflowExample.jsx b/packages/terra-graphs-docs/src/terra-dev-site/graph/CoreConcepts.b/examples/reflow/BasicReflowExample.jsx index bc86376d5..8c5bcff11 100644 --- a/packages/terra-graphs-docs/src/terra-dev-site/graph/CoreConcepts.b/examples/reflow/BasicReflowExample.jsx +++ b/packages/terra-graphs-docs/src/terra-dev-site/graph/CoreConcepts.b/examples/reflow/BasicReflowExample.jsx @@ -29,7 +29,7 @@ const graphConfig = { const dataset1 = { key: 'uid_1', label: { - display: 'Data Label 1', + display: 'Dataset 1', }, color: Carbon.helpers.COLORS.BLACK, values: [ @@ -66,14 +66,14 @@ const BasicReflowExample = () => { graph.reflowMultipleDatasets(); }; - const handleClickUpdateLimits = () => { + const handleClickUpdateLimits1 = () => { graph.config.axis.y.domain.lowerLimit = -52; graph.config.axis.y.domain.upperLimit = 52; graph.reflowMultipleDatasets(); }; - const handleClickReset = () => { + const handleClickUpdateLimits2 = () => { graph.config.axis.y.domain.lowerLimit = 0; graph.config.axis.y.domain.upperLimit = 20; @@ -83,8 +83,8 @@ const BasicReflowExample = () => { return ( <>