/maritimechartservice-sample-viewer

JavaScript example illustrating how to use the Maritime Chart Service functionality provided by ArcGIS for Maritime: Server.

Primary LanguageJavaScriptApache License 2.0Apache-2.0

Maritime Chart Service sample viewer

(Web App Builder widgets)

The Maritime Chart Service widgets are widgets and dojo classes that illustrate how web applications can consume and interact with the Maritime Chart Service exposed by the ArcGIS for Maritime: Server product. The widgets can be used directly within Web App Builder for ArcGIS. Alternatively, the source code for these widgets is available here for reuse/modification and to integrate it within custom web apps outside of the Web App Builder for ArcGIS framework.

App

Sections

Features

These Web App Builder widgets illustrates how to build web apps consuming S-57 web services published from ArcGIS for Maritime: Server in a JavaScript web app.

  • Allows users to change S-52 based display settings through the JavaScrip client
  • Enables users to identify on individual features and view their attribute information.
  • Provides the ability to search based on object name (OBJNAM) and S-57 dataset names. (functionality coming soon)

The Widget Repository currently includes:

###Maritime Chart Service Library

This is a library of custom Esri widgets and custom layer classes that extend Esri's JSAPI in order to consume the Maritime Chart Service in apps.

###Web App Builder Widgets

The following are custom Web App Builder widgets that use the maritime chart service library above and are to be used within the Web App Builder to create custom apps, templates and themes.

  • Maritime Display Properties
  • Maritime Identify
  • Maritime Search (functionality coming soon)

Requirements

  • Web App Builder for ArcGIS (Developer Edition) 1.1 or greater for the Web App builder widgets.
  • Maritime Chart Service widgets require JS API 3.11 or less.
  • ArcGIS for Maritime Server 10.3.1

Deployment

Adding Widgets to you Web AppBuilder Environment:

  1. If you haven't already, download the latest version of Web AppBuilder for ArcGIS (Developer Edition) and follow the instruction at https://developers.arcgis.com/web-appbuilder/guide/getstarted.htm
  2. Download the Maritime Chart Service widgets by clicking on Download Zip.
  3. To use the widgets, copy the ones you want to use to the Web App Builder widget directory.
  • Copy the contents of the src\widgets\ folder to %webappbuilder_install%\client\stemapp\widgets\
  1. The Web App Builder widgets depend on the modules in the libs folder.
  • Copy the contents of src\libs\ folder to <webappbuilder folder>\client\stemapp\libs\
  1. The Identify widget is an off-panel web app builder widget.
  • Copy the file src\config.json to the <webappbuilder folder>\client\stemapp\predefined-apps\default\ folder (replace the config.json file there).
  1. The Identify widget only supports JSAPI 3.11 and below.
  • Copy the file src\env.js to the <webappbuilder folder>\client\stemapp\ folder (replace the env.js file there).
  1. This example uses dojo bootstrap for the Display Settings widget.
  • Copy the file src\init.js to the <webappbuilder folder>\client\stemapp\ folder (replace the init.js file there).

Deploying your Web Application:

These steps address a known limit with our support for JSAPI 3.11 when deploying your app on a web server.

  1. See Deploy app for additional information https://developers.arcgis.com/web-appbuilder/guide/xt-deploy-app.htm
  2. After you have downloaded your app you must update your env.js file with the correct JSAPI reference.
  3. Search your env.js file for 3.13 and replace it with 3.11.
  4. Save your changes.
  5. Your app is ready to be deployed on your web server.

General Help

New to Github? Get started here.

For more resources on developing and modifying widgets please visit Web App Builder for ArcGIS (Developer Edition) documentation

Resources

Issues

  • Find a bug or want to request a new feature? Please let us know by submitting an issue.

Contributing

Esri welcomes contributions from anyone and everyone. Please see our guidelines for contributing.

If you are using JS Hint there is a .jshintrc file included in the root folder which enforces this style. We allow for 120 characters per line instead of the highly restrictive 80.

Licensing

Copyright 2015 Esri

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

A copy of the license is available in the repository's license.txt file.

[](Esri Tags: maritime maritimechartservice webappbuilder) [](Esri Language: Javascript)