Speedometer: component

Description

The Speedometer component is a visual component designed to graphically show a data set using a marked scale. An arrow that moves around the axis shows indicator values.

Comments

The Speedometer component is implemented by the Speedometer class.

To show a specific set of data this component uses:

• Radial scale.

• Indicator that moves around the circle within the specified limits.

 The user can select different colors for each data range, to show sector positions, for example, green sector color for a tolerable value, and red sector color for critical values.

 Minimum and maximum values (upper and lower limit) are defined on each chart.

 The user can define range colors to classify data. For example, the user can define a range named Best that consists of values between 60 and 100 and assign a unique color to this range to distinguish it from other ranges.

Example

 Various speedometer appearances are shown in the figure below:

The component can be shown as a fuel gauge unit:

The example of creating a speedometer is given on the Example of Creating a Fuel Gauge Unit page.

Speedometer displayed as a hand watch:

The example of creating is given on the Example of Creating Hand Watch page.

Example of Creating a Speedometer with a Wizard

Constructor

	Constructor name	Brief description
	Speedometer	The Speedometer constructor creates an instance of the Speedometer component.

Properties

	Property name	Brief description
	Background	The Background property determines speedometer background fill brush.
	BaseHeight	The BaseHeight property determines base height of speedometer.
	BaseWidth	The BaseWidth property determines base width of speedometer.
	Borders	The Borders property determines an array of elements that set speedometer rendering parameters.
	BorderStyle	The BorderStyle property dedtermines style of speedometer borders.
	Center	The Center property determines a marker for rendering speedometer center.
	CenterLabel	The CenterLabel property determines a central text label of speedometer.
	CenterPosition	The CenterPosition property determines coordinates of speedometer center.
	Markers	The Markers property determines an array of elements that set parameters of rendering speedometer markers.
	NumberFormat	The NumberFormat property determines speedometer data format.
	OuterRadius	The OuterRadius property determines speedometer radius.
	Padding	The Padding property determines component paddings.
	Scales	The Scales property determines an array of elements that set speedometer scale rendering parameters.
	TimeLineStep	The TimeLineStep property determines a current step of timeline.

Methods

	Method name	Brief description
	calcCenterPosition	The calcCenterPosition method calculates speedometer center coordinates.
	calcOuterRadius	The calcOuterRadius method calculates speedometer radius if this radius is not set relative to the container size.
	getArrowById	The getArrowById method returns arrow by its identifier.
	getChildren	The getChildren method returns an array of speedometer child elements.
	getInstance	The getInstance method returns an instance of the current speedometer.
	getOpacityEnabled	The getOpacityEnabled method returns whether speedometer uses transparency.
	getState	The getState method returns speedometer scale settings.
	getSVGNode	The getSVGNode method returns SVG element that is used to render a speedometer.
	paint	The paint method paint background and borders of SVG element according to the settings.
	redraw	The redraw method rerenders a speedometer.
	redrawScales	The redrawScales method rerenders all speedometer scales.
	refreshView	The refreshView method refreshes speedometer view based on the specified settings.
	setMasterSettings	The setMasterSettings method applies the specified speedometer settings.

Events

	Event name	Brief description
	Loaded	The Loaded event occurs after speedometer loading.
	Refreshed	The Refreshed event occurs after speedometer view is refreshed.

Properties inherited from GaugeObject class

	Property name	Brief description
	Background	The Background property determines a brush for element background fill.
	Border	The Border property determines a brush for element borders.
	BorderEnabled	The BorderEnabled property determines whether speedometer element has a border.
	BorderStyle	The BorderStyle property determines style of element borders.
	BorderWidth	The BorderWidth property determines element border width.
	MajorArrow	The MajorArrow property determines main arrow for speedometer scale.
	Name	The Name property sets name for speedometer scale pointer.
	OpacityEnabled	The OpacityEnabled property determines whether element transparency settings are used.
	Shadow	The Shadow property determines element shadow.

Methods inherited from GaugeObject class

	Method name	Brief description
	calcOffset	The calcOffset method calculates radial offset from the scale center.
	calcSize	The calcSize method calculates marker size.

