@graphistry/client-api-react

Graphistry's Client API React Component

Automatically upload and visualize datasets using React, powered by Graphistry's GPU graph visualization infrastructure.

Install

npm install @graphistry/client-api-react

Usage

import React from 'react';
import ReactDOM from 'react-dom';

import { Graphistry } from '@graphistry/client-api-react';
//... Specify bundle format when default is incompatible: @graphistry/client-api-react/dist/index.{esm,cjs,iife}.js

import '@graphistry/client-api-react/assets/index.less';

ReactDOM.render(
    <Graphistry dataset='Miserables'
                graphistryHost='https://hub.graphistry.com'/>,
    document.getElementById('react-root')
);

Additional React examples

• API: Interactive storybook
• Project structure: Create React App sample project

Versions

• @graphistry/client-api-react wraps @graphistry/client-api, so use aligned versions
• By default, React is linked as an external dependency (16.8+, 17.x, 18.x)
• You can use multiple module formats: @graphistry/client-api-react (default) or pick a specific format via @graphistry/client-api-react/dist/index.{esm,cjs,iife}.js
• You can also use the library standalone, where React is already inlined: @graphistry/client-api-react/dist/index.full.{esm,cjs,iife}.js

Changelog

5.0.0 - 2024-02-02

Added

• client-api: toggleClustering(isOn) to start/stop clustering

Infra

• Update Storybook from 6 to 7

Security

• Update dependencies

Fix

• client-api: tickClustering(milliseconds) now works, requires Graphistry server upgrade