Project

ChartForgeX

Render deterministic charts, dashboards, topology, hierarchy, and report visuals directly from .NET.

View on GitHub Releases Get package
Stars 47
Forks 2
NuGet downloads 75,067
Release ChartForgeX-v2.0.0
Language: HTML Updated: 2026-10-12

API Reference

Class

TopologyRenderOptions

Namespace ChartForgeX.Topology
Assembly ChartForgeX
Modifiers sealed

Defines topology rendering options.

Inheritance

  • Object
  • TopologyRenderOptions

Usage

Explore 217 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 66

Accepted by parameters 151

Constructors

public TopologyRenderOptions() #

Methods

public TopologyRenderOptions Clone() #
Returns: TopologyRenderOptions

Creates an independent copy suitable for adapter-specific adjustments.

public static TopologyRenderOptions FromPreset(TopologyViewPreset preset) #
Returns: TopologyRenderOptions

Creates render options from a reusable topology view preset.

Parameters

preset ChartForgeX.Topology.TopologyViewPreset requiredposition: 0
The preset to apply.

Returns

Topology render options.

Properties

public TextMeasurementMode TextMeasurementMode { get; set; } #

Gets or sets the text-width policy. Portable estimates preserve host-independent geometry by default; installed-font measurement is opt-in.

public Boolean IncludeTitle { get; set; } #

Gets or sets whether the chart title should be rendered.

public Boolean IncludeLegend { get; set; } #

Gets or sets whether the legend should be rendered.

public Boolean IncludeGroups { get; set; } #

Gets or sets whether group containers should be rendered.

public Boolean IncludeGroupLabels { get; set; } #

Gets or sets whether group labels should be rendered.

public Boolean IncludeNodeLabels { get; set; } #

Gets or sets whether node labels should be rendered.

public Boolean IncludeIconLabels { get; set; } #

Gets or sets whether icon-mode nodes should render compact labels below the icon.

public Boolean IncludeTileSubtitles { get; set; } #

Gets or sets whether tile nodes should render their subtitle as a compact chip below the tile label.

public Boolean ReadableDenseLayout { get; set; } #

Gets or sets whether TopologyLayoutMode.DenseGrouped uses the readable dense layout for large replication-style maps: left-to-right or right-to-left layouts with more than six groups wrap site panels into rows no wider than the viewport, site panels take the height of their content (panels in one row share a height) and the canvas height follows the content instead of the requested viewport height, TopologyGroupLayoutPolicy.Auto groups of 10–24 nodes keep cards in a grid (only larger groups collapse to dots), card spacing reserves room for tile captions, and obstacle-avoiding routes treat captions as part of the card and fall back to a grid search when a route would cross another card. Off by default so existing dense charts render unchanged.

public Boolean ShareIncomingTrunks { get; set; } #

Gets or sets whether readable obstacle-avoiding routes of one kind into the same target may join a shared final trunk. Only matching solid styles, target ports and highlight/selection states join; authored routes retain their geometry. Each relationship retains its own full route and metadata. Off by default.

public Boolean AllowMultilineNodeLabels { get; set; } #

Gets or sets whether explicit line breaks in node labels and subtitles should be rendered as multiple SVG/PNG text rows.

public Boolean WrapNodeLabels { get; set; } #

Gets or sets whether node labels and subtitles can wrap at word boundaries when they exceed their available width.

public Int32 MaxNodeLabelLines { get; set; } #

Gets or sets the maximum number of rendered title rows for card, compact-card, tile, and icon-label node text.

public Int32 MaxNodeSubtitleLines { get; set; } #

Gets or sets the maximum number of rendered subtitle rows for card and tile node text.

public TopologyCardSubtitleMode CardSubtitleMode { get; set; } #

Gets or sets how card and compact-card node subtitles should be rendered.

public Boolean IncludeEdgeLabels { get; set; } #

Gets or sets whether edge labels should be rendered.

public Boolean IncludeEndpointLabels { get; set; } #

Gets or sets whether source and target endpoint labels should be rendered.

public Boolean IncludeEdgeLabelBackplates { get; set; } #

Gets or sets whether edge labels should render a subtle background plate.

public Boolean IncludeEdgeLabelLeaders { get; set; } #

Gets or sets whether displaced edge labels should draw a subtle leader back to their edge route.

