API Reference
TopologyRenderOptionsExtensions
Provides reusable topology render-option presets.
Inheritance
- Object
- TopologyRenderOptionsExtensions
Methods
ApplyPreset(ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Topology.TopologyViewPreset preset) #Applies a preset to existing render options.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- preset ChartForgeX.Topology.TopologyViewPreset
- The preset to apply.
Returns
The current render options.
WithActiveScenario(ChartForgeX.Topology.TopologyRenderOptions options, System.String scenarioId) #Activates an existing topology scenario for static highlighting and initial interactive HTML state.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- scenarioId System.String
- The scenario id.
Returns
The current render options.
WithEdgeMetricLabels(ChartForgeX.Topology.TopologyRenderOptions options, System.String primaryMetricKey, System.String secondaryMetricKey, System.String tertiaryMetricKey) #Uses edge metrics as stacked edge labels.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- primaryMetricKey System.String
- The metric key for the primary edge label.
- secondaryMetricKey System.String
- The optional metric key for the secondary edge label.
- tertiaryMetricKey System.String
- The optional metric key for the tertiary edge label.
Returns
The current render options.
WithFitContentToViewport(ChartForgeX.Topology.TopologyRenderOptions options) #Keeps topology output at the requested viewport size by scaling dense rendered content down when needed.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
WithForceGraphStyle(ChartForgeX.Topology.TopologyRenderOptions options) #Applies a readable force-graph treatment for relationship-heavy topology clouds.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
WithForceLayout(ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Topology.TopologyForceLayoutProfile profile, System.Nullable{System.Int32} iterations) #Selects a deterministic force-directed solver profile.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- profile ChartForgeX.Topology.TopologyForceLayoutProfile
- The force layout profile.
- iterations System.Nullable{System.Int32}
- Optional solver iteration override.
Returns
The current render options.
WithHtmlControlPlacement(ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Topology.TopologyHtmlControlPlacement placement) #Places viewport, fullscreen, and export controls inside the interactive HTML topology viewport.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- placement ChartForgeX.Topology.TopologyHtmlControlPlacement
- The control placement.
Returns
The current render options.
WithHtmlForceGraphControls(ChartForgeX.Topology.TopologyRenderOptions options, System.Boolean enabled) #Enables or disables force-directed graph exploration controls in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- enabled System.Boolean
- Whether interactive HTML should render graph exploration controls.
Returns
The current render options.
WithHtmlFullscreenControl(ChartForgeX.Topology.TopologyRenderOptions options, System.Boolean enabled) #Enables or disables the fullscreen viewport control in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- enabled System.Boolean
- Whether interactive HTML should render a fullscreen control.
Returns
The current render options.
WithHtmlScenarioCheckboxes(ChartForgeX.Topology.TopologyRenderOptions options) #Renders topology scenarios as independent route checkboxes.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
WithHtmlScenarioControlMode(ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Topology.TopologyHtmlScenarioControlMode mode) #Chooses how topology scenario controls are rendered in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- mode ChartForgeX.Topology.TopologyHtmlScenarioControlMode
- The scenario control mode.
Returns
The current render options.
WithHtmlScenarioControls(ChartForgeX.Topology.TopologyRenderOptions options, System.Boolean enabled) #Enables or disables topology scenario picker controls in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- enabled System.Boolean
- Whether interactive HTML should render scenario picker controls.
Returns
The current render options.
WithHtmlScenarioPanel(ChartForgeX.Topology.TopologyRenderOptions options, System.Boolean enabled) #Enables or disables the compact topology scenario detail panel in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- enabled System.Boolean
- Whether interactive HTML should render the scenario detail panel.
Returns
The current render options.
WithHtmlScenarioUrlState(ChartForgeX.Topology.TopologyRenderOptions options, System.Boolean enabled) #Enables or disables query-string scenario state in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- enabled System.Boolean
- Whether interactive HTML should read and update scenario state from the page query string.
Returns
The current render options.
WithHtmlSelectionPanel(ChartForgeX.Topology.TopologyRenderOptions options, System.Boolean enabled) #Enables or disables the built-in selected-record panel in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- enabled System.Boolean
- Whether interactive HTML should render the selected-record panel.
Returns
The current render options.
WithLuminousTopologyEdges(ChartForgeX.Topology.TopologyRenderOptions options) #Uses a stronger luminous topology edge style for dark dashboards and deliberate emphasis.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
WithMindMapStyle(ChartForgeX.Topology.TopologyRenderOptions options) #Applies a clean informational treatment for centered mind maps.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
WithMonitoringDashboardStyle(ChartForgeX.Topology.TopologyRenderOptions options) #Applies the reusable monitoring-dashboard visual treatment used for dense topology and geographic monitoring views.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
WithMotion(ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Topology.TopologyMotionOptions motion) #Enables deterministic, script-free topology motion for SVG and sampled raster exports.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- motion ChartForgeX.Topology.TopologyMotionOptions
- The topology motion options.
Returns
The current render options.
WithMultilineNodeLabels(ChartForgeX.Topology.TopologyRenderOptions options, System.Boolean wrap, System.Int32 maxLabelLines, System.Int32 maxSubtitleLines) #Enables reusable multi-line node labels and optional word wrapping for dense relationship diagrams.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- wrap System.Boolean
- Whether text should wrap at word boundaries when it exceeds the available width.
- maxLabelLines System.Int32
- The maximum title rows.
- maxSubtitleLines System.Int32
- The maximum subtitle rows.
Returns
The current render options.
WithNeutralGroupSurfaces(ChartForgeX.Topology.TopologyRenderOptions options) #Renders group containers as neutral cards while preserving status/identity borders and labels.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
WithoutActiveScenario(ChartForgeX.Topology.TopologyRenderOptions options) #Clears the active topology scenario.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
WithoutMotion(ChartForgeX.Topology.TopologyRenderOptions options) #Clears topology motion.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
WithPlainTopologyEdges(ChartForgeX.Topology.TopologyRenderOptions options) #Uses a plain single-stroke topology edge style without halo or highlight layers.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
WithRelationshipOverviewStyle(ChartForgeX.Topology.TopologyRenderOptions options) #Applies a reusable relationship-overview treatment for entity maps, dependency overviews, and evidence correlation diagrams.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
WithRelationshipRadialFocus(ChartForgeX.Topology.TopologyRenderOptions options, System.String nodeId, System.Int32 maxDepth, System.Int32 maxFanout) #Selects the root and caps used by relationship-radial ego layouts.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- nodeId System.String
- The root node id.
- maxDepth System.Int32
- The maximum number of relationship hops to expand.
- maxFanout System.Int32
- The maximum neighbor count expanded per node.
Returns
The current render options.
WithRequiredIcons(ChartForgeX.Topology.TopologyRenderOptions options, System.Boolean required) #Requires all topology icon ids to resolve in the active icon catalog before rendering.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- required System.Boolean
- Whether unresolved icon ids should fail validation.
Returns
The current render options.
WithSelectedEdge(ChartForgeX.Topology.TopologyRenderOptions options, System.String edgeId) #Marks a topology edge as selected without filtering or dimming the chart.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- edgeId System.String
- The edge id.
Returns
The current render options.
WithSelectedGroup(ChartForgeX.Topology.TopologyRenderOptions options, System.String groupId) #Marks a topology group as selected without filtering or dimming the chart.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- groupId System.String
- The group id.
Returns
The current render options.
WithSelectedNode(ChartForgeX.Topology.TopologyRenderOptions options, System.String nodeId) #Marks a topology node as selected without filtering or dimming the chart.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- nodeId System.String
- The node id.
Returns
The current render options.
WithTopologyEdgeVisualStyle(ChartForgeX.Topology.TopologyRenderOptions options, ChartForgeX.Core.ChartLineVisualStyle style) #Uses a caller supplied visual style for topology edge strokes across SVG and PNG output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- style ChartForgeX.Core.ChartLineVisualStyle
- The edge stroke visual style. Pass null to return to the topology default.
Returns
The current render options.