View on GitHub Sample viewer app

Take a screenshot of the map.

Image of take screenshot

Use case

GIS users may want to export or save a screenshot of a map to enable sharing as an image or printing.

How to use the sample

Pan and zoom to find an interesting location, then use the button to take a screenshot. The screenshot will be displayed. You can share the screenshot by tapping the share button. Or save it by tapping the save button.

How it works

  1. Wait for the MapView to finish drawing.
  2. Call exportImage() to get a BitmapDrawable.
  3. Save screenshot into a File using FileOutputStream.
  4. Share the file using context.startActivity.
  5. Save the file using context.contentResolver.

Relevant API

  • MapView

Tags

capture, export, image, print, screen capture, screenshot, share, shot

Sample Code

MainActivity.kt MainActivity.kt TakeScreenshotViewModel.kt TakeScreenshotScreen.kt
/* Copyright 2025 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.arcgismaps.sample.takescreenshot
import android.os.Bundle
import androidx.activity.ComponentActivity
import androidx.activity.compose.setContent
import androidx.activity.enableEdgeToEdge
import androidx.compose.material3.MaterialTheme
import androidx.compose.material3.Surface
import androidx.compose.runtime.Composable
import com.arcgismaps.ApiKey
import com.arcgismaps.ArcGISEnvironment
import com.esri.arcgismaps.sample.sampleslib.theme.SampleAppTheme
import com.esri.arcgismaps.sample.takescreenshot.screens.TakeScreenshotScreen
class MainActivity : ComponentActivity() {
override fun onCreate(savedInstanceState: Bundle?) {
super.onCreate(savedInstanceState)
// authentication with an API key or named user is
// required to access basemaps and other location services
ArcGISEnvironment.apiKey = ApiKey.create(BuildConfig.ACCESS_TOKEN)
enableEdgeToEdge()
setContent {
SampleAppTheme {
TakeScreenshotApp()
}
}
}
@Composable
private fun TakeScreenshotApp() {
Surface(color = MaterialTheme.colorScheme.background) {
TakeScreenshotScreen(
sampleName = getString(R.string.take_screenshot_app_name)
)
}
}
}