README.md

GoogleAPI

This component is for Nette framework and make Google map display easier

Google map API

Requirements

• Nette Framework 2.1+
• Jquery 1.8+

Installation

composer require olicek/google-map-api: dev-master

then you can enable the extension using your neon config

extensions:
	map: Oli\GoogleAPI\MapApiExtension

Configuration in neon file

You can define your map and all markers in in config neon file. All configuration in neon is optional.

map:
	key: your_key								# your personal key to google map
	zoom: 2										
	width: 300px								# map will 300px width
	height: 150px								# map will 150px height
	coordinates:								# you can name keies as you whis or use [49, 15]
		lat: 49.8037633
		lng: 15.4749126
	type: SATELLITE								# type of map
	markers:									# this section will be configured amrkers
		bound: on								# zoom as mutch as possible, but every marker will be displaied
		markerClusterer: on						# neer markers group to one cluster
		addMarkers:								# definitions of markers
			- 									# first marker has no name
				coordinates: 					# the same as map coordinates
					sirka: 47
					vyska: 15
				icon: images/point.png			# it will display png image from www/images/point.png
				message: 
					text: Opened message		# text of message
					autoOpen: on				# if it is on, this message will be displaied after map loaded
			1:									# second marker has name 1
				coordinates: [46, 13]
				animation: DROP					# this marker will has drop animation
				title: Hello world
				icon: images/point2.png
			Prague:								# last marker has name Prague
				coordinates: 
					lat: 48
					lng: 15
				animation: DROP
				message: 
					Closed message
					autoOpen: off				# message has autoOpen default off

Default values can be seen in MapApiExtension

Simplest usage

To your presenter include (if you have PHP 5.4+)

class MapPresenter extends Nette\Application\UI\Presenter
{
	use \Oli\GoogleAPI\TMap;
	
	// ...
}

and to template

{control map}

Define map in component

private $map;
private $markers;

public function __constructor(\Oli\GoogleAPI\IMapAPI $mapApi, \Oli\GoogleAPI\IMarkers $markers)
{
	$this->map = $mapApi;
	$this->markers = $markers;
}

public function createComponentMap()
{
	$map = $this->map->create();
	$markers = $this->markers->create();
	
	// ...
	
	$map->addMarkers($markers);
	return $map;
}

And in template

{* JS and HTML *}
{control map}
{* just HTML *}
{control map:HTML}
{* just JS *}
{control map:JS}

Map options

protected function createComponentGoogleMap()
{
	$map->setCoordinates(array(41.15, 15.65))
	$map->setProportions('800px', '480px');	// Default is 100% x 100%. If proportion is default, map must be 
                                        	// wrapped to some concrete proportions otherwise it will not be displayed.
	$map->setKey('your_key');
	$map->setZoom(8);	// <0, 19>
	$map->setType(MapAPI::SATELITE);
	$map->isStaticMap();	// Map will be displayed as img. (To the image can be inserted colored) markers.
	$map->addMarkers($markers);	// give markers to the map
	return $map;
}

Markers options

$markers = $this->markers->create();
	
/**
 * Put marker to the coordinate
 * Optional animation, can be DROP, BOUNCE, false
 * Optional title can be string|null
 */
$markers->addMarker(array(50.250718,14.583435), false, null);

/**
 * Message can contains HTML tags
 * Optional auto open: auto open the message
 * Static map can not display messages
 */
$markers->setMessage('<h1>Hello world</h1>', false);
$markers->deleteMarkers();
$markers->isMarkerClusterer();	// neer markers group to one cluster
$markers->fitBounds();	// zoom as mutch as possible, but every marker will be displaied
$markers->setColor('red');	// Can set color of markers to 10 diferent colors
$markers->setDefaultIconPath('img/');	// Path which will be prepend icon path

/**
 * Icon from www folder.
 * If default path was not set, setIcon would be '/www/someIcon.png'
 */
$markers->setIcon('someIcon.png');

Complex example

config.neon

map:
	key: my_key
	width: 750px
	height: 450px
markers:
	defaultIconPath: images/mapPoints

Presenter

protected function createComponentGoogleMap()
{
	$map = $this->map->create();
	
	$map->setCoordinates(array(50.250718,14.583435))
		->setZoom(4)
		->setType(MapAPI::TERRAIN);
		
	$markers = $this->markers->create();
	$markers->fitBounds();
	
	if(count($markersFromDb) > 30)
	{
		$markers->isMarkerClusterer();
	}
	
	foreach ($markersFromDb as $marker)
	{
		$markers->addMarker(array($marker->lat, $marker->lng), Marker::DROP)
			->setMessage(
				'<h1>'.$marker->title.'</h1><br />'.$marker->description
			)->setIcon($marker->icon);
	}
	$map->addMarkers($markers);
	return $map;
}

Template

{block content}
	{control map:HTML}
{/block}

{block scripts}
	{control map:JS}
{/block}