API Reference
GraphScene
Describes a host-neutral graph exploration scene that adapters can render with SVG, Canvas, WebGL, desktop, or native controls.
Inheritance
- Object
- GraphScene
Usage
Explore 38 API references to this type
This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.
Returned or exposed by 10
- Extension method GraphScene.AddCluster
- Extension method GraphScene.AddEdge
- Extension method GraphScene.AddNode
- Method GraphScene.Create
- Method GraphSceneExtensions.AddCluster
- Method GraphSceneExtensions.AddEdge
- Method GraphSceneExtensions.AddNode
- Method TopologyGraphExplorerExtensions.ToGraphScene
- Method VisNetworkGraph.ToGraphScene
- Extension method TopologyChart.ToGraphScene
Accepted by parameters 28
- Extension method GraphScene.AddCluster
- Extension method GraphScene.AddEdge
- Extension method GraphScene.AddNode
- Extension method GraphScene.ApplyPatch
- Extension method GraphScene.CreateNeighborhood
- Extension method GraphScene.CreateStages
- Extension method GraphScene.GetEffectiveClusters
- Extension method GraphScene.SaveGraphStageImages
- Extension method GraphScene.ToGraphExplorerHtmlFragment
- Extension method GraphScene.ToGraphExplorerHtmlPage
- Extension method GraphScene.ToGraphPng
- Extension method GraphScene.ToGraphSvg
- Method GraphSceneClusterExtensions.GetEffectiveClusters
- Method GraphSceneExtensions.AddCluster
- Method GraphSceneExtensions.AddEdge
- Method GraphSceneExtensions.AddNode
- Method GraphSceneNeighborhoodPlanner.CreateNeighborhood
- Method GraphScenePatchExtensions.ApplyPatch
- Method GraphSceneStagePlanner.CreateStages
- Method GraphExplorerExtensions.ToGraphExplorerHtmlFragment
- Method GraphExplorerExtensions.ToGraphExplorerHtmlPage
- Method GraphSceneStaticExtensions.SaveGraphStageImages
- Method GraphSceneStaticExtensions.ToGraphPng
- Method GraphSceneStaticExtensions.ToGraphSvg
- Method HtmlGraphExplorerRenderer.RenderFragment
- Method HtmlGraphExplorerRenderer.RenderPage
- Method HtmlGraphExplorerRenderer.RenderStaticPng
- Method HtmlGraphExplorerRenderer.RenderStaticSvg
Constructors
public GraphScene() #Methods
public static GraphScene Create(String id, String title) #GraphSceneCreates a new graph scene.
Parameters
- id System.String
- Stable scene identifier.
- title System.String
- Human-readable scene title.
Returns
A new graph scene.
public Void Validate() #VoidValidates node, edge, and cluster references before an adapter renders or mutates the scene.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String Id { get; set; } #Gets or sets the stable scene identifier used for host events and persisted state.
public String Title { get; set; } #Gets or sets the human-readable scene title.
public String? Subtitle { get; set; } #Gets or sets an optional scene subtitle.
public List<GraphSceneNode> Nodes { get; } #Gets graph nodes keyed by stable node id.
public List<GraphSceneEdge> Edges { get; } #Gets graph edges keyed by stable edge id.
public List<GraphSceneCluster> Clusters { get; } #Gets semantic or computed clusters that an adapter can collapse, expand, or summarize.
public GraphSceneOptions Options { get; } #Gets reusable graph exploration settings and capability hints.
public Dictionary<String, String> Metadata { get; } #Gets arbitrary scene-level metadata for host adapters and diagnostics.
Extension Methods
public static GraphScene AddCluster(GraphScene scene, String id, String label, String[] nodeIds, Action<GraphSceneCluster>? configure = null) #GraphSceneAdds a cluster to the graph scene.
Parameters
- scene ChartForgeX.Interactivity.GraphScene
- The graph scene.
- id System.String
- Stable cluster id.
- label System.String
- Cluster label.
- nodeIds System.String[]
- Node ids contained by the cluster.
- configure System.Action<ChartForgeX.Interactivity.GraphSceneCluster>? = null
- Optional cluster configuration callback.
Returns
The current graph scene.
public static GraphScene AddEdge(GraphScene scene, String id, String sourceNodeId, String targetNodeId, String? label = null, Action<GraphSceneEdge>? configure = null) #GraphSceneAdds an edge to the graph scene.
Parameters
- scene ChartForgeX.Interactivity.GraphScene
- The graph scene.
- id System.String
- Stable edge id.
- sourceNodeId System.String
- Source node id.
- targetNodeId System.String
- Target node id.
- label System.String? = null
- Optional edge label.
- configure System.Action<ChartForgeX.Interactivity.GraphSceneEdge>? = null
- Optional edge configuration callback.
Returns
The current graph scene.
public static GraphScene AddNode(GraphScene scene, String id, String label, Action<GraphSceneNode>? configure = null) #GraphSceneAdds a node to the graph scene.
Parameters
- scene ChartForgeX.Interactivity.GraphScene
- The graph scene.
- id System.String
- Stable node id.
- label System.String
- Node label.
- configure System.Action<ChartForgeX.Interactivity.GraphSceneNode>? = null
- Optional node configuration callback.
Returns
The current graph scene.
public static GraphScenePatchResult ApplyPatch(GraphScene scene, GraphScenePatch patch) #GraphScenePatchResultApplies a patch atomically and validates the complete scene before committing it.
Parameters
- scene ChartForgeX.Interactivity.GraphScene
- The graph document to update.
- patch ChartForgeX.Interactivity.GraphScenePatch
- The requested additions, replacements, and removals.
Returns
The resulting graph document counts.
public static GraphSceneStage CreateNeighborhood(GraphScene scene, String rootNodeId, Action<GraphSceneNeighborhoodOptions>? configure = null) #GraphSceneStageCreates a view centered on a node, with explicit node and relationship budgets.
Parameters
- scene ChartForgeX.Interactivity.GraphScene
- The complete source scene. Replan after changing its nodes or relationships.
- rootNodeId System.String
- The node retained on every neighborhood page.
- configure System.Action<ChartForgeX.Interactivity.GraphSceneNeighborhoodOptions>? = null
- Optional distance, budget, and paging settings.
Returns
A stage consumable by the static graph exporters. Counts include everything omitted from the source scene.
public static IReadOnlyList<GraphSceneStage> CreateStages(GraphScene scene, Action<GraphSceneStageOptions>? configure = null) #IReadOnlyList<GraphSceneStage>Creates overview-to-detail stages for a graph scene.
Parameters
- scene ChartForgeX.Interactivity.GraphScene
- The graph scene to plan.
- configure System.Action<ChartForgeX.Interactivity.GraphSceneStageOptions>? = null
- Optional stage planning configuration.
Returns
Ordered deterministic graph stages.
public static IReadOnlyList<GraphSceneCluster> GetEffectiveClusters(GraphScene scene) #IReadOnlyList<GraphSceneCluster>Gets declared clusters plus any reusable clusters derived from the active cluster policy.
Parameters
- scene ChartForgeX.Interactivity.GraphScene
- The source graph scene.
Returns
Cluster definitions that adapters should render, collapse, search, export, and expose through host events.
public static IReadOnlyList<GraphSceneStageImageResult> SaveGraphStageImages(GraphScene scene, String outputDirectory, String fileNamePrefix, Action<GraphSceneStageImageOptions>? configure = null) #IReadOnlyList<GraphSceneStageImageResult>Saves deterministic overview-to-detail graph stage images without creating interactive HTML.
Parameters
- scene ChartForgeX.Interactivity.GraphScene
- outputDirectory System.String
- fileNamePrefix System.String
- configure System.Action<ChartForgeX.Interactivity.Html.GraphSceneStageImageOptions>? = null
public static String ToGraphExplorerHtmlFragment(GraphScene scene, Action<HtmlGraphExplorerOptions>? configure = null) #StringRenders the graph scene to an embeddable fragment with inline assets.
Parameters
- scene ChartForgeX.Interactivity.GraphScene
- The graph scene to render.
- configure System.Action<ChartForgeX.Interactivity.Html.HtmlGraphExplorerOptions>? = null
- Optional adapter configuration callback.
Returns
An embeddable HTML fragment.
public static String ToGraphExplorerHtmlPage(GraphScene scene, Action<HtmlGraphExplorerOptions>? configure = null) #StringRenders the graph scene to a complete self-contained HTML page.
Parameters
- scene ChartForgeX.Interactivity.GraphScene
- The graph scene to render.
- configure System.Action<ChartForgeX.Interactivity.Html.HtmlGraphExplorerOptions>? = null
- Optional adapter configuration callback.
Returns
A complete HTML document.
public static Byte[] ToGraphPng(GraphScene scene, GraphSceneStage? stage = null, Action<GraphSceneStaticRenderOptions>? configure = null) #Byte[]Renders a graph scene or planned stage to PNG bytes without opening a browser.
Parameters
- scene ChartForgeX.Interactivity.GraphScene
- stage ChartForgeX.Interactivity.GraphSceneStage? = null
- configure System.Action<ChartForgeX.Interactivity.Html.GraphSceneStaticRenderOptions>? = null
public static String ToGraphSvg(GraphScene scene, GraphSceneStage? stage = null, Action<GraphSceneStaticRenderOptions>? configure = null) #StringRenders a graph scene or planned stage to script-free SVG.
Parameters
- scene ChartForgeX.Interactivity.GraphScene
- stage ChartForgeX.Interactivity.GraphSceneStage? = null
- configure System.Action<ChartForgeX.Interactivity.Html.GraphSceneStaticRenderOptions>? = null