{"_id":"54557e58a1e5cd0e00435ed4","user":"545284e73f92fc0e009396c6","category":{"_id":"54557a3135f4ac0800f42bad","pages":["54557a6435f4ac0800f42baf","54557c5435f4ac0800f42bb9","54557e58a1e5cd0e00435ed4","5456daaff037df0800035612"],"project":"545285163f92fc0e009396c7","version":"5452b671b7fa011600a75c25","__v":4,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2014-11-02T00:26:25.292Z","from_sync":false,"order":1,"slug":"blueprint-inputs","title":"Blueprint Inputs"},"is_link":false,"version":{"_id":"5452b671b7fa011600a75c25","__v":13,"forked_from":"545285163f92fc0e009396ca","project":"545285163f92fc0e009396c7","createdAt":"2014-10-30T22:06:41.529Z","releaseDate":"2014-10-30T22:06:41.529Z","categories":["5452b671b7fa011600a75c26","545579ee35f4ac0800f42bac","54557a3135f4ac0800f42bad","54557b7b35f4ac0800f42bb3","54557c91a1e5cd0e00435ecc","54557caf35f4ac0800f42bbd","54557dc1a1e5cd0e00435ecf","54557e7ba1e5cd0e00435ed6","54557f81533d890e000cf8a9","54557fcd533d890e000cf8aa","54558020a1e5cd0e00435edf","545580b6533d890e000cf8ad","545580e1a1e5cd0e00435ee6"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"0.2.0","version":"0.2.0"},"__v":36,"project":"545285163f92fc0e009396c7","updates":[],"next":{"pages":[],"description":""},"createdAt":"2014-11-02T00:44:08.649Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"basic_auth":false,"results":{"codes":[]},"try":true,"auth":"never","params":[],"url":""},"isReference":false,"order":0,"body":"This module lets you retrieve map tile images from a local or external endpoint. For example, you could use this module to request map tiles from Mapbox.\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Name\"\n}\n[/block]\n`BlueprintInputMapTiles`\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\": \"`tilePath`\",\n    \"0-1\": \"`String`\",\n    \"0-2\": \"URL describing the map tile endpoint. Must contain `{x}`, `{y}` and `{z}` variables.\\n\\nEg. \\\"https://a.tiles.mapbox.com/v3/examples.map-i86l3621/{z}/{x}/{y}:::at:::2x.png\\\"\"\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 map tiles module has been added to the `World` and is ready to use.\n\n## Trigger: `tileReceived`\n\nFired when a tile image has been successfully received from the `tilePath` endpoint.\n[block:parameters]\n{\n  \"data\": {\n    \"0-0\": \"`image`\",\n    \"h-0\": \"Argument\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Example\",\n    \"1-0\": \"`tile`\",\n    \"1-1\": \"`Object`\",\n    \"1-2\": \"```\\n{\\n  x: 262116,\\n  y: 174348,\\n  z: 19\\n}\\n```\",\n    \"0-1\": \"[`HTMLImageElement`](https://developer.mozilla.org/en/docs/Web/API/HTMLImageElement.Image)\"\n  },\n  \"cols\": 3,\n  \"rows\": 2\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: `requestTiles`\n\nRequests image tiles from the `tilePath` endpoint.\n[block:parameters]\n{\n  \"data\": {\n    \"h-0\": \"Argument\",\n    \"h-1\": \"Type\",\n    \"h-2\": \"Example\",\n    \"0-0\": \"`tiles`\",\n    \"0-1\": \"`Array` of `Object`\",\n    \"0-2\": \"```\\n[{\\n  x: 262116,\\n  y: 174348,\\n  z: 19\\n}, {\\n  x: 262117,\\n  y: 174348,\\n  z: 19\\n}]\\n```\"\n  },\n  \"cols\": 3,\n  \"rows\": 1\n}\n[/block]\n\n[block:api-header]\n{\n  \"type\": \"basic\",\n  \"title\": \"Example input\"\n}\n[/block]\nExample map tile image retrieved from the Mapbox URL `https://a.tiles.mapbox.com/v3/examples.map-i86l3621/{z}/{x}/{y}@2x.png`:\n[block:image]\n{\n  \"images\": [\n    {\n      \"caption\": \"\",\n      \"image\": [\n        \"https://files.readme.io/dQVpx1QTlO55aNKIT59G_43587@2x.png\",\n        \"43587@2x.png\",\n        \"256\",\n        \"256\",\n        \"\",\n        \"\"\n      ]\n    }\n  ]\n}\n[/block]","excerpt":"Map tiles data input for ViziCities","slug":"blueprint-input-map-tiles","type":"basic","title":"Map tiles"}

Map tiles

Map tiles data input for ViziCities

This module lets you retrieve map tile images from a local or external endpoint. For example, you could use this module to request map tiles from Mapbox. [block:api-header] { "type": "basic", "title": "Name" } [/block] `BlueprintInputMapTiles` [block:api-header] { "type": "basic", "title": "Options" } [/block] Override module functionality with the following options. [block:parameters] { "data": { "h-0": "Option", "h-1": "Type", "h-2": "Description", "0-0": "`tilePath`", "0-1": "`String`", "0-2": "URL describing the map tile endpoint. Must contain `{x}`, `{y}` and `{z}` variables.\n\nEg. \"https://a.tiles.mapbox.com/v3/examples.map-i86l3621/{z}/{x}/{y}@2x.png\"" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Triggers" } [/block] These triggers are fired at various point during the lifetime of the module. ## Trigger: `initialised` Fired when the map tiles module has been added to the `World` and is ready to use. ## Trigger: `tileReceived` Fired when a tile image has been successfully received from the `tilePath` endpoint. [block:parameters] { "data": { "0-0": "`image`", "h-0": "Argument", "h-1": "Type", "h-2": "Example", "1-0": "`tile`", "1-1": "`Object`", "1-2": "```\n{\n x: 262116,\n y: 174348,\n z: 19\n}\n```", "0-1": "[`HTMLImageElement`](https://developer.mozilla.org/en/docs/Web/API/HTMLImageElement.Image)" }, "cols": 3, "rows": 2 } [/block] [block:api-header] { "type": "basic", "title": "Actions" } [/block] These actions are exposed to the Blueprint API to be triggered by other modules. ## Action: `requestTiles` Requests image tiles from the `tilePath` endpoint. [block:parameters] { "data": { "h-0": "Argument", "h-1": "Type", "h-2": "Example", "0-0": "`tiles`", "0-1": "`Array` of `Object`", "0-2": "```\n[{\n x: 262116,\n y: 174348,\n z: 19\n}, {\n x: 262117,\n y: 174348,\n z: 19\n}]\n```" }, "cols": 3, "rows": 1 } [/block] [block:api-header] { "type": "basic", "title": "Example input" } [/block] Example map tile image retrieved from the Mapbox URL `https://a.tiles.mapbox.com/v3/examples.map-i86l3621/{z}/{x}/{y}@2x.png`: [block:image] { "images": [ { "caption": "", "image": [ "https://files.readme.io/dQVpx1QTlO55aNKIT59G_43587@2x.png", "43587@2x.png", "256", "256", "", "" ] } ] } [/block]