Class MQDeclutter

Object
   |
   +--MQDeclutter

class MQDeclutter

The MQDeclutter object controls how the poi declutter functionality operates. A default MQDeclutter object gets created automatically with each tilemap and is accessed via the getDeclutter() method of the MQTileMap object.
Defined in mqdeclutter.js

Field Detail

cpCollection

Object cpCollection

leaderLineDotImage

Object leaderLineDotImage

leaderLineDotMode

Object leaderLineDotMode

MQDeclutter

MQDeclutter(map)

Constructs a MQDeclutter object. Defaults to a mode of 0 (no declutter). Valid options are 0, 1, and 2. Note: The MQDeclutter object is automatically created with an MQTileMap. There is no need to explicity create one.

Parameters:
MQTileMap - ) map The parent map of the MQDeclutter object.

getDeclutterIcon

Object getDeclutterIcon()

Returns the declutter icon for this map.

See:
- setDeclutterIcon()

getDeclutterMode

Object getDeclutterMode()

Returns the declutter mode for this map.

See:
- setDeclutterMode()

getLeaderLineColor

Object getLeaderLineColor()

Returns the color of the declutter mode 2 leader line.

See:
- setLeaderLineColor()

getLeaderLineDotImage

Object getLeaderLineDotImage()

Returns the leader line dot image.

See:
- setLeaderLineDotImage()

getLeaderLineDotMode

Object getLeaderLineDotMode()

Returns the draw status of the leader line reference dot.

See:
- setDrawLeaderLineDot

getNextPageIcon

Object getNextPageIcon()

Returns the next page declutter icon for this map.

See:
- setNextPageIcon()

getPrevPageIcon

Object getPrevPageIcon()

Returns the prev page declutter icon for this map.

See:
- setPrevPageIcon()

getRolloverDrag

Object getRolloverDrag()

Returns the drag status of rollovers.

See:
- setRolloverDrag()

getStackHeight

Object getStackHeight()

Returns the stack height setting of the MQDeclutter object.

See:
- setStackHeight()

getStackWidth

Object getStackWidth()

Returns the stack width setting of the MQDeclutter object.

See:
- setStackWidth()

setDeclutterIcon

void setDeclutterIcon(<string> url, <int> width, <int> height)

Sets the declutter icon to use for this map.

Parameters:
url - The image URL string.
width - The width size of the declutter icon image in pixels.
height - The height size of the declutter icon image in pixels.

See:
- getDeclutterIcon()

setDeclutterMode

void setDeclutterMode(<int> declutterMode)

Sets the declutter mode for this map.

Parameters:
declutterMode - - The declutter mode to set. 0 = no declutter 1 = stack decluttering 2 = leader-line declutter

See:
- getDeclutterMode()

setDeclutterOverIcon

void setDeclutterOverIcon(<string> url, <int> width, <int> height)

Sets the declutter icon to use for this map.

Parameters:
url - The image URL string.
width - The width size of the declutter icon image in pixels.
height - The height size of the declutter icon image in pixels.

See:
- getDeclutterIcon()

setLeaderLineColor

void setLeaderLineColor(<string> c)

Sets the color of the declutter mode 2 leader line. Default is #000000.

Parameters:
c - Hex value of the leaderline color.

See:
- getLeaderLineColor()

setLeaderLineDotImage

void setLeaderLineDotImage(<string> url, <int> width, <int> height)

Sets the leader line dot image.

Parameters:
url - Full url to the image.
width - Width of the image.
height - Height of the image.

See:
- getLeaderLineDotDraw

setLeaderLineDotMode

void setLeaderLineDotMode(<int> m)

Specifies how to draw the leader line reference dot. Default is 1.

Parameters:
m - Mode to use for reference point. 0 = no dot, 1 = draw dot, 2 = dot image.

See:
- getLeaderLineDotMode()

setNextPageIcon

void setNextPageIcon(<string> url, <int> width, <int> height)

Sets the next page declutter icon to use for this map.

Parameters:
url - The image URL string.
width - The width size of the next page declutter image in pixels.
height - The height size of the next page declutter image in pixels.

See:
- getNextPageIcon()

setPrevPageIcon

void setPrevPageIcon(<string> url, <int> width, <int> height)

Sets the prev page declutter icon to use for this map.

Parameters:
url - The image URL string.
width - The width size of the prev page declutter image in pixels.
height - The height size of the prev page declutter image in pixels.

See:
- getPrevPageIcon()

setRolloverDrag

void setRolloverDrag(<boolean> b)

Sets whether to drag the rollover with the poi. Default is true.

Parameters:
b - True to include the rollover with the poi drag, false otherwise..

See:
- getRolloverDrag()

setStackHeight

void setStackHeight(<int> n)

Sets the height (in icons) of the decluttered poi grouping. Default is 2.Minimum is 1.

Parameters:
n - The height of the decluttered poi grouping.

See:
- getStackHeight()

setStackWidth

void setStackWidth(<int> n)

Sets the width (in icons) of the decluttered poi grouping. Default is 5. Minimum is 2.

Parameters:
n - The width of the decluttered poi grouping.

See:
- getStackWidth()