layout: default title: SliderWidget parent: Core Classes —
dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components.Widgets
SliderWidget Class
A slider widget that can be used for filtering data, or gathering numeric input from a user. The slider can have multiple thumbs, and provides you with the ability to format labels and control user input.
ArcGIS Maps SDK for JavaScript
public class SliderWidget : dymaptic.GeoBlazor.Core.Components.Widgets.Widget
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 Widget 🡒 SliderWidget
Remarks
At a minimum, the slider’s container or parent container must have a width set in CSS for it to render.
Constructors
SliderWidget() Constructor
Parameterless constructor for use as a Razor component.
public SliderWidget();
SliderWidget(string, Nullable, Nullable, Nullable, Nullable, string, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, Nullable, double[], Nullable, Nullable, Nullable, IReadOnlyCollection, string, string, string, string, string, IReadOnlyCollection, Nullable, SliderVisibleElements) Constructor
Constructor for creating a SliderWidget in C# code.
public SliderWidget(string containerId, System.Nullable<bool> disabled=null, System.Nullable<bool> draggableSegmentsEnabled=null, System.Nullable<double> effectiveMax=null, System.Nullable<double> effectiveMin=null, string? label=null, System.Nullable<bool> labelInputsEnabled=null, System.Nullable<dymaptic.GeoBlazor.Core.Components.Widgets.SliderLayout> layout=null, System.Nullable<double> max=null, System.Nullable<double> min=null, System.Nullable<double> precision=null, System.Nullable<bool> rangeLabelInputsEnabled=null, System.Nullable<bool> snapOnClickEnabled=null, double[]? steps=null, System.Nullable<double> stepInterval=null, System.Nullable<bool> syncedSegmentsEnabled=null, System.Nullable<bool> thumbsConstrained=null, System.Collections.Generic.IReadOnlyCollection<double>? values=null, string? inputCreatedFunction=null, string? inputFormatFunction=null, string? inputParseFunction=null, string? labelFormatFunction=null, string? thumbCreatedFunction=null, System.Collections.Generic.IReadOnlyCollection<dymaptic.GeoBlazor.Core.Components.Widgets.SliderTickConfig>? tickConfigs=null, System.Nullable<bool> visible=null, dymaptic.GeoBlazor.Core.Components.Widgets.SliderVisibleElements? visibleElements=null);
Parameters
containerId System.String
The ID of the container element for the widget. The widget will be rendered within this container.
disabled System.Nullable<System.Boolean>
When true, sets the slider to a disabled state so the user cannot interact with it.
draggableSegmentsEnabled System.Nullable<System.Boolean>
Indicates if the user can drag the segment between thumbs to update thumb positions.
effectiveMax System.Nullable<System.Double>
When set, the user is restricted from moving slider thumbs to positions higher than this value. This value should be less than the slider max. The effectiveMax and effectiveMin allow you to represent ranges of values in a dataset that cannot be filtered or selected with the slider. This can be useful when using the slider to represent datasets with outliers, or scale ranges not suitable for a layer.
effectiveMin System.Nullable<System.Double>
When set, the user is restricted from moving slider thumbs to positions less than this value. This value should be greater than the slider min. The effectiveMin and effectiveMax allow you to represent ranges of values in a dataset that cannot be filtered or selected with the slider. This can be useful when using the slider to represent datasets with outliers, or scale ranges not suitable for a layer.
label System.String
The widget’s default label. This label displays when it is used within another widget, such as the Expand or LayerList widgets.
labelInputsEnabled System.Nullable<System.Boolean>
Indicates whether to enable editing input values via keyboard input when the user clicks a label. This allows the user to move the slider thumb to precise values without sliding the thumbs.
layout System.Nullable<SliderLayout>
Determines the layout/orientation of the Slider widget. By default, the slider will render horizontally with the min value on the left side of the track.
max System.Nullable<System.Double>
The maximum possible data/thumb value of the slider. In the constructor, if one of the values specified in values is greater than the max value specified in this property, then the max will update to the highest value in values.
min System.Nullable<System.Double>
The minimum possible data/thumb value of the slider. In the constructor, if one of the values specified in values is less than the min value specified in this property, then the min will update to the lowest value in values.
precision System.Nullable<System.Double>
Defines how slider thumb values should be rounded. This number indicates the number of decimal places slider thumb values should round to when they have been moved.
rangeLabelInputsEnabled System.Nullable<System.Boolean>
Indicates whether to enable editing range values via keyboard input when the user clicks a min or max label. This allows the user to increase or decrease the data range of the slider.
snapOnClickEnabled System.Nullable<System.Boolean>
Indicates if the closest thumb will snap to the clicked location on the track.
steps System.Double[]
Sets steps on the slider that restrict user input to specific values. If an array of numbers is passed to this property, the slider thumbs may only be moved to the positions specified in the array. User either this or StepInterval.
stepInterval System.Nullable<System.Double>
The interval in which slider thumbs can be moved. Use either this or Steps.
syncedSegmentsEnabled System.Nullable<System.Boolean>
When true, all segments will sync together in updating thumb values when the user drags any segment. This maintains the interval between all thumbs when any segment is dragged. Only applicable when draggableSegmentsEnabled is true.
thumbsConstrained System.Nullable<System.Boolean>
When false, the user can freely move any slider thumb to any position along the track. By default, a thumb’s position is constrained to the positions of neighboring thumbs so you cannot move one thumb past another. Set this property to false to disable this constraining behavior.
values System.Collections.Generic.IReadOnlyCollection<System.Double>
A collection of numbers representing absolute thumb positions on the slider.
inputCreatedFunction System.String
A function that provides the developer with access to the input elements when rangeLabelInputsEnabled and/or labelInputsEnabled are set to true. This allows the developer to customize the input elements corresponding to slider min/max and thumb values to validate user input. For example, you can access input elements and customize them with type and pattern attributes.
inputFormatFunction System.String
A JavaScript function used to format user inputs. As opposed to labelFormatFunction, which formats thumb labels, the inputFormatFunction formats thumb values in the input element when the user begins to edit them.
inputParseFunction System.String
Function used to parse slider inputs formatted by the inputFormatFunction. This property must be set if an inputFormatFunction is set. Otherwise the slider values will likely not update to their expected positions.
labelFormatFunction System.String
A function used to format labels. Overrides the default label formatter.
thumbCreatedFunction System.String
Function that executes each time a thumb is created on the slider. This can be used to add custom styling to each thumb or hook event listeners to specific thumbs.
tickConfigs System.Collections.Generic.IReadOnlyCollection<SliderTickConfig>
When set, renders ticks along the slider track. See the TickConfig documentation for more information on how to configure tick placement, style, and behavior.
visible System.Nullable<System.Boolean>
Indicates whether the widget is visible.
visibleElements SliderVisibleElements
The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget’s display on/off.
Properties
SliderWidget.Disabled Property
When true, sets the slider to a disabled state so the user cannot interact with it.
Default Value: false
public System.Nullable<bool> Disabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SliderWidget.DraggableSegmentsEnabled Property
Indicates if the user can drag the segment between thumbs to update thumb positions.
Default Value:true
public System.Nullable<bool> DraggableSegmentsEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SliderWidget.EffectiveMax Property
When set, the user is restricted from moving slider thumbs to positions higher than this value. This value should be less than the slider max. The effectiveMax and effectiveMin allow you to represent ranges of values in a dataset that cannot be filtered or selected with the slider. This can be useful when using the slider to represent datasets with outliers, or scale ranges not suitable for a layer.
public System.Nullable<double> EffectiveMax { get; set; }
Property Value
System.Nullable<System.Double>
SliderWidget.EffectiveMin Property
When set, the user is restricted from moving slider thumbs to positions less than this value. This value should be greater than the slider min. The effectiveMin and effectiveMax allow you to represent ranges of values in a dataset that cannot be filtered or selected with the slider. This can be useful when using the slider to represent datasets with outliers, or scale ranges not suitable for a layer.
public System.Nullable<double> EffectiveMin { get; set; }
Property Value
System.Nullable<System.Double>
SliderWidget.InputCreatedFunction Property
A function that provides the developer with access to the input elements when rangeLabelInputsEnabled and/or labelInputsEnabled are set to true. This allows the developer to customize the input elements corresponding to slider min/max and thumb values to validate user input. For example, you can access input elements and customize them with type and pattern attributes.
public string? InputCreatedFunction { get; set; }
Property Value
Remarks
Because the attributes this function exposes are in HTML, they must be set in JavaScript, and it doesn’t make sense to pass them to C#. Instead, pass in valid JavaScript code as a string. This code has access to three parameters (value, type, and thumbIndex). See ArcGIS Maps SDK for JavaScript for more information.
Example value:
“””
input.setAttribute(“type”, “number”);
input.setAttribute(“pattern”, “[0-9]*”);
“””;
SliderWidget.InputFormatFunction Property
A JavaScript function used to format user inputs. As opposed to labelFormatFunction, which formats thumb labels, the inputFormatFunction formats thumb values in the input element when the user begins to edit them.
public string? InputFormatFunction { get; set; }
Property Value
Remarks
Because this function must resolve synchronously, it cannot be used in Blazor. Instead, pass in valid JavaScript code as a string. This code has access to three parameters (value, type, and index) and must return a string. See ArcGIS Maps SDK for JavaScript for more information.
Example value:
“””
if(value >= 1000000){
return (value / 1000000).toPrecision(3) + “m”
}
if(value >= 100000){
return (value / 1000).toPrecision(3) + “k”
}
if(value >= 1000){
return (value / 1000).toPrecision(2) + “k”
}
return value.toFixed(0);
“””;
SliderWidget.InputParseFunction Property
Function used to parse slider inputs formatted by the inputFormatFunction. This property must be set if an inputFormatFunction is set. Otherwise the slider values will likely not update to their expected positions.
Overrides the default input parses, which is a parsed floating point number.
public string? InputParseFunction { get; set; }
Property Value
Remarks
Because this function must resolve synchronously, it cannot be used in Blazor. Instead, pass in valid JavaScript code as a string. This code has access to three parameters (value, type, and index) and must return a string. See ArcGIS Maps SDK for JavaScript for more information.
Example value:
“””
let charLength = value.length;
let valuePrefix = parseFloat(value.substring(0,charLength-1));
let finalChar = value.substring(charLength-1);
if(parseFloat(finalChar) >= 0){
return parseFloat(value);
}
if(finalChar === "k"){
return valuePrefix * 1000;
}
if(finalChar === "m"){
return valuePrefix * 1000000;
}
return value; """;
SliderWidget.Label Property
The widget’s default label. This label displays when it is used within another widget, such as the Expand or LayerList widgets.
public string? Label { get; set; }
Property Value
SliderWidget.LabelFormatFunction Property
A function used to format labels. Overrides the default label formatter.
By default labels are formatted in the following way:
- When the data range is less than 10 ((max - min) < 10), labels are rounded based on the value set in the precision property.
- When the data range is larger than 10, labels display with a precision of no more than two decimal places, though actual slider thumb values will maintain the precision specified in precision.
Use this property to override the behavior defined above.
public string? LabelFormatFunction { get; set; }
Property Value
Remarks
Because this function must resolve synchronously, it cannot be used in Blazor. Instead, pass in valid JavaScript code as a string. This code has access to three parameters (value, type, and index) and must return a string. See ArcGIS Maps SDK for JavaScript for more information.
Example value:
“””
return (type === “value”) ? value.toFixed(0) : value;
“””;
SliderWidget.LabelInputsEnabled Property
Indicates whether to enable editing input values via keyboard input when the user clicks a label. This allows the user to move the slider thumb to precise values without sliding the thumbs.
public System.Nullable<bool> LabelInputsEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SliderWidget.Layout Property
Determines the layout/orientation of the Slider widget. By default, the slider will render horizontally with the min value on the left side of the track.
public System.Nullable<dymaptic.GeoBlazor.Core.Components.Widgets.SliderLayout> Layout { get; set; }
Property Value
SliderWidget.Max Property
The maximum possible data/thumb value of the slider. In the constructor, if one of the values specified in values is greater than the max value specified in this property, then the max will update to the highest value in values.
To display the max value’s label on the slider, set visibleElements.rangeLabels to true. To allow the end user to modify the max value, set rangeLabelInputsEnabled to true.
public System.Nullable<double> Max { get; set; }
Property Value
System.Nullable<System.Double>
SliderWidget.Min Property
The minimum possible data/thumb value of the slider. In the constructor, if one of the values specified in values is less than the min value specified in this property, then the min will update to the lowest value in values.
To display the min value’s label on the slider, set visibleElements.rangeLabels to true. To allow the end user to modify the min value, set rangeLabelInputsEnabled to true.
public System.Nullable<double> Min { get; set; }
Property Value
System.Nullable<System.Double>
SliderWidget.OnMaxChange Property
Fires when a user changes the max value of the slider.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Components.Widgets.SliderMaxChangeEvent> OnMaxChange { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SliderMaxChangeEvent>
SliderWidget.OnMaxClick Property
Fires when a user clicks the max label element.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Components.Widgets.SliderMaxClickEvent> OnMaxClick { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SliderMaxClickEvent>
SliderWidget.OnMinChange Property
Fires when a user changes the min value of the slider.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Components.Widgets.SliderMinChangeEvent> OnMinChange { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SliderMinChangeEvent>
SliderWidget.OnMinClick Property
Fires when a user clicks the min label element.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Components.Widgets.SliderMinClickEvent> OnMinClick { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SliderMinClickEvent>
SliderWidget.OnSegmentClick Property
Fires when a user clicks a segment element on the slider. A segment is a portion of the track that lies between two thumbs. This only applies when two or more thumbs are set on the slider.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Components.Widgets.SliderSegmentClickEvent> OnSegmentClick { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SliderSegmentClickEvent>
SliderWidget.OnSegmentDrag Property
Fires when a user drags a segment element on the slider. A segment is a portion of the track that lies between two thumbs. This only applies when two or more thumbs are set on the slider.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Components.Widgets.SliderSegmentDragEvent> OnSegmentDrag { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SliderSegmentDragEvent>
SliderWidget.OnThumbChange Property
Fires when a user changes the value of a thumb via the arrow keys or by keyboard editing of the label on the slider.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Components.Widgets.SliderThumbChangeEvent> OnThumbChange { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SliderThumbChangeEvent>
SliderWidget.OnThumbClick Property
Fires when a user clicks a thumb element.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Components.Widgets.SliderThumbClickEvent> OnThumbClick { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SliderThumbClickEvent>
SliderWidget.OnThumbDrag Property
Fires when a user drags a thumb on the Slider widget.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Components.Widgets.SliderThumbDragEvent> OnThumbDrag { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SliderThumbDragEvent>
SliderWidget.OnTickClick Property
Fires when a user clicks a tick or its associated label.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Components.Widgets.SliderTickClickEvent> OnTickClick { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SliderTickClickEvent>
SliderWidget.OnTrackClick Property
Fires when a user clicks the track element.
public Microsoft.AspNetCore.Components.EventCallback<dymaptic.GeoBlazor.Core.Components.Widgets.SliderTrackClickEvent> OnTrackClick { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<SliderTrackClickEvent>
SliderWidget.Precision Property
Defines how slider thumb values should be rounded. This number indicates the number of decimal places slider thumb values should round to when they have been moved.
This value also indicates the precision of thumb labels when the data range is less than 10 (i.e. (max - min) < 10).
When the data range is larger than 10, labels display with a precision of no more than two decimal places, though actual slider thumb values will maintain the precision specified in this property.
public System.Nullable<double> Precision { get; set; }
Property Value
System.Nullable<System.Double>
SliderWidget.RangeLabelInputsEnabled Property
Indicates whether to enable editing range values via keyboard input when the user clicks a min or max label. This allows the user to increase or decrease the data range of the slider.
public System.Nullable<bool> RangeLabelInputsEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SliderWidget.SnapOnClickEnabled Property
Indicates if the closest thumb will snap to the clicked location on the track.
Default Value:true
public System.Nullable<bool> SnapOnClickEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SliderWidget.StepInterval Property
The interval in which slider thumbs can be moved. Use either this or Steps.
public System.Nullable<double> StepInterval { get; set; }
Property Value
System.Nullable<System.Double>
SliderWidget.Steps Property
Sets steps on the slider that restrict user input to specific values. If an array of numbers is passed to this property, the slider thumbs may only be moved to the positions specified in the array. User either this or StepInterval.
public System.Collections.Generic.IReadOnlyCollection<double>? Steps { get; set; }
Property Value
System.Collections.Generic.IReadOnlyCollection<System.Double>
SliderWidget.SyncedSegmentsEnabled Property
When true, all segments will sync together in updating thumb values when the user drags any segment. This maintains the interval between all thumbs when any segment is dragged. Only applicable when draggableSegmentsEnabled is true.
Default Value:false
public System.Nullable<bool> SyncedSegmentsEnabled { get; set; }
Property Value
System.Nullable<System.Boolean>
SliderWidget.ThumbCreatedFunction Property
Function that executes each time a thumb is created on the slider. This can be used to add custom styling to each thumb or hook event listeners to specific thumbs.
public string? ThumbCreatedFunction { get; set; }
Property Value
Remarks
Because the attributes this function exposes are in HTML, they must be set in JavaScript, and it doesn’t make sense to pass them to C#. Instead, pass in valid JavaScript code as a string. This code has access to four parameters (index, value, thumbElement, and labelElement). See ArcGIS Maps SDK for JavaScript for more information.
Example value:
“””
thumbElement.classList.add(“change-color”);
thumbElement.addEventListener(“focus”, function() {
// add custom behavior here…tooltips, fire other actions, etc.
});
“””;
SliderWidget.ThumbsConstrained Property
When false, the user can freely move any slider thumb to any position along the track. By default, a thumb’s position is constrained to the positions of neighboring thumbs so you cannot move one thumb past another. Set this property to false to disable this constraining behavior.
Default Value:true
public System.Nullable<bool> ThumbsConstrained { get; set; }
Property Value
System.Nullable<System.Boolean>
SliderWidget.TickConfigs Property
When set, renders ticks along the slider track. See the TickConfig documentation for more information on how to configure tick placement, style, and behavior.
public System.Collections.Generic.IReadOnlyList<dymaptic.GeoBlazor.Core.Components.Widgets.SliderTickConfig> TickConfigs { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<SliderTickConfig>
SliderWidget.ValueChanged Property
Fires when a user changes the selected range or value of the slider.
public Microsoft.AspNetCore.Components.EventCallback<double[]> ValueChanged { get; set; }
Property Value
Microsoft.AspNetCore.Components.EventCallback<System.Double[]>
SliderWidget.Values Property
A collection of numbers representing absolute thumb positions on the slider.
public System.Collections.Generic.IReadOnlyCollection<double>? Values { get; set; }
Property Value
System.Collections.Generic.IReadOnlyCollection<System.Double>
SliderWidget.VisibleElements Property
The visible elements that are displayed within the widget. This property provides the ability to turn individual elements of the widget’s display on/off.
public dymaptic.GeoBlazor.Core.Components.Widgets.SliderVisibleElements? VisibleElements { get; set; }
Property Value
SliderWidget.WidgetType Property
The type of widget
public override string WidgetType { get; }
Property Value
Methods
SliderWidget.GetEffectiveSegmentElements() Method
Retrieves references to the HTML Element nodes representing the slider segment between the min and effectiveMin, and the segment between the effectiveMax and max. You can use this method to customize the style and attach event handlers to these segments. This only applies to sliders where the effectiveMin and effectiveMax are specified.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Components.ElementReference[]?> GetEffectiveSegmentElements();
Returns
System.Threading.Tasks.Task<Microsoft.AspNetCore.Components.ElementReference[]>
SliderWidget.GetLabelElements() Method
Retrieves references to the HTML Element nodes representing labels attached to slider thumbs. You can use this property to customize the style of labels and attach event handlers to each element.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Components.ElementReference[]?> GetLabelElements();
Returns
System.Threading.Tasks.Task<Microsoft.AspNetCore.Components.ElementReference[]>
SliderWidget.GetLabels() Method
Retrieves an array of strings associated with ‘values’ generated using an internal label formatter or the values returned from labelFormatFunction.
public System.Threading.Tasks.Task<string[]?> GetLabels();
Returns
System.Threading.Tasks.Task<System.String[]>
SliderWidget.GetMaxLabelElement() Method
Retrieves the HTML Element node representing the max value label. You can use this property to customize the style and attach event handlers.
public System.Threading.Tasks.Task<System.Nullable<Microsoft.AspNetCore.Components.ElementReference>> GetMaxLabelElement();
Returns
System.Threading.Tasks.Task<System.Nullable<Microsoft.AspNetCore.Components.ElementReference>>
SliderWidget.GetMinLabelElement() Method
Retrieves the HTML Element node representing the min value label. You can use this property to customize the style and attach event handlers.
public System.Threading.Tasks.Task<System.Nullable<Microsoft.AspNetCore.Components.ElementReference>> GetMinLabelElement();
Returns
System.Threading.Tasks.Task<System.Nullable<Microsoft.AspNetCore.Components.ElementReference>>
SliderWidget.GetSegmentElements() Method
Retrieves the HTML Element nodes representing interactive slider segments. Segments are interactive when situated between two thumbs. You can use this property to customize the style and attach event handlers to segments.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Components.ElementReference[]?> GetSegmentElements();
Returns
System.Threading.Tasks.Task<Microsoft.AspNetCore.Components.ElementReference[]>
SliderWidget.GetState() Method
Retrieves the current state of the widget.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Components.Widgets.SliderState>> GetState();
Returns
System.Threading.Tasks.Task<System.Nullable<SliderState>>
SliderWidget.GetThumbElements() Method
Retrieves references to the HTML Element nodes representing slider thumbs. You can use this property to customize the style of thumbs and attach event handlers to each thumb.
public System.Threading.Tasks.Task<Microsoft.AspNetCore.Components.ElementReference[]?> GetThumbElements();
Returns
System.Threading.Tasks.Task<Microsoft.AspNetCore.Components.ElementReference[]>
SliderWidget.GetTickElements() Method
Retrieves references to the HTML Element nodes representing slider ticks and their associated labels. These elements are created in TickCreatedFunction and configured in tickConfigs.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Components.Widgets.TickElementGroup[][]?> GetTickElements();
Returns
System.Threading.Tasks.Task<TickElementGroup[][]>
SliderWidget.GetTrackElement() Method
The HTML Element node representing the slider track. Use this property to attach event listeners to the track or to customize the track’s CSS.
public System.Threading.Tasks.Task<System.Nullable<Microsoft.AspNetCore.Components.ElementReference>> GetTrackElement();
Returns
System.Threading.Tasks.Task<System.Nullable<Microsoft.AspNetCore.Components.ElementReference>>
SliderWidget.OnJsMaxChange(SliderMaxChangeEvent) Method
JS-invokable method, for internal use only.
public System.Threading.Tasks.Task OnJsMaxChange(dymaptic.GeoBlazor.Core.Components.Widgets.SliderMaxChangeEvent changeEvent);
Parameters
changeEvent SliderMaxChangeEvent
Returns
SliderWidget.OnJsMaxClick(SliderMaxClickEvent) Method
JS-invokable method, for internal use only.
public System.Threading.Tasks.Task OnJsMaxClick(dymaptic.GeoBlazor.Core.Components.Widgets.SliderMaxClickEvent clickEvent);
Parameters
clickEvent SliderMaxClickEvent
Returns
SliderWidget.OnJsMinChange(SliderMinChangeEvent) Method
JS-invokable method, for internal use only.
public System.Threading.Tasks.Task OnJsMinChange(dymaptic.GeoBlazor.Core.Components.Widgets.SliderMinChangeEvent changeEvent);
Parameters
changeEvent SliderMinChangeEvent
Returns
SliderWidget.OnJsMinClick(SliderMinClickEvent) Method
JS-invokable method, for internal use only.
public System.Threading.Tasks.Task OnJsMinClick(dymaptic.GeoBlazor.Core.Components.Widgets.SliderMinClickEvent clickEvent);
Parameters
clickEvent SliderMinClickEvent
Returns
SliderWidget.OnJsSegmentClick(SliderSegmentClickEvent) Method
JS-invokable method, for internal use only.
public System.Threading.Tasks.Task OnJsSegmentClick(dymaptic.GeoBlazor.Core.Components.Widgets.SliderSegmentClickEvent clickEvent);
Parameters
clickEvent SliderSegmentClickEvent
Returns
SliderWidget.OnJsSegmentDrag(SliderSegmentDragEvent) Method
JS-invokable method, for internal use only.
public System.Threading.Tasks.Task OnJsSegmentDrag(dymaptic.GeoBlazor.Core.Components.Widgets.SliderSegmentDragEvent dragEvent);
Parameters
dragEvent SliderSegmentDragEvent
Returns
SliderWidget.OnJsThumbChange(SliderThumbChangeEvent) Method
JS-invokable method, for internal use only.
public System.Threading.Tasks.Task OnJsThumbChange(dymaptic.GeoBlazor.Core.Components.Widgets.SliderThumbChangeEvent changeEvent);
Parameters
changeEvent SliderThumbChangeEvent
Returns
SliderWidget.OnJsThumbClick(SliderThumbClickEvent) Method
JS-invokable method, for internal use only.
public System.Threading.Tasks.Task OnJsThumbClick(dymaptic.GeoBlazor.Core.Components.Widgets.SliderThumbClickEvent clickEvent);
Parameters
clickEvent SliderThumbClickEvent
Returns
SliderWidget.OnJsThumbDrag(SliderThumbDragEvent) Method
JS-invokable method, for internal use only.
public System.Threading.Tasks.Task OnJsThumbDrag(dymaptic.GeoBlazor.Core.Components.Widgets.SliderThumbDragEvent dragEvent);
Parameters
dragEvent SliderThumbDragEvent
Returns
SliderWidget.OnJsTickClick(SliderTickClickEvent) Method
JS-invokable method, for internal use only.
public System.Threading.Tasks.Task OnJsTickClick(dymaptic.GeoBlazor.Core.Components.Widgets.SliderTickClickEvent clickEvent);
Parameters
clickEvent SliderTickClickEvent
Returns
SliderWidget.OnJsTrackClick(SliderTrackClickEvent) Method
JS-invokable method, for internal use only.
public System.Threading.Tasks.Task OnJsTrackClick(dymaptic.GeoBlazor.Core.Components.Widgets.SliderTrackClickEvent clickEvent);
Parameters
clickEvent SliderTrackClickEvent
Returns
SliderWidget.OnJsValueChanged(double[]) Method
JS-invokable method, for internal use only.
public System.Threading.Tasks.Task OnJsValueChanged(double[] newValues);
Parameters
newValues System.Double[]
Returns
SliderWidget.RegisterChildComponent(MapComponent) Method
Called from dymaptic.GeoBlazor.Core.Components.MapComponent.OnInitializedAsync to “Register” the current component with it’s parent.
public override System.Threading.Tasks.Task RegisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The calling, child component to register
Returns
Exceptions
InvalidChildElementException
Throws if the current child is not a valid sub-component to the parent.
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method. If you see no other way to register a child component, please open an issue on GitHub.
SliderWidget.SetMax(double) Method
Updates the Max value after initial render.
public System.Threading.Tasks.Task SetMax(double max);
Parameters
max System.Double
Returns
SliderWidget.SetMin(double) Method
Updates the Min value after initial render.
public System.Threading.Tasks.Task SetMin(double min);
Parameters
min System.Double
Returns
SliderWidget.SetStepInterval(double) Method
Updates the StepInterval value after initial render.
public System.Threading.Tasks.Task SetStepInterval(double stepInterval);
Parameters
stepInterval System.Double
Returns
SliderWidget.SetSteps(IReadOnlyCollection) Method
Updates the Steps value after initial render.
public System.Threading.Tasks.Task SetSteps(System.Collections.Generic.IReadOnlyCollection<double> steps);
Parameters
steps System.Collections.Generic.IReadOnlyCollection<System.Double>
Returns
SliderWidget.SetValues(IReadOnlyCollection) Method
Updates the Values after initial render.
public System.Threading.Tasks.Task SetValues(System.Collections.Generic.IReadOnlyCollection<double> values);
Parameters
values System.Collections.Generic.IReadOnlyCollection<System.Double>
Returns
SliderWidget.UnregisterChildComponent(MapComponent) Method
Undoes the “Registration” of a child with its parent.
public override System.Threading.Tasks.Task UnregisterChildComponent(dymaptic.GeoBlazor.Core.Components.MapComponent child);
Parameters
child MapComponent
The child to unregister
Returns
Remarks
This method is an implementation detail and should not be called directly by consumers. In future versions, this may be changed to an internal method.