Search results

LinearGaugeComponent

Represents react Linear Gauge Component

<LinearGaugeComponent></LinearGaugeComponent>

Properties

allowImageExport

boolean

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

Defaults to false

allowPdfExport

boolean

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

Defaults to false

allowPrint

boolean

Enables or disables the print functionality in linear gauge.

Defaults to false

annotations

AnnotationModel[]

Specifies the options for customizing the annotation of linear gauge.

annotationsModule

Annotations

Specifies the module that is used to place any text or images as annotation into the 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.

Defaults to ‘transparent’

border

BorderModel

Specifies the options for customizing the color and width of the border for linear gauge.

container

ContainerModel

Specifies the options for customizing the container in linear gauge.

description

string

Specifies the description for linear gauge.

Defaults to null

enablePersistence

boolean

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

Defaults to false

enableRtl

boolean

Enable or disable rendering component in right to left direction.

Defaults to false

format

string

Specifies the format to apply for internationalization in linear gauge.

Defaults to null

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.

Defaults to null

locale

string

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

Defaults to

margin

MarginModel

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

orientation

string

Specifies the orientation of the rendering of the linear gauge.

Defaults to Vertical

rangePalettes

string[]

Specifies the color palette for axis ranges in linear gauge.

Defaults to []

tabIndex

number

Specifies the tab index value for the linear gauge.

Defaults to 1

theme

string

Specifies the theme supported for the linear gauge.

Defaults to Material

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.

tooltipModule

GaugeTooltip

Specifies the module that is used to display the pointer value in tooltip.

useGroupingSeparator

boolean

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

Defaults to false

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.

Defaults to null

Methods

destroy

To destroy the gauge element from the DOM.

Returns void

export

This method handles the export functionality for linear gauge.

Returns Promise

getModuleName

Get component name

Returns string

print

This method handles the print functionality for linear gauge.

Parameter Type Description
id (optional) string[] | string | Element Specifies the element to print the linear gauge.

Returns void

setAnnotationValue

This method is used to set the annotation value in the linear gauge.

Returns void

setPointerValue

This method is used to set the pointer value in the linear gauge.

Parameter Type Description
axisIndex number Specifies the index of the axis.
pointerIndex number Specifies the index of the pointer.
value number Specifies the pointer value.

Returns void

Events

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 prints 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 after window resize.

tooltipRender

EmitType<ITooltipRenderEventArgs>

Triggers before the tooltip get rendered.

valueChange

EmitType<IValueChangeEventArgs>

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