ElevationProfiler-Widget

Features

An ArcGIS for JavaScript API widget to simplify the use and deployment of the existing ESRI Elevation Profile widget.

Quickstart

// This sample code is setup to have the ElevationProfiler contained in a Dojo FloatingPane.  The widget is created the first time a button is clicked, and the results dialog is shown/hidden when the main button is clicked.
var elevationProfiler = null;

// When the ElevationProfilerWindow is shown
on(buttonController, "showElevationProfilerWindow", function()
{
    // If the widget hasn't been built yet
    if (elevationProfiler == null)
    {
        // ElevationProfiler widget
        elevationProfiler = new ElevationProfiler({
            map: mainMap,
            profileTaskUrl: url_elevation
            }, "ElevationProfilerWindow");
        elevationProfiler.startup();
        
        // When the ElevationProfilerWindow is hidden
        on(buttonController, "hideElevationProfilerWindow", function()
        {
            elevationProfiler.hideResults();
        });
        
    }
    
    // Show the results window
    elevationProfiler.showResults();
});

Requirements

Notepad or HTML editor
A little background with JavaScript
Experience with the ArcGIS API for JavaScript would help.

Setup

Set your dojo config to load the module.

var package_path = window.location.pathname.substring(0, window.location.pathname.lastIndexOf('/'));
var dojoConfig = {
    // The locationPath logic below may look confusing but all its doing is
    // enabling us to load the api from a CDN and load local modules from the correct location.
    packages: [{
        name: "application",
        location: package_path + '/js'
    }]
};

Require module

Include the module for the ElevationProfiler widget.

require(["application/ElevationProfiler", ... ], function(ElevationProfiler, ... ){ ... });

Constructor

ElevationProfiler(options, srcNode);

Options (Object)

property	required	type	value	description
map	x	Map	null	ArcGIS JS Map.
profileTaskUrl	x	string		The URL to the elevation profile service.
theme		string	elevationProfilerWidget	CSS Class for uniquely styling the widget.

Methods

startup

startup(): Start the widget. Map object must be loaded first.

Issues

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

Contributing

Anyone and everyone is welcome to contribute.

Licensing

The MIT License (MIT)

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

JoeGIS/ElevationProfiler-Widget