@graphistry/client-api-react

Embed a Graphistry visualization via React


License
ISC
Install
npm install @graphistry/client-api-react@3.7.6

Documentation

GraphistryJS

GraphistryJS is a visual graph analytics library to extract, transform, and load big graphs into Graphistry's GPU visual graph analytics platform and control the style and interactions. It is typically used by developers on problems like visually mapping the behavior of devices and users, especially when there are many events or entities involved. We recommend data scientists considering exploring initial prototype iterations in Python notebooks with PyGraphistry.

Graphistry

Graphistry supports unusually large graphs for interactive visualization. The client's custom WebGL rendering engine renders up to 8MM nodes and edges at a time, and most older client GPUs smoothly support somewhere between 100K and 1MM elements. The serverside GPU analytics engine supports even bigger graphs. Graphistry comes with many prebuilt visual analytics tools like clustering, interactive histograms and timebars, data brushing, point-and-click filtering. Graphistry can be used standalone by analysts, through notebooks by data scientists, and embedded through multiple language and REST APIs.

You can launch your own Graphistry server with just a few clicks.

JavaScript client APIs

The JavaScript client APIs makes it easy to embed visual graph analytics into JavaScript frontends and control the style and interactions. Developers can quickly prototype and deploy stunning solutions.

GraphistryJS comes in 2 flavors:

  • client-api: Pure JavaScript API taking advantage of reactive/observable style code for chaining async code
  • client-api-react: React component for simple embedding, configuration, and lightweight dynamic control

Architecture

You can think of Graphistry as a live data version of Google Maps.

  • Graphistry runs as an embedded iframe that streams live with your Graphistry server
  • GraphistryJS runs as a lightweight JavaScript library in your application. It simplifies creating the iframe, uploading data for visualization as needed, and sending the iframe messages to control style and interactions
  • GraphistryJS can be used to upload and view new visualizations, or run sessions for existing uploads, including those from other clients
  • User and GraphistryJS interactions will transparently leverage the Graphistry server as needed, such as for loading a graph, running analytics, drilling into data, and saving settings

Security

  • You can configure your Graphistry server to run as http, https, or both
  • Uploads (generally) require API keys. Log in to your server for your account's API key and information on how to generate new ones
  • Sessions are based on unguessable web keys: sharing a secret ID means sharing read access
  • Datasets are immutable and thus their integrity is safe for sharing, while session state (e.g., filters) are writable: share a copy when in doubt