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 Exclusion Controls

Overview

Field exclusion lets you hide specific fields from the entity inspector. All fields not explicitly excluded will remain visible.

Key Points

  • Only affects what appears in the entity inspector - does not remove data from the visualization
  • Cannot exclude essential fields (like node IDs and edge source/destination)
  • Type-specific exclusions take precedence over global exclusions
  • Useful when you want to show most fields but hide a few specific ones

Examples

Global Exclusion

Hide specific fields from all nodes:


{
  "node_encodings": {
    "bindings": {
      "node": "nodeId"
    },
    "complex": {
      "default": {
        "pointFieldExclusionEncoding": {
          "graphType": "point",
          "encodingType": "fieldexclusion",
          "exclude": {
            "internal_id": true,
            "timestamp": true,
            "debug_info": true
          }
        }
      }
    }
  }
}

Type-Specific Exclusion

Hide different fields for different types of nodes:


{
  "node_encodings": {
    "bindings": {
      "node": "nodeId"
    },
    "complex": {
      "default": {
        "pointFieldExclusionEncoding": {
          "graphType": "point",
          "encodingType": "fieldexclusion",
          "exclude": {
            "types": {
              "server": { "private_key": true, "internal_ip": true },
              "client": { "password_hash": true, "session_token": true }
            }
          }
        }
      }
    }
  }
}

Validation Rules

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

When to Use Exclusion vs Inclusion

  • Use exclusion when you want to show most fields but hide a few specific ones
  • Use inclusion when you want to show only a few specific fields and hide everything else