Library of example catalog items (for documentation/getting started purposes)

[nf-s]

I think we need a nice library of example catalog items - the easiest way for someone new to Terria to create a map is by copying and then slightly modifying examples (I guess this goes for anything right?)

So I am putting all of my github gists here for reference until we get a Wiki or something going.

These examples should appear in docs.terria.io under each Catalog Item/Group/Reference:

• Include the JSON snippet inline with docs
• Include a link using map.terria.io to show the example

We also need to include a short description of each Catalog Item/Group/Reference

The list of examples doesn't need to be fully complete (eg show examples of all traits)

Note

Suggest to create a public S3 bucket folder that contains all files, such as csv and czml files, to be used in the examples.

I've created this folder for the purpose.

• [x] ApiTableCatalogItem (api-table)
• [x] ArcGisCatalogGroup (esri-group)
• [x] ArcGisFeatureServerCatalogGroup (esri-featureServer-group)
• [x] ArcGisFeatureServerCatalogItem (esri-featureServer)
• [x] ArcGisMapServerCatalogGroup (esri-mapServer-group)
• [x] ArcGisMapServerCatalogItem (esri-mapServer)
• [x] ArcGisPortalCatalogGroup (arcgis-portal-group)
• [x] ArcGisPortalItemReference (arcgis-portal-item)
• [ ] ArcGisTerrainCatalogItem
• [x] AssImpCatalogItem
• [ ] BingMapsCatalogItem
• [ ] CartoMapV1CatalogItem
• [ ] CartoMapV3CatalogItem
• [ ] CatalogGroup
• [ ] CatalogIndexReference
• [x] Cesium3DTilesCatalogItem (3d-tiles)
• [x] CesiumTerrainCatalogItem (cesium-terrain)
• [x] CkanCatalogGroup (ckan-group)
• [x] CkanItemReference (ckan-item)
• [x] CompositeCatalogItem (composite)
• [x] CsvCatalogItem (csv)
• [x] CswCatalogGroup (csw)
• [x] CzmlCatalogItem (czml)
• [x] GeoJsonCatalogItem (geojson)
• [ ] GeoRssCatalogItem (georss)
• [x] GltfCatalogItem (gltf)
• [ ] GpxCatalogItem (gpx)
• [x] GtfsCatalogItem (gtfs) Note: Need to find a public service url. This https://api.transport.nsw.gov.au/v1/gtfs/vehiclepos/buses needs credentials.
• [ ] IonImageryCatalogItem (ion-imagery)
• [ ] KmlCatalogItem (kml)
• [x] MagdaReference (magda)
• [ ] MapboxMapCatalogItem (mapbox-map)
• [ ] MapboxStyleCatalogItem (mapbox-style)
• [ ] MapboxVectorTileCatalogItem (mvt)
• [x] OpenDataSoftCatalogGroup (opendatasoft-group)
• [x] OpenDataSoftCatalogItem (opendatasoft-item)
• [x] OpenStreetMapCatalogItem (open-street-map)
• [x] SdmxCatalogGroup (sdmx-group)
• [x] SdmxJsonCatalogItem (sdmx-json)
• [ ] SenapsLocationsCatalogItem (senaps-locations)
• [ ] SensorObservationServiceCatalogItem (sos) Note: Need to find a public service url. This service http://www.bom.gov.au/waterdata/services is not free.
• [x] ShapefileCatalogItem (shp)
• [ ] SocrataCatalogGroup (socrata-group)
• [ ] SocrataMapViewCatalogItem (socrata-map-item)
• [ ] SplitItemReference (split-reference)
• [ ] StubCatalogItem (stub)
• [x] TerriaReference (terria-reference)
• [x] ThreddsCatalogGroup (thredds-group)
• [ ] UrlReference (url-reference)
• [x] UrlTemplateImageryCatalogItem (url-template-imagery)
• [x] WebFeatureServiceCatalogItem (wfs)
• [x] WebFeatureServiceCatalogGroup (wfs-group)
• [x] WebMapServiceCatalogItem (wms)
• [x] WebMapServiceCatalogGroup (wms-group)
• [x] WebMapTileServiceCatalogItem (wmts)
• [x] WebMapTileServiceCatalogGroup (wmts-group)
• [ ] WebProcessingServiceCatalogFunction (wps)
• [ ] WebProcessingServiceCatalogFunctionJob (wps-result)
• [ ] WebProcessingServiceCatalogGroup (wps-getCapabilities)
• [ ] YDYRCatalogFunction (ydyr)
• [ ] YDYRCatalogFunctionJob (ydyr-job)

