Skip to content

Commit

Permalink
Merge pull request #259 from andygup/get_started
Browse files Browse the repository at this point in the history
v2.3
  • Loading branch information
andygup committed Oct 13, 2014
2 parents 1057ebd + 1039a76 commit 4b42df2
Show file tree
Hide file tree
Showing 46 changed files with 9,373 additions and 1,380 deletions.
17 changes: 17 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,22 @@
# offline-editor-js - Changelog

## Version 2.3 - Oct 13, 2014
- Closes #74 - Build sample with nice UX for editing
- Closes #257 - Build getting started pages for AGOL, editing and TPK. All samples show basic functionality and are responsive. Also integrated a new launch page for the API and How To Use docs.
- Closes #258 - Convert modal popup to widget
- The following samples were updated to be responsive:
- appcache-features.html
- appcache-tiles.html
- tpk-layer.html

New functionality:

- Closes #256 - Add getMaxZoom and getMinZoom to offlineTilesEnabler
- Added getMinMaxLOD() to offlineTilesEnabler and OfflineTilesEnablerLayer

Breaking Changes - None.


## Version 2.2.1 - Oct 1, 2014
Added a Getting Started for Tiles tutorial.

Expand Down
48 changes: 7 additions & 41 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,17 +3,17 @@ offline-editor-js

Offline-editor-js is a set of JavaScript libraries for using the ArcGIS API for JavaScript offline. It offers both lightweight editing and tile management capabilities while offline or intermittently offline. It's a work-in-progress so if you have suggestions open an issue or if you want to make a pull request we welcome your proposed modifications.

