Class LinearGauge
Inheritance
Namespace: Syncfusion.EJ2.LinearGauge
Assembly: Syncfusion.EJ2.dll
Syntax
public class LinearGauge : EJTagHelper
Constructors
LinearGauge()
Declaration
public LinearGauge()
Properties
AllowImageExport
Enables or disables the export to image functionality in linear gauge.
Declaration
public bool AllowImageExport { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowMargin
Enables or disables the ability of the gauge to be rendered to the complete width. The left, right, top and bottom spacing will not be considered in the gauge when this property is disabled.
Declaration
public bool AllowMargin { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is true |
AllowPdfExport
Enables or disables the export to PDF functionality in linear gauge.
Declaration
public bool AllowPdfExport { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AllowPrint
Enables or disables the print functionality in linear gauge.
Declaration
public bool AllowPrint { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
AnimationComplete
Triggers after completing the animation for pointer.
Declaration
public string AnimationComplete { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
AnimationDuration
Defines the duration of the loading animation in linear gauge, which animates the axis line, ticks, axis labels, ranges, pointers, and annotations. The value of this property will be in milliseconds.
Declaration
public double AnimationDuration { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
AnnotationRender
Triggers before each annotation gets rendered.
Declaration
public string AnnotationRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Annotations
Specifies the options for customizing the annotation of linear gauge.
Declaration
public List<LinearGaugeAnnotation> Annotations { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Syncfusion.EJ2.LinearGauge.LinearGaugeAnnotation> | The default value is null |
Axes
Specifies the options for customizing the axis in linear gauge.
Declaration
public List<LinearGaugeAxis> Axes { get; set; }
Property Value
Type | Description |
---|---|
System.Collections.Generic.List<Syncfusion.EJ2.LinearGauge.LinearGaugeAxis> | The default value is null |
AxisLabelRender
Triggers before each axis label gets rendered.
Declaration
public string AxisLabelRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Background
Specifies the background color of the gauge. This property accepts value in hex code, rgba string as a valid CSS color string.
Declaration
public string Background { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "transparent" |
BeforePrint
Triggers before the print functionality gets started.
Declaration
public string BeforePrint { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Border
Specifies the options for customizing the style properties of the border for linear gauge.
Declaration
public LinearGaugeBorder Border { get; set; }
Property Value
Type | Description |
---|---|
LinearGaugeBorder | The default value is null |
Container
Specifies the options for customizing the container in linear gauge.
Declaration
public LinearGaugeContainer Container { get; set; }
Property Value
Type | Description |
---|---|
LinearGaugeContainer | The default value is null |
Description
Sets and gets the information about gauge for assistive technology.
Declaration
public string Description { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DragEnd
Triggers after the pointer is dragged.
Declaration
public string DragEnd { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DragMove
Triggers while dragging the pointers.
Declaration
public string DragMove { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
DragStart
Triggers before the pointer is dragged.
Declaration
public string DragStart { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
EdgeLabelPlacement
Specifies the placement of the label in linear gauge.
Declaration
public LabelPlacement EdgeLabelPlacement { get; set; }
Property Value
Type | Description |
---|---|
LabelPlacement | The default value is LabelPlacement.None |
EnablePersistence
Enable or disable persisting component's state between page reloads.
Declaration
public bool EnablePersistence { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
EnableRtl
Enable or disable rendering component in right to left direction.
Declaration
public bool EnableRtl { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
Format
Specifies the format to apply for internationalization in linear gauge.
Declaration
public string Format { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
GaugeMouseDown
Triggers when performing the mouse down operation on gauge area.
Declaration
public string GaugeMouseDown { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
GaugeMouseLeave
Triggers when performing the mouse leave operation from the gauge area.
Declaration
public string GaugeMouseLeave { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
GaugeMouseMove
Triggers when performing the mouse move operation on gauge area.
Declaration
public string GaugeMouseMove { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
GaugeMouseUp
Triggers when performing mouse up operation on gauge area.
Declaration
public string GaugeMouseUp { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Height
Specifies the height of the linear gauge as a string in order to provide input as both like '100px' or '100%'. If specified as '100%, gauge will render to the full height of its parent element.
Declaration
public string Height { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
HtmlAttributes
Allows additional HTML attributes such as title, name, etc., and accepts n number of attributes in a key-value pair format.
Declaration
public object HtmlAttributes { get; set; }
Property Value
Type |
---|
System.Object |
Load
Triggers before the gauge gets rendered.
Declaration
public string Load { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Loaded
Triggers after the gauge gets rendered.
Declaration
public string Loaded { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Locale
Overrides the global culture and localization value for this component. Default global culture is 'en-US'.
Declaration
public string Locale { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is "" |
Margin
Specifies the options to customize the margins of the linear gauge.
Declaration
public LinearGaugeMargin Margin { get; set; }
Property Value
Type | Description |
---|---|
LinearGaugeMargin | The default value is null |
Orientation
Specifies the orientation of the rendering of the linear gauge.
Declaration
public Orientation Orientation { get; set; }
Property Value
Type | Description |
---|---|
Orientation | The default value is Orientation.Vertical |
RangePalettes
Specifies the color palette for axis ranges in linear gauge.
Declaration
public string[] RangePalettes { get; set; }
Property Value
Type | Description |
---|---|
System.String[] | The default value is null |
Resized
Triggers to notify the resize of the linear gauge when the window is resized.
Declaration
public string Resized { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
TabIndex
Specifies the tab index value for the linear gauge.
Declaration
public double TabIndex { get; set; }
Property Value
Type | Description |
---|---|
System.Double | The default value is 0 |
Theme
Sets and gets the theme styles supported for linear gauge. When the theme is set, the styles associated with the theme will be set in the gauge.
Declaration
public LinearGaugeTheme Theme { get; set; }
Property Value
Type | Description |
---|---|
LinearGaugeTheme | The default value is LinearGaugeTheme.Material |
Title
Specifies the title for linear gauge.
Declaration
public string Title { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
TitleStyle
Specifies the options for customizing the appearance of title for linear gauge.
Declaration
public LinearGaugeFont TitleStyle { get; set; }
Property Value
Type | Description |
---|---|
LinearGaugeFont | The default value is null |
Tooltip
Specifies the options for customizing the tooltip in linear gauge.
Declaration
public LinearGaugeTooltipSettings Tooltip { get; set; }
Property Value
Type | Description |
---|---|
LinearGaugeTooltipSettings | The default value is null |
TooltipRender
Triggers before the tooltip get rendered.
Declaration
public string TooltipRender { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
UseGroupingSeparator
Enables or disables a grouping separator should be used for a number.
Declaration
public bool UseGroupingSeparator { get; set; }
Property Value
Type | Description |
---|---|
System.Boolean | The default value is false |
ValueChange
Triggers while changing the value of the pointer by UI interaction.
Declaration
public string ValueChange { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |
Width
Specifies the width of the linear gauge as a string in order to provide input as both like '100px' or '100%'. If specified as '100%, gauge will render to the full width of its parent element.
Declaration
public string Width { get; set; }
Property Value
Type | Description |
---|---|
System.String | The default value is null |