[nf-s]

Thredds catalog group

https://gist.github.com/nf-s/6a002318d6ee2aac086c56e754b4e5ca

[nf-s]

Catalog functions - WPS and YDYR

https://gist.github.com/nf-s/36eabf17577e78a5cde482928d96ff52

[nf-s]

WMTS

https://gist.github.com/nf-s/075689074a843bcf99182241406d7858

[nf-s]

SDMX

https://gist.github.com/nf-s/24b9288c6cdb6ba41d12f3d269318a0d

[nf-s]

CKAN

https://gist.github.com/nf-s/715b0a35c94f3f48e2595eef28b48c3d

[nf-s]

WFS

https://gist.github.com/nf-s/b71d4aef0e027c8013136a3c6dc895dc

[nf-s]

WMS (shows styles and dimensions) + DiffWms

https://gist.github.com/nf-s/3d77d4acb9105283226444677e011dd9

WMS with WCS

https://gist.github.com/nf-s/8a55c04720ec60f5d210f794ad604599

[nf-s]

Polling CSV

https://gist.github.com/nf-s/7add30fc21d000e5e1710faf09e0dc4b

[nf-s]

GeoJSON with short report sections

https://gist.github.com/nf-s/be2c74551c426011914fedd6d3d8b20d

[nf-s]

We have some ability to add description and examples to trait classes

For example

https://github.com/TerriaJS/terriajs/blob/8514256dec6737b76c7e4518b51f8e6cefab5ffb/lib/Traits/TraitsClasses/WebMapServiceCatalogItemTraits.ts#L157-L167

[nf-s]

I want to make a simple version of Cesium sandcastle

• JSON editor on the left
• TerriaMap on the right
• Some sort of gallery somewhere

POC requirements

• JSON doesn't need to auto-update (press button to "run")
• Only edit whole init file

[nf-s]

More example

Config URLs

http://ci.terria.io/main/#configUrl={url}

Initialization files

https://ci.terria.io/main/#clean&{url}

Mapbox vector tiles

Mapbox vector tile source from ArcGis Vector Tile Service

• https://gist.githubusercontent.com/nf-s/a26e67ae59e85dfc49279d3bf07b3779/raw/bd063024bbbe8aeb85cf1ec1d8b4d3941aac2f1f/esri-mvt-style.json

ESRI world base map MVT

• http://ci.terria.io/main/#share=s-kMGzeYzE1ymufQMkJ0rcdJ3FUdL&clean&https://gist.githubusercontent.com/nf-s/a232b3f39eca70e3cf727cbca259ee0c/raw/7e9113e2135d41fb4162efb19c707cef15c252ba/esri-mvt.json
• https://gist.githubusercontent.com/nf-s/a232b3f39eca70e3cf727cbca259ee0c/raw/7e9113e2135d41fb4162efb19c707cef15c252ba/esri-mvt.json

Mapbox-streets v4 basemap exmaple

• http://ci.terria.io/main/#share=s-eGXZfwQZo3v0aMwkONO0Ds2Oz54&clean&https://gist.githubusercontent.com/nf-s/7f5a90a78b73722add5b61a361a8b53b/raw/1d4c4212bf9ec0b4aaed1d7728527a739e078954/mvt.json
• https://gist.githubusercontent.com/nf-s/7f5a90a78b73722add5b61a361a8b53b/raw/1d4c4212bf9ec0b4aaed1d7728527a739e078954/mvt.json

