API Reference
Class
TopologyScenarioStep
Describes one node or edge reference inside a topology scenario.
Inheritance
- Object
- TopologyScenarioStep
Usage
Explore 13 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 5
- Method TopologyChartExtensions.WithDuration
- Method TopologyChartExtensions.WithMetadata
- Property TopologyScenario.Steps
- Extension method TopologyScenarioStep.WithDuration
- Extension method TopologyScenarioStep.WithMetadata
Accepted by parameters 8
- Method TopologyChartExtensions.AddEdgeStep
- Method TopologyChartExtensions.AddNodeStep
- Method TopologyChartExtensions.WithDuration
- Method TopologyChartExtensions.WithMetadata
- Extension method TopologyScenario.AddEdgeStep
- Extension method TopologyScenario.AddNodeStep
- Extension method TopologyScenarioStep.WithDuration
- Extension method TopologyScenarioStep.WithMetadata
Constructors
public TopologyScenarioStep() #Inherited Methods
public virtual Boolean Equals(Object? obj) #Returns:
BooleanInherited from Object
Parameters
- obj Object?
Properties
public String Id { get; set; } #Gets or sets the referenced node or edge id.
public TopologyScenarioStepKind Kind { get; set; } #Gets or sets whether this step references a node or an edge.
public String? Label { get; set; } #Gets or sets an optional step label.
public String? Description { get; set; } #Gets or sets an optional step description.
public Int32? DurationMilliseconds { get; set; } #Gets or sets an optional playback duration that overrides the route default.
public Dictionary<String, String> Metadata { get; } #Gets arbitrary step metadata for route inspectors and host adapters.
Extension Methods
public static TopologyScenarioStep WithDuration(TopologyScenarioStep step, Int32 durationMilliseconds) #Returns:
TopologyScenarioStepOverrides how long this route step remains visible during timeline playback.
Parameters
- step ChartForgeX.Topology.TopologyScenarioStep
- durationMilliseconds System.Int32
public static TopologyScenarioStep WithMetadata(TopologyScenarioStep step, String key, String? value) #Returns:
TopologyScenarioStepAdds host-readable metadata to a topology scenario step.
Parameters
- step ChartForgeX.Topology.TopologyScenarioStep
- The topology scenario step.
- key System.String
- The metadata key.
- value System.String?
- The metadata value.
Returns
The current scenario step.