GeoBlazor Pro

dymaptic.GeoBlazor.Pro

dymaptic.GeoBlazor.Pro.Components

TimeSliderViewModel Class

Provides the logic for the TimeSlider widget.
ArcGIS Maps SDK for JavaScript

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, TimeExtent, Nullable, Nullable, Nullable, 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
!timeSlider-actions-menu in the widget.
ArcGIS Maps SDK for JavaScript

fullTimeExtent dymaptic.GeoBlazor.Core.Components.TimeExtent

The temporal extent of the entire slider.
ArcGIS Maps SDK for JavaScript

loop System.Nullable<System.Boolean>

If animating, the time indicator(s) will restart if they reach the edge.
default false
ArcGIS Maps SDK for JavaScript

mode System.Nullable<TimeSliderMode>

The time slider mode.
default “time-window”
ArcGIS Maps SDK for JavaScript

playRate System.Nullable<System.Double>

The time (in milliseconds) between animation steps.
default 1000
ArcGIS Maps SDK for JavaScript

stops TimeSliderStops

Defines specific locations on the time slider where thumbs will snap to when manipulated.
default { count : 10 }
ArcGIS Maps SDK for JavaScript

timeExtent dymaptic.GeoBlazor.Core.Components.TimeExtent

The current time extent of the time slider.
default null
ArcGIS Maps SDK for JavaScript

Properties

TimeSliderViewModel.Actions Property

Defines actions that will appear in a menu when the user clicks the ellipsis button
!timeSlider-actions-menu in the widget.
ArcGIS Maps SDK for JavaScript

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

Defined specific locations on the timeline that the handles will snap to when manipulated.
default null
ArcGIS Maps SDK for JavaScript

public System.Collections.Generic.IReadOnlyList<System.DateTime>? EffectiveStops { get; set; }

Property Value

System.Collections.Generic.IReadOnlyList<System.DateTime>

TimeSliderViewModel.FullTimeExtent Property

The temporal extent of the entire slider.
ArcGIS Maps SDK for JavaScript

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

System.Boolean

TimeSliderViewModel.Loop Property

If animating, the time indicator(s) will restart if they reach the edge.
default false
ArcGIS Maps SDK for JavaScript

public System.Nullable<bool> Loop { get; set; }

Property Value

System.Nullable<System.Boolean>

TimeSliderViewModel.Mode Property

The time slider mode.
default “time-window”
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.TimeSliderMode> Mode { get; set; }

Property Value

System.Nullable<TimeSliderMode>

TimeSliderViewModel.OnTriggerAction Property

Fires when a user clicks on an action in the actions menu.

public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Pro.Events.TimeSliderViewModelTriggerActionEvent> OnTriggerAction { get; set; }

Property Value

Microsoft.AspNetCore.Components.EventCallback<TimeSliderViewModelTriggerActionEvent>

TimeSliderViewModel.PlayRate Property

The time (in milliseconds) between animation steps.
default 1000
ArcGIS Maps SDK for JavaScript

public System.Nullable<double> PlayRate { get; set; }

Property Value

System.Nullable<System.Double>

TimeSliderViewModel.State Property

The view model’s state.
default “disabled”
ArcGIS Maps SDK for JavaScript

public System.Nullable<dymaptic.GeoBlazor.Pro.Enums.TimeSliderViewModelState> State { get; set; }

Property Value

System.Nullable<TimeSliderViewModelState>

TimeSliderViewModel.Stops Property

Defines specific locations on the time slider where thumbs will snap to when manipulated.
default { count : 10 }
ArcGIS Maps SDK for JavaScript

public dymaptic.GeoBlazor.Pro.Components.TimeSliderStops? Stops { get; set; }

Property Value

TimeSliderStops

TimeSliderViewModel.TimeExtent Property

The current time extent of the time slider.
default null
ArcGIS Maps SDK for JavaScript

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

System.Threading.Tasks.Task

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

Incrementally moves the time extent forward one stop.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task Next();

Returns

System.Threading.Tasks.Task

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

System.Threading.Tasks.Task

TimeSliderViewModel.Play() Method

Initiates the time slider’s temporal playback.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task Play();

Returns

System.Threading.Tasks.Task

TimeSliderViewModel.Previous() Method

Incrementally moves the time extent back one stop.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task Previous();

Returns

System.Threading.Tasks.Task

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

System.Threading.Tasks.Task

TimeSliderViewModel.SetActions(IReadOnlyList) 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

System.Threading.Tasks.Task

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

System.Threading.Tasks.Task

TimeSliderViewModel.SetLoop(Nullable) 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

System.Threading.Tasks.Task

TimeSliderViewModel.SetMode(Nullable) 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

System.Threading.Tasks.Task

TimeSliderViewModel.SetPlayRate(Nullable) 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

System.Threading.Tasks.Task

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

System.Threading.Tasks.Task

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

System.Threading.Tasks.Task

TimeSliderViewModel.Stop() Method

Stops the time slider’s temporal playback.
ArcGIS Maps SDK for JavaScript

public System.Threading.Tasks.Task Stop();

Returns

System.Threading.Tasks.Task

TimeSliderViewModel.UpdateWebDocument(Map) Method

Updates the time slider widget definition in the provided WebMap or WebScene.
ArcGIS Maps SDK for JavaScript

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

System.Threading.Tasks.Task

TimeSliderViewModel.ValidateRequiredGeneratedChildren() Method

Validates source-generated child components.

public override void ValidateRequiredGeneratedChildren();

Implements ValidateRequiredGeneratedChildren()