idProperty

• https://gist.githubusercontent.com/nf-s/7ee61e28a9edebdbb631196d9682b3a6/raw/b09c2f8ae56daab8c811a3f1f4a9790521f41b46/mvt-idproperty.json

AssImp

Example 3D models converted with AssImp to GLTF

• https://gist.githubusercontent.com/nf-s/d14ad46ed7ed8e0beabfda7673c178ad/raw/80b79d55ef7cc3a9967be539c98f82a5e77f3dfe/assimp.json

CZML

CZML example with point and label

• https://gist.githubusercontent.com/nf-s/4083f4855cabc102861986576167b835/raw/f06669e6475b6238994e8407dd8cd4ce9713d852/czml-point-label.json

CZML Template

CZML Template example showing GeoJSON point with label

• https://gist.githubusercontent.com/nf-s/182d099fd57cfd7c22d9707741048f9e/raw/4a2e3a480bcb2310c10445d926687b90f7a7ffde/geojson-czml-label.json

Example with cylinder and data-driven length and radius

• http://ci.terria.io/main/#clean&https://gist.githubusercontent.com/nf-s/327a06724f1f00aaafa2052036ed9243/raw/8779ecbcc18b29c827736084be7e54692d5a6cf0/czml-geojson.json&share=s-oXbmfNBZdw4ljl2BMg5cqkGwTdL
• https://gist.githubusercontent.com/nf-s/327a06724f1f00aaafa2052036ed9243/raw/8779ecbcc18b29c827736084be7e54692d5a6cf0/czml-geojson.json

WMS

Tile height/width = 512px

• http://ci.terria.io/main/#https://gist.githubusercontent.com/nf-s/49949c938a81469bfd442b535ff3bd7b/raw/03096be7b1b2d43e06ec2dbca62ab919fc1ee87b/wms-tilewidth-tileheight.json&share=s-43TXcShoeWqsPH0vZgn5e3VufxF
• https://gist.githubusercontent.com/nf-s/49949c938a81469bfd442b535ff3bd7b/raw/03096be7b1b2d43e06ec2dbca62ab919fc1ee87b/wms-tilewidth-tileheight.json

WMS Feature Info Format

WMS Feature Info format

• https://gist.githubusercontent.com/nf-s/aff559b09813ac4f33745cbbff4f7eb5/raw/d3689bfdd48ef23b411d057b63c389c84f13f38b/esri-wms-info-format.json

Model Dimensions

Model dimensions to control CSV color scale

• http://ci.terria.io/main/#clean&https://gist.githubusercontent.com/nf-s/1e1123826bc5baa47049d6e8e862dcf6/raw/fa16c069a2c69a05e1926c55c4d18bd4e49db41d/model-dim-mustache.json&share=s-qrpTHG31ahpKcSXoSjhs78Iqy1z
• https://gist.githubusercontent.com/nf-s/1e1123826bc5baa47049d6e8e862dcf6/raw/fa16c069a2c69a05e1926c55c4d18bd4e49db41d/model-dim-mustache.json

Url Template Imagery

Example of url-template-imagery catalog item

• http://ci.terria.io/main/#share=s-aPxNuyyZadc2zqV7BytG2WxFChC&clean&https://gist.githubusercontent.com/nf-s/5d8ef020cb11aec26585a28e50274c1b/raw/5ed5175dcddabd4754711a6bb347a2cf3df9f89e/url-template-imagery.json
• https://gist.githubusercontent.com/nf-s/5d8ef020cb11aec26585a28e50274c1b/raw/5ed5175dcddabd4754711a6bb347a2cf3df9f89e/url-template-imagery.json

Catalog Group

sortMembersBy examples (no sort, sort by name, sort by WMS layer name)

• http://ci.terria.io/main/#clean&https://gist.githubusercontent.com/nf-s/f55f14d31f80829a968b4c323a462cf1/raw/9acc82eb82c12214336d47b764c16e5b3fbb48f7/sort-members-by.json
• https://gist.githubusercontent.com/nf-s/f55f14d31f80829a968b4c323a462cf1/raw/9acc82eb82c12214336d47b764c16e5b3fbb48f7/sort-members-by.json

