Search

Data Format

Data

Explore the JSON object data format for ReGraph.

Data Format
View live example →

ReGraph accepts data in the form of a JSON object. Each key is the id of a node or a link. See the Data tab to see how this chart was created.

Links are identified by having both an id1 and id2 property with node ids as their values.

See also

import React from "react";
import { createRoot } from "react-dom/client";

import { Chart } from "regraph";

import data from "./data";

export const Demo = () => <DataFormat items={data()} />;

function DataFormat(props) {
  const { items } = props;
  return <Chart items={items} />;
}

const root = createRoot(document.getElementById("regraph"));
root.render(<Demo />);
import { style } from "@ci/theme/rg/js/storyStyles";

function data() {
  return {
    // node1 is the 'id' of the node
    node1: {
      label: {
        text: "Node One",
        ...style.primaryLabel1,
      },
      ...style.primary1,
    },
    node2: {
      label: {
        text: "Node Two",
        ...style.primaryLabel1,
      },
      ...style.primary1,
    },
    link: {
      // a link's ends are defined by id1 and id2
      id1: "node1",
      id2: "node2",
      label: {
        text: "Link",
        ...style.darkLabelBackground,
      },
      ...style.link,
    },
  };
}

export default data;
<!doctype html>
<html>
  <body>
    <div id="regraph" style="height: 100vh"></div>
    <script type="module" src="./code.jsx"></script>
  </body>
</html>

Terms of use

These terms do not alter or supersede any existing agreements between you (or your employer) and us.

By accessing or using any Content you agree to be bound by these Terms of Use. Please review these terms carefully before using the website.

The contents of this website, including but not limited to any text, code samples, API references, schemas, interactive tools, and other materials (collectively, the 'Content'), are made available for informational and internal evaluation purposes only. All intellectual property rights in the Content are reserved. No licence is granted to use the Content for any commercial purpose, or to copy, distribute, modify, reverse-engineer, or incorporate any part of the Content into any product or service, without our prior written consent.

This Content is provided “as is” and “as available,” without any representations, warranties, or guarantees of any kind, whether express or implied, including but not limited to implied warranties of merchantability, fitness for a particular purpose, non-infringement, or accuracy. To the fullest extent permitted by applicable law, we expressly exclude and disclaim all implied warranties, conditions, and other terms that might otherwise be implied.

We disclaim all liability for any loss or damage, whether direct, indirect, incidental, consequential, or otherwise, arising from any reliance placed on the Content or from your use of it, to the fullest extent permitted by applicable law. By continuing to access or use the Content, you acknowledge and agree to these terms.