Create and save a map as a web map item to an ArcGIS portal.
Use case
Maps can be created programmatically in code and then serialized and saved as an ArcGIS portal item. In this case, the portal item is a web map which can be shared with others and opened in various applications and APIs throughout the platform, such as ArcGIS Pro, ArcGIS Online, the JavaScript API, Collector, and Explorer.
How to use the sample
When you run the sample, you will be challenged for an ArcGIS Online login. Enter a username and password for an ArcGIS Online named user account (such as your ArcGIS for Developers account). Then, choose the basemap and layers for your new map. To save the map, add a title, tags, description (optional), and a folder on your portal (you will need to create one in your portal's My Content section if you don't already have one). Tap the Save button to save the map to the chosen folder.
How it works
- Set a
DefaultAuthenticationChallengeHandlerto the app'sAuthenticationManager. - Create a new
Portaland load it to invoke the authentication challenge. - Access the
PortalUserContentwithportal.getUser().fetchContentAsync().get(), to get the user's list of portal folders withportalUserContent.getFolders(). - Create an
ArcGISMapwith aBasemapStyleand a few operational layers. - Call
map.saveMapAsAsync()to save a newArcGISMapwith the specified title, tags, and folder to the portal.
Relevant API
- ArcGISMap
- Portal
Additional information
In this sample, an API key is set directly on Basemap objects rather than on the whole app using the ArcGISRuntimeEnvironment class. This is useful in a scenario where an individual developer is part of an organization within ArcGIS Online that uses an API key to access a range of BasemapStyles. In the case that an individual member of the organization wants to save a map locally to their account, and not that of the organization, they can set the organization's API key on the basemap, and log in to their own account when challenged. The individual can then save the final map to their own ArcGIS Online account.
Tags
ArcGIS Online, ArcGIS Pro, portal, publish, share, web map
Sample Code
MainActivity.java
/* Copyright 2016 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.
*
*/
package com.esri.arcgisruntime.sample.createandsavemap;
import android.content.DialogInterface;
import android.content.res.Configuration;
import android.os.Bundle;
import android.util.Log;
import android.view.LayoutInflater;
import android.view.Menu;
import android.view.MenuItem;
import android.view.View;
import android.widget.ArrayAdapter;
import android.widget.Button;
import android.widget.EditText;
import android.widget.ListView;
import android.widget.Spinner;
import android.widget.Toast;
import androidx.appcompat.app.ActionBarDrawerToggle;
import androidx.appcompat.app.AlertDialog;
import androidx.appcompat.app.AppCompatActivity;
import androidx.core.view.GravityCompat;
import androidx.drawerlayout.widget.DrawerLayout;
import com.esri.arcgisruntime.concurrent.ListenableFuture;
import com.esri.arcgisruntime.layers.ArcGISMapImageLayer;
import com.esri.arcgisruntime.layers.ArcGISTiledLayer;
import com.esri.arcgisruntime.loadable.LoadStatus;
import com.esri.arcgisruntime.mapping.ArcGISMap;
import com.esri.arcgisruntime.mapping.Basemap;
import com.esri.arcgisruntime.mapping.BasemapStyle;
import com.esri.arcgisruntime.mapping.Viewpoint;
import com.esri.arcgisruntime.mapping.view.MapView;
import com.esri.arcgisruntime.portal.Portal;
import com.esri.arcgisruntime.portal.PortalFolder;
import com.esri.arcgisruntime.portal.PortalItem;
import com.esri.arcgisruntime.portal.PortalUserContent;
import com.esri.arcgisruntime.security.AuthenticationChallengeHandler;
import com.esri.arcgisruntime.security.AuthenticationManager;
import com.esri.arcgisruntime.security.DefaultAuthenticationChallengeHandler;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;
public class MainActivity extends AppCompatActivity {
private static final String TAG = MainActivity.class.getSimpleName();
private MapView mMapView;
// objects that implement Loadable must be class fields to prevent being garbage collected before loading
private Portal mPortal;
private List<PortalFolder> mPortalFolders;
private DrawerLayout mDrawerLayout;
private ListView mBasemapListView;
private ListView mLayerListView;
private CharSequence mDrawerTitle;
private ActionBarDrawerToggle mDrawerToggle;
private Spinner mFolderSpinner;
@Override
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
setContentView(R.layout.activity_drawer);
// set up an authentication handler to take credentials for access to arcgis.com
AuthenticationChallengeHandler handler = new DefaultAuthenticationChallengeHandler(this);
AuthenticationManager.setAuthenticationChallengeHandler(handler);
mDrawerTitle = getTitle();
// inflate MapView from layout
mMapView = findViewById(R.id.mapView);
// create a map with Topographic Basemap
Basemap streetsBasemap = new Basemap(BasemapStyle.ARCGIS_STREETS);
ArcGISMap map = new ArcGISMap(streetsBasemap);
map.addDoneLoadingListener(() -> {
if (map.getLoadStatus() != LoadStatus.LOADED) {
String error = "Error loading map: " + map.getLoadError().getCause().getMessage();
Toast.makeText(this, error, Toast.LENGTH_SHORT).show();
Log.e(TAG, error);
}
});
// set the map to be displayed in this view
mMapView.setMap(map);
mMapView.setViewpoint(new Viewpoint(48.354388, -99.998245, 100000000));
// inflate the Basemap and Layer list views
mBasemapListView = findViewById(R.id.basemap_list);
mLayerListView = findViewById(R.id.layer_list);
mDrawerLayout = findViewById(R.id.drawer_layout);
ArcGISTiledLayer tiledLayer = new ArcGISTiledLayer(
"https://sampleserver6.arcgisonline.com/arcgis/rest/services/WorldTimeZones/MapServer");
ArcGISMapImageLayer mapImageLayer = new ArcGISMapImageLayer(
"https://sampleserver6.arcgisonline.com/arcgis/rest/services/Census/MapServer");
// create base map array and set it to a list view adapter
String[] basemapTiles = getResources().getStringArray(R.array.basemap_array);
mBasemapListView
.setAdapter(new ArrayAdapter<>(this, android.R.layout.simple_list_item_single_choice,
basemapTiles));
mBasemapListView.setItemChecked(0, true);
// create operation layers array and set it to a list view adapter
String[] operationalLayerTiles = getResources().getStringArray(R.array.operational_layer_array);
mLayerListView
.setAdapter(new ArrayAdapter<>(this, android.R.layout.simple_list_item_multiple_choice,
operationalLayerTiles));
// creates a drawer to handle display of layers on the map
createDrawer(tiledLayer, mapImageLayer);
getSupportActionBar().setDisplayHomeAsUpEnabled(true);
getSupportActionBar().setHomeButtonEnabled(true);
}
/**
* Creates a drawer to handle display of layers on the map.
*
* @param tiledLayer to display on the map
* @param mapImageLayer to display on the map
*/
private void createDrawer(ArcGISTiledLayer tiledLayer, ArcGISMapImageLayer mapImageLayer) {
ArcGISMap map = mMapView.getMap();
// set actions for drawer state - close/open
mDrawerToggle = new ActionBarDrawerToggle(this, mDrawerLayout, R.string.app_name,
R.string.app_name) {
// if the drawer is closed, get the checked items from LayerListView and add the checked layer
@Override
public void onDrawerClosed(View view) {
getSupportActionBar().setTitle(getTitle());
map.addDoneLoadingListener(() -> {
if (map.getLoadStatus() == LoadStatus.LOADED) {
// if both items are checked, add them
if (mLayerListView.getCheckedItemCount() > 1) {
map.getOperationalLayers().clear();
map.getOperationalLayers().add(tiledLayer);
map.getOperationalLayers().add(mapImageLayer);
} else { // if any one item is checked, add as layer
if (mLayerListView.isItemChecked(0)) {
map.getOperationalLayers().clear();
map.getOperationalLayers().add(tiledLayer);
} else if (mLayerListView.isItemChecked(1)) {
map.getOperationalLayers().clear();
map.getOperationalLayers().add(mapImageLayer);
} else {
map.getOperationalLayers().clear();
}
}
}
});
invalidateOptionsMenu();
}
@Override
public void onDrawerOpened(View drawerView) {
getSupportActionBar().setTitle(mDrawerTitle);
// calling onPrepareOptionsMenu() to hide action bar icons
invalidateOptionsMenu();
}
};
// handle clicks in the drawer
mBasemapListView.setOnItemClickListener((parent, view, position, id) -> {
mMapView.getMap().getOperationalLayers().clear();
switch (position) {
case 0:
mMapView.getMap().setBasemap(new Basemap(BasemapStyle.ARCGIS_STREETS));
break;
case 1:
mMapView.getMap().setBasemap(new Basemap(BasemapStyle.ARCGIS_IMAGERY));
break;
case 2:
mMapView.getMap().setBasemap(new Basemap(BasemapStyle.ARCGIS_TOPOGRAPHIC));
break;
case 3:
mMapView.getMap().setBasemap(new Basemap(BasemapStyle.ARCGIS_OCEANS));
break;
default:
Toast.makeText(this, R.string.unsupported_option, Toast.LENGTH_SHORT).show();
}
});
mDrawerToggle.setDrawerIndicatorEnabled(true);
mDrawerLayout.addDrawerListener(mDrawerToggle);
}
/**
* Shows the save map dialog allowing the user to enter title, tags, description and folder for
* saving of their map.
*/
private void showSaveMapDialog() {
// inflate save map dialog layout
LayoutInflater inflater = LayoutInflater.from(this);
View saveMapDialogView = inflater.inflate(R.layout.save_map_dialog, null, false);
// get references to edit text views
EditText titleEditText = saveMapDialogView.findViewById(R.id.titleEditText);
EditText tagsEditText = saveMapDialogView.findViewById(R.id.tagsEditText);
EditText descriptionEditText = saveMapDialogView.findViewById(R.id.descriptionEditText);
mFolderSpinner = saveMapDialogView.findViewById(R.id.folderSpinner);
// create a portal to arcgis
mPortal = new Portal("https://www.arcgis.com", true);
mPortal.addDoneLoadingListener(() -> {
if (mPortal.getLoadStatus() == LoadStatus.LOADED) {
try {
// get the users list of portal folders
PortalUserContent portalUserContent = mPortal.getUser().fetchContentAsync().get();
mPortalFolders = portalUserContent.getFolders();
// get a list of the user's portal folder titles
List<String> portalFolderTitles = new ArrayList<>();
portalFolderTitles.add("No Folder");
for (PortalFolder portalFolder : mPortalFolders) {
portalFolderTitles.add(portalFolder.getTitle());
}
// add the list of portal folder titles to a spinner
ArrayAdapter<String> adapter = new ArrayAdapter<>(this,
android.R.layout.simple_spinner_item, portalFolderTitles);
adapter.setDropDownViewResource(android.R.layout.simple_spinner_dropdown_item);
mFolderSpinner.setAdapter(adapter);
} catch (Exception e) {
String error = "Error fetching content from portal item: " + e.getCause().getMessage();
Toast.makeText(this, error, Toast.LENGTH_LONG).show();
Log.e(TAG, error);
}
}
});
mPortal.loadAsync();
// build the dialog
AlertDialog saveMapDialog = new AlertDialog.Builder(this)
.setView(saveMapDialogView)
.setPositiveButton(R.string.save_map, null)
.setNegativeButton(R.string.cancel, null)
.show();
// click handling for the save map button
Button saveMapButton = saveMapDialog.getButton(DialogInterface.BUTTON_POSITIVE);
saveMapButton.setOnClickListener(v -> {
Iterable<String> tags = Arrays.asList(tagsEditText.getText().toString().split(","));
// make sure the title edit text view has text
if (titleEditText.getText().length() > 0) {
// check if a folder was selected
if (mFolderSpinner.getSelectedItemPosition() <= 0) {
// if no folder was selected, just pass null for portalFolder argument
saveMap(titleEditText.getText().toString(), tags,
descriptionEditText.getText().toString(), null);
} else {
// call save map passing in title, tags, description and portal
saveMap(titleEditText.getText().toString(), tags,
descriptionEditText.getText().toString(),
mPortalFolders.get(mFolderSpinner.getSelectedItemPosition() - 1));
}
saveMapDialog.dismiss();
} else {
Toast.makeText(this, "A title is required to save your map.", Toast.LENGTH_LONG).show();
}
});
// click handling for the cancel button
Button cancelButton = saveMapDialog.getButton(DialogInterface.BUTTON_NEGATIVE);
cancelButton.setOnClickListener(v -> saveMapDialog.dismiss());
}
/**
* Save the map to that portal.
*
* @param title of the map
* @param tags related to the map
* @param description of the map
* @param portalFolder where the map should be saved
*/
private void saveMap(String title, Iterable<String> tags, String description,
PortalFolder portalFolder) {
// call save as async and pass portal info, as well as details of the map including title, tags and description
ListenableFuture<PortalItem> saveAsAsyncFuture = mMapView.getMap()
.saveAsAsync(mPortal, portalFolder, title, tags, description, null, true);
saveAsAsyncFuture.addDoneListener(
() -> Toast.makeText(this, "Map saved to portal!", Toast.LENGTH_LONG).show());
}
@Override
public boolean onCreateOptionsMenu(Menu menu) {
getMenuInflater().inflate(R.menu.menu_main, menu);
return true;
}
@Override
public boolean onOptionsItemSelected(MenuItem item) {
if (item.getItemId() == R.id.action_save) {
showSaveMapDialog();
}
return mDrawerToggle.onOptionsItemSelected(item) || super.onOptionsItemSelected(item);
}
/***
* Called when invalidateOptionsMenu() is triggered
*/
@Override
public boolean onPrepareOptionsMenu(Menu menu) {
// if nav drawer is opened, hide the action items
menu.findItem(R.id.action_save).setVisible(!mDrawerLayout.isDrawerOpen(GravityCompat.START));
return super.onPrepareOptionsMenu(menu);
}
@Override
public void setTitle(CharSequence title) {
getActionBar().setTitle(title);
}
/**
* Sync the state of the drawer toggle
*/
@Override
protected void onPostCreate(Bundle savedInstanceState) {
super.onPostCreate(savedInstanceState);
// Sync the toggle state after onRestoreInstanceState has occurred.
mDrawerToggle.syncState();
}
@Override
public void onConfigurationChanged(Configuration newConfig) {
super.onConfigurationChanged(newConfig);
// Pass any configuration change to the drawer toggle
mDrawerToggle.onConfigurationChanged(newConfig);
}
@Override
protected void onPause() {
mMapView.pause();
super.onPause();
}
@Override
protected void onResume() {
super.onResume();
mMapView.resume();
}
@Override
protected void onDestroy() {
mMapView.dispose();
super.onDestroy();
}
}