public Boolean IncludeDirectionMarkers { get; set; } #

Gets or sets whether direction markers should be rendered on directed edges.

public Boolean IncludeStatusBadges { get; set; } #

Gets or sets whether node status badges should be rendered.

public Boolean IncludeGroupStatusDots { get; set; } #

Gets or sets whether monitoring group headers should render compact status dots.

public Boolean IncludeTooltips { get; set; } #

Gets or sets whether SVG title tooltip elements should be rendered.

public Boolean IncludeCss { get; set; } #

Gets or sets whether scoped CSS should be emitted.

public Boolean IncludeDataAttributes { get; set; } #

Gets or sets whether element metadata and metrics should be emitted as SVG data attributes.

public Boolean IncludeLayoutDiagnosticOverlay { get; set; } #

Gets or sets whether renderers should draw a developer-oriented layout geometry overlay.

public Boolean UseResponsiveSvg { get; set; } #

Gets or sets whether the SVG should include responsive sizing style.

public Boolean FitContentToViewport { get; set; } #

Gets or sets whether rendered topology content should scale down to remain inside the requested viewport instead of expanding it.

public Boolean EnableHtmlInteractions { get; set; } #

Gets or sets whether complete HTML pages should include lightweight selection interactions. Defaults to static, script-free HTML.

public Boolean EnableHtmlViewportControls { get; set; } #

Gets or sets whether interactive HTML pages should include lightweight zoom and pan controls.

public Boolean EnableHtmlExportControls { get; set; } #

Gets or sets whether interactive HTML pages should include lightweight SVG and PNG export controls.

public Boolean EnableHtmlForceGraphControls { get; set; } #

Gets or sets whether force-directed HTML pages should include graph exploration controls.

public Boolean EnableHtmlSynchronizedState { get; set; } #

Gets or sets whether interactive HTML pages should synchronize selection and viewport state with wrappers in the same sync group.

public Boolean EnableHtmlScenarioControls { get; set; } #

Gets or sets whether interactive HTML pages should render scenario picker controls when scenarios are present.

public TopologyHtmlScenarioControlMode HtmlScenarioControlMode { get; set; } #

Gets or sets how interactive HTML pages should render scenario controls.

public Boolean EnableHtmlScenarioPanel { get; set; } #

Gets or sets whether interactive HTML pages should render a compact scenario detail panel when scenarios are present.

public Boolean EnableHtmlSelectionPanel { get; set; } #

Gets or sets whether interactive HTML pages should render a compact selected-record panel for clicked nodes, edges, and groups.

public Boolean EnableHtmlFullscreenControl { get; set; } #

Gets or sets whether interactive HTML pages should render a fullscreen viewport control.

public TopologyHtmlControlPlacement HtmlControlPlacement { get; set; } #

Gets or sets where viewport, fullscreen, and export controls are placed in interactive HTML output.

public Boolean EnableHtmlScenarioUrlState { get; set; } #

Gets or sets whether interactive HTML pages should read and update scenario state from the page query string.

public String? HtmlSyncGroupName { get; set; } #

Gets or sets the optional HTML synchronization group name used by topology wrappers on the same page.

public String? ActiveScenarioId { get; set; } #

Gets or sets the optional scenario id to activate when an interactive HTML page loads.

public Boolean IncludeGeographicCallouts { get; set; } #

Gets or sets whether geographic topology layouts should render map callout summaries for coordinated groups.

public Boolean IncludeGeographicRegionHulls { get; set; } #

Gets or sets whether geographic topology layouts should render soft status-colored region hulls around coordinated groups.

public Boolean PreferGeographicCalloutMapEdges { get; set; } #

Gets or sets whether geographic callouts should prefer map-edge placements before near-anchor placement.

public Int32 GeographicCalloutMaxItems { get; set; } #

Gets or sets the maximum number of geographic callout summaries to render.

public Double GeographicRegionHullPadding { get; set; } #

Gets or sets the padding added around nodes when calculating geographic region hull radius.

public Double GeographicRegionHullMinRadius { get; set; } #

Gets or sets the minimum geographic region hull radius.

public Double GeographicRegionHullMaxRadius { get; set; } #

Gets or sets the maximum geographic region hull radius.

public Boolean OpenLinksInNewTab { get; set; } #

