ArcGIS for Desktop

  • Documentation
  • Pricing
  • Support

  • My Profile
  • Help
  • Sign Out
ArcGIS for Desktop

ArcGIS Online

The mapping platform for your organization

ArcGIS for Desktop

A complete professional GIS

ArcGIS for Server

GIS in your enterprise

ArcGIS for Developers

Tools to build location-aware apps

ArcGIS Solutions

Free template maps and apps for your industry

ArcGIS Marketplace

Get apps and data for your organization

  • Documentation
  • Pricing
  • Support
Esri
  • Sign In
user
  • My Profile
  • Sign Out

Help

  • Home
  • Get Started
  • Map
  • Analyze
  • Manage Data
  • Tools
  • More...

Manage Tile Cache

  • Summary
  • Usage
  • Syntax
  • Code sample
  • Environments
  • Licensing information

Summary

Creates a tile cache or updates tiles in an existing tile cache. You can use this tool to create new tiles, replace missing tiles, overwrite outdated tiles, and delete tiles.

Usage

  • The Input Data Source can be a map; however, the document cannot contain a map service or an image service.

  • To create cache in a custom tiling scheme, make sure you have a tiling scheme defined for your source dataset before using this tool. You can use the Generate Tile Cache Tiling Scheme tool to create the tiling scheme.

  • To create a cache in ArcGIS Online Tiling Scheme, specify ARCGISONLINE_SCHEME for the Input Tiling Scheme parameter.

  • This tool may take a long time to run for caches that cover a large geographic extent or very large scales. If the tool is canceled, tile creation is stopped, but the existing tiles are not deleted. This means you can cancel the tool at any time, and if you rerun it later on the same cache and specify RECREATE_EMPTY_TILES for the Manage Mode parameter, it will continue from where it left off.

  • This tool supports the Parallel Processing environment setting.

Syntax

ManageTileCache_management (in_cache_location, manage_mode, {in_cache_name}, {in_datasource}, {tiling_scheme}, {import_tiling_scheme}, {scales}, {area_of_interest}, {max_cell_size}, {min_cached_scale}, {max_cached_scale})
ParameterExplanationData Type
in_cache_location

The folder in which the cache dataset is created or the path to an existing tile cache.

Folder; Raster Layer
manage_mode

The mode for managing the cache.

  • RECREATE_ALL_TILES —Existing tiles will be replaced and new tiles will be added if the extent has changed or if layers have been added to a multilayer cache.
  • RECREATE_EMPTY_TILES —Only tiles that are empty will be created. Existing tiles will be left unchanged.
  • DELETE_TILES —Tiles will be deleted from the cache. The cache folder structure will not be deleted.
String
in_cache_name
(Optional)

Name of the cache dataset to be created inside the cache location.

String
in_datasource
(Optional)

A raster dataset, mosaic dataset, or a map document.

This parameter is not required when DELETE_TILES is specified in the manage_mode parameter.

An ArcMap document (.mxd) cannot contain a map service or image service.

ArcMap Document; Mosaic Layer; Raster Layer
tiling_scheme
(Optional)

An optional parameter to specify tiling scheme.

  • ARCGISONLINE_SCHEME —Use the default ArcGIS Online tiling scheme.
  • IMPORT_SCHEME —Import an existing tiling scheme.
String
import_tiling_scheme
(Optional)

Path to an existing scheme file (.xml) or imported from an existing image service or map service.

Image Service; MapServer; File
scales
[scale,...]
(Optional)

The scale levels at which you will create or delete tiles when running this tool, depending on the value of the manage_mode parameter. The pixel size is represented based on the spatial reference of the tiling scheme.

  • By default, only the scales within the min_cached_scale and max_cached_scale will be used when generating cache.
  • Altering the value of either min_cached_scale or max_cached_scale parameters will change which scales are used when generating cache.
  • Scales that exist but are not within the range of min_cached_scale or max_cached_scale are ignored when generating the cache.
Double
area_of_interest
(Optional)

Defines an area of interest to constrain where tiles will be created or deleted.

It can be a feature class, or it can be a feature that you interactively define in ArcMap.

This parameter is useful if you want to manage tiles for irregularly shaped areas. It's also useful in situations where you want to precache some areas and leave less-visited areas uncached.

Feature Set
max_cell_size
(Optional)

The value that defines the visibility of the data source for which the cache will be generated. By default, the value is empty.

If the value is empty

  • For levels of cache that lie within the visibility ranges of the data source, the cache is generated from the data source.
  • For levels of cache that fall outside the visibility of the data source, the cache is generated from the previous level of cache.

If the value is greater than zero

  • For levels with cell sizes smaller than or equal to Maximum Source Cell Size (max_cell_size), the cache is generated from the data source.
  • For levels with cell sizes greater than Maximum Source Cell Size (max_cell_size), the cache is generated from the previous level of cache.

The unit of the Maximum Source Cell Size value should be the same as the unit of the cell size of the source dataset.

Double
min_cached_scale
(Optional)

The minimum scale at which you want to create tiles. This does not have to be the smallest scale in your tiling scheme. Your minimum cache scale will determine which scales are used when generating cache.

Double
max_cached_scale
(Optional)

The maximum scale at which you want to create tiles. This does not have to be the largest scale in your tiling scheme. The maximum cache scale will determine which scales are used when generating cache.

Double

Code sample

ManageTileCache example 1 (Python window)

This is a Python sample for the ManageTileCache tool.

import arcpy
            
arcpy.ManageTileCache_management(
      "C:/CacheDatasets/Manage", "RECREATE_ALL_TILES", "Test",
      "C:/Data/Cache.gdb/Md", "IMPORT_SCHEME", "C:/Data/Cache.gdb/Md",
      "#", "#", "#", "40000", "2000")
ManageTileCache example 2 (stand-alone script)

This is a Python script sample for the ManageTileCache tool.

#Generate tile cache for 3 out of 5 levels defined in tiling scheme

import arcpy

folder = "C:/Workspace/CacheDatasets/Manage"
mode = "RECREATE_ALL_TILES"
cacheName = "Test"
dataSource = "C:/Workspace/Cache.gdb/md"
method = "IMPORT_SCHEME"
tilingScheme = "C:/Workspace/Schemes/Tilingscheme.xml"
scales = "16000;8000;4000;2000;1000"
areaofinterest = "#"
maxcellsize = "#"
mincachedscale = "8000"
maxcachedscale = "2000"

arcpy.ManageTileCache_management(
       folder, mode, cacheName, dataSource, method, tilingScheme,
       scales, areaofinterest, maxcellsize, mincachedscale, maxcachedscale)

Environments

  • Parallel Processing Factor
    Note:

    If the Parallel Processing Factor value is empty (blank), the tool will run with a default value of 50 percent (one-half) of the available cores.

Licensing information

  • ArcGIS for Desktop Basic: Yes
  • ArcGIS for Desktop Standard: Yes
  • ArcGIS for Desktop Advanced: Yes

Related topics

  • An overview of the Tile Cache toolset

ArcGIS for Desktop

  • Home
  • Documentation
  • Pricing
  • Support

ArcGIS Platform

  • ArcGIS Online
  • ArcGIS for Desktop
  • ArcGIS for Server
  • ArcGIS for Developers
  • ArcGIS Solutions
  • ArcGIS Marketplace

About Esri

  • About Us
  • Careers
  • Insiders Blog
  • User Conference
  • Developer Summit
Esri
Tell us what you think.
© Copyright 2016 Environmental Systems Research Institute, Inc. | Privacy | Legal