dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
TickConfig Class
Object specification for configuring ticks on the slider.
ArcGIS Maps SDK for JavaScript
public class TickConfig : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 TickConfig
Constructors
TickConfig() Constructor
Parameterless constructor for use as a Razor Component.
public TickConfig();
TickConfig(TickConfigMode, SliderLabelFormatter, Nullable, TickCreatedFunction, IReadOnlyList) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public TickConfig(dymaptic.GeoBlazor.Core.Enums.TickConfigMode mode, dymaptic.GeoBlazor.Core.Functions.SliderLabelFormatter? labelFormatFunction=null, System.Nullable<bool> labelsVisible=null, dymaptic.GeoBlazor.Core.Functions.TickCreatedFunction? tickCreatedFunction=null, System.Collections.Generic.IReadOnlyList<double>? values=null);
Parameters
mode TickConfigMode
The mode or method of positioning ticks along the slider track.
ArcGIS Maps SDK for JavaScript
labelFormatFunction SliderLabelFormatter
Callback for formatting tick labels.
ArcGIS Maps SDK for JavaScript
labelsVisible System.Nullable<System.Boolean>
Indicates whether to render labels for the ticks.
ArcGIS Maps SDK for JavaScript
tickCreatedFunction TickCreatedFunction(double, ElementReference, ElementReference)
Callback that fires for each tick.
ArcGIS Maps SDK for JavaScript
values System.Collections.Generic.IReadOnlyList<System.Double>
Indicates where ticks will be rendered below the track.
ArcGIS Maps SDK for JavaScript
Properties
TickConfig.HasLabelFormatFunction Property
A convenience property that signifies whether a custom LabelFormatFunction function was registered.
public bool HasLabelFormatFunction { get; }
Property Value
TickConfig.HasTickCreatedFunction Property
A convenience property that signifies whether a custom TickCreatedFunction function was registered.
public bool HasTickCreatedFunction { get; }
Property Value
TickConfig.LabelFormatFunction Property
Callback for formatting tick labels.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Functions.SliderLabelFormatter? LabelFormatFunction { get; set; }
Property Value
TickConfig.LabelsVisible Property
Indicates whether to render labels for the ticks.
public System.Nullable<bool> LabelsVisible { get; set; }
Property Value
System.Nullable<System.Boolean>
TickConfig.Mode Property
The mode or method of positioning ticks along the slider track.
public dymaptic.GeoBlazor.Core.Enums.TickConfigMode Mode { get; set; }
Property Value
TickConfig.TickCreatedFunction Property
Callback that fires for each tick.
ArcGIS Maps SDK for JavaScript
public dymaptic.GeoBlazor.Core.Functions.TickCreatedFunction? TickCreatedFunction { get; set; }
Property Value
TickCreatedFunction(double, ElementReference, ElementReference)
TickConfig.Values Property
Indicates where ticks will be rendered below the track.
ArcGIS Maps SDK for JavaScript
public System.Collections.Generic.IReadOnlyList<double>? Values { get; set; }
Property Value
System.Collections.Generic.IReadOnlyList<System.Double>
Methods
TickConfig.AddToValues(double[]) Method
Asynchronously adds elements to the Values property.
public System.Threading.Tasks.Task AddToValues(params double[] values);
Parameters
values System.Double[]
The elements to add.
Returns
TickConfig.GetLabelsVisible() Method
Asynchronously retrieve the current value of the LabelsVisible property.
public System.Threading.Tasks.Task<System.Nullable<bool>> GetLabelsVisible();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Boolean>>
TickConfig.GetMode() Method
Asynchronously retrieve the current value of the Mode property.
public System.Threading.Tasks.Task<System.Nullable<dymaptic.GeoBlazor.Core.Enums.TickConfigMode>> GetMode();
Returns
System.Threading.Tasks.Task<System.Nullable<TickConfigMode>>
TickConfig.GetValues() Method
Asynchronously retrieve the current value of the Values property.
public System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<double>?> GetValues();
Returns
System.Threading.Tasks.Task<System.Collections.Generic.IReadOnlyList<System.Double>>
TickConfig.OnJsTickCreatedFunction(double, ElementReference, ElementReference) Method
JS-invokable method that triggers the TickCreatedFunction function.
Should not be called by consuming code.
public System.Threading.Tasks.Task OnJsTickCreatedFunction(double value, Microsoft.AspNetCore.Components.ElementReference tickElement, Microsoft.AspNetCore.Components.ElementReference labelElement);
Parameters
value System.Double
tickElement Microsoft.AspNetCore.Components.ElementReference
labelElement Microsoft.AspNetCore.Components.ElementReference
Returns
TickConfig.RemoveFromValues(double[]) Method
Asynchronously remove an element from the Values property.
public System.Threading.Tasks.Task RemoveFromValues(params double[] values);
Parameters
values System.Double[]
The elements to remove.
Returns
TickConfig.SetLabelsVisible(Nullable) Method
Asynchronously set the value of the LabelsVisible property after render.
public System.Threading.Tasks.Task SetLabelsVisible(System.Nullable<bool> value);
Parameters
value System.Nullable<System.Boolean>
The value to set.
Returns
TickConfig.SetMode(TickConfigMode) Method
Asynchronously set the value of the Mode property after render.
public System.Threading.Tasks.Task SetMode(dymaptic.GeoBlazor.Core.Enums.TickConfigMode value);
Parameters
value TickConfigMode
The value to set.
Returns
TickConfig.SetValues(IReadOnlyList) Method
Asynchronously set the value of the Values property after render.
public System.Threading.Tasks.Task SetValues(System.Collections.Generic.IReadOnlyList<double>? value);
Parameters
value System.Collections.Generic.IReadOnlyList<System.Double>
The value to set.