Support for Vector Grid

examples/VectorChoropleth.ipynb

@@ -0,0 +1,127 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 2,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "application/vnd.jupyter.widget-view+json": {
+       "model_id": "7cb56d3a71774a97b4af9806cb53f5f0",
+       "version_major": 2,
+       "version_minor": 0
+      },
+      "text/plain": [
+       "VBox(children=(Select(description='Select Field:', options={'Negative Nil income Family households.': 'neg_nil…"
+      ]
+     },
+     "metadata": {},
+     "output_type": "display_data"
+    }
+   ],
+   "source": [
+    "import folium\n",
+    "import json\n",
+    "from branca.colormap import linear\n",
+    "import geopandas\n",
+    "import ipywidgets as widgets\n",
+    "out = widgets.Output()\n",
+    "\n",
+    "dataFile = \"data/choropleth_data.geojson\"\n",
+    "metaDataFile = \"data/choropleth_metadata.json\"\n",
+    "vectorTilesPBF= \"http://openapi-dev.aurin.org.au/public/gwc/service/wmts?REQUEST=GetTile&SERVICE=WMTS&VERSION=1.0.0&LAYER=aurin:SA1_2016_AUST&STYLE=&TILEMATRIX=EPSG:900913:{z}&TILEMATRIXSET=EPSG:900913&FORMAT=application/x-protobuf;type=mapbox-vector&TILECOL={x}&TILEROW={y}\"\n",
+    "\n",
+    "\n",
+    "\n",
+    "#loading the local data\n",
+    "myData=geopandas.read_file(dataFile)\n",
+    "\n",
+    "#load the linkingKey from metadata\n",
+    "metaData = json.load(open(metaDataFile))\n",
+    "keyField = metaData[\"key\"]\n",
+    "\n",
+    "numericFields = {}\n",
+    "#extract the numeric fields\n",
+    "for att in metaData[\"selectedAttributes\"]:\n",
+    "    if(att['type'] == 'Short'):\n",
+    "        numericFields[att['description']] = att['name']\n",
+    "\n",
+    "\n",
+    "select = widgets.Select(\n",
+    "    options=numericFields,\n",
+    "    description='Select Field:',\n",
+    "    disabled=False\n",
+    ")\n",
+    "\n",
+    "#Generate and display a map\n",
+    "def onFieldSelect(b):\n",
+    "    with out:\n",
+    "        field = select.value\n",
+    "        #generate a scalled color map\n",
+    "        colormap = linear.YlGn_09.scale(\n",
+    "            myData[field].min(),\n",
+    "            myData[field].max())\n",
+    "\n",
+    "        #generate a key value dictionary with key as linking field and value as color to be applied\n",
+    "        linkData = {}\n",
+    "        for index, row in myData.iterrows():\n",
+    "            linkData[row[keyField]] =  colormap(row['negative_nil_income_tot'])\n",
+    "        #initialize a map\n",
+    "        m= folium.Map(tiles=None, location=[-37, 140],zoom_start=8)\n",
+    "        m.add_vector_grid_choropleth(vectorTilesPBF,\n",
+    "                                   name=\"SA1_2016_AUST\",\n",
+    "                                   data=json.dumps(linkData),\n",
+    "                                   field=keyField.upper())\n",
+    "        folium.LayerControl().add_to(m)\n",
+    "        colormap.caption = select.label\n",
+    "        colormap.add_to(m)\n",
+    "        display(m)\n",
+    "\n",
+    "\n",
+    "button = widgets.Button(description=\"Show Map\")\n",
+    "button.on_click(onFieldSelect)\n",
+    "controllComponent = widgets.VBox([select,button,out])\n",
+    "display(controllComponent)\n",
+    "\n",
+    "\n",
+    "    \n"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.5"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}

examples/VectorGrid.ipynb

@@ -0,0 +1,62 @@
+{
+ "cells": [
+  {
+   "cell_type": "code",
+   "execution_count": 5,
+   "metadata": {},
+   "outputs": [
+    {
+     "data": {
+      "text/html": [
+       "<div style=\"width:100%;\"><div style=\"position:relative;width:100%;height:0;padding-bottom:60%;\"><iframe src=\"data:text/html;charset=utf-8;base64,PCFET0NUWVBFIGh0bWw+CjxoZWFkPiAgICAKICAgIDxtZXRhIGh0dHAtZXF1aXY9ImNvbnRlbnQtdHlwZSIgY29udGVudD0idGV4dC9odG1sOyBjaGFyc2V0PVVURi04IiAvPgogICAgPHNjcmlwdD5MX1BSRUZFUl9DQU5WQVM9ZmFsc2U7IExfTk9fVE9VQ0g9ZmFsc2U7IExfRElTQUJMRV8zRD1mYWxzZTs8L3NjcmlwdD4KICAgIDxzY3JpcHQgc3JjPSJodHRwczovL2Nkbi5qc2RlbGl2ci5uZXQvbnBtL2xlYWZsZXRAMS4zLjQvZGlzdC9sZWFmbGV0LmpzIj48L3NjcmlwdD4KICAgIDxzY3JpcHQgc3JjPSJodHRwczovL2FqYXguZ29vZ2xlYXBpcy5jb20vYWpheC9saWJzL2pxdWVyeS8xLjExLjEvanF1ZXJ5Lm1pbi5qcyI+PC9zY3JpcHQ+CiAgICA8c2NyaXB0IHNyYz0iaHR0cHM6Ly9tYXhjZG4uYm9vdHN0cmFwY2RuLmNvbS9ib290c3RyYXAvMy4yLjAvanMvYm9vdHN0cmFwLm1pbi5qcyI+PC9zY3JpcHQ+CiAgICA8c2NyaXB0IHNyYz0iaHR0cHM6Ly9jZG5qcy5jbG91ZGZsYXJlLmNvbS9hamF4L2xpYnMvTGVhZmxldC5hd2Vzb21lLW1hcmtlcnMvMi4wLjIvbGVhZmxldC5hd2Vzb21lLW1hcmtlcnMuanMiPjwvc2NyaXB0PgogICAgPHNjcmlwdCBzcmM9Imh0dHBzOi8vdW5wa2cuY29tL2xlYWZsZXQudmVjdG9yZ3JpZEBsYXRlc3QvZGlzdC9MZWFmbGV0LlZlY3RvckdyaWQuYnVuZGxlZC5qcyI+PC9zY3JpcHQ+CiAgICA8bGluayByZWw9InN0eWxlc2hlZXQiIGhyZWY9Imh0dHBzOi8vY2RuLmpzZGVsaXZyLm5ldC9ucG0vbGVhZmxldEAxLjMuNC9kaXN0L2xlYWZsZXQuY3NzIi8+CiAgICA8bGluayByZWw9InN0eWxlc2hlZXQiIGhyZWY9Imh0dHBzOi8vbWF4Y2RuLmJvb3RzdHJhcGNkbi5jb20vYm9vdHN0cmFwLzMuMi4wL2Nzcy9ib290c3RyYXAubWluLmNzcyIvPgogICAgPGxpbmsgcmVsPSJzdHlsZXNoZWV0IiBocmVmPSJodHRwczovL21heGNkbi5ib290c3RyYXBjZG4uY29tL2Jvb3RzdHJhcC8zLjIuMC9jc3MvYm9vdHN0cmFwLXRoZW1lLm1pbi5jc3MiLz4KICAgIDxsaW5rIHJlbD0ic3R5bGVzaGVldCIgaHJlZj0iaHR0cHM6Ly9tYXhjZG4uYm9vdHN0cmFwY2RuLmNvbS9mb250LWF3ZXNvbWUvNC42LjMvY3NzL2ZvbnQtYXdlc29tZS5taW4uY3NzIi8+CiAgICA8bGluayByZWw9InN0eWxlc2hlZXQiIGhyZWY9Imh0dHBzOi8vY2RuanMuY2xvdWRmbGFyZS5jb20vYWpheC9saWJzL0xlYWZsZXQuYXdlc29tZS1tYXJrZXJzLzIuMC4yL2xlYWZsZXQuYXdlc29tZS1tYXJrZXJzLmNzcyIvPgogICAgPGxpbmsgcmVsPSJzdHlsZXNoZWV0IiBocmVmPSJodHRwczovL3Jhd2dpdC5jb20vcHl0aG9uLXZpc3VhbGl6YXRpb24vZm9saXVtL21hc3Rlci9mb2xpdW0vdGVtcGxhdGVzL2xlYWZsZXQuYXdlc29tZS5yb3RhdGUuY3NzIi8+CiAgICA8c3R5bGU+aHRtbCwgYm9keSB7d2lkdGg6IDEwMCU7aGVpZ2h0OiAxMDAlO21hcmdpbjogMDtwYWRkaW5nOiAwO308L3N0eWxlPgogICAgPHN0eWxlPiNtYXAge3Bvc2l0aW9uOmFic29sdXRlO3RvcDowO2JvdHRvbTowO3JpZ2h0OjA7bGVmdDowO308L3N0eWxlPgogICAgCiAgICA8c3R5bGU+I21hcF84MGRiNTVmOGNiZWM0MmJlODU3MDMyOWE3MzkzNDAwNSB7CiAgICAgICAgcG9zaXRpb246IHJlbGF0aXZlOwogICAgICAgIHdpZHRoOiAxMDAuMCU7CiAgICAgICAgaGVpZ2h0OiAxMDAuMCU7CiAgICAgICAgbGVmdDogMC4wJTsKICAgICAgICB0b3A6IDAuMCU7CiAgICAgICAgfQogICAgPC9zdHlsZT4KPC9oZWFkPgo8Ym9keT4gICAgCiAgICAKICAgIDxkaXYgY2xhc3M9ImZvbGl1bS1tYXAiIGlkPSJtYXBfODBkYjU1ZjhjYmVjNDJiZTg1NzAzMjlhNzM5MzQwMDUiID48L2Rpdj4KPC9ib2R5Pgo8c2NyaXB0PiAgICAKICAgIAogICAgCiAgICAgICAgdmFyIGJvdW5kcyA9IG51bGw7CiAgICAKCiAgICB2YXIgbWFwXzgwZGI1NWY4Y2JlYzQyYmU4NTcwMzI5YTczOTM0MDA1ID0gTC5tYXAoCiAgICAgICAgJ21hcF84MGRiNTVmOGNiZWM0MmJlODU3MDMyOWE3MzkzNDAwNScsIHsKICAgICAgICBjZW50ZXI6IFstMzcsIDE0MF0sCiAgICAgICAgem9vbTogNiwKICAgICAgICBtYXhCb3VuZHM6IGJvdW5kcywKICAgICAgICBsYXllcnM6IFtdLAogICAgICAgIHdvcmxkQ29weUp1bXA6IGZhbHNlLAogICAgICAgIGNyczogTC5DUlMuRVBTRzM4NTcsCiAgICAgICAgem9vbUNvbnRyb2w6IHRydWUsCiAgICAgICAgfSk7CgogICAgCiAgICAKICAgIHZhciB0aWxlX2xheWVyXzE0ZThlNGFiMDkzNzQwODc4NmU0MTBkODI4ODQ4M2E4ID0gTC50aWxlTGF5ZXIoCiAgICAgICAgJ2h0dHA6Ly9vcGVuYXBpLWRldi5hdXJpbi5vcmcuYXUvcHVibGljL2d3Yy9zZXJ2aWNlL3dtdHM/UkVRVUVTVD1HZXRUaWxlJlNFUlZJQ0U9V01UUyZWRVJTSU9OPTEuMC4wJkxBWUVSPWF1cmluOkdDQ1NBXzIwMTFfQVVTVCZTVFlMRT0mVElMRU1BVFJJWD1FUFNHOjkwMDkxMzp7en0mVElMRU1BVFJJWFNFVD1FUFNHOjkwMDkxMyZGT1JNQVQ9aW1hZ2UvanBlZyZUSUxFQ09MPXt4fSZUSUxFUk9XPXt5fScsCiAgICAgICAgewogICAgICAgICJhdHRyaWJ1dGlvbiI6ICJOb25lIiwKICAgICAgICAiZGV0ZWN0UmV0aW5hIjogZmFsc2UsCiAgICAgICAgIm1heE5hdGl2ZVpvb20iOiAxOCwKICAgICAgICAibWF4Wm9vbSI6IDE4LAogICAgICAgICJtaW5ab29tIjogMCwKICAgICAgICAibm9XcmFwIjogZmFsc2UsCiAgICAgICAgInN1YmRvbWFpbnMiOiAiYWJjIgp9KS5hZGRUbyhtYXBfODBkYjU1ZjhjYmVjNDJiZTg1NzAzMjlhNzM5MzQwMDUpOwogICAgdmFyIHZlY3Rvcl9ncmlkXzUyZWNhMjJlYWEwZTQ4MGE5M2FhYWQ0YTYzMTNiMzM0ID0gTC52ZWN0b3JHcmlkLnByb3RvYnVmKAogICAgICAgICdodHRwOi8vb3BlbmFwaS1kZXYuYXVyaW4ub3JnLmF1L3B1YmxpYy9nd2Mvc2VydmljZS93bXRzP1JFUVVFU1Q9R2V0VGlsZSZTRVJWSUNFPVdNVFMmVkVSU0lPTj0xLjAuMCZMQVlFUj1hdXJpbjpHQ0NTQV8yMDExX0FVU1QmU1RZTEU9JlRJTEVNQVRSSVg9RVBTRzo5MDA5MTM6e3p9JlRJTEVNQVRSSVhTRVQ9RVBTRzo5MDA5MTMmRk9STUFUPWFwcGxpY2F0aW9uL3gtcHJvdG9idWY7dHlwZT1tYXBib3gtdmVjdG9yJlRJTEVDT0w9e3h9JlRJTEVST1c9e3l9JywKICAgICAgICApLmFkZFRvKG1hcF84MGRiNTVmOGNiZWM0MmJlODU3MDMyOWE3MzkzNDAwNSk7Cjwvc2NyaXB0Pg==\" style=\"position:absolute;width:100%;height:100%;left:0;top:0;border:none !important;\" allowfullscreen webkitallowfullscreen mozallowfullscreen></iframe></div></div>"
+      ],
+      "text/plain": [
+       "<folium.folium.Map at 0x11f5ea940>"
+      ]
+     },
+     "execution_count": 5,
+     "metadata": {},
+     "output_type": "execute_result"
+    }
+   ],
+   "source": [
+    "import folium;\n",
+    "\n",
+    "vectorTilesPBF= \"http://openapi-dev.aurin.org.au/public/gwc/service/wmts?REQUEST=GetTile&SERVICE=WMTS&VERSION=1.0.0&LAYER=aurin:GCCSA_2011_AUST&STYLE=&TILEMATRIX=EPSG:900913:{z}&TILEMATRIXSET=EPSG:900913&FORMAT=application/x-protobuf;type=mapbox-vector&TILECOL={x}&TILEROW={y}\"\n",
+    "rasterTiles= \"http://openapi-dev.aurin.org.au/public/gwc/service/wmts?REQUEST=GetTile&SERVICE=WMTS&VERSION=1.0.0&LAYER=aurin:GCCSA_2011_AUST&STYLE=&TILEMATRIX=EPSG:900913:{z}&TILEMATRIXSET=EPSG:900913&FORMAT=image/jpeg&TILECOL={x}&TILEROW={y}\"\n",
+    "m= folium.Map(tiles=None, location=[-37, 140],zoom_start=6)\n",
+    "m.add_tile_layer(rasterTiles,attr=\"AURIN\")\n",
+    "m.add_vector_grid_protobuf(vectorTilesPBF,name=\"GCCSA_2011_AUST\",options=\"{vectorTileLayerStyles: {  GCCSA_2011_AUST: { fill: true, weight: 1, fillColor: '#53e033', color: '#53e033', fillOpacity: 0.2, opacity: 0.4}}}\")\n",
+    "m"
+   ]
+  },
+  {
+   "cell_type": "code",
+   "execution_count": null,
+   "metadata": {},
+   "outputs": [],
+   "source": []
+  }
+ ],
+ "metadata": {
+  "kernelspec": {
+   "display_name": "Python 3",
+   "language": "python",
+   "name": "python3"
+  },
+  "language_info": {
+   "codemirror_mode": {
+    "name": "ipython",
+    "version": 3
+   },
+   "file_extension": ".py",
+   "mimetype": "text/x-python",
+   "name": "python",
+   "nbconvert_exporter": "python",
+   "pygments_lexer": "ipython3",
+   "version": "3.6.6"
+  }
+ },
+ "nbformat": 4,
+ "nbformat_minor": 2
+}