Class LinearGaugePointer

Defines the pointer element for an axis in linear gauge component.

Inheritance

System.Object

LinearGaugePointer

Namespace: Syncfusion.Blazor.LinearGauge

Assembly: Syncfusion.Blazor.dll

Syntax

public class LinearGaugePointer : OwningComponentBase

Constructors

LinearGaugePointer()

Declaration

public LinearGaugePointer()

Properties

AnimationDuration

Gets or sets the duration of animation in pointer.

Declaration

public double AnimationDuration { get; set; }

Property Value

Type
System.Double

ChildContent

Gets or sets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type
Microsoft.AspNetCore.Components.RenderFragment

Color

Gets or sets the color of the pointer.

Declaration

public string Color { get; set; }

Property Value

Type
System.String

Description

Gets or sets the description for the pointer.

Declaration

public string Description { get; set; }

Property Value

Type
System.String

EnableDrag

Gets or sets a value indicating whether or not to enable the dragging movement of the pointer.

Declaration

public bool EnableDrag { get; set; }

Property Value

Type
System.Boolean

Height

Gets or sets the height of the pointer.

Declaration

public double Height { get; set; }

Property Value

Type
System.Double

ImageUrl

Gets or sets the URL path for the image in marker when the marker type is chosen as image.

Declaration

public string ImageUrl { get; set; }

Property Value

Type
System.String

MarkerType

Gets or sets the type of the marker for pointers in axis.

Declaration

public MarkerType MarkerType { get; set; }

Property Value

Type
MarkerType

Offset

Gets or sets the value to position the pointer from the axis.

Declaration

public string Offset { get; set; }

Property Value

Type
System.String

Opacity

Gets or sets the opacity of pointer in linear gauge.

Declaration

public double Opacity { get; set; }

Property Value

Type
System.Double

Placement

Gets or sets the place of the pointer.

Declaration

public Placement Placement { get; set; }

Property Value

Type
Placement

PointerValue

Gets or sets the value of the pointer in axis.

Declaration

public double PointerValue { get; set; }

Property Value

Type
System.Double

Position

Gets or sets the position of the pointer.

Declaration

public Position Position { get; set; }

Property Value

Type
Position

RoundedCornerRadius

Gets or sets the corner radius for pointer.

Declaration

public double RoundedCornerRadius { get; set; }

Property Value

Type
System.Double

Text

Gets or sets the text to be displayed as pointer in Linear Gauge.

Declaration

public string Text { get; set; }

Property Value

Type	Description
System.String	Accepts the string value to be displayed as pointer.

Remarks

This property is used to set the text that needs to be rendered as pointer.

Type

Gets or sets the type of pointer in axis.

Declaration

public Point Type { get; set; }

Property Value

Type
Point

Width

Gets or sets the width of the pointer.

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

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.