Class eniro.maps.Drawn
Defined in: Drawn.js.
Constructor Attributes | Constructor Name and Description |
---|---|
Creates a drawn object.
|
Method Attributes | Method Name and Description |
---|---|
Returns the fill color CSS string.
|
|
Returns the fill opacity.
|
|
getMap()
Returns the map instance this object is associated with or null if none set.
|
|
Returns the stroke color
|
|
Returns the stroke opacity.
|
|
Returns the stroke weight in pixels.
|
|
Returns the drawing order.
|
|
setFillColor(fillColor)
Sets the fill color as a CSS string.
|
|
setFillOpacity(fillOpacity)
Sets the fill opacity.
|
|
setMap(map)
Sets the map to draw this object on.
|
|
setOptions(opts)
Sets the options as an object.
|
|
setStrokeColor(color)
Sets the stroke color as a string.
|
|
setStrokeOpacity(opacity)
Sets the stroke opacity.
|
|
setStrokeWeight(weight)
Sets the stroke weight in pixels.
|
|
setZIndex(zIndex)
Sets the drawing order.
|
Event Attributes | Event Name and Description |
---|---|
click()
Drawn is clicked.
|
|
mouseout()
Drawn is left by mouse pointer.
|
|
Drawn is entered by mouse pointer.
|
Method Detail
{string}
getFillColor()
Returns the fill color CSS string.
- Returns:
- {string} The fill color CSS string.
{number}
getFillOpacity()
Returns the fill opacity.
- Returns:
- {number} The fill opacity.
{eniro.maps.Map}
getMap()
Returns the map instance this object is associated with or null if none set.
- Returns:
- {eniro.maps.Map} The map instance or null.
{string}
getStrokeColor()
Returns the stroke color
- Returns:
- {string} The stroke color.
{number}
getStrokeOpacity()
Returns the stroke opacity.
- Returns:
- {number} The stroke opacity.
{number}
getStrokeWeight()
Returns the stroke weight in pixels.
- Returns:
- {number} The stroke weight in pixels.
{number}
getZIndex()
Returns the drawing order.
- Returns:
- {number} The z-index.
setFillColor(fillColor)
Sets the fill color as a CSS string.
- Parameters:
- {string} fillColor
- The css value to set.
setFillOpacity(fillOpacity)
Sets the fill opacity.
- Parameters:
- {number} fillOpacity
- A number between 0.0 and 1.0.
setMap(map)
Sets the map to draw this object on.
Setting the map to null will remove the line.
- Parameters:
- {eniro.map.Map} map
- A map instance.
setOptions(opts)
Sets the options as an object.
- Parameters:
- {DrawnOptions} opts
- Options object.
setStrokeColor(color)
Sets the stroke color as a string.
- Parameters:
- {string} color
- The stroke color.
setStrokeOpacity(opacity)
Sets the stroke opacity.
- Parameters:
- {number} opacity
- A number between 0.0 and 1.0
setStrokeWeight(weight)
Sets the stroke weight in pixels.
- Parameters:
- {number} weight
- The stroke weight in pixels.
setZIndex(zIndex)
Sets the drawing order.
- Parameters:
- {number} zIndex
- The z-index to set.
Event Detail
click()
Drawn is clicked.
eniro.maps.event(drawn, 'click', listener);
mouseout()
Drawn is left by mouse pointer.
eniro.maps.event(drawn, 'mouseout', listener);
mouseover()
Drawn is entered by mouse pointer.
eniro.maps.event(drawn, 'mouseover', listener);