GeoBlazor Pro
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components
TimeSliderViewModel Class
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html”>GeoBlazor Docs</a> Provides the logic for the <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider.html”>TimeSlider</a> widget. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html”>ArcGIS Maps SDK for JavaScript</a>
public class TimeSliderViewModel : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 TimeSliderViewModel
Constructors
TimeSliderViewModel() Constructor
Parameterless constructor for use as a Razor Component.
public TimeSliderViewModel();
TimeSliderViewModel(IReadOnlyList<ActionBase>, TimeExtent, Nullable<bool>, Nullable<TimeSliderMode>, Nullable<double>, TimeSliderStops, TimeExtent) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public TimeSliderViewModel(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ActionBase>? actions=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? fullTimeExtent=null, System.Nullable<bool> loop=null, System.Nullable<dymaptic.GeoBlazor.Pro.Enums.TimeSliderMode> mode=null, System.Nullable<double> playRate=null, dymaptic.GeoBlazor.Pro.Components.TimeSliderStops? stops=null, dymaptic.GeoBlazor.Core.Components.TimeExtent? timeExtent=null);
Parameters
actions System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ActionBase>
Defines actions that will appear in a menu when the user clicks the ellipsis button !<a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/timeslider/ellipsis.png”>timeSlider-actions-menu</a> in the widget. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#actions”>ArcGIS Maps SDK for JavaScript</a>
fullTimeExtent dymaptic.GeoBlazor.Core.Components.TimeExtent
The temporal extent of the entire slider. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#fullTimeExtent”>ArcGIS Maps SDK for JavaScript</a>
loop System.Nullable<System.Boolean>
If animating, the time indicator(s) will restart if they reach the edge. default false <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#loop”>ArcGIS Maps SDK for JavaScript</a>
mode System.Nullable<TimeSliderMode>
The time slider mode. default “time-window” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#mode”>ArcGIS Maps SDK for JavaScript</a>
playRate System.Nullable<System.Double>
The time (in milliseconds) between animation steps. default 1000 <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#playRate”>ArcGIS Maps SDK for JavaScript</a>
stops TimeSliderStops
Defines specific locations on the time slider where thumbs will snap to when manipulated. default { count : 10 } <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#stops”>ArcGIS Maps SDK for JavaScript</a>
timeExtent dymaptic.GeoBlazor.Core.Components.TimeExtent
The current time extent of the time slider. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#timeExtent”>ArcGIS Maps SDK for JavaScript</a>
Properties
TimeSliderViewModel.Actions Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelactions-property”>GeoBlazor Docs</a> Defines actions that will appear in a menu when the user clicks the ellipsis button !<a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/assets/img/apiref/widgets/timeslider/ellipsis.png”>timeSlider-actions-menu</a> in the widget. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#actions”>ArcGIS Maps SDK for JavaScript</a>
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ActionBase>? Actions { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ActionBase>
TimeSliderViewModel.EffectiveStops Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodeleffectivestops-property”>GeoBlazor Docs</a> Defined specific locations on the timeline that the handles will snap to when manipulated. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#effectiveStops”>ArcGIS Maps SDK for JavaScript</a>
public System.Collections.Generic.IReadOnlyList<System.DateTime>? EffectiveStops { get; }
Property Value
System.Collections.Generic.IReadOnlyList<System.DateTime>
TimeSliderViewModel.FullTimeExtent Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelfulltimeextent-property”>GeoBlazor Docs</a> The temporal extent of the entire slider. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#fullTimeExtent”>ArcGIS Maps SDK for JavaScript</a>
public dymaptic.GeoBlazor.Core.Components.TimeExtent? FullTimeExtent { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.TimeExtent
TimeSliderViewModel.HasTriggerActionListener Property
Used in JavaScript layer to determine if the event listener is registered.
public bool HasTriggerActionListener { get; }
Property Value
TimeSliderViewModel.Loop Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelloop-property”>GeoBlazor Docs</a> If animating, the time indicator(s) will restart if they reach the edge. default false <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#loop”>ArcGIS Maps SDK for JavaScript</a>
public System.Nullable<bool> Loop { get; set; }
Property Value
System.Nullable<System.Boolean>
TimeSliderViewModel.Mode Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelmode-property”>GeoBlazor Docs</a> The time slider mode. default “time-window” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#mode”>ArcGIS Maps SDK for JavaScript</a>
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.TimeSliderMode> Mode { get; set; }
Property Value
System.Nullable<TimeSliderMode>
TimeSliderViewModel.OnTriggerAction Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelontriggeraction-property”>GeoBlazor Docs</a> Fires when a user clicks on an <a href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#action”>action</a> in the <a href=”#actions”>actions</a> menu.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.TimeSliderViewModelTriggerActionEvent> OnTriggerAction { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<TimeSliderViewModelTriggerActionEvent>
TimeSliderViewModel.PlayRate Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelplayrate-property”>GeoBlazor Docs</a> The time (in milliseconds) between animation steps. default 1000 <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#playRate”>ArcGIS Maps SDK for JavaScript</a>
public System.Nullable<double> PlayRate { get; set; }
Property Value
System.Nullable<System.Double>
TimeSliderViewModel.State Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelstate-property”>GeoBlazor Docs</a> The view model’s state. default “disabled” <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#state”>ArcGIS Maps SDK for JavaScript</a>
public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.TimeSliderViewModelState> State { get; }
Property Value
System.Nullable<TimeSliderViewModelState>
TimeSliderViewModel.Stops Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelstops-property”>GeoBlazor Docs</a> Defines specific locations on the time slider where thumbs will snap to when manipulated. default { count : 10 } <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#stops”>ArcGIS Maps SDK for JavaScript</a>
public dymaptic.GeoBlazor.Pro.Components.TimeSliderStops? Stops { get; set; }
Property Value
TimeSliderViewModel.TimeExtent Property
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodeltimeextent-property”>GeoBlazor Docs</a> The current time extent of the time slider. default null <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#timeExtent”>ArcGIS Maps SDK for JavaScript</a>
public dymaptic.GeoBlazor.Core.Components.TimeExtent? TimeExtent { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Components.TimeExtent
Methods
TimeSliderViewModel.AddToActions(ActionBase[]) Method
Asynchronously adds elements to the Actions property.
public System.Threading.Tasks.Task AddToActions(params dymaptic.GeoBlazor.Core.Components.ActionBase[] values);
Parameters
values dymaptic.GeoBlazor.Core.Components.ActionBase[]
The elements to add.
Returns
TimeSliderViewModel.GetActions() Method
Asynchronously retrieve the current value of the Actions property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ActionBase>?> GetActions();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ActionBase>>
TimeSliderViewModel.GetEffectiveStops() Method
Asynchronously retrieve the current value of the EffectiveStops property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.DateTime>?> GetEffectiveStops();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.DateTime>>
TimeSliderViewModel.GetFullTimeExtent() Method
Asynchronously retrieve the current value of the FullTimeExtent property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TimeExtent?> GetFullTimeExtent();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TimeExtent>
TimeSliderViewModel.GetLoop() Method
Asynchronously retrieve the current value of the Loop property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetLoop();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
TimeSliderViewModel.GetMode() Method
Asynchronously retrieve the current value of the Mode property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.TimeSliderMode>> GetMode();
Returns
System.Threading.Tasks.Task<System.Nullable<TimeSliderMode>>
TimeSliderViewModel.GetPlayRate() Method
Asynchronously retrieve the current value of the PlayRate property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetPlayRate();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
TimeSliderViewModel.GetState() Method
Asynchronously retrieve the current value of the State property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Pro.Enums.TimeSliderViewModelState>> GetState();
Returns
System.Threading.Tasks.Task<System.Nullable<TimeSliderViewModelState>>
TimeSliderViewModel.GetStops() Method
Asynchronously retrieve the current value of the Stops property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.TimeSliderStops?> GetStops();
Returns
System.Threading.Tasks.Task<TimeSliderStops>
TimeSliderViewModel.GetTimeExtent() Method
Asynchronously retrieve the current value of the TimeExtent property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TimeExtent?> GetTimeExtent();
Returns
System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.TimeExtent>
TimeSliderViewModel.Next() Method
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelnext-method”>GeoBlazor Docs</a> Incrementally moves the time extent forward one stop. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#next”>ArcGIS Maps SDK for JavaScript</a>
public System.Threading.Tasks.Task Next();
Returns
TimeSliderViewModel.OnJsTriggerAction(IJSStreamReference) Method
JavaScript-Invokable Method for internal use only.
public System.Threading.Tasks.Task OnJsTriggerAction(Microsoft.JSInterop.IJSStreamReference jsStreamRef);
Parameters
jsStreamRef Microsoft.JSInterop.IJSStreamReference
Returns
TimeSliderViewModel.Play() Method
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelplay-method”>GeoBlazor Docs</a> Initiates the time slider’s temporal playback. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#play”>ArcGIS Maps SDK for JavaScript</a>
public System.Threading.Tasks.Task Play();
Returns
TimeSliderViewModel.Previous() Method
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelprevious-method”>GeoBlazor Docs</a> Incrementally moves the time extent back one stop. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#previous”>ArcGIS Maps SDK for JavaScript</a>
public System.Threading.Tasks.Task Previous();
Returns
TimeSliderViewModel.RemoveFromActions(ActionBase[]) Method
Asynchronously remove an element from the Actions property.
public System.Threading.Tasks.Task RemoveFromActions(params dymaptic.GeoBlazor.Core.Components.ActionBase[] values);
Parameters
values dymaptic.GeoBlazor.Core.Components.ActionBase[]
The elements to remove.
Returns
TimeSliderViewModel.SetActions(IReadOnlyList<ActionBase>) Method
Asynchronously set the value of the Actions property after render.
public System.Threading.Tasks.Task SetActions(System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ActionBase>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.ActionBase>
The value to set.
Returns
TimeSliderViewModel.SetFullTimeExtent(TimeExtent) Method
Asynchronously set the value of the FullTimeExtent property after render.
public System.Threading.Tasks.Task SetFullTimeExtent(dymaptic.GeoBlazor.Core.Components.TimeExtent? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.TimeExtent
The value to set.
Returns
TimeSliderViewModel.SetLoop(Nullable<bool>) Method
Asynchronously set the value of the Loop property after render.
public System.Threading.Tasks.Task SetLoop(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
TimeSliderViewModel.SetMode(Nullable<TimeSliderMode>) Method
Asynchronously set the value of the Mode property after render.
public System.Threading.Tasks.Task SetMode(System.Nullable<dymaptic.GeoBlazor.Pro.Enums.TimeSliderMode> value);
Parameters
value System.Nullable<TimeSliderMode>
The value to set.
Returns
TimeSliderViewModel.SetPlayRate(Nullable<double>) Method
Asynchronously set the value of the PlayRate property after render.
public System.Threading.Tasks.Task SetPlayRate(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
TimeSliderViewModel.SetStops(TimeSliderStops) Method
Asynchronously set the value of the Stops property after render.
public System.Threading.Tasks.Task SetStops(dymaptic.GeoBlazor.Pro.Components.TimeSliderStops? value);
Parameters
value TimeSliderStops
The value to set.
Returns
TimeSliderViewModel.SetTimeExtent(TimeExtent) Method
Asynchronously set the value of the TimeExtent property after render.
public System.Threading.Tasks.Task SetTimeExtent(dymaptic.GeoBlazor.Core.Components.TimeExtent? value);
Parameters
value dymaptic.GeoBlazor.Core.Components.TimeExtent
The value to set.
Returns
TimeSliderViewModel.Stop() Method
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelstop-method”>GeoBlazor Docs</a> Stops the time slider’s temporal playback. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#stop”>ArcGIS Maps SDK for JavaScript</a>
public System.Threading.Tasks.Task Stop();
Returns
TimeSliderViewModel.UpdateWebDocument(Map) Method
<a target=”_blank” href=”https://docs.geoblazor.com/pages/classes/dymaptic.GeoBlazor.Pro.Components.TimeSliderViewModel.html#timesliderviewmodelupdatewebdocument-method”>GeoBlazor Docs</a> Updates the time slider widget definition in the provided <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-WebMap.html”>WebMap</a> or <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-WebScene.html”>WebScene</a>. <a target=”_blank” href=”https://developers.arcgis.com/javascript/latest/api-reference/esri-widgets-TimeSlider-TimeSliderViewModel.html#updateWebDocument”>ArcGIS Maps SDK for JavaScript</a>
public System.Threading.Tasks.Task UpdateWebDocument(dymaptic.GeoBlazor.Core.Components.Map document);
Parameters
document dymaptic.GeoBlazor.Core.Components.Map
The webmap or webscene to be updated.
Returns
TimeSliderViewModel.ValidateRequiredGeneratedChildren() Method
Validates source-generated child components.
public override void ValidateRequiredGeneratedChildren();
Implements ValidateRequiredGeneratedChildren()