ScaleBase

Namespace: PP;

Inheritance hierarchy

Object

ScaleBase

Description

The ScaleBase class is a base implementation of color and numeric scale.

Syntax

PP.initClass(PP.ScaleBase, PP.Object, "PP.ScaleBase");

Properties

	Property name	Brief description
	ActiveItems	The ActiveItems property sets the collection of active scale elements.
	AutoCalculable	The AutoCalculable property determines whether a scale is calculated automatically.
	EnableEquality	The EnableEquality property determines whether equalities are taken into account when plotting a scale, or a scale is based only on intervals.
	First	The First property sets the first scale element.
	InactiveItem	The InactiveItem property determines color of the scale elements that is not included into the ScaleBase.ActiveItems collection.
	IntervalsCount	The IntervalsCount property sets the number of scale intervals.
	Item	The Item property sets value for a scale element by element index.
	Items	The Items property sets the collection of scale elements.
	Last	The Last property sets the last scale element.
	LogarithmBase	The LogarithmBase property sets logarithm base to estimate scale intervals.
	MaxValue	The MaxValue property sets maximum possible scale value.
	MinValue	The MinValue property sets minimum possible scale value.
	Mode	The Mode property sets scale calculation mode.
	NoData	The NoData property sets a scale element that corresponds to data absence.
	RecalcValues	The RecalcValues property determines whether to recalculate the collection of scale values.
	ResultMode	The ResultMode property determines types of returned values of visualizer scale.
	RoundBias	The RoundBias property determines maximum available values of difference between scale source value and rounded scale value.
	Value	The Value property sets value of scale interval border.
	Values	The Values property sets the collection of scale interval borders' values.

Methods

	Method name	Brief description
	addItem	The addItem method adds an element to a scale.
	addValue	The addValue method adds a value of scale interval border.
	between	The between method returns scale minor tick mark.
	clearItems	The clearItems method clears elements collection of a scale.
	clearValues	The clearValues method clears the collection of scale interval borders.
	constructScaleElements	The constructScaleElements method creates the collection of scale intervals based on transmitted data.
	equal	The equal method returns scale element for the value that equals to that corresponding to the specified index.
	getCount	The getCount method returns the number of scale intervals.
	getItemsCount	The getItemsCount method returns the number of scale elements.
	getItemValue	The getItemValue method returns scale element that corresponds to the specified data value.
	getValuesPair	The getValuesPair method returns interval border by its index.
	greater	The greater method returns scale element for the value greater than that corresponding to the specified index.
	less	The less method returns scale element for the value less than that of scale interval borders with the specified index.
	removeItemAt	The removeItemAt method removes scale element by the specified index.
	removeValueAt	The removeItemAt method removes value of scale interval borders by the specified index.

Events

	Event name	Brief description
	ItemsChanged	The ItemsChanged event occurs on changing scale settings from the wizard.
	ItemsChanging	The ItemsChanging event occurs on setting of scale elements collection or on setting of scale element corresponding to missing data.

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:

PP