GaugeScale

Namespace: PP.Ui;

Inheritance hierarchy

Object

Control

GaugeObject

   GaugeScale

Description

The GaugeScale class implements definition of speedometer scale.

Syntax

PP.initClass(PP.Ui.GaugeScale, PP.Ui.GaugeObject, "GaugeScale");

Constructor

	Constructor name	Brief description
	GaugeScale	The GaugeScale constructor creates an instance of the GaugeScale class.

Properties

	Property name	Brief description
	Arrows	The Arrows property sets an array of scale pointers.
	Center	The Center property determines a marker that is used to render scale center.
	CenterPosition	The CenterPosition property determines coordinates of scale center; if they are not set, speedometer center coordinates are used.
	Direction	The Direction property determines direction of rendering speedometer scale.
	EnablePassedStyles	The EnablePassedStyles property determines whether to use style for tick marks and text labels of speedometer scale, passed with the main pointer of this scale.
	IsAbsoluteLabelOffset	The IsAbsoluteLabelOffset property determines units that are used to specify offset for text labels in a scale.
	IsAbsoluteSectorOffset	The IsAbsoluteSectorOffset property determines units that are used to specify offset of scale sectors.
	IsAbsoluteTickOffset	The IsAbsoluteTickOffset property determines units that are used to specify scale ticks offset.
	LabelFont	The LabelFont property sets label font.
	LabelOffset	The LabelOffset property determines offset for speedometer text labels.
	Labels	The Labels property determines major tick mark labels.
	Length	The Length property determines scale angle length.
	MajorTick	The MajorTick property determines descriptor of major tick mark type.
	MaskLabel	The MaskLabel property determines format of value output in the label for the values, for which it is not set.
	MaxValue	The MaxValue property determines the maximum value on a scale.
	MinorTick	The MinorTick property determines descriptor of minor tick mark type.
	MinStepSize	The MinStepSize property determines minimum available distance between minor tick marks in pixels.
	MinValue	The MinValue property determines the minimum value on a scale.
	OuterRadius	The OuterRadius property determines scale radius; if is it not set, the speedometer radius is used as a scale radius.
	PassedLabelFont	The PassedLabelFont property determines font of speedometer scale text labels passed by the main pointer.
	PassedMajorTick	The PassedMajorTick property determines settings for speedometer scale major tick marks passed by the main pointer.
	PassedMinorTick	The PassedMinorTick property determines settings for speedometer scale minor tick marks passed by the main pointer.
	Rotate	The Rotate property determines scale rotation angle.
	RotateLabels	The RotateLabels property determines label rotation state.
	StartAngle	The StartAngle property determines the angle of positioning the minimum value on a scale.
	Sectors	The Sectors property determines an array of scale sectors.
	Size	The Size property determines scale width.
	Step	The Step property determines the step for positioning minor tick marks.
	Trends	The Trends property determines an array of scale pointers.
	Values	The Values property determines major tick mark values.

Methods

	Method name	Brief description
	addArrow	The addArrow method adds a new pointer or array of pointers to a speedometer scale.
	addSector	The addSector method adds new sectors to the array of scale sectors.
	calcCenterPosition	The calcCenterPosition method calculates coordinates of the point at the scale center.
	calcOuterRadius	The calcOuterRadius method calculates speedometer radius if this radius is set respective to the container size.
	getArrowByName	The getArrowByName method returns array of speedometer scale pointers with the specified name.
	getArrowValue	The getArrowValue method returns pointer value.
	getLabelset	The getLabelset method returns array of scale text nodes.
	getMajorTicks	The getMajorTicks method returns array of scale major tick marks.
	getMinorTicks	The getMinorTicks method returns array of scale minor tick marks.
	getRenderInfo	The getRenderInfo method returns data concerning scale size and position.
	getSectorByName	The getSectorByName method returns array of sectors with the specified name.
	getValueAngle	The getValueAngle method calculates angle position on the scale for the passed value.
	redrawLabels	The redrawLabels method rerenders text labels of speedometer scale.
	refreshTicks	The refreshTicks method refreshes speedometer scale markers.
	setArrow	The setArrow method replaces one of the existing pointers of speedometer scale.
	setLabelsColor	The setLabelsColor method sets color of text labels in speedometer scale.
	setSector	The setSector method sets a scale sector.

Properties inherited from the 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
	getChildren	The getChildren method returns an array of child elements of GaugeObject.
	paint	The paint method colors SVG element background and border according to settings determined in Background and Border.
	redraw	The redraw method sets attributes of SVG element according to the properties.
	render	The render method creates SVG elements and places them in the parent object.
	rerender	The rerender method removes an object and rerenders it.

Properties inherited from the class Control

NOTE. By default the Offset property of the GaugeScale class is set to 10.

	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:

Speedometer