Class MQShapeOverlay

Object
   |
   +--MQObject
         |
         +--MQShapeOverlay

Direct Known Subclasses:

MQRectangleOverlay, MQImageOverlay, MQPolygonOverlay, MQLineOverlay, MQEllipseOverlay

class MQShapeOverlay

extends MQObject

Defined in mqoverlays.js

Field Detail

altBorderWidth

Object altBorderWidth

altColor

Object altColor

altColorAlpha

Object altColorAlpha

altFillColor

Object altFillColor

altFillColorAlplha

Object altFillColorAlplha

altStateFlag

Object altStateFlag

borderWidth

Object borderWidth

className

Object className

color

Object color

colorAlpha

Object colorAlpha

fillColor

Object fillColor

fillColorAlpha

Object fillColorAlpha

key

Object key

map

Object map

maxZoomLevel

Object maxZoomLevel

minZoomLevel

Object minZoomLevel

shape

Object shape

shapePoints

Object shapePoints

shapePointsXY

Object shapePointsXY

visible

Object visible

MQShapeOverlay

MQShapeOverlay()

Base shape class Constructs a new MQShapeOverlay object

getAltBorderWidth

int getAltBorderWidth()

Returns the alternate border width for this overlay object.

Returns:
the alt border width for this overlay object.

See:
- setAltBorderWidth()

getAltColor

color in [r,g,b] format. getAltColor()

Returns the alt border color for this overlay object.

Returns:
the alt color for this overlay object.

See:
- setAltColor()

getAltColorAlpha

Double value for alpha transparency (ex: 0.9) getAltColorAlpha()

Returns the altColorAlpha for this overlay object.

Returns:
the alt color alpha for this overlay object.

See:
- setAltColorAlpha()

getAltFillColor

string in rgba(int, int, int, double) format getAltFillColor()

Returns the alt fill color for this overlay object.

Returns:
the alt fill color for this overlay object.

See:
- setAltFillColor()

getAltFillColorAlpha

double value for alpha transparency (ex: 0.9) getAltFillColorAlpha()

Returns the alt fill color alpha (transparency) for this overlay object.

Returns:
the alt fill color alpha (transparency) for this overlay object.

See:
- setAltFillColor()

getAltStateFlag

boolean getAltStateFlag()

Returns the alternate state for this overlay object.

Returns:
the alt state for this overlay object.

See:
- setAltStateFlag()

getBorderWidth

int getBorderWidth()

Returns the border width for this overlay object.

Returns:
the border width for this overlay object.

See:
- setBorderWidth()

getClassName

Object getClassName()

Gets the class name of the overlay.

Returns:
String value for the class name.

getColor

color in [r,g,b] format. getColor()

Returns the border color for this overlay object.

Returns:
the color for this overlay object.

See:
- setColor()

getColorAlpha

Double value for alpha transparency (ex: 0.9) getColorAlpha()

Returns the color alpha (transparency) for this overlay object.

Returns:
the color alpha for this overlay object.

See:
- setColorAlpha()

getFillColor

string in rgba(int, int, int, double) format getFillColor()

Returns the fill color for this overlay object.

Returns:
the fill color for this overlay object.

See:
- setFillColor()

getFillColorAlpha

double value for alpha transparency (ex: 0.9) getFillColorAlpha()

Returns the fill color alpha (transparency) for this overlay object.

Returns:
the fill color alpha (transparency) for this overlay object.

See:
- setFillColorAlpha()

getKey

string getKey()

Returns the key for this overlay object.

Returns:
the key for this overlay object.

See:
- setKey()

getMaxZoomLevel

Object getMaxZoomLevel()

Gets the maximum zoom level set by the user for the overlay.

Returns:
integer value for the maximum zoom level

getMinZoomLevel

Object getMinZoomLevel()

Gets the minimum zoom level set by the user for the overlay.

Returns:
integer value for the minimum zoom level

getShapePoints

Object getShapePoints()

Gets the shape points of the overlay.

Returns:
MQLatLngCollection The shape points for the overlay.

getVisible

Object getVisible()

Gets the visibility state for the overlay.

Returns:
Boolean value for the visibility state (true/false)

redraw

void redraw()

Redraws an existing overlay.

setAll

Object setAll(params)

Sets all the properties of the overlay.