Gets or sets whether links should open in a new tab.

public String? CssClassPrefix { get; set; } #

Gets or sets the CSS class prefix.

public String? IdScope { get; set; } #

Gets or sets an optional scope put in front of every SVG id the render emits (title, description, filters, arrow and endpoint markers, groups, nodes, edges, callouts, motion paths, and the cfxi- ids of icon artwork imported from SVG packs) and of the CSS rules scoped to the root id, so several renders of the same chart can share one document. Null or white space (the default) keeps the ids based on the chart id alone. Class names and data-* attributes do not change, and ids inside hand-written TopologyIconArtwork.InlineSvg artwork without the cfxi- prefix are not scoped.

public SvgColorVariables? SvgColorVariables { get; set; } #

Gets or sets the CSS custom properties the SVG writes for mapped colours, with the literal colour as fallback (see SvgColorVariables); null (the default) writes literal colours. PNG output always uses literal colours.

public Boolean PinStateColorsInForcedColors { get; set; } #

Gets or sets whether SVG output keeps status marks in their colours in forced-colours mode (Windows high contrast), as ChartOptions.PinStateColorsInForcedColors does for charts: edges and their arrow and endpoint markers, node status badges, group status dots, geographic callout status chips, node detail status dots, and status line and dot legend swatches get forced-color-adjust:none. Node and group cards, whose labels sit on the canvas, and geographic region hulls, which lie under such labels, keep following forced colours. The rule is written in a <style> element even when TopologyRenderOptions.IncludeCss is off. Off by default. A host that also remaps its colour variables in forced-colours mode must keep the values these marks use, because custom properties are not affected by forced-color-adjust. PNG output is not affected.

public TopologyView? View { get; set; } #

Gets or sets an optional focused topology view.

public TopologyViewPreset Preset { get; set; } #

Gets or sets a reusable render preset.

public TopologyLayoutPreset LayoutPreset { get; set; } #

Gets or sets a reusable spacing and presentation profile.

public Double? LayeredNodeSpacing { get; set; } #

Gets or sets an optional minimum gap between nodes within a layered rank.

public Double? LayeredRankSpacing { get; set; } #

Gets or sets an optional minimum gap between layered ranks.

public TopologyVisualStyle VisualStyle { get; set; } #

Gets or sets the reusable visual treatment used by renderers.

public Boolean UseForceGraphPresentation { get; set; } #

Gets or sets whether renderers should use force-graph presentation defaults for dense relationship clouds.

public TopologyForceLayoutProfile ForceLayoutProfile { get; set; } #

Gets or sets the deterministic force-directed solver profile.

public Int32? ForceLayoutIterations { get; set; } #

Gets or sets an optional force-directed solver iteration override.

public String? RelationshipRootNodeId { get; set; } #

Gets or sets an optional root node id for relationship-radial layouts.

public Int32 RelationshipRadialMaxDepth { get; set; } #

Gets or sets the maximum relationship depth for relationship-radial layouts.

public Int32 RelationshipRadialMaxFanout { get; set; } #

Gets or sets the maximum fanout expanded from each node in relationship-radial layouts.

public TopologyMapBackgroundStyle MapBackgroundStyle { get; set; } #

Gets or sets the geographic map background treatment.

public TopologyCanvasSurfaceStyle CanvasSurfaceStyle { get; set; } #

Gets or sets the dashboard-style canvas surface used behind non-geographic topology content.

public TopologyHeaderStyle HeaderStyle { get; set; } #

Gets or sets how the topology title area should be rendered.

public TopologyGroupSurfaceStyle GroupSurfaceStyle { get; set; } #

Gets or sets the group card fill treatment.

public TopologyNodeSurfaceStyle NodeSurfaceStyle { get; set; } #

Gets or sets the card-like node fill treatment.

public TopologyNodeDisplayMode NodeDisplayMode { get; set; } #

Gets or sets how topology nodes should be presented.

public TopologyArrowMarkerStyle ArrowMarkerStyle { get; set; } #

Gets or sets the marker shape used for directed topology edges.

public TopologyEdgeCornerStyle EdgeCornerStyle { get; set; } #

Gets or sets how orthogonal edge bends should be drawn.

public Double EdgeCornerRadius { get; set; } #

