MapArrowBase

Namespace: PP.Ui;

Inheritance hierarchy

Object

MapObject

MapArrowBase

Description

The MapArrowBase class is an abstract class that contains basic properties of system arrows.

Comments

Three types of system arrows are available; they are implemented with the classes MapFiguredArrow (shaped arrow), MapFilledArrow (filled arrow), MapSimpleArrow (simple arrow).

Syntax

PP.initClass(PP.Ui.MapArrowBase, PP.Ui.MapObject, "MapArrowBase");

Properties

	Property name	Brief description
	Angle	The Angle property sets arrow tilt angle.
	AngleLimit	The AngleLimit property determines the maximum angle between arrow cap and curve tangent in radians.
	Border	The Border property determines map arrow border.
	Color	The Color property sets arrow color in HTML format.
	EndPoint	The EndPoint property sets arrow end point.
	EndShape	The EndShape property sets map region where an arrow ends.
	IsRelativeWidth	The IsRelativeWidth property determines whether arrow pointer size and scale values are expressed in parts from its length.
	Label	The Label property determines map arrow label.
	PointerLength	The PointerLength property sets arrow pointer height.
	PointerWidth	The PointerWidth property sets arrow pointer width.
	StartPoint	The StartPoint property sets start point for an arrow.
	StartShape	The StartShape property sets the map region where an arrow starts.
	Step3d	The Step3d property determines how detailed arrows look on a 3D map.
	TextOrientation	The TextOrientation property sets orientation for arrow label text.
	ToolTip	The ToolTip property determines a tooltip for a map arrow.
	UseAnimation	The UseAnimation property determines whether animation is used for a map arrow.
	Visual	The Visual property determines an object that is used to map arrow data on a map with object properties.

Method

	Method name	Brief description
	animate	The animate method plays animation of map arrow.
	clear	The clear method removes the arrow from the map layer.
	getIntersectionWithRay	The getIntersectionWithRay method returns distance between beam start and its intersection with the arrow on a 3D map.
	getToolTipColor	The getToolTipColor method returns tooltip border color for map arrows.
	getToolTipValues	The getToolTipValues method returns data values displayed in the tooltip for a map arrow.
	render3d	The render3d method renders an arrow on a 3D map.
	setBorderSettings	The setBorderSettings method determines settings for arrow border on a map.
	setFont	The setFont property sets arrow label font.
	setTextBackground	The setTextBackground property sets arrow label fill.
	toggleToolTip	The toggleToolTip method toggle displays and hides a tooltip for a map arrow.

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