Catalog Member

dataUrls

• http://ci.terria.io/main/#share=s-s4VbwWCJTb9V7T1POZyrkp5jbCG&clean&https://gist.githubusercontent.com/nf-s/aad79f8ae2934c9da989733c42bfb705/raw/69c14584db1bead64918ce699696e5f23c5a98fd/dataurl.json
• https://gist.githubusercontent.com/nf-s/aad79f8ae2934c9da989733c42bfb705/raw/69c14584db1bead64918ce699696e5f23c5a98fd/dataurl.json

Region Mapping

Example of manual region mapping.

• https://gist.githubusercontent.com/nf-s/20d4af76fcd1a9e46679d76367ab8353/raw/d56041915df10efb296b3d208a28a336cbe51d27/region-mapping.json

Feature Info

Example tempalte for ESRI MapServer

• http://ci.terria.io/main/#clean&https://gist.githubusercontent.com/nf-s/d1a6b434cb2799832eb8f69ef4e3120a/raw/fe5bc0de8f1c7fcbace867ca8d4513060c23cc0a/feature-info-test.json&share=s-6ksCzuiAL6VA7hlAA2hhp2Z6T58
• https://gist.githubusercontent.com/nf-s/d1a6b434cb2799832eb8f69ef4e3120a/raw/fe5bc0de8f1c7fcbace867ca8d4513060c23cc0a/feature-info-test.json

Styling

Basic bin color example

• http://ci.terria.io/main/#share=s-qA7TMWHzjkFjogKiAJ9gXgYkYq5&clean&https://gist.githubusercontent.com/nf-s/11d3f65450eabbcd38371ab15e84cee7/raw/41a6edafe71da665f8dcaa2dcc1ab52ad3f1f182/color-bin-fix.json
• https://gist.githubusercontent.com/nf-s/11d3f65450eabbcd38371ab15e84cee7/raw/41a6edafe71da665f8dcaa2dcc1ab52ad3f1f182/color-bin-fix.json

GeoJSON

Height Property

• http://ci.terria.io/main/#clean&https://gist.githubusercontent.com/nf-s/bdd3187b531386a1dc3c793b6fcaf866/raw/c90472f8f08b79d8a646c0b7c8cde2153dee7ff5/geojson-height.json&share=s-94ZuOux8nqXpRlLaWOw84JF6SOH
• https://gist.githubusercontent.com/nf-s/bdd3187b531386a1dc3c793b6fcaf866/raw/c90472f8f08b79d8a646c0b7c8cde2153dee7ff5/geojson-height.json

Api Table

Api table catalog item example

• http://ci.terria.io/main/#clean&https://gist.githubusercontent.com/nf-s/845b4ec1c00d0142282394eba4b1a26c/raw/a49f9df540ffff06bc546fd7f7b328d2c633c8b2/api-tab-item-v2.json&share=s-Asa2nEFyCdJxuon0m9pqzwxEduC
• https://gist.githubusercontent.com/nf-s/845b4ec1c00d0142282394eba4b1a26c/raw/a49f9df540ffff06bc546fd7f7b328d2c633c8b2/api-tab-item-v2.json

Carto v3

• https://gist.githubusercontent.com/nf-s/c2485b3d2f05cbededdaa50e85a64db9/raw/87f132a401682098599ee911383d0c82543cbd19/carto-v3.json

Related Maps config

• https://gist.githubusercontent.com/nf-s/210a1c0d559a80e9f27994155cef7324/raw/6be92992396b1950e7767805f661f3136288e4f3/related-maps-config.json

[nf-s]

I have added most of my useful snippets to this ticket.

I don't think I should spend time creating the "sand-castle" like app at the moment.

[nf-s]

This should stay open until we have created the library of examples

[nf-s]

After completed, do a blog post

[ljowen]

Examples ready for review / merge