Properties inherited from the class Control

	Property name	Brief description
	Anchors	The Anchors property determines position of the component placed within container.
	Animation	The Animation property sets animation parameters for component.
	Bottom	The Bottom property sets bottom offset on placing the component within the LayoutPanel.
	Content	The Content property sets the component contents.
	ContextMenu	The ContextMenu property sets the context menu for the component.
	Data	The Data property is used to store any custom data.
	DataContext	The DataContext property contains an object with data.
	Enabled	The Enabled property sets whether the component is enabled.
	Height	The Height property determines the component height.
	IsResizable	The IsResizable property determines whether the component can be resized.
	IsRTL	The lsRTL property sets right to left text direction.
	IsVisible	The IsVisible property determines whether the component is displayed.
	Left	The Left property sets left offset on placing the component within the GridPanel.
	Offset	The Offset property determines coordinates of root DOM node of a control.
	Opacity	The Opacity property determines component transparency.
	Parent	The Parent property determines a parent component of a control.
	ParentNode	The ParentNode property sets parent DOM node.
	ResourceKey	The ResourceKey property sets the resource key for the component.
	Right	The Right property sets right offset on placing the component within the LayoutPanel.
	Rotate	The Rotate property sets component rotation angle.
	ShowToolTip	The ShowToolTip property determines whether the tooltip of the component can be displayed.
	Style	The Style property sets component style.
	TabIndex	The TabIndex property sets the order of the control element passing inside the container.
	Tag	The Tag property sets JSON object associated with the component.
	ToolTip	The ToolTip property determines text of component tooltip.
	Top	The Top property sets top offset on placing the component within the GridPanel.
	Value	The Value property sets the value to the component.
	Width	The Width property sets the component width.

Methods inherited from the class Control

	Method name	Brief description
	addClass	The addClass method adds a CSS class to the component.
	addEvent	The addEvent method adds an event handler to a DOM node.
	addEventHandler	The addEventHandler method adds an event handler to a DOM node.
	addEvents	The addEvents method adds an array of event handlers to a DOM node.
	addStateClass	The addStateClass method adds a CSS class to the component and removes the previous CSS class.
	addStyleBySelector	The addStyleBySelector method creates a block that contains a style with the specified CSS selector.
	addToNode	The addToNode method adds a component to the specified node.
	bindEvents	The bindEvents method subscribes an element to all available events.
	clearStylesCache	The clearStylesCache method clears cache of component styles.
	getAnchorFlags	The getAnchorFlags method returns JSON object that contains settings of the current component's position.
	getClass	The getClass method returns the current CSS classes of the component.
	getCssStyle	The getCssStyle method returns style for the specified node.
	getDomNode	The getDomNode method returns main DOM node of the component.
	getFocused	The getFocused method determines whether the component is focused.
	getFunctionByName	The getFunctionByName method returns function by name.
	getIsBinded	The getIsBinded method returns whether an element is subscribed to all DOM node events.
	hasClass	The hasClass method determines whether the specified CSS class is set for root DOM node of the control.
	hide	The hide method hides a control.
	hideToolTip	The hideToolTip method clears tooltip timeout and hides the tooltip if it is displayed.
	isResingNow	The isResingNow method determines whether the component is being resized.
	refreshBindingProperty	The refreshBindingProperty method refreshes the bound property by name.
	refreshItemsStyle	The refreshItemsStyle method refreshes CSS styles of child elements.
	refreshStyle	The refreshStyle method refreshes element CSS styles.
	removeClass	The removeClass method removes CSS class from the component.
	removeEvent	The removeEvent method removes event handler from DOM node.
	removeEventHandler	The removeEventHandler method removes event handler from DOM node.
	removeFromDOM	The removeFromDOM method removes node from the DOM structure.
	removeStateClasses	The removeStateClasses method removes CSS classes of the component.
	setDraggable	The setDraggable method determines whether it is possible to drag component on the HTML page.
	setFocus	The setFocus method sets the component focus.
	setIsHovered	The setIsHovered method displays the component as on hover.
	setIsPressed	The setIsPressed method displays the component as if clicked upon.
	setOpacityIE8	The setOpacityIE8 method sets component transparency value in Internet Explorer 8.
	setSize	The setSize method establishes the sizes of the component.
	show	The show method displays a control.
	unBindEvents	The unBindEvents method unsubscribes an element from all standard events.
	updatePosition	The updatePosition method updates size and position when absolute positioning based on the current parameters is used.
	updateSize	The updateSize method updates the component size on changing the size of the container that contains the component.

Events inherited from the class Control

	Event name	Brief description
	Drag	The Drag event occurs on clicking and holding the left mouse button.
	DragEnd	The DragEnd event occurs when dragging the component finishes.
	DragStart	The DragStart event occurs when dragging the component starts.
	OnContextMenu	The OnContextMenu event occurs on calling context menu of the component.
	SizeChanged	The SizeChanged event occurs after the component is resized.
	SizeChanging	The SizeChanging event occurs during component resize.

Properties inherited from the class Object

	Property name	Brief description
	Data	The Data property associates a random object with this component.
	Id	The Id property sets component identifier.
	Settings	The Settings property sets the component parameters.

Methods inherited from the class Object

	Method name	Brief description
	clone	The clone method creates a copy of object. It is not implemented in PP.Ui.Control.
	dispose	The dispose method deletes the component.
	getTypeName	The getTypeName method returns the name of the object type without the namespace, to which it belongs.

See also:

DHTML Components