API Reference
TopologyScenario
Describes an interactive path or story through a topology chart.
Inheritance
- Object
- TopologyScenario
Usage
Explore 31 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 15
- Property TopologyChart.Scenarios
- Method TopologyChartExtensions.AddEdgeStep
- Method TopologyChartExtensions.AddNodeStep
- Method TopologyChartExtensions.WithColor
- Method TopologyChartExtensions.WithDescription
- Method TopologyChartExtensions.WithMetadata
- Method TopologyChartExtensions.WithPlayback
- Method TopologyChartExtensions.WithSpotlight
- Extension method TopologyScenario.AddEdgeStep
- Extension method TopologyScenario.AddNodeStep
- Extension method TopologyScenario.WithColor
- Extension method TopologyScenario.WithDescription
- Extension method TopologyScenario.WithMetadata
- Extension method TopologyScenario.WithPlayback
- Extension method TopologyScenario.WithSpotlight
Accepted by parameters 16
- Extension method TopologyChart.AddScenario
- Method TopologyChartExtensions.AddEdgeStep
- Method TopologyChartExtensions.AddNodeStep
- Method TopologyChartExtensions.AddScenario
- Method TopologyChartExtensions.WithColor
- Method TopologyChartExtensions.WithDescription
- Method TopologyChartExtensions.WithMetadata
- Method TopologyChartExtensions.WithPlayback
- Method TopologyChartExtensions.WithSpotlight
- Extension method TopologyScenario.AddEdgeStep
- Extension method TopologyScenario.AddNodeStep
- Extension method TopologyScenario.WithColor
- Extension method TopologyScenario.WithDescription
- Extension method TopologyScenario.WithMetadata
- Extension method TopologyScenario.WithPlayback
- Extension method TopologyScenario.WithSpotlight
Constructors
public TopologyScenario() #Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String Id { get; set; } #Gets or sets the stable scenario identifier.
public String Label { get; set; } #Gets or sets the scenario label used by host controls.
public String? Description { get; set; } #Gets or sets an optional scenario description.
public String? Color { get; set; } #Gets or sets an optional scenario accent color.
public Int32 PlaybackDelayMilliseconds { get; set; } #Gets or sets the default time each route step remains visible during playback.
public Boolean LoopPlayback { get; set; } #Gets or sets whether playback returns to the first route step after the last.
public Boolean AutoPlay { get; set; } #Gets or sets whether an HTML adapter may start playback automatically when motion is allowed.
public Boolean Spotlight { get; set; } #Gets or sets whether non-route members are dimmed for a focused review.
public List<TopologyScenarioStep> Steps { get; } #Gets ordered node and edge references that participate in the scenario.
public Dictionary<String, String> Metadata { get; } #Gets arbitrary scenario metadata for host adapters.
Extension Methods
public static TopologyScenario AddEdgeStep(TopologyScenario scenario, String edgeId, String? label = null, String? description = null, Action<TopologyScenarioStep>? configure = null) #TopologyScenarioAdds a scenario segment that references an existing topology edge.
Parameters
- scenario ChartForgeX.Topology.TopologyScenario
- The topology scenario.
- edgeId System.String
- The edge id.
- label System.String? = null
- The optional segment label.
- description System.String? = null
- The optional segment description.
- configure System.Action<ChartForgeX.Topology.TopologyScenarioStep>? = null
- Optional step configuration.
Returns
The current scenario.
public static TopologyScenario AddNodeStep(TopologyScenario scenario, String nodeId, String? label = null, String? description = null, Action<TopologyScenarioStep>? configure = null) #TopologyScenarioAdds a scenario hop that references an existing topology node.
Parameters
- scenario ChartForgeX.Topology.TopologyScenario
- The topology scenario.
- nodeId System.String
- The node id.
- label System.String? = null
- The optional hop label.
- description System.String? = null
- The optional hop description.
- configure System.Action<ChartForgeX.Topology.TopologyScenarioStep>? = null
- Optional step configuration.
Returns
The current scenario.
public static TopologyScenario WithColor(TopologyScenario scenario, String? color) #TopologyScenarioSets an optional scenario accent color.
Parameters
- scenario ChartForgeX.Topology.TopologyScenario
- The topology scenario.
- color System.String?
- The scenario color.
Returns
The current scenario.
public static TopologyScenario WithDescription(TopologyScenario scenario, String? description) #TopologyScenarioSets an optional scenario description.
Parameters
- scenario ChartForgeX.Topology.TopologyScenario
- The topology scenario.
- description System.String?
- The scenario description.
Returns
The current scenario.
public static TopologyScenario WithMetadata(TopologyScenario scenario, String key, String? value) #TopologyScenarioAdds host-readable metadata to a topology scenario.
Parameters
- scenario ChartForgeX.Topology.TopologyScenario
- The topology scenario.
- key System.String
- The metadata key.
- value System.String?
- The metadata value.
Returns
The current scenario.
public static TopologyScenario WithPlayback(TopologyScenario scenario, Int32 stepDurationMilliseconds = 900, Boolean loop = false, Boolean autoPlay = false) #TopologyScenarioConfigures route timeline playback without enabling automatic playback by default.
Parameters
- scenario ChartForgeX.Topology.TopologyScenario
- stepDurationMilliseconds System.Int32 = 900
- loop System.Boolean = false
- autoPlay System.Boolean = false
public static TopologyScenario WithSpotlight(TopologyScenario scenario, Boolean enabled = true) #TopologyScenarioControls whether the route spotlights members by dimming surrounding topology.
Parameters
- scenario ChartForgeX.Topology.TopologyScenario
- enabled System.Boolean = true