MapShape

Namespace: PP;

Inheritance hierarchy

Object

MapObject

MapShape

Description

The MapShape class implements map layer area.

Syntax

PP.initClass(PP.MapShape, PP.MapObject, "MapShape");

Properties

	Property name	Brief description
	Background	The Background property sets background for map area.
	BorderColor	The BorderColor property sets border color for map layer area.
	BoundingAngles	The BoundingAngles property determines a rectangular shape bounding map layer area.
	Effect	The Effect property sets effect for the map area.
	Hover	The Hover event occurs on hovering over a map area.
	IsHandCursor	The IsHandCursor property determines whether to show mouse pointer in the Link Selection mode on hovering over a map layer area.
	IsRendered	The IsRendered property determines whether the map layer area is rendered.
	IsStroked	The IsStroked property determines whether the draw mode of the map layer area with outline and without fill is enabled.
	Label	The Label property sets label for the map area.
	ParentLayer	The ParentLayer property sets parent layer for map area.
	StrokeWidth	The StrokeWidth property determines border width for map layer area.
	ToolTip	The ToolTip property determines a tooltip for a map layer area.
	Value	The Value property determines a value for map layer area.
	VerticesData	The VerticesData property determines data of map layer area nodes.
	Visual	The Visual property determines data mapping settings of the map layer area.
	ZValue	The ZValue property determines height of map layer area.

Method

	Method name	Brief description
	addVerticesData	The addVerticesData method adds a new node data for map layer area.
	animate	The animate method plays animation of map layer area.
	applyEffect3d	The applyEffect3d method applies effect for an area of 3D map layer.
	clear	The clear method clears map layer area.
	getBoundingBox	The getBoundingBox method returns the cube bounding 3D map layer area.
	getBoundsRec	The getBoundsRec method returns a rectangular shape bounding map layer area.
	getCenter	The getCenter method returns central point of map layer area.
	getCurrentBrush	The getCurrentBrush method returns the current object of map layer area fill.
	getIntersectionWithRay	The getIntersectionWithRay method returns distance between beam start and its intersection with map layer area.
	getPoint	The getPoint method returns a point that belongs to map layer area, by offsets from left and top map border.
	getRGBColor	The getRGBColor method returns color of map layer area as an array of shares of red, green and blue colors.
	getToolTipColor	The getToolTipColor method returns border color of the tooltip.
	getToolTipValues	The getToolTipValues method returns values of the data used to be shown in the tooltip of the map layer area.
	isInsideFrustum	The isInsideFrustum method determines whether current area of the 3D map layer enters in the selected rectangular area.
	isOpaque	The isOpaque method returns the attribute whether map layer area is not transparent.
	joinVerticesData	The joinVerticesData method joins added data of the nodes that belong to map layer area.
	normalize3d	The normalize3d method normalizes area of 3D map layer.
	rebuildLabel	The rebuildLabel method rerenders label for map layer area.
	rebuildToolTip	The rebuildToolTip method rerenders tooltip for map layer area.
	render3d	The render3d method renders a region of 3D map layer.
	renderBorder3d	The renderBorder3d method renders layer area border of the 3D map.
	setBorder	The setBorder method sets border for map layer area.
	toggleLabel	The toggleLabel method shows or hides label for map layer area after each time it is called.
	toggleLabel3d	The toggleLabel3d method shows and hides label for 3D map layer area after each time it is called.
	toggleTooltip	The toggleTooltip method hides and shows (toggles) tooltip for a map layer area after each method invocation.
	toggleToolTip3d	The toggleToolTip3d method hides and shows (toggles) tooltip for an area of 3D map layer after each method calling.
	updateLabelPosition	The updateLabelPosition method updates label position for map layer area.
	updateLabelPosition3d	The updateLabelPosition3d method updates label position for an area of 3D map layer.
	updateTooltipPosition	The updateTooltipPosition method updates tooltip position for map layer area.
	updateTooltipPosition3d	The updateTooltipPosition3d method updates tooltip position for an area of 3D map layer.
	updateTranscript	The updateTranscript method highlights territory info item for a specified map layer area.

Events

	Event name	Brief description
	Disposing	The Disposing event occurs after map layer area deletion.
	Hover	The Hover event occurs on hovering over a map area.
	MouseMove	The MouseMove event is fired when mouse pointer moves over map layer area.

Properties inherited from the MapObject class

	Property name	Brief description
	Chart	The Chart property specifies the map, to which an object belongs.
	DomNode	The DomNode property determines a DOM node that corresponds to a map object.
	IsVisible	The IsVisible property determines whether an object is displayed on a map.
	PluginData	The PluginData property determines data of map external component.

Methods inherited from the MapObject class

	Property name	Brief description
	draw	The draw method renders an object on a map.
	getIsSettingsCreated	The getIsSettingsCreated method returns whether a map object is created based on user settings.
	hide	The hide method hides an object on a map.
	scale	The scale method scales an object on a map.
	show	The show method shows an object on a map.

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:

Classes Used to Work with DHTML Map