LinearGaugeModel

23 Sep 20254 minutes to read

Interface for a class LinearGauge

Properties

animationComplete EmitType<IAnimationCompleteEventArgs>

Triggers after completing the animation for pointer.

annotationRender EmitType<IAnnotationRenderEventArgs>

Triggers before each annotation gets rendered.

axisLabelRender EmitType<IAxisLabelRenderEventArgs>

Triggers before each axis label gets rendered.

beforePrint EmitType<IPrintEventArgs>

Triggers before the print functionality gets started.

dragEnd EmitType<IPointerDragEventArgs>

Triggers after the pointer is dragged.

dragMove EmitType<IPointerDragEventArgs>

Triggers while dragging the pointers.

dragStart EmitType<IPointerDragEventArgs>

Triggers before the pointer is dragged.

gaugeMouseDown EmitType<IMouseEventArgs>

Triggers when performing the mouse down operation on gauge area.

gaugeMouseLeave EmitType<IMouseEventArgs>

Triggers when performing the mouse leave operation from the gauge area.

gaugeMouseMove EmitType<IMouseEventArgs>

Triggers when performing the mouse move operation on gauge area.

gaugeMouseUp EmitType<IMouseEventArgs>

Triggers when performing mouse up operation on gauge area.

load EmitType<ILoadEventArgs>

Triggers before the gauge gets rendered.

loaded EmitType<ILoadedEventArgs>

Triggers after the gauge gets rendered.

resized EmitType<IResizeEventArgs>

Triggers to notify the resize of the linear gauge when the window is resized.

tooltipRender EmitType<ITooltipRenderEventArgs>

Triggers before the tooltip get rendered.

valueChange EmitType<IValueChangeEventArgs>

Triggers while changing the value of the pointer by UI interaction.

allowImageExport boolean

Enables or disables the export to image functionality in linear gauge.

allowMargin boolean

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.

allowPdfExport boolean

Enables or disables the export to PDF functionality in linear gauge.

allowPrint boolean

Enables or disables the print functionality in linear gauge.

animationDuration number

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.

annotations AnnotationModel[]

Specifies the options for customizing the annotation of linear gauge.

axes AxisModel[]

Specifies the options for customizing the axis in linear gauge.

background string

Specifies the background color of the gauge. This property accepts value in hex code, rgba string as a valid CSS color string.

border BorderModel

Specifies the options for customizing the style properties of the border for linear gauge.

container ContainerModel

Specifies the options for customizing the container in linear gauge.

description string

Sets and gets the information about gauge for assistive technology.

edgeLabelPlacement LabelPlacement

Specifies the placement of the label in linear gauge.

enablePersistence boolean

Enable or disable persisting component’s state between page reloads.

enableRtl boolean

Enable or disable rendering component in right to left direction.

format string

Specifies the format to apply for internationalization in linear gauge.

height string

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.

locale string

Overrides the global culture and localization value for this component. Default global culture is ‘en-US’.

margin MarginModel

Specifies the options to customize the margins of the linear gauge.

orientation Orientation

Specifies the orientation of the rendering of the linear gauge.

rangePalettes string[]

Specifies the color palette for axis ranges in linear gauge.

tabIndex number

Specifies the tab index value for the linear gauge.

theme LinearGaugeTheme

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.

title string

Specifies the title for linear gauge.

titleStyle FontModel

Specifies the options for customizing the appearance of title for linear gauge.

tooltip TooltipSettingsModel

Specifies the options for customizing the tooltip in linear gauge.

useGroupingSeparator boolean

Enables or disables a grouping separator should be used for a number.

width string

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.