Skip to content
ChartForgeX
Class

TopologyScenarioStoryExtensions

ChartForgeX.Topology

Edit on GitHub
Namespace
ChartForgeX.Topology
Assembly
ChartForgeX.Stories
Source
TopologyScenarioStory.cs:42
Modifiers
static

Turns topology scenarios into visual stories: one scene per step, with the step highlighted on the topology and its request or response payload beside it. The stories export to SVG, PNG per step, GIF, APNG, and HTML.

Inheritance

  • object
  • TopologyScenarioStoryExtensions

Methods

public static VisualStory ToScenarioStory(TopologyChart chart, string scenarioId, TopologyScenarioStoryOptions? options = null) #
TopologyScenarioStory.cs:42

Builds a visual story with one scene per scenario step.

Parameters

chart ChartForgeX.Topology.TopologyChart required
The topology chart.
scenarioId string required
The scenario id.
options ChartForgeX.Topology.TopologyScenarioStoryOptions? = null optional
Optional story options.

Returns

VisualStory A visual story whose chapters are the scenario steps.

Fields

public const int MaximumSteps #
TopologyScenarioStory.cs:32

Visual stories hold at most this many scenes, so longer scenarios are rejected.

Value: 24