Class MapsPolygonTooltipSettings

Gets or sets the options for customizing the tooltip of the polygon in maps.

Inheritance

System.Object

MapsPolygonTooltipSettings

Namespace: Syncfusion.Blazor.Maps

Assembly: Syncfusion.Blazor.dll

Syntax

public class MapsPolygonTooltipSettings : OwningComponentBase

Constructors

MapsPolygonTooltipSettings()

Declaration

public MapsPolygonTooltipSettings()

Properties

BorderColor

Gets or sets the color of the border of the tooltip of the polygon shape.

Declaration

public string BorderColor { get; set; }

Property Value

Type	Description
System.String	Accepts the string value, which represents the color as in HTML elements.

Remarks

The property is used to change the border color of the tooltip of the polygon shape. This property takes the value as in the color CSS style of the HTML element, such as hex color code, rgb value, rgba value, hsl value, and others.

BorderOpacity

Gets or sets the border opacity of the tooltip of the polygon shape.

Declaration

public double BorderOpacity { get; set; }

Property Value

Type	Description
System.Double	Accepts the number value from 0 to 1 that represents the opacity.

Remarks

The property is used to change the border opacity of the tooltip of the polygon shape. This property takes the value from 0 to 1.

BorderWidth

Gets or sets the border width of the tooltip of the polygon shape.

Declaration

public double BorderWidth { get; set; }

Property Value

Type	Description
System.Double	Accepts the number value that represents the border width.

Remarks

The property is used to change the border width of the tooltip of the polygon shape.

Duration

Gets or sets the duration for the tooltip of the polygon shape on the mobile device.

Declaration

public double Duration { get; set; }

Property Value

Type	Description
System.Double	Accepts the number value that represents the duration in milliseconds.

Remarks

This property is used to change the duration of the tooltip for polygon shapes. It specifies the time in milliseconds after which the tooltip will be removed on a mobile device. If the value is set to 0, the tooltip will not be removed. If the value is set to greater than 0, the tooltip will be removed after the specified duration.

Fill

Gets or sets the background color for the tooltip of the polygon shape.

Declaration

public string Fill { get; set; }

Property Value

Type	Description
System.String	Accepts the string value, which represents the color as in HTML elements.

Remarks

The property is used to change the background color of the tooltip of the polygon shape. This property takes the value as in the color CSS style of the HTML element, such as hex color code, rgb value, rgba value, hsl value, and others.

FontColor

Gets or sets the color of the text in the tooltip of the polygon shape.

Declaration

public string FontColor { get; set; }

Property Value

Type	Description
System.String	Accepts the string value, which represents the font color as in HTML elements.

Remarks

The property is used to change the font color of the text in the tooltip of the polygon shape. This property takes the value as in the color CSS style of the HTML element, such as hex color code, rgb value, rgba value, hsl value, and others.

FontFamily

Gets or sets the font family of the text in the tooltip of the polygon shape. The default value of this property varies based on the Theme property value set in the Maps component.

Declaration

public string FontFamily { get; set; }

Property Value

Type	Description
System.String	Accepts the string value, which represents the font family as in HTML elements.

Remarks

The property is used to change the font family of the text in the tooltip of the polygon shape. This property takes the value as in the font family CSS style of the HTML element.

FontOpacity

Gets or sets the opacity of the text in the tooltip of the polygon shape.

Declaration

public double FontOpacity { get; set; }

Property Value

Type	Description
System.Double	Accepts the number value from 0 to 1 that represents the opacity.

Remarks

The property is used to change the opacity of the text in the tooltip of the polygon shape. This property takes the value from 0 to 1.

FontSize

Gets or sets the font size of the text in the tooltip of the polygon shape.

Declaration

public string FontSize { get; set; }

Property Value

Type	Description
System.String	Accepts the string value that represents the font size.

Remarks

The property is used to change the font size of the text in the tooltip of the polygon shape. This property takes the value as in the font size CSS style of the HTML element, which normally holds pixel values.

FontStyle

Gets or sets the font style of the text in the tooltip of the polygon shape.

Declaration

public string FontStyle { get; set; }

Property Value

Type	Description
System.String	Accepts the string value, which represents the font style as in HTML elements.

Remarks

The property is used to change the font style of the text in the tooltip of the polygon shape. This property takes the value as defined in the font style CSS style of the HTML element.

FontWeight

Gets or sets the font weight of the text in the tooltip of the polygon shape.

Declaration

public string FontWeight { get; set; }

Property Value

Type	Description
System.String	Accepts the string value, which represents the font weight as in HTML elements.

Remarks

The property is used to change the font weight of the text in the tooltip of the polygon shape. This property takes the value as in the font weight CSS style of the HTML element.

Visible

Shows or hides the tooltip of the polygon shapes. When this property is set to false, the tooltip for all the polygon shapes in a layer will not be shown.

Declaration

public bool Visible { get; set; }

Property Value

Type	Description
System.Boolean	Accepts the boolean value to show or hide the tooltip for all the polygon shapes.

Remarks

You can show or hide the tooltip for all the polygon shapes in the map layer.

Methods

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

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.

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.