API Reference
TopologyMotionOptions
Defines deterministic, script-free topology motion for SVG and sampled raster exports.
Inheritance
- Object
- TopologyMotionOptions
Usage
Explore 26 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 11
- Method TopologyMotionOptions.AddEdges
- Method TopologyMotionOptions.AtProgress
- Method TopologyMotionOptions.RoutePulse
- Method TopologyMotionOptions.RoutePulseForEdges
- Method TopologyMotionOptions.RoutePulseForScenario
- Method TopologyMotionOptions.WithDuration
- Method TopologyMotionOptions.WithEndpointPulses
- Method TopologyMotionOptions.WithFrameLimit
- Method TopologyMotionOptions.WithFrameRate
- Method TopologyMotionOptions.WithMarker
- Method TopologyMotionOptions.WithMarkerColor
Accepted by parameters 15
- Extension method PreparedTopology.WithMotion
- Extension method TopologyChart.SaveApng
- Extension method TopologyChart.SaveGif
- Extension method TopologyChart.ToApng
- Extension method TopologyChart.ToGif
- Extension method TopologyChart.WithMotion
- Extension method TopologyChart.WriteApng
- Extension method TopologyChart.WriteGif
- Method TopologyMotionExtensions.SaveApng
- Method TopologyMotionExtensions.SaveGif
- Method TopologyMotionExtensions.ToApng
- Method TopologyMotionExtensions.ToGif
- Method TopologyMotionExtensions.WithMotion
- Method TopologyMotionExtensions.WriteApng
- Method TopologyMotionExtensions.WriteGif
Constructors
public TopologyMotionOptions() #Methods
public TopologyMotionOptions AddEdges(params String[] edgeIds) #TopologyMotionOptionsAdds explicit edge ids to the route motion source.
Parameters
- edgeIds System.String[]
- The edge ids to animate.
Returns
The current motion options.
public TopologyMotionOptions AtProgress(Double progress) #TopologyMotionOptionsSets the sampled progress used by static raster frame rendering.
Parameters
- progress System.Double
- Progress from 0.0 to 1.0.
Returns
The current motion options.
public static TopologyMotionOptions RoutePulse(String? scenarioId = null, params String[] edgeIds) #TopologyMotionOptionsCreates a route-pulse motion preset for topology scenarios and map routes.
Parameters
- scenarioId System.String? = null
- Optional scenario id to animate.
- edgeIds System.String[]
- Optional explicit edge ids to animate without requiring a scenario.
Returns
Topology motion options.
public static TopologyMotionOptions RoutePulseForEdges(params String[] edgeIds) #TopologyMotionOptionsCreates a route-pulse motion preset from explicit topology edge ids.
Parameters
- edgeIds System.String[]
- Explicit edge ids to animate without requiring a scenario.
Returns
Topology motion options.
public static TopologyMotionOptions RoutePulseForScenario(String scenarioId) #TopologyMotionOptionsCreates a route-pulse motion preset from a topology scenario.
Parameters
- scenarioId System.String
- Scenario id to animate.
Returns
Topology motion options.
public TopologyMotionOptions WithDuration(Double seconds) #TopologyMotionOptionsSets the animation duration.
Parameters
- seconds System.Double
- The duration in seconds.
Returns
The current motion options.
public TopologyMotionOptions WithEndpointPulses(Boolean enabled = true) #TopologyMotionOptionsEnables or disables endpoint node pulses for explicit-edge route motion.
Parameters
- enabled System.Boolean = true
- Whether endpoint nodes should pulse.
Returns
The current motion options.
public TopologyMotionOptions WithFrameLimit(Int32 maximumFrames) #TopologyMotionOptionsSets the maximum number of frames sampled by animated raster exports.
Parameters
- maximumFrames System.Int32
- The maximum sampled frame count.
Returns
The current motion options.
public TopologyMotionOptions WithFrameRate(Double framesPerSecond) #TopologyMotionOptionsSets the sampled frame rate used by animated raster exports.
Parameters
- framesPerSecond System.Double
- The sampled frame rate.
Returns
The current motion options.
public TopologyMotionOptions WithMarker(Double radius, String? color = null) #TopologyMotionOptionsSets the moving route marker radius and optional color.
Parameters
- radius System.Double
- The marker radius.
- color System.String? = null
- Optional marker color.
Returns
The current motion options.
public TopologyMotionOptions WithMarkerColor(String? color) #TopologyMotionOptionsSets the optional moving route marker color.
Parameters
- color System.String?
- The marker color. Empty values clear the override.
Returns
The current motion options.
Inherited Methods
public virtual Boolean Equals(Object? obj) #BooleanParameters
- obj Object?
Properties
public String? ScenarioId { get; set; } #Gets or sets the scenario id used as the route source. When unset, the active scenario or first scenario is used.
public List<String> EdgeIds { get; } #Gets edge ids used as an explicit route source. When set, these edges are animated without requiring a scenario.
public Double DurationSeconds { get; set; } #Gets or sets the animation duration in seconds.
public Double FramesPerSecond { get; set; } #Gets or sets the sampled frame rate used by animated raster exports.
public Int32 MaximumRasterFrames { get; set; } #Gets or sets the maximum number of frames sampled by animated raster exports.
public Boolean Loop { get; set; } #Gets or sets whether the animation loops.
public Double Progress { get; set; } #Gets or sets the sampled progress from 0.0 to 1.0 used by raster frame rendering.
public Double MarkerRadius { get; set; } #Gets or sets the moving route marker radius.
public String? MarkerColor { get; set; } #Gets or sets the optional moving route marker color. When unset, the scenario or edge color is used.
public Boolean PulseRouteEndpoints { get; set; } #Gets or sets whether explicit edge motion should pulse source and target nodes.