MapBar

Namespace: PP;

Inheritance hierarchy

Object

MapVisualItem

MapBar

Description

The MapBar class is used to work with bar factor on the map.

Syntax

PP.initClass(PP.MapBar, PP.MapVisualItem, "PP.MapBar");

Constructor

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

Properties

	Property name	Brief description
	AllPeriod	The AllPeriod property determines whether the bar factor displays data for the whole time period.
	Axis	The Axis property determines data axis for bar view.
	BarDistance	The BarDistance property determines the distance between columns in the bar factor.
	BorderThickness	The BorderThickness property determines column border width in pixels.
	HideZeroHeight	The HideZeroHeight property determines whether columns with the zero value should be hidden.
	IsPercentage	The IsPercentage property determines whether the column value is a percentage.
	LeastHeightPart	The LeastHeightPart property sets height of the column that displays the least value.
	LeastWidthPart	The LeastWidthPart property determines the column width with minimum value.
	MaxBarsCount	The MaxBarsCount property determines maximum number of columns in bar factor.

Methods

	Method name	Brief description
	getAnimationType	The getAnimationType method returns animation playing mode of map bar factor.
	getToolTipColor	The getToolTipColor method returns border color of the tooltip.

Properties inherited form the MapVisualItem class

	Property name	Brief description
	Chart	The Chart property determines a map, to which this factor is added.
	IsVisible	The IsVisible property determines whether a factor is displayed on a map.
	Layer	The Layer property determines a map layer with regions, to which of one this factor is bound.
	SelectedIndex	The SelectedIndex property determines index of the time axis tick mark, which data is displayed by the map layer region factor.
	Shape	The Shape property determines a map layer region, to which this factor is bound.
	ToolTip	The ToolTip property determines a tooltip for a map layer region factor.
	Visual	The Visual property determines an object for comparison of the map layer region factor with its dimensions.

Methods inherited from the MapVisualItem class

	Method name	Brief description
	animate	The animate method plays animation of map layer region factor for the specified time and in the specified mode.
	checkEnclosure	The checkEnclosure method checks if a point with the specified coordinates corresponds to any of the bars of bar factor.
	checkIntersection	The checkIntersection method checks if the specified area intersects bar factor bars.
	clear	The clear method deletes the specified factor from the map layer.
	draw	The draw method renders the specified factor of map layer region.
	getBoundsRect	The getBoundsRect method returns a rectangular area that restricts the map layer region factor.
	getHeight	The getHeight method returns map layer region factor height.
	getLeft	The getLeft method returns the left offset of map layer region factor.
	getMainMappingId	The getMainMappingId method returns identifier of the main comparison of factor data for the specified tick mark of map time axis.
	getShapeId	The getShapeId method returns identifier of the map layer region, to which the factor is bound.
	getToolTipValues	The getToolTipValues method returns values of the data that is displayed in a tooltip of the map layer region factor.
	getTop	The getTop method returns the top offset of map layer region factor.
	getWidth	The getWidth method returns width of map layer region factor.
	hide	The hide method hides the map layer region factor.
	renderFrame	The renderFrame method renders the map layer region factor on the specified canvas.
	show	The show method shows the map layer region factor.
	toggleToolTip	The toggleToolTip method toggle displays and hides a tooltip for the map layer region factor.
	updatePosition	The updatePosition method updates position for the map layer region factor.

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 Map