Class TimeSlider

The TimeSlider is a utility Control that emits TimeExtent values typically for use with the Map Control to enhance the viewing of geographic features that have attributes based upon Date/Time information.

Inheritance
object
DependencyObject
UIElement
FrameworkElement
Control
TimeSlider
Namespace: Esri.ArcGISRuntime.Toolkit.UI.Controls
Assembly: Esri.ArcGISRuntime.Toolkit.WinUI.dll
Syntax
[TemplatePart(Name = "SliderTrack", Type = typeof(FrameworkElement))]
[TemplatePart(Name = "HorizontalTrackThumb", Type = typeof(Thumb))]
[TemplatePart(Name = "MinimumThumb", Type = typeof(Thumb))]
[TemplatePart(Name = "MinimumThumbLabel", Type = typeof(TextBlock))]
[TemplatePart(Name = "MaximumThumb", Type = typeof(Thumb))]
[TemplatePart(Name = "MaximumThumbLabel", Type = typeof(TextBlock))]
[TemplatePart(Name = "Tickmarks", Type = typeof(Tickbar))]
[TemplatePart(Name = "SliderTrackStepBackRepeater", Type = typeof(RepeatButton))]
[TemplatePart(Name = "SliderTrackStepForwardRepeater", Type = typeof(RepeatButton))]
[TemplatePart(Name = "PlayPauseButton", Type = typeof(ToggleButton))]
[TemplatePart(Name = "NextButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "PreviousButton", Type = typeof(ButtonBase))]
[TemplatePart(Name = "FullExtentStartTimeLabel", Type = typeof(TextBlock))]
[TemplatePart(Name = "FullExtentEndTimeLabel", Type = typeof(TextBlock))]
[TemplateVisualState(GroupName = "CommonStates", Name = "Normal")]
[TemplateVisualState(GroupName = "CommonStates", Name = "MouseOver")]
[TemplateVisualState(GroupName = "CommonStates", Name = "Disabled")]
[TemplateVisualState(GroupName = "FocusStates", Name = "Focused")]
[TemplateVisualState(GroupName = "FocusStates", Name = "Unfocused")]
[WinRTRuntimeClassName("Microsoft.UI.Xaml.IUIElementOverrides")]
[WinRTExposedType(typeof(Esri_ArcGISRuntime_Toolkit_UI_Controls_CompassWinRTTypeDetails))]
public class TimeSlider : Control, IEquatable<DependencyObject>, IAnimationObject, IVisualElement, IVisualElement2, IEquatable<UIElement>, IEquatable<FrameworkElement>, IWinRTObject, IUnmanagedVirtualMethodTableProvider, IDynamicInterfaceCastable, IEquatable<Control>

Constructors

Name Description
TimeSlider()

Initializes a new instance of the TimeSlider class.

Fields

Name Description
CurrentExtentFillProperty

Identifies the CurrentExtentFill dependency property.
CurrentExtentLabelColorProperty

Identifies the CurrentExtentLabelColor dependency property.
CurrentExtentLabelFormatProperty

Identifies the CurrentExtentLabelFormat dependency property.
CurrentExtentProperty

Identifies the CurrentExtent dependency property.
FullExtentFillProperty

Identifies the FullExtentFill dependency property.
FullExtentLabelColorProperty

Identifies the FullExtentLabelColor dependency property.
FullExtentLabelFormatProperty

Identifies the FullExtentLabelFormat dependency property.
FullExtentProperty

Identifies the FullExtent dependency property.
FullExtentStrokeProperty

Identifies the FullExtentStroke dependency property.
IsEndTimePinnedProperty

Identifies the IsEndTimePinned dependency property.
IsPlayingProperty

Identifies the IsPlaying dependency property.
IsStartTimePinnedProperty

Identifies the IsStartTimePinned dependency property.
LabelModeProperty

Identifies the LabelMode dependency property.
LoopModeProperty

Identifies the PlaybackLoopMode dependency property.
PlaybackButtonsFillProperty

Identifies the PlaybackButtonsFill dependency property.
PlaybackButtonsStrokeProperty

Identifies the PlaybackButtonsStroke dependency property.
PlaybackDirectionProperty

Identifies the PlaybackDirection dependency property.
PlaybackIntervalProperty

Identifies the PlaybackInterval dependency property.
ThumbFillProperty

Identifies the ThumbFill dependency property.
ThumbStrokeProperty

Identifies the ThumbStroke dependency property.
TimeStepIntervalLabelColorProperty

Identifies the TimeStepIntervalLabelColor dependency property.
TimeStepIntervalLabelFormatProperty

Identifies the TimeStepIntervalLabelFormat dependency property.
TimeStepIntervalProperty

Identifies the TimeStepInterval dependency property.
TimeStepIntervalTickFillProperty

Identifies the TimeStepIntervalTickFill dependency property.

Properties

Name Description
CurrentExtent

Gets or sets the TimeExtent associated with the visual thumbs(s) displayed on the TimeSlider.
CurrentExtentFill

Gets or sets the fill color of the area on the slider track that indicates the CurrentExtent.
CurrentExtentLabelColor

Gets or sets the color of the current extent labels.
CurrentExtentLabelFormat

Gets or sets the string format to use for displaying the start and end labels for the CurrentExtent.
FullExtent

Gets or sets the TimeExtent that specifies the overall start and end time of the time slider instance.
FullExtentFill

Gets or sets the fill color of the area on the slider track that indicates the FullExtent.
FullExtentLabelColor

Gets or sets the color of the full extent labels.
FullExtentLabelFormat

Gets or sets the string format to use for displaying the start and end labels for the FullExtent.
FullExtentStroke

Gets or sets the border color of the area on the slider track that indicates the FullExtent.
IsEndTimePinned

Gets or sets a value indicating whether the end time of the CurrentExtent is locked into place.
IsPlaying

Gets or sets a value indicating whether the time slider is animating playback.
IsStartTimePinned

Gets or sets a value indicating whether the start time of the CurrentExtent is locked into place.
LabelMode

Gets or sets the mode to use for labels along the time slider.
PlaybackButtonsFill

Gets or sets the fill color of the playback buttons.
PlaybackButtonsStroke

Gets or sets the border color of the playback buttons.
PlaybackDirection

Gets or sets whether the current extent will move to the next or the previous time step during playback.
PlaybackInterval

Gets or sets the interval at which the time slider's current extent will move to the next or previous time step.
PlaybackLoopMode

Gets or sets the behavior when the current extent reaches the end of the slider during playback.
ThumbFill

Gets or sets the fill color of the thumbs.
ThumbStroke

Gets or sets the border color of the thumbs.
TimeStepInterval

Gets or sets the time step intervals for the time slider. The slider thumbs will snap to and tick marks will be shown at this interval.
TimeStepIntervalLabelColor

Gets or sets the color of the time step interval labels.
TimeStepIntervalLabelFormat

Gets or sets the string format to use for displaying the labels for the tick marks representing each time step interval.
TimeStepIntervalTickFill

Gets or sets the color of the slider's tickmarks.
TimeSteps

Gets the time steps that can be used to set the slider instance's current extent.

Methods

Name Description
InitializeTimePropertiesAsync(ITimeAware)

Initializes the time slider's temporal properties based on the specified time-aware layer. Specifically, this will initialize FullExtent, TimeStepInterval, and CurrentExtent.
InitializeTimePropertiesAsync(GeoView?)

Initializes the time slider's temporal properties based on the specified GeoView. Specifically, this will initialize FullExtent, TimeStepInterval, and CurrentExtent.
InitializeTimeSteps(int)

Updates the time slider to have the specified number of time steps.
OnApplyTemplate()

When overridden in a derived class, is invoked whenever application code or internal processes (such as a rebuilding layout pass) call System.Windows.Controls.Control.ApplyTemplate.
OnGotFocus(RoutedEventArgs)

Called before the GotFocus event occurs.
OnGotFocus(RoutedEventArgs)

Called before the GotFocus event occurs.
OnKeyDown(KeyRoutedEventArgs)

Called before the KeyDown event occurs.
OnKeyDown(KeyEventArgs)

Called before the KeyDown event occurs.
OnLostFocus(RoutedEventArgs)

Called before the LostFocus event occurs.
OnLostFocus(RoutedEventArgs)

Called before the LostFocus event occurs.
OnMouseEnter(MouseEventArgs)

Invoked when an unhandled MouseEnter attached event is raised on this element. Implement this method to add class handling for this event.
OnMouseLeave(MouseEventArgs)

Invoked when an unhandled MouseLeave attached event is raised on this element. Implement this method to add class handling for this event.
OnMouseLeftButtonDown(MouseButtonEventArgs)

Invoked when an unhandled MouseLeftButtonDown routed event is raised on this element. Implement this method to add class handling for this event.
OnPointerEntered(PointerRoutedEventArgs)

Called before the PointerEntered event occurs.
OnPointerExited(PointerRoutedEventArgs)

Called before the PointerExited event occurs.
OnPointerPressed(PointerRoutedEventArgs)

Called before the PointerPressed event occurs.
StepBack(int)

Moves the slider position back by the specified number of time steps.
StepForward(int)

Moves the slider position forward by the specified number of time steps.

Events

Name Description
CurrentExtentChanged

Occurs when the selected time extent has changed.