Class MapsMarker<TValue>
Sets and gets the option for the customization of marker for the maps.
Implements
Inherited Members
Namespace: Syncfusion.Blazor.Maps
Assembly: Syncfusion.Blazor.dll
Syntax
public class MapsMarker<TValue> : SfDataBoundComponent, IMarker
Type Parameters
Name | Description |
---|---|
TValue | represents the class name of the data source. |
Constructors
MapsMarker()
Declaration
public MapsMarker()
Properties
AnimationDelay
Sets and gets the delay time for the animation in marker.
Declaration
public double AnimationDelay { get; set; }
Property Value
Type |
---|
System.Double |
AnimationDuration
Sets and gets the duration time for animating the marker.
Declaration
public double AnimationDuration { get; set; }
Property Value
Type |
---|
System.Double |
ChildContent
Sets and gets the content of the UI element.
Declaration
public RenderFragment ChildContent { get; set; }
Property Value
Type |
---|
Microsoft.AspNetCore.Components.RenderFragment |
ColorValuePath
Sets and gets the value path from the marker data source to apply color for the marker.
Declaration
public string ColorValuePath { get; set; }
Property Value
Type |
---|
System.String |
DashArray
Sets and gets the dash-array for the marker.
Declaration
public string DashArray { get; set; }
Property Value
Type |
---|
System.String |
DataSource
Sets and gets the data source for the marker. The data source for the marker will contain latitude and longitude values to specify the location of the marker. The data source can contain data such as color, shape, and other details that can be bound to the color, shape, and tooltip of the marker.
Declaration
public IEnumerable<object> DataSource { get; set; }
Property Value
Type |
---|
System.Collections.Generic.IEnumerable<System.Object> |
EnableDrag
Gets or sets a value indicating whether the user can drag and drop markers on the map at any location.
Declaration
public bool EnableDrag { get; set; }
Property Value
Type |
---|
System.Boolean |
Remarks
You can enable or disable the marker drag and drop functionality through mouse or touch interactions in the Syncfusion.Blazor.Maps component.
Fill
Sets and gets the color for the marker in maps.
Declaration
public string Fill { get; set; }
Property Value
Type |
---|
System.String |
Height
Sets and gets the height of the marker in maps.
Declaration
public double Height { get; set; }
Property Value
Type |
---|
System.Double |
ImageUrl
Sets and gets the URL for rendering the marker as image.
Declaration
public string ImageUrl { get; set; }
Property Value
Type |
---|
System.String |
ImageUrlValuePath
Sets and gets the value path from the marker data source for the image of the marker.
Declaration
public string ImageUrlValuePath { get; set; }
Property Value
Type |
---|
System.String |
LatitudeValuePath
Defines the value path from the marker data source for setting latitude for a set of markers.
Declaration
public string LatitudeValuePath { get; set; }
Property Value
Type |
---|
System.String |
LegendText
Sets and gets the text for the legend from the marker data source.
Declaration
public string LegendText { get; set; }
Property Value
Type |
---|
System.String |
LongitudeValuePath
Defines the value path from the marker data source for setting longitude for a set of markers.
Declaration
public string LongitudeValuePath { get; set; }
Property Value
Type |
---|
System.String |
MarkerTemplate
Gets or sets the content of UI element.
Declaration
public RenderFragment<object> MarkerTemplate { get; set; }
Property Value
Type |
---|
Microsoft.AspNetCore.Components.RenderFragment<System.Object> |
OffsetX
Sets and gets the X position value of the marker in the Maps component. When this property is set, the marker will render a certain distance from the provided longitude value.
Declaration
public double OffsetX { get; set; }
Property Value
Type |
---|
System.Double |
OffsetY
Sets and gets the Y position value of the marker in the Maps component. When this property is set, the marker will render a certain distance from the provided longitude value.
Declaration
public double OffsetY { get; set; }
Property Value
Type |
---|
System.Double |
Opacity
Sets and gets the opacity for the marker in maps.
Declaration
public double Opacity { get; set; }
Property Value
Type |
---|
System.Double |
Query
Sets and gets the query to select particular data from the marker data. This property is applicable only when the data source is created by data manager.
Declaration
public Query Query { get; set; }
Property Value
Type |
---|
Query |
Shape
Sets and gets the shape of the marker in maps.
Declaration
public MarkerType Shape { get; set; }
Property Value
Type |
---|
MarkerType |
ShapeValuePath
Sets and gets the value path from the marker data source to set the shape of the marker.
Declaration
public string ShapeValuePath { get; set; }
Property Value
Type |
---|
System.String |
Visible
Enables or disables the visibility state of the marker based on the marker data source in maps.
Declaration
public bool Visible { get; set; }
Property Value
Type |
---|
System.Boolean |
Width
Sets and gets the width of the marker in maps.
Declaration
public double Width { get; set; }
Property Value
Type |
---|
System.Double |
Methods
BuildRenderTree(RenderTreeBuilder)
Declaration
protected override void BuildRenderTree(RenderTreeBuilder __builder)
Parameters
Type | Name | Description |
---|---|---|
Microsoft.AspNetCore.Components.Rendering.RenderTreeBuilder | __builder |
Dispose(Boolean)
Disposes the property values during the destroy of the component that is hold up for the execution of the component.
Declaration
protected override void Dispose(bool disposing)
Parameters
Type | Name | Description |
---|---|---|
System.Boolean | disposing |
Overrides
OnInitializedAsync()
OnInitializedAsync method is called when the component has received its initial parameters.
Declaration
protected override Task OnInitializedAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | System.Threading.Tasks.Task representing the asynchronous operation. |
Overrides
OnObservableChange(String, Object, Boolean, NotifyCollectionChangedEventArgs)
INotifyCollectionChanged event handler to track the changes in the marker data source.
Declaration
protected override void OnObservableChange(string propertyName, object sender, bool isCollectionChanged = false, NotifyCollectionChangedEventArgs e = null)
Parameters
Type | Name | Description |
---|---|---|
System.String | propertyName | Observable property name. |
System.Object | sender | Observable model object. |
System.Boolean | isCollectionChanged | Sets true if the observable collection changed. |
System.Collections.Specialized.NotifyCollectionChangedEventArgs | e | Changed Event Args |
Overrides
OnParametersSetAsync()
OnParametersSetAsync is a lifecycle method that is invoked when the component has received parameters, and the incoming values have been assigned to the properties.
Declaration
protected override Task OnParametersSetAsync()
Returns
Type | Description |
---|---|
System.Threading.Tasks.Task | System.Threading.Tasks.Task representing the asynchronous operation. |