Class CircularGaugePointerBuilder
Inheritance
System.Object
Syncfusion.EJ2.ControlBuilder
CircularGaugePointerBuilder
Assembly: Syncfusion.EJ2.dll
Syntax
public class CircularGaugePointerBuilder : ControlBuilder
Constructors
CircularGaugePointerBuilder()
Declaration
public CircularGaugePointerBuilder()
CircularGaugePointerBuilder(List<CircularGaugePointer>)
Declaration
public CircularGaugePointerBuilder(List<CircularGaugePointer> collection)
Parameters
Methods
Add()
Declaration
Animation(CircularGaugeAnimation)
Sets and gets the options for the animation of the pointers that propagate while rendering the axis and updating the pointer value in the circular gauge.
Declaration
public CircularGaugePointerBuilder Animation(CircularGaugeAnimation animation)
Parameters
Returns
Animation(Action<CircularGaugeAnimationBuilder>)
Declaration
public CircularGaugePointerBuilder Animation(Action<CircularGaugeAnimationBuilder> animation)
Parameters
Returns
Border(CircularGaugeBorder)
Sets and gets the options to customize the style properties of the border for the needle pointer in an axis.
Declaration
public CircularGaugePointerBuilder Border(CircularGaugeBorder border)
Parameters
Returns
Border(Action<CircularGaugeBorderBuilder>)
Declaration
public CircularGaugePointerBuilder Border(Action<CircularGaugeBorderBuilder> border)
Parameters
Returns
Cap(CircularGaugeCap)
Sets and gets the options to customize the cap element of the needle pointer in an axis.
Declaration
public CircularGaugePointerBuilder Cap(CircularGaugeCap cap)
Parameters
Returns
Cap(Action<CircularGaugeCapBuilder>)
Declaration
public CircularGaugePointerBuilder Cap(Action<CircularGaugeCapBuilder> cap)
Parameters
Returns
Color(String)
Sets and gets the color of the pointer in an axis.
Declaration
public CircularGaugePointerBuilder Color(string color)
Parameters
| Type |
Name |
Description |
| System.String |
color |
|
Returns
Description(String)
Sets and gets the information about pointer for assistive technology.
Declaration
public CircularGaugePointerBuilder Description(string description)
Parameters
| Type |
Name |
Description |
| System.String |
description |
|
Returns
EnableDrag(Boolean)
Enables and disables drag movement of the pointer in the circular gauge.
Declaration
public CircularGaugePointerBuilder EnableDrag(bool enableDrag)
Parameters
| Type |
Name |
Description |
| System.Boolean |
enableDrag |
|
Returns
ImageUrl(String)
Sets and gets the URL for the image that is to be displayed as pointer.
It requires marker shape value to be Image.
Declaration
public CircularGaugePointerBuilder ImageUrl(string imageUrl)
Parameters
| Type |
Name |
Description |
| System.String |
imageUrl |
|
Returns
LinearGradient(CircularGaugeLinearGradient)
Sets and gets the properties to render a linear gradient for the pointer.
If both linear and radial gradient is set, then the linear gradient will be rendered in the pointer.
Declaration
public CircularGaugePointerBuilder LinearGradient(CircularGaugeLinearGradient linearGradient)
Parameters
Returns
LinearGradient(Action<CircularGaugeLinearGradientBuilder>)
Declaration
public CircularGaugePointerBuilder LinearGradient(Action<CircularGaugeLinearGradientBuilder> linearGradient)
Parameters
Returns
MarkerHeight(Double)
Sets and gets the height of the marker pointer in an axis.
Declaration
public CircularGaugePointerBuilder MarkerHeight(double markerHeight)
Parameters
| Type |
Name |
Description |
| System.Double |
markerHeight |
|
Returns
MarkerShape(GaugeShape)
Sets and gets the shape of the marker pointer in an axis.
Declaration
public CircularGaugePointerBuilder MarkerShape(GaugeShape markerShape)
Parameters
Returns
MarkerWidth(Double)
Sets and gets the width of the marker pointer in an axis.
Declaration
public CircularGaugePointerBuilder MarkerWidth(double markerWidth)
Parameters
| Type |
Name |
Description |
| System.Double |
markerWidth |
|
Returns
NeedleEndWidth(Double)
Sets or gets the width at the ending edge of the needle pointer in an axis.
Declaration
public CircularGaugePointerBuilder NeedleEndWidth(double needleEndWidth)
Parameters
| Type |
Name |
Description |
| System.Double |
needleEndWidth |
|
Returns
NeedleStartWidth(Double)
Sets or gets the width at the starting edge of the needle pointer in an axis.
Declaration
public CircularGaugePointerBuilder NeedleStartWidth(double needleStartWidth)
Parameters
| Type |
Name |
Description |
| System.Double |
needleStartWidth |
|
Returns
NeedleTail(CircularGaugeNeedleTail)
Sets and gets the options to customize the tail element of the needle pointer in an axis.
Declaration
public CircularGaugePointerBuilder NeedleTail(CircularGaugeNeedleTail needleTail)
Parameters
Returns
NeedleTail(Action<CircularGaugeNeedleTailBuilder>)
Declaration
public CircularGaugePointerBuilder NeedleTail(Action<CircularGaugeNeedleTailBuilder> needleTail)
Parameters
Returns
Offset(Double)
Sets and gets the offset value of pointer from scale.
Declaration
public CircularGaugePointerBuilder Offset(double offset)
Parameters
| Type |
Name |
Description |
| System.Double |
offset |
|
Returns
Offset(String)
Sets and gets the offset value of pointer from scale.
Declaration
public CircularGaugePointerBuilder Offset(string offset)
Parameters
| Type |
Name |
Description |
| System.String |
offset |
|
Returns
PointerWidth(Double)
Sets and gets the width of the pointer in axis.
Declaration
public CircularGaugePointerBuilder PointerWidth(double pointerWidth)
Parameters
| Type |
Name |
Description |
| System.Double |
pointerWidth |
|
Returns
Position(PointerRangePosition)
Sets and gets the position of pointer for an axis.
Declaration
public CircularGaugePointerBuilder Position(PointerRangePosition position)
Parameters
Returns
RadialGradient(CircularGaugeRadialGradient)
Sets and gets the properties to render a radial gradient for pointer.
Declaration
public CircularGaugePointerBuilder RadialGradient(CircularGaugeRadialGradient radialGradient)
Parameters
Returns
RadialGradient(Action<CircularGaugeRadialGradientBuilder>)
Declaration
public CircularGaugePointerBuilder RadialGradient(Action<CircularGaugeRadialGradientBuilder> radialGradient)
Parameters
Returns
Radius(String)
Sets and gets the radius of pointer for marker and range type pointer and fix length of pointer for needle pointer.
Declaration
public CircularGaugePointerBuilder Radius(string radius)
Parameters
| Type |
Name |
Description |
| System.String |
radius |
|
Returns
RoundedCornerRadius(Double)
Sets and gets the corner radius for pointer in axis.
Declaration
public CircularGaugePointerBuilder RoundedCornerRadius(double roundedCornerRadius)
Parameters
| Type |
Name |
Description |
| System.Double |
roundedCornerRadius |
|
Returns
Text(String)
Sets and gets the text for the marker pointer. To render the text in the marker pointer, the marker shape must be set as Text.
Declaration
public CircularGaugePointerBuilder Text(string text)
Parameters
| Type |
Name |
Description |
| System.String |
text |
|
Returns
TextStyle(Object)
Sets and gets the style of text in marker pointer of an axis.
Declaration
public CircularGaugePointerBuilder TextStyle(object textStyle)
Parameters
| Type |
Name |
Description |
| System.Object |
textStyle |
|
Returns
Type(PointerType)
Sets and gets the type of pointer for an axis in Circular gauge.
Declaration
public CircularGaugePointerBuilder Type(PointerType type)
Parameters
Returns
Value(Double)
Sets and gets the value of the pointer in circular gauge.
Declaration
public CircularGaugePointerBuilder Value(double value)
Parameters
| Type |
Name |
Description |
| System.Double |
value |
|
Returns