Gets or sets the radius used when rendering rounded orthogonal edge bends.

public ChartLineVisualStyle? EdgeVisualStyle { get; set; } #

Gets or sets an optional reusable visual style for topology edge strokes. When unset, the renderer uses its topology preset.

public TopologyIconCatalog? IconCatalog { get; set; } #

Gets or sets an optional icon catalog used to resolve node and group icon ids. When unset, the built-in catalog is used.

public Boolean RequireResolvedIcons { get; set; } #

Gets or sets whether unresolved node, group, and legend icon ids should fail validation instead of using renderer-owned fallback glyphs.

public TopologyLegendMode LegendMode { get; set; } #

Gets or sets how the topology legend should be sourced.

public String? EdgeLabelMetricKey { get; set; } #

Gets or sets the edge metric key to use as the primary edge label. When unset, the edge label is used.

public String? EdgeSecondaryLabelMetricKey { get; set; } #

Gets or sets the edge metric key to use as the secondary edge label. When unset, the edge secondary label is used.

public String? EdgeTertiaryLabelMetricKey { get; set; } #

Gets or sets the edge metric key to use as the tertiary edge label. When unset, the edge tertiary label is used.

public List<TopologyHealthStatus> HighlightStatuses { get; private set; } #

Gets health statuses to highlight while dimming non-matching topology elements.

public List<String> HighlightGroupIds { get; private set; } #

Gets group ids to highlight while dimming non-matching topology elements.

public List<String> HighlightNodeIds { get; private set; } #

Gets node ids to highlight while dimming non-matching topology elements.

public List<String> HighlightEdgeIds { get; private set; } #

Gets edge ids to highlight while dimming non-matching topology elements.

public Boolean HighlightConnectedEdges { get; set; } #

Gets or sets whether edges connected to highlighted nodes should also be highlighted.

public List<String> SelectedGroupIds { get; private set; } #

Gets group ids to mark as selected without filtering or dimming the topology.

public List<String> SelectedNodeIds { get; private set; } #

Gets node ids to mark as selected without filtering or dimming the topology.

public List<String> SelectedEdgeIds { get; private set; } #

Gets edge ids to mark as selected without filtering or dimming the topology.

public Double DimmedOpacity { get; set; } #

Gets or sets the opacity used for non-highlighted elements when highlighting is active.

public Int32 PngSupersamplingScale { get; set; } #

Gets or sets the PNG supersampling scale used by the topology PNG renderer.

public Int32 PngOutputScale { get; set; } #

Gets or sets the PNG output scale used by the topology PNG renderer.

Extension Methods

public static TopologyRenderOptions ApplyLayoutPreset(TopologyRenderOptions options, TopologyLayoutPreset preset) #
Returns: TopologyRenderOptions

Applies a reusable topology spacing and presentation profile.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
preset ChartForgeX.Topology.TopologyLayoutPreset requiredposition: 1
public static TopologyRenderOptions ApplyPreset(TopologyRenderOptions options, TopologyViewPreset preset) #
Returns: TopologyRenderOptions

Applies a preset to existing render options.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
preset ChartForgeX.Topology.TopologyViewPreset requiredposition: 1
The preset to apply.

Returns

The current render options.

public static TopologyRenderOptions WithActiveScenario(TopologyRenderOptions options, String scenarioId) #
Returns: TopologyRenderOptions

Activates an existing topology scenario for static highlighting and initial interactive HTML state.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
scenarioId System.String requiredposition: 1
The scenario id.

Returns

The current render options.

public static TopologyRenderOptions WithEdgeMetricLabels(TopologyRenderOptions options, String? primaryMetricKey, String? secondaryMetricKey = null, String? tertiaryMetricKey = null) #
Returns: TopologyRenderOptions

Uses edge metrics as stacked edge labels.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
primaryMetricKey System.String? requiredposition: 1
The metric key for the primary edge label.
secondaryMetricKey System.String? = null optionalposition: 2
The optional metric key for the secondary edge label.
tertiaryMetricKey System.String? = null optionalposition: 3
The optional metric key for the tertiary edge label.

Returns

The current render options.

public static TopologyRenderOptions WithFitContentToViewport(TopologyRenderOptions options) #
Returns: TopologyRenderOptions

Keeps topology output at the requested viewport size by scaling dense rendered content down when needed.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.

