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	Description
System.Double	A System.Double specifying the animation duration in milliseconds.

Remarks

Used to control the time it takes for the pointer to transition during changes.

ChildContent

Gets or sets the content of the UI element.

Declaration

public RenderFragment ChildContent { get; set; }

Property Value

Type	Description
Microsoft.AspNetCore.Components.RenderFragment	A Microsoft.AspNetCore.Components.RenderFragment for defining custom content within the pointer.

Remarks

Customize the appearance of the pointer in the linear gauge by setting this property.

Color

Gets or sets the color of the pointer.

Declaration

public string Color { get; set; }

Property Value

Type	Description
System.String	A System.String representing the CSS color value.

Remarks

This property sets the color of the pointer to visually distinguish it.

Description

Gets or sets the description for the pointer.

Declaration

public string Description { get; set; }

Property Value

Type	Description
System.String	A System.String containing the description text for accessibility.

Remarks

Descriptions can improve accessibility by providing context to screen readers.

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	Description
System.Boolean	A System.Boolean to enable or disable dragging functionality.

Remarks

When enabled, users can drag the pointer to adjust its value manually.

Height

Gets or sets the height of the pointer.

Declaration

public double Height { get; set; }

Property Value

Type	Description
System.Double	A System.Double representing the height in pixels. Default is 20.

Remarks

Adjusting the height configures the visual size of the pointer in the gauge.

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	Description
System.String	A System.String representing the URL of the image.

Remarks

Set this property with an image URL to use an image as the marker instead of a standard shape.

MarkerType

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

Declaration

public MarkerType MarkerType { get; set; }

Property Value

Type	Description
MarkerType	A MarkerType specifying the shape of the marker. Default is InvertedTriangle.

Remarks

Choose from different marker shapes such as Circle, Diamond, etc., to diversify pointer appearance.

Offset

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

Declaration

public string Offset { get; set; }

Property Value

Type	Description
System.String	A System.String that specifies the offset from the axis.

Remarks

This offset can be used to move the pointer to a specific position relative to the axis.

Opacity

Gets or sets the opacity of pointer in linear gauge.

Declaration

public double Opacity { get; set; }

Property Value

Type	Description
System.Double	A System.Double between 0 (transparent) and 1 (opaque). Default is 1.

Remarks

Change the opacity to make the pointer more or less visible based on requirements.

Placement

Gets or sets the place of the pointer.

Declaration

public Placement Placement { get; set; }

Property Value

Type	Description
Placement	A Placement to specify where the pointer is aligned. Default is Far.

Remarks

Placement settings can adjust where the pointer is rendered in relation to the axis.

PointerValue

Gets or sets the value of the pointer in axis.

Declaration

public double PointerValue { get; set; }

Property Value

Type	Description
System.Double	A System.Double representing the value the pointer points to.

Remarks

This value determines the pointer's position on the axis, corresponding to certain units being measured.

Position

Gets or sets the position of the pointer.

Declaration

public Position Position { get; set; }

Property Value

Type	Description
Position	A Position that defines how the pointer is positioned. Default is Auto.

Remarks

Position controls the logical alignment of the pointer on its axis.

RoundedCornerRadius

Gets or sets the corner radius for pointer.

Declaration

public double RoundedCornerRadius { get; set; }

Property Value

Type	Description
System.Double	A System.Double indicating the radius for rounded corners. Default is 10.

Remarks

Use rounded corners to give pointers a softer appearance.

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	A System.String used to display textual information in place of a typical pointer.

Remarks

This property allows the depiction of information directly on the pointer.

Type

Gets or sets the type of pointer in axis.

Declaration

public Point Type { get; set; }

Property Value

Type	Description
Point	A Point type that determines the pointer's representation.

Remarks

The Point type can differ based on functionality requirements, allowing text, images, or other representations.

Width

Gets or sets the width of the pointer.

Declaration

public double Width { get; set; }

Property Value

Type	Description
System.Double	A System.Double representing the width in pixels. Default is 20.

Remarks

Modifying width adjusts the horizontal measurement of pointers for visual customization.

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.