{"metadata":{"image":[],"title":"","description":""},"api":{"url":"","auth":"never","try":true,"basic_auth":false,"params":[],"results":{"codes":[]}},"next":{"description":"","pages":[]},"title":"KML","type":"basic","slug":"blueprint-input-kml","excerpt":"KML data input for ViziCities","body":"This module lets you retrieve KML data from a relative or external URL. For example, you could use this module to request a KML file from Google Maps, or to request a KML file relative to your ViziCities installation.\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Name\"\n}\n[/block]\n`BlueprintInputKML`\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Options\"\n}\n[/block]\nOverride module functionality with the following options.\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Option\",\n \"h-1\": \"Type\",\n \"h-2\": \"Description\",\n \"0-0\": \"`path`\",\n \"0-1\": \"`String`\",\n \"0-2\": \"URL describing the KML file. Can be relative to path of ViziCities installation.\\n\\nEg. \\\"/data/sample.kml\\\"\"\n },\n \"cols\": 3,\n \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Triggers\"\n}\n[/block]\nThese triggers are fired at various point during the lifetime of the module.\n\n## Trigger: `initialised`\n\nFired when the KML module has been added to the `World` and is ready to use.\n\n## Trigger: `dataReceived`\n\nFired when KML data from a single file has been successfully received from the `path` URL. Data is converted into the [JSON-like JXON format](https://developer.mozilla.org/en-US/docs/JXON).\n[block:parameters]\n{\n \"data\": {\n \"h-0\": \"Argument\",\n \"h-1\": \"Type\",\n \"h-2\": \"Example\",\n \"0-0\": \"`kml`\",\n \"0-1\": \"`Object` ([JXON](https://developer.mozilla.org/en-US/docs/JXON))\"\n },\n \"cols\": 3,\n \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Actions\"\n}\n[/block]\nThese actions are exposed to the Blueprint API to be triggered by other modules.\n\n## Action: `requestData`\n\nRequests KML data from the `path` URL.\n[block:api-header]\n{\n \"type\": \"basic\",\n \"title\": \"Example input\"\n}\n[/block]\nExample KML file from the [Google KML tutorial](https://developers.google.com/kml/documentation/kml_tut).\n[block:code]\n{\n \"codes\": [\n {\n \"code\": \"<?xml version=\\\"1.0\\\" encoding=\\\"UTF-8\\\"?>\\n<kml xmlns=\\\"http://www.opengis.net/kml/2.2\\\">\\n <Placemark>\\n <name>Simple placemark</name>\\n <description>Attached to the ground. Intelligently places itself \\n at the height of the underlying terrain.</description>\\n <Point>\\n <coordinates>-122.0822035425683,37.42228990140251,0</coordinates>\\n </Point>\\n </Placemark>\\n</kml>\",\n \"language\": \"xml\"\n }\n ]\n}\n[/block]","updates":[],"order":2,"isReference":false,"hidden":false,"sync_unique":"","link_url":"","link_external":false,"_id":"54557c5435f4ac0800f42bb9","user":"545284e73f92fc0e009396c6","version":{"version":"0.2.0","version_clean":"0.2.0","codename":"","is_stable":true,"is_beta":true,"is_hidden":false,"is_deprecated":false,"categories":["5452b671b7fa011600a75c26","545579ee35f4ac0800f42bac","54557a3135f4ac0800f42bad","54557b7b35f4ac0800f42bb3","54557c91a1e5cd0e00435ecc","54557caf35f4ac0800f42bbd","54557dc1a1e5cd0e00435ecf","54557e7ba1e5cd0e00435ed6","54557f81533d890e000cf8a9","54557fcd533d890e000cf8aa","54558020a1e5cd0e00435edf","545580b6533d890e000cf8ad","545580e1a1e5cd0e00435ee6"],"_id":"5452b671b7fa011600a75c25","__v":13,"createdAt":"2014-10-30T22:06:41.529Z","forked_from":"545285163f92fc0e009396ca","releaseDate":"2014-10-30T22:06:41.529Z","project":"545285163f92fc0e009396c7"},"createdAt":"2014-11-02T00:35:32.237Z","is_link":false,"project":"545285163f92fc0e009396c7","category":{"sync":{"isSync":false,"url":""},"pages":["54557a6435f4ac0800f42baf","54557c5435f4ac0800f42bb9","54557e58a1e5cd0e00435ed4","5456daaff037df0800035612"],"title":"Blueprint Inputs","slug":"blueprint-inputs","order":1,"from_sync":false,"reference":false,"_id":"54557a3135f4ac0800f42bad","createdAt":"2014-11-02T00:26:25.292Z","project":"545285163f92fc0e009396c7","version":"5452b671b7fa011600a75c25","__v":4},"__v":15,"githubsync":""}
KML
KML data input for ViziCities