Returns

The current render options.

public static TopologyRenderOptions WithForceGraphStyle(TopologyRenderOptions options) #
Returns: TopologyRenderOptions

Applies a readable force-graph treatment for relationship-heavy topology clouds.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.

Returns

The current render options.

public static TopologyRenderOptions WithForceLayout(TopologyRenderOptions options, TopologyForceLayoutProfile profile, Int32? iterations = null) #
Returns: TopologyRenderOptions

Selects a deterministic force-directed solver profile.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
profile ChartForgeX.Topology.TopologyForceLayoutProfile requiredposition: 1
The force layout profile.
iterations System.Int32? = null optionalposition: 2
Optional solver iteration override.

Returns

The current render options.

public static TopologyRenderOptions WithHtmlControlPlacement(TopologyRenderOptions options, TopologyHtmlControlPlacement placement) #
Returns: TopologyRenderOptions

Places viewport, fullscreen, and export controls inside the interactive HTML topology viewport.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
placement ChartForgeX.Topology.TopologyHtmlControlPlacement requiredposition: 1
The control placement.

Returns

The current render options.

public static TopologyRenderOptions WithHtmlForceGraphControls(TopologyRenderOptions options, Boolean enabled = true) #
Returns: TopologyRenderOptions

Enables or disables force-directed graph exploration controls in interactive HTML output.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
enabled System.Boolean = true optionalposition: 1
Whether interactive HTML should render graph exploration controls.

Returns

The current render options.

public static TopologyRenderOptions WithHtmlFullscreenControl(TopologyRenderOptions options, Boolean enabled = true) #
Returns: TopologyRenderOptions

Enables or disables the fullscreen viewport control in interactive HTML output.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
enabled System.Boolean = true optionalposition: 1
Whether interactive HTML should render a fullscreen control.

Returns

The current render options.

public static TopologyRenderOptions WithHtmlScenarioCheckboxes(TopologyRenderOptions options) #
Returns: TopologyRenderOptions

Renders topology scenarios as independent route checkboxes.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.

Returns

The current render options.

public static TopologyRenderOptions WithHtmlScenarioControlMode(TopologyRenderOptions options, TopologyHtmlScenarioControlMode mode) #
Returns: TopologyRenderOptions

Chooses how topology scenario controls are rendered in interactive HTML output.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
mode ChartForgeX.Topology.TopologyHtmlScenarioControlMode requiredposition: 1
The scenario control mode.

Returns

The current render options.

public static TopologyRenderOptions WithHtmlScenarioControls(TopologyRenderOptions options, Boolean enabled = true) #
Returns: TopologyRenderOptions

Enables or disables topology scenario picker controls in interactive HTML output.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
enabled System.Boolean = true optionalposition: 1
Whether interactive HTML should render scenario picker controls.

Returns

The current render options.

public static TopologyRenderOptions WithHtmlScenarioPanel(TopologyRenderOptions options, Boolean enabled = true) #
Returns: TopologyRenderOptions

Enables or disables the compact topology scenario detail panel in interactive HTML output.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
enabled System.Boolean = true optionalposition: 1
Whether interactive HTML should render the scenario detail panel.

Returns

The current render options.

public static TopologyRenderOptions WithHtmlScenarioUrlState(TopologyRenderOptions options, Boolean enabled = true) #
Returns: TopologyRenderOptions

Enables or disables query-string scenario state in interactive HTML output.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
enabled System.Boolean = true optionalposition: 1
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) #
Returns: TopologyRenderOptions

Enables or disables the built-in selected-record panel in interactive HTML output.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
enabled System.Boolean = true optionalposition: 1
Whether interactive HTML should render the selected-record panel.

Returns

The current render options.

public static TopologyRenderOptions WithLuminousTopologyEdges(TopologyRenderOptions options) #
Returns: TopologyRenderOptions

Uses a stronger luminous topology edge style for dark dashboards and deliberate emphasis.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.

Returns

The current render options.

public static TopologyRenderOptions WithMindMapStyle(TopologyRenderOptions options) #
Returns: TopologyRenderOptions

Applies a clean informational treatment for centered mind maps.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.

Returns

The current render options.

public static TopologyRenderOptions WithMonitoringDashboardStyle(TopologyRenderOptions options) #
Returns: TopologyRenderOptions

