dymaptic.GeoBlazor.Core
dymaptic.GeoBlazor.Core.Components
HighlightOptions Class
HighlightOptions are used to customize the appearance of highlights applied to features.
ArcGIS Maps SDK for JavaScript
public class HighlightOptions : dymaptic.GeoBlazor.Core.Components.MapComponent
Inheritance System.Object 🡒 Microsoft.AspNetCore.Components.ComponentBase 🡒 MapComponent 🡒 HighlightOptions
Constructors
HighlightOptions() Constructor
Parameterless constructor for use as a Razor Component.
public HighlightOptions();
HighlightOptions(MapColor, MapColor, Nullable, Nullable, MapColor, Nullable, Nullable, string) Constructor
Constructor for use in C# code. Use named parameters (e.g., item1: value1, item2: value2) to set properties in any order.
public HighlightOptions(dymaptic.GeoBlazor.Core.Model.MapColor? color=null, dymaptic.GeoBlazor.Core.Model.MapColor? haloColor=null, System.Nullable<double> haloOpacity=null, System.Nullable<double> fillOpacity=null, dymaptic.GeoBlazor.Core.Model.MapColor? shadowColor=null, System.Nullable<double> shadowOpacity=null, System.Nullable<double> shadowDifference=null, string? name=null);
Parameters
color MapColor
The color of the highlight fill.
ArcGIS Maps SDK for JavaScript
haloColor MapColor
The color of the halo surrounding the highlight.
ArcGIS Maps SDK for JavaScript
haloOpacity System.Nullable<System.Double>
The opacity of the highlight halo.
default 1
ArcGIS Maps SDK for JavaScript
fillOpacity System.Nullable<System.Double>
The opacity of the fill (area within the halo).
default 0.25
ArcGIS Maps SDK for JavaScript
shadowColor MapColor
The color of the highlighted feature’s shadow in a 3D SceneView.
default #000000
ArcGIS Maps SDK for JavaScript
shadowOpacity System.Nullable<System.Double>
The opacity of the highlighted feature’s shadow in a 3D SceneView.
default 0.4
ArcGIS Maps SDK for JavaScript
shadowDifference System.Nullable<System.Double>
Defines the intensity of the shadow area obtained by overlapping the shadow of the highlighted feature and the
shadow of other objects in a 3D SceneView.
default 0.2
ArcGIS Maps SDK for JavaScript
name System.String
A name used to uniquely identify the highlight options within the view’s
highlights collection.
ArcGIS Maps SDK for JavaScript
Properties
HighlightOptions.Color Property
The color of the highlight fill.
DefaultValue: #00ffff
public dymaptic.GeoBlazor.Core.Model.MapColor? Color { get; set; }
Property Value
HighlightOptions.FillOpacity Property
The opacity of the fill (area within the halo). This will be multiplied with the opacity specified in color.
DefaultValue: 0.25
public System.Nullable<double> FillOpacity { get; set; }
Property Value
System.Nullable<System.Double>
HighlightOptions.HaloColor Property
The color of the halo surrounding the highlight. If no haloColor is provided, then the halo will be colored with the specified color.
public dymaptic.GeoBlazor.Core.Model.MapColor? HaloColor { get; set; }
Property Value
HighlightOptions.HaloOpacity Property
The opacity of the highlight halo. This will be multiplied with any opacity specified in color.
DefaultValue: 1
public System.Nullable<double> HaloOpacity { get; set; }
Property Value
System.Nullable<System.Double>
HighlightOptions.Name Property
A name used to uniquely identify the highlight options within the view’s
highlights collection.
ArcGIS Maps SDK for JavaScript
public string? Name { get; set; }
Property Value
HighlightOptions.ShadowColor Property
The color of the highlighted feature’s shadow.
DefaultValue: #000000
public dymaptic.GeoBlazor.Core.Model.MapColor? ShadowColor { get; set; }
Property Value
Remarks
Only supported on 3D scene views.
HighlightOptions.ShadowDifference Property
Defines the intensity of the shadow area obtained by overlapping the shadow of the highlighted feature and the shadow of other objects in the scene. The value ranges from 0 to 1. A value of 0 highlights the overlapping shadow areas in the same way (no difference). Setting it to 1 highlights only the difference between the shadow areas, so the overlapping shadow areas aren’t highlighted at all.
DefaultValue: 0.375
public System.Nullable<double> ShadowDifference { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Only supported on 3D scene views.
HighlightOptions.ShadowOpacity Property
The opacity of the highlighted feature’s shadow. This will be multiplied with the opacity specified in shadowColor.
DefaultValue: 0.4
public System.Nullable<double> ShadowOpacity { get; set; }
Property Value
System.Nullable<System.Double>
Remarks
Only supported on 3D scene views.
Methods
HighlightOptions.GetColor() Method
Asynchronously retrieve the current value of the Color property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.MapColor?> GetColor();
Returns
System.Threading.Tasks.Task<MapColor>
HighlightOptions.GetFillOpacity() Method
Asynchronously retrieve the current value of the FillOpacity property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetFillOpacity();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
HighlightOptions.GetHaloColor() Method
Asynchronously retrieve the current value of the HaloColor property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.MapColor?> GetHaloColor();
Returns
System.Threading.Tasks.Task<MapColor>
HighlightOptions.GetHaloOpacity() Method
Asynchronously retrieve the current value of the HaloOpacity property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetHaloOpacity();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
HighlightOptions.GetName() Method
Asynchronously retrieve the current value of the Name property.
public System.Threading.Tasks.Task<string?> GetName();
Returns
System.Threading.Tasks.Task<System.String>
HighlightOptions.GetShadowColor() Method
Asynchronously retrieve the current value of the ShadowColor property.
public System.Threading.Tasks.Task<dymaptic.GeoBlazor.Core.Model.MapColor?> GetShadowColor();
Returns
System.Threading.Tasks.Task<MapColor>
HighlightOptions.GetShadowDifference() Method
Asynchronously retrieve the current value of the ShadowDifference property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetShadowDifference();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
HighlightOptions.GetShadowOpacity() Method
Asynchronously retrieve the current value of the ShadowOpacity property.
public System.Threading.Tasks.Task<System.Nullable<double>> GetShadowOpacity();
Returns
System.Threading.Tasks.Task<System.Nullable<System.Double>>
HighlightOptions.SetColor(MapColor) Method
Asynchronously set the value of the Color property after render.
public System.Threading.Tasks.Task SetColor(dymaptic.GeoBlazor.Core.Model.MapColor? value);
Parameters
value MapColor
The value to set.
Returns
HighlightOptions.SetFillOpacity(Nullable) Method
Asynchronously set the value of the FillOpacity property after render.
public System.Threading.Tasks.Task SetFillOpacity(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
HighlightOptions.SetHaloColor(MapColor) Method
Asynchronously set the value of the HaloColor property after render.
public System.Threading.Tasks.Task SetHaloColor(dymaptic.GeoBlazor.Core.Model.MapColor? value);
Parameters
value MapColor
The value to set.
Returns
HighlightOptions.SetHaloOpacity(Nullable) Method
Asynchronously set the value of the HaloOpacity property after render.
public System.Threading.Tasks.Task SetHaloOpacity(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
HighlightOptions.SetName(string) Method
Asynchronously set the value of the Name property after render.
public System.Threading.Tasks.Task SetName(string? value);
Parameters
value System.String
The value to set.
Returns
HighlightOptions.SetShadowColor(MapColor) Method
Asynchronously set the value of the ShadowColor property after render.
public System.Threading.Tasks.Task SetShadowColor(dymaptic.GeoBlazor.Core.Model.MapColor? value);
Parameters
value MapColor
The value to set.
Returns
HighlightOptions.SetShadowDifference(Nullable) Method
Asynchronously set the value of the ShadowDifference property after render.
public System.Threading.Tasks.Task SetShadowDifference(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.
Returns
HighlightOptions.SetShadowOpacity(Nullable) Method
Asynchronously set the value of the ShadowOpacity property after render.
public System.Threading.Tasks.Task SetShadowOpacity(System.Nullable<double> value);
Parameters
value System.Nullable<System.Double>
The value to set.