Class MapsBubble<TValue>

Defines the properties for customizing the bubble of the maps.

Inheritance

object

ComponentBase

OwningComponentBase

SfOwningComponentBase

SfBaseComponent

SfDataBoundComponent

MapsBubble<TValue>

Implements

Inherited Members

ComponentBase.Assets

ComponentBase.AssignedRenderMode

ComponentBase.DispatchExceptionAsync(Exception)

ComponentBase.InvokeAsync(Action)

ComponentBase.InvokeAsync(Func<Task>)

ComponentBase.OnAfterRender(bool)

ComponentBase.OnInitialized()

ComponentBase.OnParametersSet()

ComponentBase.RendererInfo

ComponentBase.SetParametersAsync(ParameterView)

ComponentBase.ShouldRender()

ComponentBase.StateHasChanged()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

OwningComponentBase.IsDisposed

OwningComponentBase.ScopedServices

SfBaseComponent.Dispose()

SfBaseComponent.GetEffectivePlatform()

SfBaseComponent.GetMainComponentPlatform()

SfBaseComponent.IsMainLicenseComponent()

SfBaseComponent.LicenseContext

SfBaseComponent.ValidateLicense()

SfDataBoundComponent.DataManager

SfDataBoundComponent.MainParent

SfDataBoundComponent.OnAfterRenderAsync(bool)

SfDataBoundComponent.SetDataManager<T>(object)

Namespace: Syncfusion.Blazor.Maps

Assembly: Syncfusion.Blazor.dll

Syntax

public class MapsBubble<TValue> : SfDataBoundComponent, IComponent, IHandleEvent, IHandleAfterRender, IDisposable, IBubble

Type Parameters

Name	Description
TValue	represents the class name of the data source.

Constructors

MapsBubble()

Declaration

public MapsBubble()

Properties

AnimationDelay

Gets or sets the delay in animation for bubbles in the map.

Declaration

[Parameter]
public double AnimationDelay { get; set; }

Property Value

Type	Description
double	A double representing the delay in milliseconds.

Remarks

This property controls when the bubble animation will start after rendering.

AnimationDuration

Gets or sets the duration for the animation of bubbles in the map.

Declaration

[Parameter]
public double AnimationDuration { get; set; }

Property Value

Type	Description
double	A double representing the animation duration in milliseconds, with a default of 1000.

Remarks

This determines how long the bubble animation will last.

BubbleType

Gets or sets the type of the bubble in the map.

Declaration

[Parameter]
public BubbleType BubbleType { get; set; }

Property Value

Type	Description
BubbleType	A BubbleType specifying the shape of the bubble, with a default of Circle.

Remarks

Supported bubble types include circles or other predefined shapes.

ChildContent

Gets or sets the child content UI element within the map bubble.

Declaration

[Parameter]
public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
RenderFragment	A RenderFragment representing the content of the UI element.

Remarks

This property allows custom UI elements to be included inside the bubble using a render fragment.

ColorValuePath

Gets or sets the value from the data source of bubble settings for the color of the bubble in the map.

Declaration

[Parameter]
public string ColorValuePath { get; set; }

Property Value

Type	Description
string	A string specifying the path to the color value in the data source.

Remarks

Use this to bind color data from the data source to the bubble color in the map.

DataSource

Gets or sets the data source for the bubble.

Declaration

[Parameter]
public IEnumerable<object> DataSource { get; set; }

Property Value

Type	Description
IEnumerable<object>	An IEnumerable<T> representing the data source.

Remarks

The data source should contain the size and other data properties required for bubble rendering.

Fill

Gets or sets the color for the bubble in the map.

Declaration

[Parameter]
public string Fill { get; set; }

Property Value

Type	Description
string	A string representing the fill color.

Remarks

This property defines the appearance fill color of the bubble used in the map.

MaxRadius

Gets or sets the maximum radius for the bubble in the map.

Declaration

[Parameter]
public double MaxRadius { get; set; }

Property Value

Type	Description
double	A double representing the maximum bubble size in pixels, with a default value of 20.

Remarks

Controls the largest size the bubble can reach.

MinRadius

Gets or sets the minimum radius for the bubble in the map.

Declaration

[Parameter]
public double MinRadius { get; set; }

Property Value

Type	Description
double	A double representing the minimum bubble size in pixels, with a default value of 10.

Remarks

Controls the smallest size the bubble can be.

Opacity

Gets or sets the opacity of the bubble in the map.

Declaration

[Parameter]
public double Opacity { get; set; }

Property Value

Type	Description
double	A double indicating the opacity level, with a default value of 1.

Remarks

This property defines the transparency level of the bubble, where 0 is fully transparent and 1 is fully opaque.

Query

Gets or sets the query to select particular data from the bubble data.

Declaration

[Parameter]
public Query Query { get; set; }

Property Value

Type	Description
Query	A Query used to filter data, applicable only when the data source is created by a data manager.

Remarks

Use this to refine which data points should be considered when creating bubbles.

ValuePath

Gets or sets the value from the data source of bubble settings for the rendering of bubbles in the map.

Declaration

[Parameter]
public string ValuePath { get; set; }

Property Value

Type	Description
string	A string representing the path to the value for bubble size or other properties.

Remarks

Use this to bind specific data values to bubble properties such as size.

Visible

Gets or sets a value indicating whether the bubbles are visible on the map.

Declaration

[Parameter]
public bool Visible { get; set; }

Property Value

Type	Description
bool	A bool indicating the visibility state.

Remarks

Set to true to display the bubbles and false to hide them.

Methods

BuildRenderTree(RenderTreeBuilder)

Declaration

protected override void BuildRenderTree(RenderTreeBuilder __builder)

Parameters

Type	Name	Description
RenderTreeBuilder	__builder

Overrides

ComponentBase.BuildRenderTree(RenderTreeBuilder)

Dispose(bool)

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
bool	disposing

Overrides

SfBaseComponent.Dispose(bool)

OnInitializedAsync()

OnInitializedAsync method is called when the component has received its initial parameters.

Declaration

protected override Task OnInitializedAsync()

Returns

Type	Description
Task	Task representing the asynchronous operation.

Overrides

SfDataBoundComponent.OnInitializedAsync()

OnObservableChange(string, object, bool, NotifyCollectionChangedEventArgs)

INotifyCollectionChanged event handler to track the changes in the bubble data source.

Declaration

protected override void OnObservableChange(string propertyName, object sender, bool isCollectionChanged = false, NotifyCollectionChangedEventArgs e = null)

Parameters

Type	Name	Description
string	propertyName	Observable property name.
object	sender	Observable model object.
bool	isCollectionChanged	Sets true if the observable collection changed.
NotifyCollectionChangedEventArgs	e	Changed Event Args

Overrides

SfBaseComponent.OnObservableChange(string, object, bool, NotifyCollectionChangedEventArgs)

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
Task	Task representing the asynchronous operation.

Overrides

SfDataBoundComponent.OnParametersSetAsync()

Implements

IComponent

IHandleEvent

IHandleAfterRender

IDisposable

IBubble