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