UI Guides


Graphistry Setup


REST APIs

Introduction

2.0 REST API Tutorial (cURL)


URL API to Embed & Control

- HTML

- URL Options

- IFrame CSS Style Tips


Authentication (2.0 API)

- Concepts

- Create token

- Refresh token

- Verify token

- Modes: Password, Personal Key, & SSO


Computation

- GFQL Query Endpoint

    - GFQL Operations

    - GFQL Predicates

- Python Query Endpoint

- GFQL UDF Endpoint

- Python UDF Endpoint


Upload Data (2.0 API)

- Concepts

- List Files

- Create File

- Delete File

- Upload File Data

- List Visualization Datasets

- Create Visualization Dataset with Bindings

    - Hypergraphs

- Delete Visualization

- Schema

Basic Bindings

    - Color

    - Color Palettes

    - Edge Weight Bindings

Complex Bindings

    - Colors and Sizes

    - Icons

    - Badges

    - Radial & Horizontal Axis

    - Field Controls Overview

        - Field Inclusion

        - Field Exclusion

        - Computed Fields

- Branding Metadata: Logos, title, backgrounds, & effects

- Upload Node & Edge Data

   - json

   - csv

   - parquet

   - orc

   - arrow


Live Sessions (experimental)

- View


Health Checks


Python Notebooks & API

- PyGraphistry Homepage (GitHub)

- PyGraphistry API (ReadTheDocs)

- Jupyter Notebook Examples (GitHub)

- Pygraphistry Databricks Examples (GitHub)

- Graph Algorithms


Visual Playbooks

- Connectors

- Pivots

- Templates


JavaScript Libraries

- React - Storybook

- React - API

- Browser JS - Storybook

- Browser JS - Example

- Browser JS - API

- Node.js - API

Field Inclusion Controls

Overview

Field inclusion lets you specify exactly which fields should appear in the entity inspector. Any fields not explicitly included will be hidden.

Key Points

  • Only affects what appears in the entity inspector - does not filter or remove data
  • Essential fields (like node IDs and edge source/destination) are always shown
  • Type-specific rules take precedence over global rules

Examples

Global Inclusion

Show only specific fields for all nodes:


{
  "node_encodings": {
    "bindings": {
      "node": "nodeId"
    },
    "complex": {
      "default": {
        "pointFieldInclusionEncoding": {
          "graphType": "point",
          "encodingType": "fieldinclusion",
          "include": {
            "name": true,
            "type": true,
            "status": true
          }
        }
      }
    }
  }
}

Type-Specific Inclusion

Show different fields for different types of nodes:


{
  "node_encodings": {
    "bindings": {
      "node": "nodeId"
    },
    "complex": {
      "default": {
        "pointFieldInclusionEncoding": {
          "graphType": "point",
          "encodingType": "fieldinclusion",
          "include": {
            "types": {
              "server": { "cpu": true, "ram": true, "status": true },
              "client": { "name": true, "email": true }
            }
          }
        }
      }
    }
  }
}

Validation Rules

  • Field names must match your data's column names
  • Values must be boolean (true to show, false to hide)
  • Cannot exclude essential binding fields
  • Cannot mix inclusion and exclusion rules for the same fields