API Reference
TopologyRenderOptionsExtensions
Provides reusable topology render-option presets.
Inheritance
- Object
- TopologyRenderOptionsExtensions
Methods
public static TopologyRenderOptions ApplyLayoutPreset(TopologyRenderOptions options, TopologyLayoutPreset preset) #TopologyRenderOptionsApplies a reusable topology spacing and presentation profile.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- preset ChartForgeX.Topology.TopologyLayoutPreset
public static TopologyRenderOptions ApplyPreset(TopologyRenderOptions options, TopologyViewPreset preset) #TopologyRenderOptionsApplies 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.
public static TopologyRenderOptions WithActiveScenario(TopologyRenderOptions options, String scenarioId) #TopologyRenderOptionsActivates 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.
public static TopologyRenderOptions WithEdgeMetricLabels(TopologyRenderOptions options, String? primaryMetricKey, String? secondaryMetricKey = null, String? tertiaryMetricKey = null) #TopologyRenderOptionsUses 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? = null
- The optional metric key for the secondary edge label.
- tertiaryMetricKey System.String? = null
- The optional metric key for the tertiary edge label.
Returns
The current render options.
public static TopologyRenderOptions WithFitContentToViewport(TopologyRenderOptions options) #TopologyRenderOptionsKeeps 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.
public static TopologyRenderOptions WithForceGraphStyle(TopologyRenderOptions options) #TopologyRenderOptionsApplies a readable force-graph treatment for relationship-heavy topology clouds.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
public static TopologyRenderOptions WithForceLayout(TopologyRenderOptions options, TopologyForceLayoutProfile profile, Int32? iterations = null) #TopologyRenderOptionsSelects a deterministic force-directed solver profile.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- profile ChartForgeX.Topology.TopologyForceLayoutProfile
- The force layout profile.
- iterations System.Int32? = null
- Optional solver iteration override.
Returns
The current render options.
public static TopologyRenderOptions WithHtmlControlPlacement(TopologyRenderOptions options, TopologyHtmlControlPlacement placement) #TopologyRenderOptionsPlaces 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.
public static TopologyRenderOptions WithHtmlForceGraphControls(TopologyRenderOptions options, Boolean enabled = true) #TopologyRenderOptionsEnables or disables force-directed graph exploration controls in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- enabled System.Boolean = true
- Whether interactive HTML should render graph exploration controls.
Returns
The current render options.
public static TopologyRenderOptions WithHtmlFullscreenControl(TopologyRenderOptions options, Boolean enabled = true) #TopologyRenderOptionsEnables or disables the fullscreen viewport control in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- enabled System.Boolean = true
- Whether interactive HTML should render a fullscreen control.
Returns
The current render options.
public static TopologyRenderOptions WithHtmlScenarioCheckboxes(TopologyRenderOptions options) #TopologyRenderOptionsRenders topology scenarios as independent route checkboxes.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
public static TopologyRenderOptions WithHtmlScenarioControlMode(TopologyRenderOptions options, TopologyHtmlScenarioControlMode mode) #TopologyRenderOptionsChooses 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.
public static TopologyRenderOptions WithHtmlScenarioControls(TopologyRenderOptions options, Boolean enabled = true) #TopologyRenderOptionsEnables or disables topology scenario picker controls in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- enabled System.Boolean = true
- Whether interactive HTML should render scenario picker controls.
Returns
The current render options.
public static TopologyRenderOptions WithHtmlScenarioPanel(TopologyRenderOptions options, Boolean enabled = true) #TopologyRenderOptionsEnables or disables the compact topology scenario detail panel in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- enabled System.Boolean = true
- Whether interactive HTML should render the scenario detail panel.
Returns
The current render options.
public static TopologyRenderOptions WithHtmlScenarioUrlState(TopologyRenderOptions options, Boolean enabled = true) #TopologyRenderOptionsEnables or disables query-string scenario state in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- enabled System.Boolean = true
- Whether interactive HTML should read and update scenario state from the page query string.
Returns
The current render options.
public static TopologyRenderOptions WithHtmlSelectionPanel(TopologyRenderOptions options, Boolean enabled = true) #TopologyRenderOptionsEnables or disables the built-in selected-record panel in interactive HTML output.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- enabled System.Boolean = true
- Whether interactive HTML should render the selected-record panel.
Returns
The current render options.
public static TopologyRenderOptions WithLuminousTopologyEdges(TopologyRenderOptions options) #TopologyRenderOptionsUses 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.
public static TopologyRenderOptions WithMindMapStyle(TopologyRenderOptions options) #TopologyRenderOptionsApplies a clean informational treatment for centered mind maps.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
public static TopologyRenderOptions WithMonitoringDashboardStyle(TopologyRenderOptions options) #TopologyRenderOptionsApplies 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.
public static TopologyRenderOptions WithMultilineNodeLabels(TopologyRenderOptions options, Boolean wrap = true, Int32 maxLabelLines = 2, Int32 maxSubtitleLines = 2) #TopologyRenderOptionsEnables reusable multi-line node labels and optional word wrapping for dense relationship diagrams.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- wrap System.Boolean = true
- Whether text should wrap at word boundaries when it exceeds the available width.
- maxLabelLines System.Int32 = 2
- The maximum title rows.
- maxSubtitleLines System.Int32 = 2
- The maximum subtitle rows.
Returns
The current render options.
public static TopologyRenderOptions WithNeutralGroupSurfaces(TopologyRenderOptions options) #TopologyRenderOptionsRenders 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.
public static TopologyRenderOptions WithoutActiveScenario(TopologyRenderOptions options) #TopologyRenderOptionsClears the active topology scenario.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
Returns
The current render options.
public static TopologyRenderOptions WithPlainTopologyEdges(TopologyRenderOptions options) #TopologyRenderOptionsUses 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.
public static TopologyRenderOptions WithRelationshipOverviewStyle(TopologyRenderOptions options) #TopologyRenderOptionsApplies 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.
public static TopologyRenderOptions WithRelationshipRadialFocus(TopologyRenderOptions options, String nodeId, Int32 maxDepth = 2, Int32 maxFanout = 18) #TopologyRenderOptionsSelects 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 = 2
- The maximum number of relationship hops to expand.
- maxFanout System.Int32 = 18
- The maximum neighbor count expanded per node.
Returns
The current render options.
public static TopologyRenderOptions WithRequiredIcons(TopologyRenderOptions options, Boolean required = true) #TopologyRenderOptionsRequires all topology icon ids to resolve in the active icon catalog before rendering.
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- required System.Boolean = true
- Whether unresolved icon ids should fail validation.
Returns
The current render options.
public static TopologyRenderOptions WithSelectedEdge(TopologyRenderOptions options, String edgeId) #TopologyRenderOptionsMarks 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.
public static TopologyRenderOptions WithSelectedGroup(TopologyRenderOptions options, String groupId) #TopologyRenderOptionsMarks 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.
public static TopologyRenderOptions WithSelectedNode(TopologyRenderOptions options, String nodeId) #TopologyRenderOptionsMarks 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.
public static TopologyRenderOptions WithStateColorsPinnedInForcedColors(TopologyRenderOptions options, Boolean pin = true) #TopologyRenderOptionsKeeps status marks in their colours in forced-colours mode (see TopologyRenderOptions.PinStateColorsInForcedColors).
Parameters
- options ChartForgeX.Topology.TopologyRenderOptions
- The render options.
- pin System.Boolean = true
- True to pin the status colours; false (the default) lets forced colours apply.
Returns
The current render options.
public static TopologyRenderOptions WithTopologyEdgeVisualStyle(TopologyRenderOptions options, ChartLineVisualStyle? style) #TopologyRenderOptionsUses 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.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?