Project

ChartForgeX

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

Stars 45
Forks 2
NuGet downloads 48,107
Release ChartForgeX-v1.7.0
Language: HTML Updated: 2026-09-02

API Reference

Class

TopologyRenderOptions

Namespace ChartForgeX.Topology

Defines topology rendering options.

Inheritance

  • Object
  • TopologyRenderOptions

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Accepted by parameters

Methods

FromPreset(ChartForgeX.Topology.TopologyViewPreset preset) #

Creates render options from a reusable topology view preset.

Parameters

preset ChartForgeX.Topology.TopologyViewPreset required
The preset to apply.

Returns

Topology render options.

Properties

IncludeTitle #

Gets or sets whether the chart title should be rendered.

IncludeLegend #

Gets or sets whether the legend should be rendered.

IncludeGroups #

Gets or sets whether group containers should be rendered.

IncludeGroupLabels #

Gets or sets whether group labels should be rendered.

IncludeNodeLabels #

Gets or sets whether node labels should be rendered.

IncludeIconLabels #

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

IncludeTileSubtitles #

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

AllowMultilineNodeLabels #

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

WrapNodeLabels #

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

MaxNodeLabelLines #

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

MaxNodeSubtitleLines #

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

CardSubtitleMode #

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

IncludeEdgeLabels #

Gets or sets whether edge labels should be rendered.

IncludeEdgeLabelBackplates #

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

IncludeEdgeLabelLeaders #

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

IncludeDirectionMarkers #

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

IncludeStatusBadges #

Gets or sets whether node status badges should be rendered.

IncludeGroupStatusDots #

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

IncludeTooltips #

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

IncludeCss #

Gets or sets whether scoped CSS should be emitted.

IncludeDataAttributes #

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

UseResponsiveSvg #

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

FitContentToViewport #

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

EnableHtmlInteractions #

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

EnableHtmlViewportControls #

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

EnableHtmlExportControls #

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

EnableHtmlForceGraphControls #

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

EnableHtmlSynchronizedState #

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

EnableHtmlScenarioControls #

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

HtmlScenarioControlMode #

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

EnableHtmlScenarioPanel #

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

EnableHtmlSelectionPanel #

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

EnableHtmlFullscreenControl #

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

HtmlControlPlacement #

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

EnableHtmlScenarioUrlState #

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

HtmlSyncGroupName #

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

ActiveScenarioId #

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

Motion #

Gets or sets optional script-free topology motion for SVG and sampled raster exports.

IncludeGeographicCallouts #

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

IncludeGeographicRegionHulls #

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

PreferGeographicCalloutMapEdges #

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

GeographicCalloutMaxItems #

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

GeographicRegionHullPadding #

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

GeographicRegionHullMinRadius #

Gets or sets the minimum geographic region hull radius.

GeographicRegionHullMaxRadius #

Gets or sets the maximum geographic region hull radius.

OpenLinksInNewTab #

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

CssClassPrefix #

Gets or sets the CSS class prefix.

View #

Gets or sets an optional focused topology view.

Preset #

Gets or sets a reusable render preset.

VisualStyle #

Gets or sets the reusable visual treatment used by renderers.

UseForceGraphPresentation #

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

ForceLayoutProfile #

Gets or sets the deterministic force-directed solver profile.

ForceLayoutIterations #

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

RelationshipRootNodeId #

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

RelationshipRadialMaxDepth #

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

RelationshipRadialMaxFanout #

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

MapBackgroundStyle #

Gets or sets the geographic map background treatment.

CanvasSurfaceStyle #

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

HeaderStyle #

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

GroupSurfaceStyle #

Gets or sets the group card fill treatment.

NodeSurfaceStyle #

Gets or sets the card-like node fill treatment.

NodeDisplayMode #

Gets or sets how topology nodes should be presented.

ArrowMarkerStyle #

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

EdgeCornerStyle #

Gets or sets how orthogonal edge bends should be drawn.

EdgeCornerRadius #

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

EdgeVisualStyle #

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

IconCatalog #

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

RequireResolvedIcons #

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

LegendMode #

Gets or sets how the topology legend should be sourced.

EdgeLabelMetricKey #

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

EdgeSecondaryLabelMetricKey #

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

EdgeTertiaryLabelMetricKey #

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

HighlightStatuses #

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

HighlightGroupIds #

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

HighlightNodeIds #

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

HighlightEdgeIds #

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

HighlightConnectedEdges #

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

SelectedGroupIds #

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

SelectedNodeIds #

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

SelectedEdgeIds #

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

DimmedOpacity #

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

PngSupersamplingScale #

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

PngOutputScale #

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