MapLayer

Namespace: PP;

Inheritance hierarchy

Object

MapObject

MapLayer

Description

The MapLayer class implements a map layer.

Syntax

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

Properties

  Property name Brief description
Bars The Bars property determines bar factors for the map layer.
Bubbles The Bubbles property determines bubble factors for the map layer.
Effect The Effect property sets an effect for the layer.
Label The Label property sets a label for the layer.
Milestones The Milestones property determines milestones with image on the map.
ParentLayer The ParentLayer property determines parent map layer.
Pies The Pies property determines pie factors for the map layer.
PlaceVisualsOneByOne The PlaceVisualsOneByOne property determines whether map factors are in line.
Shapes The Shapes property determines map layer areas.
ToolTip The ToolTip property determines a tooltip for a map layer.
Visual The Visual property determines an object for visualizer data mapping with visualizer dimensions.
VisualsOffset The VisualsOffset property determines the distance between map factors placed in line.

Methods

  Method name Brief description
addShape The addShape method adds a map area in the current layer.
addSubLayer The addSubLayer method adds a child layer.
animate The animate method plays animation for the map layer.
clear The clear method clears a map layer.
clearLayers The clearLayers method clears child layers of a map.
clearShapes The clearShapes method clears the list of map areas in the current layer.
clearVisualItems The clearVisualItems method deletes factors from the map layer.
getIsLayersVisible The getIsLayersVisible method returns the attribute whether map layer is shown.
getMapBarCollection The getMapBarCollection method returns an array of the map bar factors.
getMapBubbleCollection The getMapBubbleCollection method returns an array of map bubble factors.
getMapPieCollection The getMapPieCollection method returns an array of map pie factors.
getShape The getShape method returns map layer area by its identifier.
getSubLayer The getSubLayer method returns map child layer by its identifier.
getSubLayers The getSubLayers method returns all the first level child layers.
rebuildLabels The rebuildLabels method rerenders labels for areas of the current map layer and child layers.
rebuildToolTips The rebuildToolTip method rerenders tooltips for areas of the current map layer and child layers.
removeShape The removeShape method deletes the map layer area.
removeSubLayer The removeSubLayer method deletes map child layer.
renderFrame The renderFrame method renders a map layer.
setSize The setSize method sets sizes and view scale of the map layer.
updateLabelPositions The updateLabelPositions method updates positions of labels for areas of the current map layer and its children.
updateLabelPositions3d The updateLabelPosition3d method updates positions of labels for regions of the current map layer and its child layers on 3D map.
updateMilestones The updateMilestones method updates milestones in the current map layer and its children.
updateMilestones3d The updateMilestones3d method updates milestones positioned in the current 3D map layer and its child layers.
updateTooltipPositions The updateTooltipPositions method updates position of tooltip defined for map layer area.
updateTooltipPositions3d The updateTooltipPositions3d method updates tooltip position for areas of the current layer and child layers of a 3D map.
updateVisualItemsPositions The updateVisualItemsPositions method updates position of factors on the map.

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
sub_image.gif draw The draw method renders an object on a map.
sub_image.gif getIsSettingsCreated The getIsSettingsCreated method returns whether a map object is created based on user settings.
sub_image.gif hide The hide method hides an object on a map.
sub_image.gif scale The scale method scales an object on a map.
sub_image.gif 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 Control

  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