Parameters:
shapePoints - :value (MQRectLL or MQLatLngCollection) shape points for the overlay.
key - :value (string) The key for this overlay.
color - :value (string) Hex or RGB color string.
altColor - :value (string) Hex or RGB color string.
colorAlpha - :value (integer) Opacity value of the color.
altColorAlpha - :value (integer) Opacity value of the altColor.
fillColor - :value (string) Hex or RGB color string.
altFillColor - :value (string) Hex or RGB color string.
fillColorAlpha - :value (integer) Opacity value of the fillColor.
altFillColorAlpha - :value (integer) Opacity value of the altFillColor.
borderWidth - :value (integer) Width of the overlay border.
altBorderWidth - :value (integer) Width of the overlay alt border.
altStateFlag - :value (boolean) altStateFlag setting.
visible - :value (boolean) Visible state. etc.

Returns:
void

setAltBorderWidth

void setAltBorderWidth(lineWidth)

Sets the altBorderWidth for this overlay object.

Parameters:
int - The overlay object alternate border size

See:
- getAltBorderWidth()

setAltColor

void setAltColor(altColor)

Sets the altColor for this overlay object.

Parameters:
mixed - String in hex format or 3-element array of R,G,B values. The overlay object (border) altColor

See:
- getAltColor()

setAltColorAlpha

void setAltColorAlpha(altColorAlpha)

Sets the altColorAlpha for this overlay object.

Parameters:
Double - value for alpha transparency (ex: 0.9)

See:
- getAltColorAlpha()

setAltFillColor

void setAltFillColor(altFillColor)

Sets the altFillColor for this overlay object.

Parameters:
mixed - String in hex format or 3-element array of R,G,B values. The overlay object (interior) altFillColor

See:
- getAltFillColor()

setAltFillColorAlpha

void setAltFillColorAlpha(altFillColorAlpha)

Sets the altFillColorAlpha for this overlay object.

Parameters:
Double - value for alpha transparency (ex: 0.9)

See:
- getAltColorAlpha()

setAltStateFlag

void setAltStateFlag(altStateFlag)

Sets the altStateFlag for this overlay object.

Parameters:
boolean - The overlay object alternate state -- 'true' if in alternate state.

See:
- getAltStateFlag()

setBorderWidth

void setBorderWidth(lineWidth)

Sets the borderWidth for this overlay object.

Parameters:
int - The overlay object border size

See:
- getBorderWidth()

setColor

void setColor(color)

Sets the color for this overlay object.

Parameters:
mixed - String in hex format or 3-element array of R,G,B values. The overlay object (border) color

See:
- getColor()

setColorAlpha

void setColorAlpha(colorAlpha)

Sets the alpha (transparency) for this overlay object.

Parameters:
Double - value for alpha transpaency (ex: 0.9)

See:
- getColorAlpha()

setFillColor

void setFillColor(fillColor)

Sets the fillColor for this overlay object.

Parameters:
mixed - String in hex format or 3-element array of R,G,B values. The overlay object (interior) fillColor

See:
- getFillColor()

setFillColorAlpha

void setFillColorAlpha(fillColorAlpha)

Sets the fillColorAlpha for this overlay object.

Parameters:
Double - value for alpha transparency (ex: 0.9)

See:
- getAltColorAlpha()

setKey

void setKey(key)

Sets the key for this overlay object.

Parameters:
string - The overlay object key

See:
- getKey()

setMaxZoomLevel

Object setMaxZoomLevel(level)

Sets the maximum zoom level for the overlay.

Parameters:
level - (integer) specifies the max zoom level in integer.

Returns:
void

setMinZoomLevel

Object setMinZoomLevel(level)

Sets the minimum zoom level for the overlay.

Parameters:
level - (integer) specifies the minimum zoom level in integer.

Returns:
void

setShapePoints

Object setShapePoints(shapePnts)

Sets the shape points for the overlay.

Parameters:
shapePoints - (MQRectLL, MQRectXY, or MQObjectCollection) shape points for the overlay.
isXY - (integer) optional. If 1, the shapepoints are MQPoints, not MQLatLngs. MQPolygonOverlay must take an MQObjectCollection of at least 3 points. If MQRectLL is passed in, it is automatically converted to MQObjectCollection.

Returns:
void

setVisible

Object setVisible(bVisible)

Sets the visibility state for the overlay.

Parameters:
visible - Boolean value for visibility state (true/false)

Returns:
void