offline-editor-js/samples/appcache-features.html

803 lines
34 KiB
HTML

<!DOCTYPE html>
<html manifest="appcache-features.appcache">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=utf-8">
<!--The viewport meta tag is used to improve the presentation and behavior of the samples
on iOS devices-->
<meta name="viewport" content="initial-scale=1, maximum-scale=1,user-scalable=no">
<!--
This sample demonstrates using an application manifest to store features and tiles locally.
The use cases for using this sample are to ensure you can reload and restart you application
one it is offline.
It is strongly recommended that you use your own optimized build of the ArcGIS API for JavaScript
using the Web Optimizer: http://jso.arcgis.com/. You can reference the CDN or host it on your
own web server.
Here is the node list for the optimized file used in this sample app: https://github.com/Esri/offline-editor-js/issues/284
Use the Grunt task in the /samples directory to help generate the manifest file. There is manual
work involved in determining which files need to go into the manifest. The included manifest
file should work with this sample to give you an idea of what goes into the manifest.
A few things to know about manifest files:
- You cannot load an online url that has a redirect.
- If there is an error encountered, the manifest file will stop loading
- The /utils/appCacheManager.js library will auto detect if the manifest changed and
ask if you want to reload the application.
HINT: When testing be sure you allow for browser caching. If you are using Chrome make sure you have NOT
checked Network Tab > Disable cache.
-->
<title>AppCache Tiles and Features</title>
<!-- Bootstrap core CSS -->
<link rel="stylesheet" href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css">
<link rel="stylesheet" href="../samples/widgets/modal/css/modal-popup.css">
<link rel="stylesheet" href="http://js.arcgis.com/3.11/dijit/themes/claro/claro.css">
<link rel="stylesheet" href="http://js.arcgis.com/3.11/esri/css/esri.css">
<link rel="stylesheet" href="http://esri.github.io/bootstrap-map-js/src/css/bootstrapmap.css">
<script>
// DO NOT DELETE!
// Listen for application cache update events
window.addEventListener('load', function(evt) {
window.applicationCache.addEventListener('updateready', function(evt) {
if (window.applicationCache.status == window.applicationCache.UPDATEREADY) {
// Browser downloaded a new app cache.
if (confirm('A new version of this cache is available.')) {
window.location.reload();
console.log("App cache reloaded");
}
} else {
// Manifest didn't changed. Nothing new to server.
console.log("App cache no change");
}
}, false);
}, false);
// If you need to catch AppCache errors as early as possible to troubleshoot errors.
// You should delete this for production use.
// window.applicationCache.addEventListener("error",function(err){
// console.log("ApplicationCache listener: " + err.toString());
// if (confirm('There was a problem setting this app up for offline. Reload?')) {
// window.location.reload();
// console.log("App cache reloaded");
// }
// },false)
</script>
<style>
#mapDiv {
min-height: 400px;
max-height: 1000px;
}
body {
background-color: #ffffff;
overflow: hidden;
font-family: "Trebuchet MS";
}
#loader-gif{
visibility: hidden;
}
/* Override mod-popup default */
.mod-popup-stop-input {color: black;}
.span-pending {color: blue; padding-left: 1em;}
.floatRight { float: right;}
.container { padding: 20px; width: 100%;}
</style>
<script src="../vendor/offline/offline.min.js"></script>
<script>
// This options sets up an image that the offline status detection library
// will use to ping to see if app is online or offline.
Offline.options = {
checks: {
image: {
url: function() {
return 'http://esri.github.io/offline-editor-js/tiny-image.png?_=' + (Math.floor(Math.random() * 1000000000));
}
},
active: 'image'
}
}
var locationPath = location.pathname.replace(/\/[^/]+$/, "");
var dojoConfig = {
paths: {
vendor: locationPath + "/../vendor",
utils: locationPath + "/../utils",
widgets: locationPath + "/widgets"
}
}
</script>
<!--
Required when using the offline-editor-js library with Safari.
-->
<script src="../vendor/IndexedDBShim/dist/IndexedDBShim.js"></script>
<!--
This is a locally hosted optimized build of the ArcGIS JS API.
The optimizer creates a single JavaScript file that you can host yourself.
To create your own optimized build go to: http://http://jso.arcgis.com/
-->
<script src="../samples/jsolib/dojo.js" data-dojo-config="async: true"></script>
</head>
<body>
<!-- Our buttons and online/offline indicator -->
<div class="container">
<div class="row">
<div class="col-xs-10">
<div class="form form-group btn-group" data-toggle="buttons">
<button class="btn btn-success" id="btn-get-tiles">1. Download Tiles</button>
<button class="btn btn-success" disabled id="btn-online-offline">2. Go Offline</button>
</div>
<span class="span-pending">Pending Edits <span id="span-pending-edits" class="badge">0</span></span>
<img id="loader-gif" src="images/loading.gif"/>
</div>
<div class="col-xs-2">
<!-- this indicates whether app is offline (down) or online (up) -->
<button id="btn-state" class="btn btn-success btn-large floatRight">
<span id="state-span" class="glyphicon glyphicon-link"> Up</span>
</button>
</div>
</div>
<div class="row">
<div class="col-xs-12">
<div id="mapDiv"></div>
</div>
</div>
</div>
<!-- Stub for modal editing popup -->
<div id="modal-popup"></div>
<script>
require(["esri/map","esri/layers/FeatureLayer",
"esri/renderers/SimpleRenderer","esri/symbols/SimpleMarkerSymbol",
"esri/Color",
"esri/tasks/query",
"dojo/on",
"esri/graphic","esri/geometry/Extent", "esri/SpatialReference",
"widgets/modal/popup",
"//esri.github.io/bootstrap-map-js/src/js/bootstrapmap.js",
"../dist/offline-tiles-advanced-src.js",
"../dist/offline-edit-src.js",
"dojo/domReady!"],
function(Map,FeatureLayer,
SimpleRenderer,SimpleMarkerSymbol,Color,Query,
on,Graphic,Extent,SpatialReference,ModalPopup,BootstrapMap) {
var map = null;
var _isOnline = true;
var defaultSymbol;
// Variables for editing handling
var currentFeature, busStopFeatureLayer = null, offlineFeaturesManager = null;
var pendingEdits = document.getElementById("span-pending-edits");
var imgOfflineIndicator = document.getElementById("state-span");
var btnState = document.getElementById("btn-state");
// Variables for handling tiles
var tileLayer;
var _currentExtent = null;
var _wantToCancel;
var globalState = {};
var btnGetTiles = document.getElementById("btn-get-tiles");
var btnOnlineOffline = document.getElementById("btn-online-offline");
// Important settings for determining which tile layers gets stored for offline use.
var minZoomAdjust = -1, maxZoomAdjust = 1;
var EXTENT_BUFFER = 0; //buffers the map extent in meters
// Misc.
var loading = document.getElementById("loader-gif");
// Variables for modal popup
var popup,closeBtn,saveBtn,deleteBtn,stopMainID,stopID,stopRoutes,stopNames;
mediaQueries();
initModalPopup();
/**
* NOTE: This is the entry point into the application. The very first thing
* we need to do is check if the application is online or offline.
*
* There have been a few bugs in the offline detection library (offline.min.js)
* This is a utility check to 100% validate if the application is online or
* offline prior to launching any map functionality.
*/
verifyOnline(function(result){ console.log("VERIFY ONLINE " + result)
if(result){
_isOnline = true;
setUIOnline();
}
else{
_isOnline = false;
setUIOffline();
}
startMap();
});
function initModalPopup(){
popup = new ModalPopup({animation: true, animationDuration: 1},"modal-popup");
// Variables for modal popup
closeBtn = document.getElementById("mod-popup-close-btn");
saveBtn = document.getElementById("mod-popup-save-btn");
deleteBtn = document.getElementById("mod-popup-delete-btn");
stopMainID = document.getElementById("stop-main-id");
stopID = document.getElementById("stop-id");
stopRoutes = document.getElementById("stop-routes");
stopNames = document.getElementById("stop-names");
}
/**
* Modify symbol size to devices. Make them easier to touch on.
* Feel free to tweak this based on your requirements
*/
function mediaQueries(){
var widthQuery = window.matchMedia("(max-width: 768px)");
var orientation = window.matchMedia("(orientation:portrait)");
if(widthQuery.matches && orientation.matches){
defaultSymbol= new SimpleMarkerSymbol().setStyle(
SimpleMarkerSymbol.STYLE_DIAMOND).setColor(
new Color([255,0,0,0.5])).setSize(35);
}
else{
defaultSymbol= new SimpleMarkerSymbol().setStyle(
SimpleMarkerSymbol.STYLE_DIAMOND).setColor(
new Color([255,0,0,0.5])).setSize(20);
}
}
function startMap(){
//Make sure map shows up after a browser refresh
Offline.check();
tileLayer = new O.esri.Tiles.OfflineTileEnablerLayer("http://server.arcgisonline.com/ArcGIS/rest/services/World_Topo_Map/MapServer",function(evt){
console.log("Tile Layer initialized for offline. App state is: " + Offline.state);
},_isOnline);
// We don't need a proxy. All ArcGIS Online Service are CORS enabled.
tileLayer.offline.proxyPath = null;
// We are using Esri bootstrap-map-js to create a responsive mapping app
map = BootstrapMap.create("mapDiv",{
center: [-104.99,39.75], // long, lat
zoom: 17,
sliderStyle: "small"
});
// Add our offline enabled tile layer to the map
map.addLayer(tileLayer);
// Initialize our feature layer like we normally would
busStopFeatureLayer = new FeatureLayer("http://services1.arcgis.com/M8KJPUwAXP8jhtnM/arcgis/rest/services/Denver_Bus_Stops/FeatureServer/0", {
mode: FeatureLayer.MODE_SNAPSHOT,
outFields: ["GlobalID","BSID","ROUTES","STOPNAME"]
});
//Set the graphics to red boxes to make it easy to click on them
//on a mobile device.
busStopFeatureLayer.setRenderer(new SimpleRenderer(defaultSymbol));
initFeatureUpdateEndListener();
initMapLoadListener();
map.addLayer(busStopFeatureLayer);
}
function initFeatureUpdateEndListener(){
//While loading application ONLINE
busStopFeatureLayer.on("update-end",function(evt){
if(offlineFeaturesManager == null || _isOnline){
// Set click listeners
on(btnGetTiles,"click",downloadTiles);
on(btnOnlineOffline, 'click', goOnlineOffline);
initOfflineFeaturesMgr(evt,function(success){
if(success){
initPanZoomListeners();
setFeatureLayerClickHandler();
setModalPopupClickListeners();
}
else{
alert("There was a problem initializing the map for offline.");
}
});
}
});
}
function initMapLoadListener(){
map.on("load",function(evt){
_currentExtent = evt.map.extent;
//**************************************************
//
// This is where we detect an offline condition
// within the lifecycle of the "mapping" application.
// If we are offline then run our offline
// specific code for reconstituting our map.
//
//**************************************************
if(_isOnline == false){
if(offlineFeaturesManager == null){
initOfflineFeaturesMgr(null,function(success){
console.log("Offline Feature Manager initialized.");
loadFeatureLayerOffline();
});
}
else{
loadFeatureLayerOffline();
}
}
});
}
/**
* **********************************************
* EVENT LISTENER MANAGEMENT CODE
* **********************************************
*/
function initPanZoomListeners(){
updateOfflineUsage();
updateStatus();
map.on("zoom-end",function(evt){
_currentExtent = evt.extent;
updateFeatureLayerJSON();
});
map.on("pan-end",function(evt){
_currentExtent = evt.extent;
updateFeatureLayerJSON();
});
}
/**
* Load the feature while offline using information stored in database
*/
function loadFeatureLayerOffline(){
busStopFeatureLayer.getFeatureLayerJSONOptions(function(success,optionsObj){
if(success){
// Use the feature layer returns from getFeatureDefinition() to reconstitute the layer
busStopFeatureLayer = new FeatureLayer(JSON.parse(optionsObj.featureLayerCollection),{
mode: FeatureLayer.MODE_SNAPSHOT,
outFields: ["GlobalID","BSID","ROUTES","STOPNAME"]
});
var symbol = new SimpleMarkerSymbol(defaultSymbol);
// Set the graphic symbols to red diamond to make it easy to click on them
// on a mobile device.
busStopFeatureLayer.setRenderer(new SimpleRenderer(symbol));
// If/when the update-end event has been thrown then let's finish initializing
var mapListen = map.on("update-end",function(evt){
console.log("Feature has been added back to the map while offline.");
on(btnGetTiles,"click",downloadTiles);
on(btnOnlineOffline, 'click', goOnlineOffline);
setFeatureLayerClickHandler();
setModalPopupClickListeners();
updatePhantomGraphicsLayer();
map.centerAt(optionsObj.centerPt);
map.setZoom(optionsObj.zoom);
mapListen.remove();
});
map.addLayer(busStopFeatureLayer);
}
else{
alert("There was a problem retrieving feature layer options object. " + optionsObj);
}
})
}
/**
* **********************************************
* FEATURE LAYER MANAGEMENT CODE
* **********************************************
*/
function initOfflineFeaturesMgr(event,callback){
offlineFeaturesManager = new O.esri.Edit.OfflineFeaturesManager();
// IMPORTANT!!!
// This tells the database which graphic.attribute property to use as a unique identifier
// You can lok this information up in your feature service directory under the "Fields" category.
// Example: http://services1.arcgis.com/M8KJPUwAXP8jhtnM/arcgis/rest/services/Denver_Bus_Stops/FeatureServer/0
offlineFeaturesManager.DB_UID = "FID";
// IMPORTANT!!!
// A proxy page may be required to upload attachments.
// If you are using a CORS enabled feature service you can ignore this.
// If your feature service is not CORS-enabled then you will need to configure this.
// Refer to "Using the Proxy Page" for more information: https://developers.arcgis.com/en/javascript/jshelp/ags_proxy.html
offlineFeaturesManager.proxyPath = null;
offlineFeaturesManager.on(offlineFeaturesManager.events.EDITS_ENQUEUED, editsEnqueued);
offlineFeaturesManager.on(offlineFeaturesManager.events.EDITS_SENT, updateStatus);
offlineFeaturesManager.on(offlineFeaturesManager.events.ALL_EDITS_SENT, allEditsSent);
offlineFeaturesManager.on(offlineFeaturesManager.events.EDITS_SENT_ERROR, editsError);
var featureLayerJSON = null;
if(event != null){
// This object contains everything we need to restore the map and feature layer after an offline restart
//
// There are two caveats:
// First, you cannot use the object key 'id'. That's a reserved key for internal offline library use.
// Second, complex objects need to be serialized or you'll get a database cloning error.
featureLayerJSON = getFeatureLayerJSON();
}
offlineFeaturesManager.extend(busStopFeatureLayer,function(result, error){
if(result){
console.log("offlineFeaturesManager initialized.");
Offline.check();
Offline.on('up', goOnline);
Offline.on('down', goOffline);
// If the app is online then set offlineFeaturesManager to its online state
// This will force the library to check for pending edits and attempt to
// resend them to the Feature Service.
if(_isOnline == true){
offlineFeaturesManager.goOnline();
}
callback(true);
}
else{
callback(false);
alert("Unable to initialize the database. " + error);
}
},/* This is the optional offline configuration property */featureLayerJSON);
}
/**
* Display modal popup when someone clicks on a feature
*/
function setFeatureLayerClickHandler(){
busStopFeatureLayer.on("click", function(evt) {
currentFeature = evt.graphic;
showModalPopup(currentFeature);
var atts = currentFeature.attributes;
stopID.value = atts.GlobalID;
stopMainID.value = atts.BSID;
stopNames.value = atts.STOPNAME;
stopRoutes.value = atts.ROUTES;
}.bind(this));
}
function setModalPopupClickListeners(){
closeBtn.onclick = function(evt){
hideModalPopup();
}
saveBtn.onclick = function(evt){
//You may need to uncomment this forced offline check for production use.
//forceInternalOfflineCheck();
popup.graphic.attributes.ROUTES = stopRoutes.value;
popup.graphic.attributes.STOPNAME = stopNames.value;
busStopFeatureLayer.applyEdits(null,[popup.graphic],null,function(result){
updateFeatureLayerJSON();
console.log("Successfully saved changes to: " + popup.graphic.attributes.STOPNAME);
hideModalPopup();
},
function(err){
alert("There was a problem while trying to save: " + popup.graphic.attributes.STOPNAME);
})
}
deleteBtn.onclick = function(evt){
// Best practice is to uncomment these for production use
//forceInternalOfflineCheck();
busStopFeatureLayer.applyEdits(null,null,[popup.graphic],function(result){
updateFeatureLayerJSON();
console.log("Successfully deleted: " + popup.graphic.attributes.STOPNAME);
hideModalPopup();
},
function(err){
alert("There was a problem while trying to delete: " + popup.graphic.attributes.STOPNAME);
})
}
}
function showModalPopup(graphic){
popup.graphic = graphic; // assign graphic to popup as a property.
popup.show();
}
function hideModalPopup(){
popup.hide();
}
function getFeatureLayerJSON(){
return {
"featureLayerCollection": JSON.stringify(busStopFeatureLayer.toJson()),
"zoomLevel": map.getZoom(),
"centerPt" : (map.extent.getCenter()).toJson()
}
}
function updateFeatureLayerJSON(){
var fl = getFeatureLayerJSON();
busStopFeatureLayer.setFeatureLayerJSONOptions(fl,function(result,error){
console.log("updateFeatureLayerJSON - Result: " + result + ", error: " + error);
})
}
/**
* ************************************
* TILE MANAGEMENT CODE
* ************************************
*/
/**
* Manually starts the process to download and store tiles
* in the local database
*/
function downloadTiles(){
tileLayer.deleteAllTiles(function(success,err){
if(success == false){
alert("There was a problem deleting the tile cache");
}
else{
console.log("success deleting tile cache");
if( globalState.downloadState == 'downloading')
{
console.log("cancel!");
_wantToCancel = true;
btnGetTiles.innerHTML = "cancelling..";
}
else
{
var zoom = tileLayer.getMinMaxLOD(minZoomAdjust,maxZoomAdjust);
var extent = tileLayer.getExtentBuffer(EXTENT_BUFFER,_currentExtent);
_wantToCancel = false;
tileLayer.prepareForOffline(zoom.min, zoom.max, extent, reportProgress.bind(this));
globalState.downloadState = 'downloading';
}
}
}.bind(this))
}
/**
* Reports the process while downloading tiles.
*/
function reportProgress(progress)
{
console.log("downloading tiles...");
if(progress.hasOwnProperty("countNow")){
var percent = Math.floor(progress.countNow / progress.countMax * 100);
btnGetTiles.innerHTML = 'Saving to phone ' + percent + "% - Tap to Cancel";
}
if( progress.finishedDownloading )
{
btnGetTiles.innerHTML = "Saving to phone 100% - Tap to Cancel";
updateOfflineUsage();
updateFeatureLayerJSON();
if( progress.cancelRequested )
{
globalState.downloadState = 'cancelled';
alert("Tile download was cancelled");
}
else
{
globalState.downloadState = 'downloaded';
btnOnlineOffline.disabled = false;
alert("Tile download complete");
}
btnGetTiles.innerHTML = '1. Download Tiles';
}
return _wantToCancel; //determines if a cancel request has been issued
}
/**
* ************************************
* HANDLE GOING ONLINE/OFFLINE
* ************************************
*/
/**
* Forces offlineFeaturesManager online
*/
function goOnline(){
console.log("Going online...");
loading.style.visibility = "visible";
offlineFeaturesManager.goOnline(function(success,error){
if(error === undefined){
setUIOnline();
console.log("offlineFeatureManager is online.");
}
else{
alert("There was a problem syncing offline edits: " + JSON.stringify(error));
}
loading.style.visibility = "hidden";
});
updateOfflineUsage();
if(typeof tileLayer != "undefined") tileLayer.goOnline();
}
/**
* Forces offlineFeaturesManager offline
*/
function goOffline(){
console.log("Going offline...");
setUIOffline();
offlineFeaturesManager.goOffline();
if(typeof tileLayer != "undefined") tileLayer.goOffline();
}
/**
* Toggles offlineFeaturesManager online/offline
*/
function goOnlineOffline(){
if(offlineFeaturesManager.getOnlineStatus() == offlineFeaturesManager.ONLINE){
goOffline();
}
else{
goOnline();
}
}
function setUIOnline(){
btnOnlineOffline.innerHTML = "2. Go Offline";
imgOfflineIndicator.className = "glyphicon glyphicon-link";
imgOfflineIndicator.innerHTML = " Up";
btnState.className = "btn btn-success btn-large floatRight";
}
function setUIOffline(){
btnOnlineOffline.innerHTML = "2. Go Online";
imgOfflineIndicator.className = "glyphicon glyphicon-thumbs-down";
imgOfflineIndicator.innerHTML = " Down";
btnState.className = "btn btn-danger btn-large floatRight";
}
/**
* For internal use - detecting amount of storage used and number of tiles stored.
*/
function updateOfflineUsage()
{
tileLayer.offline.store.usedSpace(function(result,err){
if(result != null){
console.log( "DB Tile count: " + result.tileCount + ", DB Bytes: " + result.sizeBytes);
}
else{
console.log("DB Tile count: " + count + ", DB Bytes: Error");
}
})
}
/**
* Forces a check of the Offline.js state
*/
function forceInternalOfflineCheck(){
Offline.check();
if(Offline.state == "up"){
goOnline();
}
if(Offline.state == "down"){
goOffline();
}
}
/**
* Attempts a manual http request to verify if app is online or offline.
* Use this in conjunction with the offline checker library: offline.min.js
* @param callback
*/
function verifyOnline(callback){
var req = new XMLHttpRequest();
req.open("GET", "http://esri.github.io/offline-editor-js/samples/images/blue-pin.png?" + (Math.floor(Math.random() * 1000000000)), true);
req.onload = function()
{
if( req.status === 200 && req.responseText !== "")
{
callback(true);
}
else
{
console.log("verifyOffline failed");
callback(false);
}
};
req.onerror = function(e)
{
console.log("appcache-features.html verifyOnline failed: " + e);
callback(false);
};
req.send(null);
}
/**
* ***********************************************
* OFFLINE FEATURE MANAGER - EVENT MANAGEMENT CODE
* ***********************************************å
*/
function editsEnqueued(){
busStopFeatureLayer.pendingEditsCount(function(count){
pendingEdits.innerHTML = count;
});
}
function allEditsSent(){
busStopFeatureLayer.pendingEditsCount(function(count){
pendingEdits.innerHTML = count;
});
}
function editsError(evt){
alert("There was a problem. Not all edits were synced with the server. " + JSON.stringify(evt));
}
function updateStatus(){
busStopFeatureLayer.pendingEditsCount(function(count){
pendingEdits.innerHTML = count;
});
}
function updatePhantomGraphicsLayer(){
var phantomLocalGraphics = localStorage.offlinePhantomGraphics;
if(phantomLocalGraphics){
var graphics = JSON.parse(phantomLocalGraphics);
busStopFeatureLayer.setPhantomLayerGraphics(graphics);
}
}
});
</script>
<!-- Bootstrap core JavaScript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="https://code.jquery.com/jquery-2.1.1.min.js"></script>
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
</body>
</html>