Applies the reusable monitoring-dashboard visual treatment used for dense topology and geographic monitoring views.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.

Returns

The current render options.

public static TopologyRenderOptions WithMultilineNodeLabels(TopologyRenderOptions options, Boolean wrap = true, Int32 maxLabelLines = 2, Int32 maxSubtitleLines = 2) #
Returns: TopologyRenderOptions

Enables reusable multi-line node labels and optional word wrapping for dense relationship diagrams.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
wrap System.Boolean = true optionalposition: 1
Whether text should wrap at word boundaries when it exceeds the available width.
maxLabelLines System.Int32 = 2 optionalposition: 2
The maximum title rows.
maxSubtitleLines System.Int32 = 2 optionalposition: 3
The maximum subtitle rows.

Returns

The current render options.

public static TopologyRenderOptions WithNeutralGroupSurfaces(TopologyRenderOptions options) #
Returns: TopologyRenderOptions

Renders group containers as neutral cards while preserving status/identity borders and labels.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.

Returns

The current render options.

public static TopologyRenderOptions WithoutActiveScenario(TopologyRenderOptions options) #
Returns: TopologyRenderOptions

Clears the active topology scenario.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.

Returns

The current render options.

public static TopologyRenderOptions WithPlainTopologyEdges(TopologyRenderOptions options) #
Returns: TopologyRenderOptions

Uses a plain single-stroke topology edge style without halo or highlight layers.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.

Returns

The current render options.

public static TopologyRenderOptions WithRelationshipOverviewStyle(TopologyRenderOptions options) #
Returns: TopologyRenderOptions

Applies a reusable relationship-overview treatment for entity maps, dependency overviews, and evidence correlation diagrams.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.

Returns

The current render options.

public static TopologyRenderOptions WithRelationshipRadialFocus(TopologyRenderOptions options, String nodeId, Int32 maxDepth = 2, Int32 maxFanout = 18) #
Returns: TopologyRenderOptions

Selects the root and caps used by relationship-radial ego layouts.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
nodeId System.String requiredposition: 1
The root node id.
maxDepth System.Int32 = 2 optionalposition: 2
The maximum number of relationship hops to expand.
maxFanout System.Int32 = 18 optionalposition: 3
The maximum neighbor count expanded per node.

Returns

The current render options.

public static TopologyRenderOptions WithRequiredIcons(TopologyRenderOptions options, Boolean required = true) #
Returns: TopologyRenderOptions

Requires all topology icon ids to resolve in the active icon catalog before rendering.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
required System.Boolean = true optionalposition: 1
Whether unresolved icon ids should fail validation.

Returns

The current render options.

public static TopologyRenderOptions WithSelectedEdge(TopologyRenderOptions options, String edgeId) #
Returns: TopologyRenderOptions

Marks a topology edge as selected without filtering or dimming the chart.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
edgeId System.String requiredposition: 1
The edge id.

Returns

The current render options.

public static TopologyRenderOptions WithSelectedGroup(TopologyRenderOptions options, String groupId) #
Returns: TopologyRenderOptions

Marks a topology group as selected without filtering or dimming the chart.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
groupId System.String requiredposition: 1
The group id.

Returns

The current render options.

public static TopologyRenderOptions WithSelectedNode(TopologyRenderOptions options, String nodeId) #
Returns: TopologyRenderOptions

Marks a topology node as selected without filtering or dimming the chart.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
nodeId System.String requiredposition: 1
The node id.

Returns

The current render options.

public static TopologyRenderOptions WithStateColorsPinnedInForcedColors(TopologyRenderOptions options, Boolean pin = true) #
Returns: TopologyRenderOptions

Keeps status marks in their colours in forced-colours mode (see TopologyRenderOptions.PinStateColorsInForcedColors).

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
pin System.Boolean = true optionalposition: 1
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) #
Returns: TopologyRenderOptions

Uses a caller supplied visual style for topology edge strokes across SVG and PNG output.

Parameters

options ChartForgeX.Topology.TopologyRenderOptions requiredposition: 0
The render options.
style ChartForgeX.Core.ChartLineVisualStyle? requiredposition: 1
The edge stroke visual style. Pass null to return to the topology default.

Returns

The current render options.