Online samples and tutorials are available here: [http://esri.github.io/offline-editor-js/demo/](http://esri.github.io/offline-editor-js/demo/)
Online samples and getting started tutorials are available here: **[http://esri.github.io/offline-editor-js/demo/](http://esri.github.io/offline-editor-js/demo/)**

*IMPORTANT:* If you need a fully integrated robust offline solution then you should be using our ArcGIS Runtime SDKs for .NET, WPF, Java, iOS, Android and Qt.

This repo contains the following libraries:

- `/dist`:
* `offline-edit-min.js` - _(replaces v1.x of OfflineFeaturesManager.js)_ stores adds, updates and deletes of features as well as limited attachment support while offline. Resync's edits with server once connection is reestablished.
* `offline-tiles-basic-min.js` - _(replaces v1.x of offlineTilesEnabler.js)_ caches map tiles for partial offline use cases. Use this library with ArcGIS Online Web maps as well as with tiled map services. This repo will not work with browser restarts or reloads while offline.
* `offline-tiles-advanced-min.js` - _(replaces v1.x of OfflineTilesEnablerLayer.js)_ Extends any ArcGIS Tiled Map Service that has a requirement for offline browser reload and/or restart. This library should be used in conjunction with an HTML5 application cache coding pattern.
* `offline-tpk-min.js` - _(replaces v1.x of TPKLayer.js)_ parses a TPK file and displays it as a tiled map layer.
* `offline-edit-min.js` - stores adds, updates and deletes of features as well as limited attachment support while offline. Resync's edits with server once connection is reestablished.
* `offline-tiles-basic-min.js` - caches map tiles for partial offline use cases. Use this library with ArcGIS Online Web maps as well as with tiled map services. This repo will not work with browser restarts or reloads while offline.
* `offline-tiles-advanced-min.js` - Extends any ArcGIS Tiled Map Service that has a requirement for offline browser reload and/or restart. This library should be used in conjunction with an HTML5 application cache coding pattern.
* `offline-tpk-min.js` - parses a TPK file and displays it as a tiled map layer.
- `/utils`: contains various helper library modules. These modules are all AMD compliant.
- `/samples`: samples that show how to use the different offline libraries capabilities.

Expand All @@ -33,31 +33,9 @@ Using an [application manifest](https://developer.mozilla.org/en-US/docs/HTML/Us
__Attachment Support__: Attachments are supported with some limitations. See documentation [here](./doc/attachments.md)


#API Doc
#API and How To Use Docs

##Offline Editing of Geographic Features
Extends and overrides an ArcGIS Feature Layer. This library allows you to extend esri.layers.FeatureLayer with offline capabilities and to manage the resync process.

* __Click [here](doc/offlinefeaturesmanager.md) to see the full API doc for `offline-edit-min.js`__


##Offline Mapping Tiles
Extends and overrides a tiled map service. Provides the ability to customize the extent used to cut the tiles. See the detailed description of basemap.prepareForOffline() in the "How To Use" section to learn different options.

* __Click [here](doc/offlinetilesenabler.md) to see the full API doc for `offline-tiles-basic-min.js and offline-tiles-advanced-min.js`__

##TPKLayer

You can display TPK files with this library. TPK's are binary tile package files. Extends TileMapServiceLayer. Go [here](http://resources.arcgis.com/en/help/main/10.1/index.html#//00170000017w000000) for more information on how to create a TPK file.

* __Click [here](doc/tpklayer.md) to see the full API doc for `offline-tpk-min.js`__

##How to use

* [Learn more about using the `tile` library](doc/howtousetiles.md)
* [Learn more about using the `edit` library](doc/howtouseeditlibrary.md)
* [Learn more about using the `tpk` library](doc/howtousetpklibrary.md)
* [Learn more about using an application cache with this library](doc/howtouseappcache.md)
Go __[here](demo/api-doc.html)__ to get links to the API docs and How to use docs.


## Migrating from v1 to v2
Expand All @@ -76,18 +54,6 @@ If you are migrating your v1 code to v2 then go [here](doc/migratefromv1tov2.md)
1. From the root directory run `npm install`
2. Run `Grunt build`. If there are no errors, the minimized _(min)_ and source _(src)_ versions of the libraries will be output to `\dist`


##Samples

* `appcache-features.html` - shows how to work with the application manifest, tiles and features. This sample works with browser reloads and restarts.
* `appcache-tiles.html` - shows how to work with the application manifest and map tiles. This sample works with browser reloads and restarts.
* `attachments-editor.html` - demonstrates how to work with this library using feature attachments.
* `draw-pointlinepoly-offline.html` shows working with points, lines and polygons locally.
* `tpklayer.html` - shows how to work with TPK files.
* `tiles-indexed-db.html` - shows how to work with storing tiles locally.
* `Gruntfile.js` - a node.js app and its associated `package.json` file to help with creating an application manifest file.


##Dependencies

* ArcGIS API for JavaScript (v3.8+)
Expand Down
167 changes: 167 additions & 0 deletions demo/api-doc.html
Original file line number Diff line number Diff line change
@@ -0,0 +1,167 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1">
<!--<link rel="shortcut icon" href="../images/favicon.ico">-->

<title>Offline-editor-js</title>

<!-- Bootstrap core CSS -->
<link href="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/css/bootstrap.min.css" rel="stylesheet">

<link rel="stylesheet" href="http://js.arcgis.com/3.10/js/esri/css/esri.css">
<link rel="stylesheet" type="text/css" href="http://esri.github.io/bootstrap-map-js/src/css/bootstrapmap.css">

<!-- Custom styles for this template -->
<link href="css/style.css" rel="stylesheet">

<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->

<style>

#mapDiv {
min-height: 300px;
max-height: 1000px;
}

pre {
overflow: auto;
word-wrap: normal;
white-space: pre;
font-family: Courier,"Courier New";
font-size: 13px;
background-color: #fee9cc;
}

pre.prettyprint {
border: 1px solid #cccccc !important;
}

#img-offline-indicator {
padding: 8px;
position: relative; float: right;
}
</style>
</head>

<body>

<a class="hidden-xs" href="https://github.com/Esri/offline-editor-js">
<img style="position: absolute; top: 50; right: 0; border: 0; width:150px;" src="https://s3.amazonaws.com/github/ribbons/forkme_right_green_007200.png" alt="Fork me on GitHub">
</a>

<header id="header"></header>

<!-- Main jumbotron for a primary marketing message or call to action -->
<div class="jumbotron">
<div class="container">
<h1>API Docs</h1>
<p>Documentation for the <i>offline-editor-js</i> JavaScript libraries.</p>
</div>
</div>

<div class="container">
<!-- Example row of columns -->
<div class="row">
<div class="col-sm-12 col-md-12 col-lg-12">

<div class="panel panel-default">
<div class="panel-heading">
<h3>Offline Tiles - Basic</h3>
<p>The <i>offline-tiles-basic-min.js</i> library is for use with ArcGIS.com web maps and partial/intermittently offline use cases.
You won't be able to restart or reload your app when using this library offline.
</p>
</div>
<div class="panel-body">
<ul>
<li>
<a href="../doc/offlinetilesenabler.md">O.esri.Tiles.OfflineTilesEnabler</a>
</li>
<li>
<a href="../doc/howtousetiles.md">How to use.</a>
</li>
</ul>
</div>
</div>

<div class="panel panel-default">
<div class="panel-heading">
<h3>Offline Tiles - Advanced</h3>
<p>The <i>offline-tiles-advanced-min.js</i> library is for use with tiled map services in partial or fully offline use cases.
If you have a requirement to reload or restart your app while offline you should use this library.
</p>
</div>
<div class="panel-body">
<ul>
<li>
<a href="../doc/offlinetilesenablerlayer.md">O.esri.Tiles.OfflineTilesEnablerLayer</a>
</li>
<li>
<a href="../doc/howtousetiles.md">How to use.</a>
</li>
</ul>
</div>
</div>

<div class="panel panel-default">
<div class="panel-heading">
<h3>Offline Features</h3>
<p>The <i>offline-edit-min.js</i> library is for working with ArcGIS JS API points, lines and polygons in partial or fully offline use cases.
</p>
</div>
<div class="panel-body">
<ul>
<li>
<a href="../doc/offlinefeaturesmanager.md">O.esri.Edit.OfflineFeaturesManager</a>
</li>
<li>
<a href="../doc/howtouseeditlibrary.md">How to use.</a>
</li>
</ul>
</div>
</div>

<div class="panel panel-default">
<div class="panel-heading">
<h3>Offline TPK</h3>
<p>The <i>offline-tpk-min.js</i> library is for working with TPK files in partial or fully offline use cases.
TPK files are binary tile image packages. They can be used stand-alone or alongside tiled base maps.
</p>
</div>
<div class="panel-body">
<ul>
<li>
<a href="../doc/tpklayer.md">O.esri.TPK.TPKLayer</a>
</li>
<li>
<a href="../doc/howtousetpklibrary.md">How to use.</a>
</li>
</ul>
</div>
</div>

</div><!-- class="col-sm-12 col-md-12 col-lg-12" -->
<hr>
</div> <!-- /container -->
<script src="https://ajax.googleapis.com/ajax/libs/jquery/1.11.1/jquery.min.js"></script>
<script>

$(document).ready(function() {
$("#header").load("../demo/header.html");
});
</script>

<!-- Bootstrap core JavaScript
================================================== -->
<!-- Placed at the end of the document so the pages load faster -->
<script src="//maxcdn.bootstrapcdn.com/bootstrap/3.2.0/js/bootstrap.min.js"></script>
<!-- add syntax highlighting to code snippts -->
<script src="https://google-code-prettify.googlecode.com/svn/loader/run_prettify.js"></script>
</body>
</html>
Loading

0 comments on commit 4b42df2

Please sign in to comment.