Class deCarta.Mobile.MapControl
A MapControl is a base class upon which to build custom map controls This base class should be extended to provide the desired functionality in your control. Some the following for some already-defined map controls: deCarta.Mobile.CopyrightControl deCarta.Mobile.ZoomControl
| Constructor Attributes | Constructor Name and Description |
|---|---|
|
deCarta.Mobile.MapControl(options)
Base Class for Map Controls
|
| Method Attributes | Method Name and Description |
|---|---|
|
position()
Controls the positioning of the control over the map.
|
|
|
render()
You need to implement the render method in every map control so that
it produces a single HTML Dom Element containing the whole GUI for the control.
|
Class Detail
deCarta.Mobile.MapControl(options)
Base Class for Map Controls
- Parameters:
- {object} options
- Options A list of options for the control, which will vary
depending on the functionality the control offers. However, there is a set
of standard options every control should implement:
- (string) position: specifies how the control will be positioned on the map. can be one of 'topLeft', 'topRight', 'bottomLeft', 'bottomRight' or any other string your control will be able to interpret.
- (int) marginX: margin from the edge of the map (left OR right) on the X coordinate, in pixels (default=10)
- (int) marginY: margin from the edge of the map (top OR bottom) on the Y coordinate, in pixels (default=10)
Method Detail
position()
Controls the positioning of the control over the map.
You might need to implement the position function in controls inherited from the base
MapControl.
render()
You need to implement the render method in every map control so that
it produces a single HTML Dom Element containing the whole GUI for the control.
The render function should return this DOM Element to the caller so that it can
be placed on the map.
The dom element should be created with the following css attributes :
- Position: absolute
- top (bottom): appropriate for the position specified in the options
- left (right): appropriate for the position specified in the options
- Returns:
- HTMLDomElement