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

What Are Field Controls?

Field controls let you customize which fields appear in the entity inspector and how they're displayed. These controls only affect the inspector view - they don't modify your underlying data or the visualization itself.

Core Concepts

Choosing Your Approach

  • Inclusion (Whitelist): Explicitly specify which fields to show
    • Best when you want to show only a few specific fields
    • Everything else is automatically hidden
  • Exclusion (Blacklist): Specify which fields to hide
    • Best when you want to hide just a few fields
    • Everything else remains visible

Specificity Levels

  • Global Rules: Apply to all entities of a type (nodes or edges)
  • Type-Specific Rules: Apply only to specific entity subtypes (e.g., "server" nodes vs "client" nodes)
    • Type-specific rules override global rules
    • Different types can have different field visibility

Available Controls

Field Visibility

Field Enhancement

  • Computed Fields: Create new fields by combining or transforming existing data
    • Combine multiple fields into one display
    • Generate clickable links
    • Format data for better readability

Common Use Cases

Simplified Views


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

Shows only the most important fields, reducing clutter in the inspector.

Type-Specific Information


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

Shows different fields for different entity types.

Important Notes

  • All controls only affect the entity inspector display
  • Essential fields (IDs, source/destination) cannot be hidden
  • Type-specific rules take precedence over global rules
  • Cannot mix inclusion and exclusion for the same fields
  • Field names must match your data's column names