API Reference
TopologyMotionOptions
Defines deterministic, script-free topology motion for SVG and sampled raster exports.
Inheritance
- Object
- TopologyMotionOptions
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
AddEdges(System.String[] edgeIds) #Adds explicit edge ids to the route motion source.
Parameters
- edgeIds System.String[]
- The edge ids to animate.
Returns
The current motion options.
AtProgress(System.Double progress) #Sets 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.
RoutePulse(System.String scenarioId, System.String[] edgeIds) #Creates a route-pulse motion preset for topology scenarios and map routes.
Parameters
- scenarioId System.String
- Optional scenario id to animate.
- edgeIds System.String[]
- Optional explicit edge ids to animate without requiring a scenario.
Returns
Topology motion options.
RoutePulseForEdges(System.String[] edgeIds) #Creates 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.
RoutePulseForScenario(System.String scenarioId) #Creates a route-pulse motion preset from a topology scenario.
Parameters
- scenarioId System.String
- Scenario id to animate.
Returns
Topology motion options.
WithDuration(System.Double seconds) #Sets the animation duration.
Parameters
- seconds System.Double
- The duration in seconds.
Returns
The current motion options.
WithEndpointPulses(System.Boolean enabled) #Enables or disables endpoint node pulses for explicit-edge route motion.
Parameters
- enabled System.Boolean
- Whether endpoint nodes should pulse.
Returns
The current motion options.
WithFrameLimit(System.Int32 maximumFrames) #Sets the maximum number of frames sampled by animated raster exports.
Parameters
- maximumFrames System.Int32
- The maximum sampled frame count.
Returns
The current motion options.
WithFrameRate(System.Double framesPerSecond) #Sets the sampled frame rate used by animated raster exports.
Parameters
- framesPerSecond System.Double
- The sampled frame rate.
Returns
The current motion options.
WithMarker(System.Double radius, System.String color) #Sets the moving route marker radius and optional color.
Parameters
- radius System.Double
- The marker radius.
- color System.String
- Optional marker color.
Returns
The current motion options.
WithMarkerColor(System.String color) #Sets the optional moving route marker color.
Parameters
- color System.String
- The marker color. Empty values clear the override.
Returns
The current motion options.
Properties
ScenarioId #Gets or sets the scenario id used as the route source. When unset, the active scenario or first scenario is used.
EdgeIds #Gets edge ids used as an explicit route source. When set, these edges are animated without requiring a scenario.
DurationSeconds #Gets or sets the animation duration in seconds.
FramesPerSecond #Gets or sets the sampled frame rate used by animated raster exports.
MaximumRasterFrames #Gets or sets the maximum number of frames sampled by animated raster exports.
Loop #Gets or sets whether the animation loops.
Progress #Gets or sets the sampled progress from 0.0 to 1.0 used by raster frame rendering.
MarkerRadius #Gets or sets the moving route marker radius.
MarkerColor #Gets or sets the optional moving route marker color. When unset, the scenario or edge color is used.
PulseRouteEndpoints #Gets or sets whether explicit edge motion should pulse source and target nodes.