layout: default title: GoToOptions parent: Core Classes —
dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Widgets
GoToOptions Class
Animation options for the goTo() method. See properties below for parameter specifications.
public class GoToOptions :
System.IEquatable<dymaptic.GeoBlazor.Core.Components.Widgets.GoToOptions>
Inheritance System.Object 🡒 GoToOptions
Implements System.IEquatable<GoToOptions>
Constructors
GoToOptions(Nullable, Nullable, string, Nullable, Nullable) Constructor
Animation options for the goTo() method. See properties below for parameter specifications.
public GoToOptions(System.Nullable<bool> Animate, System.Nullable<double> Duration, string? Easing, System.Nullable<double> SpeedFactor, System.Nullable<double> MaxDuration);
Parameters
Animate System.Nullable<System.Boolean>
Indicates if the transition to the new view should be animated. If set to false, speedFactor, duration, maxDuration, and easing properties are ignored.
Default Value is True.
Duration System.Nullable<System.Double>
Set the exact duration (in milliseconds) of the animation. Note that by default, animation duration is calculated based on the time required to reach the target at a constant speed. Setting duration overrides the speedFactor option. Note that the resulting duration is still limited to the maxDuration.
Easing System.String
The easing function to use for the animation. This may either be a preset (named) function, or a user specified function. Supported named presets are: linear, in-cubic, out-cubic, in-out-cubic, in-expo, out-expo, in-out-expo, in-out-coast-quadratic.
SpeedFactor System.Nullable<System.Double>
Increases or decreases the animation speed by the specified factor. A speedFactor of 2 will make the animation twice as fast, while a speedFactor of 0.5 will make the animation half as fast. Setting the speed factor will automatically adapt the default maxDuration accordingly.
Default Value is 1.
MaxDuration System.Nullable<System.Double>
The maximum allowed duration (in milliseconds) of the animation. The default maxDuration value takes the specified speedFactor into account.
Default Value is 8000.
Properties
GoToOptions.Animate Property
Indicates if the transition to the new view should be animated. If set to false, speedFactor, duration, maxDuration, and easing properties are ignored.
Default Value is True.
public System.Nullable<bool> Animate { get; set; }
Property Value
System.Nullable<System.Boolean>
GoToOptions.Duration Property
Set the exact duration (in milliseconds) of the animation. Note that by default, animation duration is calculated based on the time required to reach the target at a constant speed. Setting duration overrides the speedFactor option. Note that the resulting duration is still limited to the maxDuration.
public System.Nullable<double> Duration { get; set; }
Property Value
System.Nullable<System.Double>
GoToOptions.Easing Property
The easing function to use for the animation. This may either be a preset (named) function, or a user specified function. Supported named presets are: linear, in-cubic, out-cubic, in-out-cubic, in-expo, out-expo, in-out-expo, in-out-coast-quadratic.
public string? Easing { get; set; }
Property Value
GoToOptions.MaxDuration Property
The maximum allowed duration (in milliseconds) of the animation. The default maxDuration value takes the specified speedFactor into account.
Default Value is 8000.
public System.Nullable<double> MaxDuration { get; set; }
Property Value
System.Nullable<System.Double>
GoToOptions.SpeedFactor Property
Increases or decreases the animation speed by the specified factor. A speedFactor of 2 will make the animation twice as fast, while a speedFactor of 0.5 will make the animation half as fast. Setting the speed factor will automatically adapt the default maxDuration accordingly.
Default Value is 1.
public System.Nullable<double> SpeedFactor { get; set; }