GeoBlazor Pro
layout: pro title: TimeSliderWidget parent: Pro Classes grand_parent: GeoBlazor Pro —
dymaptic.GeoBlazor.Pro
dymaptic.GeoBlazor.Pro.Components.Widgets
TimeSliderWidget Class
The TimeSlider widget simplifies visualization of temporal data in your application.
ore adding the TimeSlider to your application, you first should understand how it can be configured to correctly display your temporal data.
ArcGIS Maps SDK for JavaScript
public class TimeSliderWidget : dymaptic.GeoBlazor.Pro.Components.Widgets.ProWidget
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 dymaptic.GeoBlazor.Core.Components.MapComponent 🡒 dymaptic.GeoBlazor.Core.Components.Widgets.Widget 🡒 ProWidget 🡒 TimeSliderWidget
Properties
TimeSliderWidget.Actions Property
Defines actions that will appear in a menu when the user clicks the ellipsis button timeSlider-actions-menu in the widget.
public System.Collections.Generic.List<System.Action>? Actions { get; set; }
Property Value
System.Collections.Generic.List<System.Action>
TimeSliderWidget.Disabled Property
When true, sets the widget to a disabled state so the user cannot interact with it.
public System.Nullable<bool> Disabled { get; set; }
Property Value
System.Nullable<System.Boolean>
TimeSliderWidget.FullTimeExtent Property
The temporal extent of the entire slider.
public dymaptic.GeoBlazor.Core.Objects.TimeExtent? FullTimeExtent { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Objects.TimeExtent
TimeSliderWidget.Label Property
The widget’s default label.
public string? Label { get; set; }
Property Value
TimeSliderWidget.LabelFormatFunction Property
A function used to specify custom formatting and styling of the min, max, and extent labels of the TimeSlider.
This is currently a string that is evaluated as a function.
public string? LabelFormatFunction { get; set; }
Property Value
TimeSliderWidget.Layout Property
Determines the layout used by the TimeSlider widget.
public dymaptic.GeoBlazor.Pro.Components.Widgets.TimeSliderLayout Layout { get; set; }
Property Value
TimeSliderWidget.Loop Property
When true, the time slider will play its animation in a loop.
public bool Loop { get; set; }
Property Value
TimeSliderWidget.Mode Property
The time slider mode.
public dymaptic.GeoBlazor.Pro.Components.Widgets.TimeSliderMode Mode { get; set; }
Property Value
TimeSliderWidget.PlayRate Property
The time (in milliseconds) between animation steps.
public double PlayRate { get; set; }
Property Value
TimeSliderWidget.Stops Property
Defines specific locations on the time slider where thumbs will snap to when manipulated
StopsByDates | StopsByCount | StopsByInterval
public dymaptic.GeoBlazor.Pro.Components.Widgets.TimeSliderStop? Stops { get; set; }
Property Value
TimeSliderWidget.TickConfigs Property
When set, overrides the default TimeSlider ticks labeling system.
public System.Collections.Generic.List<dymaptic.GeoBlazor.Pro.Components.Widgets.TickConfig>? TickConfigs { get; set; }
Property Value
System.Collections.Generic.List<TickConfig>
TimeSliderWidget.TimeExtent Property
The current time extent of the time slider.
public dymaptic.GeoBlazor.Core.Objects.TimeExtent? TimeExtent { get; set; }
Property Value
dymaptic.GeoBlazor.Core.Objects.TimeExtent
TimeSliderWidget.TimeVisible Property
Shows/hides time in the display.
public bool TimeVisible { get; set; }
Property Value
Methods
TimeSliderWidget.GetPropertiesFromWebMap(Guid) Method
Extracts time slider settings from a WebMap if the webmap contains a time slider widget definition.
Returns an object with properties that can be used to configure the TimeSlider or TimeSliderViewModel.
If a webmap does not contain a time slider definition then null is returned.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Pro.Components.Widgets.WebMapProperties?> GetPropertiesFromWebMap(System.Guid viewId);
Parameters
viewId System.Guid
The Guid Id of the view that contains the map to get the properties from
Returns
System.Threading.Tasks.Task<WebMapProperties>
TimeSliderWidget.SetFullTimeExtent(TimeExtent) Method
Use to set the fullTimeExtent property after the widget has been created.
public System.Threading.Tasks.Task SetFullTimeExtent(dymaptic.GeoBlazor.Core.Objects.TimeExtent fullTimeExtent);
Parameters
fullTimeExtent dymaptic.GeoBlazor.Core.Objects.TimeExtent
Returns
TimeSliderWidget.SetLabelFormatFunction(string) Method
Use to set the labelFormatFunction property after the widget has been created.
public System.Threading.Tasks.Task SetLabelFormatFunction(string labelFormatFunction);
Parameters
labelFormatFunction System.String
A string that can be evaluated as a Javascript function.
Returns
TimeSliderWidget.SetPropertiesFromWebMap(WebMapProperties) Method
Sets the specified properties on the widget.
public System.Threading.Tasks.Task SetPropertiesFromWebMap(dymaptic.GeoBlazor.Pro.Components.Widgets.WebMapProperties properties);
Parameters
properties WebMapProperties
The properties to set on the TimeSlider Widget
Returns
TimeSliderWidget.SetStops(TimeSliderStop) Method
Use to set the Stops property after the widget has been created.
public System.Threading.Tasks.Task SetStops(dymaptic.GeoBlazor.Pro.Components.Widgets.TimeSliderStop timeSliderStop);
Parameters
timeSliderStop TimeSliderStop
Returns
TimeSliderWidget.SetTimeExtent(TimeExtent) Method
Use to set the TimeExtent property after the widget has been created.
public System.Threading.Tasks.Task SetTimeExtent(dymaptic.GeoBlazor.Core.Objects.TimeExtent timeExtent);
Parameters
timeExtent dymaptic.GeoBlazor.Core.Objects.TimeExtent