Create Vector Tile Package (Data Management)

Summary

Generates vector tiles from a map or basemap and packages the tiles in a single .vtpk file.

Usage

Parameters

LabelExplanationData Type
Input Map

The map from which tiles will be generated and packaged. The input map must have metadata description and tags.

Map
Output File

The output vector tile package. The file extension of the package is .vtpk.

File
Package for ArcGIS Online | Bing Maps | Google Maps

Specifies whether the tiling scheme will be generated from an existing map service or if map tiles will be generated for ArcGIS Online, Bing Maps, and Google Maps.

  • Checked—The ArcGIS Online/Bing Maps/Google Maps tiling scheme will be used. This tiling scheme allows you to overlay cache tiles with tiles from these online mapping services. AllSource includes this tiling scheme as a built-in option when loading a tiling scheme. When you choose this tiling scheme, the data frame of the source map must use the WGS 1984 Web Mercator (Auxiliary Sphere) projected coordinate system. This is the default.
  • Unchecked—A tiling scheme from an existing vector tile service will be used. Only tiling schemes with scales that double in progression through levels and have 512-by-512 tile size are supported. You must specify a vector tile service or tiling scheme file for the Tiling scheme parameter.

  • OnlineThe ArcGIS Online/Bing Maps/Google Maps tiling scheme will be used. This tiling scheme allows you to overlay cache tiles with tiles from these online mapping services. AllSource includes this tiling scheme as a built-in option when loading a tiling scheme. When you choose this tiling scheme, the data frame of the source map must use the WGS 1984 Web Mercator (Auxiliary Sphere) projected coordinate system. This is the default.
  • ExistingA tiling scheme from an existing vector tile service will be used. Only tiling schemes with scales that double in progression through levels and have 512-by-512 tile size are supported. You must specify a vector tile service or tiling scheme file in the tiling_scheme parameter.
Boolean
Tiling scheme
(Optional)

A vector tile service or tiling scheme file that will be used if the Package for ArcGIS Online | Bing Maps | Google Maps parameter is unchecked. The tiling scheme tile size must be 512 by 512 and must have consecutive scales in a ratio of two.

Map Server; File
Tiling Format
(Optional)

Specifies whether the tile generation structure will be optimized with an indexed structure or as a flat array of all tiles at all levels of detail. The optimized indexed structure is the default and results in a smaller cache.

  • IndexedTiles that are based on an index of feature density that optimizes the tile generation and file sizes will be produced. This is the default.
  • FlatRegular tiles for each level of detail will be produced without regard to feature density. This cache is larger than that produced with an indexed structure.
String
Minimum Cached Scale
(Optional)

The minimum (smallest) scale at which tiles will be generated. This does not need to be the smallest scale in the tiling scheme. The minimum cached scale determines which scales will be used to generate cache.

Double
Maximum Cached Scale
(Optional)

The maximum (largest) scale at which tiles will be generated. This does not need to be the largest scale in the tiling scheme. The maximum cached scale determines which scales will be used to generate cache.

Double
Index Polygons
(Optional)

A pregenerated index of tiles based on feature density, applicable only when the Tiling Format parameter is set to Indexed. Use the Create Vector Tile Index tool to create index polygons. If no index polygons are specified for this parameter, optimized index polygons will be generated during processing to aid in tile creation, but they will not be saved or output.

Feature Layer
Summary
(Optional)

Adds summary information to properties of the output vector tile package.

String
Tags
(Optional)

Adds tag information to the properties of the output vector tile package. Separate multiple tags with commas or semicolons.

String

arcpy.management.CreateVectorTilePackage(in_map, output_file, service_type, {tiling_scheme}, {tile_structure}, {min_cached_scale}, {max_cached_scale}, {index_polygons}, {summary}, {tags})
NameExplanationData Type
in_map

The map from which tiles will be generated and packaged. The input map must have metadata description and tags.

Map
output_file

The output vector tile package. The file extension of the package is .vtpk.

File
service_type

Specifies whether the tiling scheme will be generated from an existing map service or if map tiles will be generated for ArcGIS Online, Bing Maps, and Google Maps.

  • ONLINEThe ArcGIS Online/Bing Maps/Google Maps tiling scheme will be used. This tiling scheme allows you to overlay cache tiles with tiles from these online mapping services. AllSource includes this tiling scheme as a built-in option when loading a tiling scheme. When you choose this tiling scheme, the data frame of the source map must use the WGS 1984 Web Mercator (Auxiliary Sphere) projected coordinate system. This is the default.
  • EXISTINGA tiling scheme from an existing vector tile service will be used. Only tiling schemes with scales that double in progression through levels and have 512-by-512 tile size are supported. You must specify a vector tile service or tiling scheme file in the tiling_scheme parameter.
Boolean
tiling_scheme
(Optional)

A vector tile service or tiling scheme file that will be used if the service_type parameter is set to EXISTING. The tiling scheme tile size must be 512 by 512 and must have consecutive scales in a ratio of two.

Map Server; File
tile_structure
(Optional)

Specifies whether the tile generation structure will be optimized with an indexed structure or as a flat array of all tiles at all levels of detail. The optimized indexed structure is the default and results in a smaller cache.

  • INDEXEDTiles that are based on an index of feature density that optimizes the tile generation and file sizes will be produced. This is the default.
  • FLATRegular tiles for each level of detail will be produced without regard to feature density. This cache is larger than that produced with an indexed structure.
String
min_cached_scale
(Optional)

The minimum (smallest) scale at which tiles will be generated. This does not need to be the smallest scale in the tiling scheme. The minimum cached scale determines which scales will be used to generate cache.

Double
max_cached_scale
(Optional)

The maximum (largest) scale at which tiles will be generated. This does not need to be the largest scale in the tiling scheme. The maximum cached scale determines which scales will be used to generate cache.

Double
index_polygons
(Optional)

A pregenerated index of tiles based on feature density, applicable only when the tile_structure parameter is set to INDEXED. Use the Create Vector Tile Index tool to create index polygons. If no index polygons are specified for this parameter, optimized index polygons will be generated during processing to aid in tile creation, but they will not be saved or output.

Feature Layer
summary
(Optional)

Adds summary information to properties of the output vector tile package.

String
tags
(Optional)

Adds tag information to the properties of the output vector tile package. Separate multiple tags with commas or semicolons.

String

Code sample

CreateVectorTilePackage example 1 (Python window)

The following script shows how to use the CreateVectorTilePackage function in the Python window to create vector tile package for the first map in the project.

import arcpy
arcpy.env.workspace = "C:/TilePackageExample"
aprx = arcpy.mp.ArcGISProject("CURRENT")
map = aprx.listMaps()[0]
arcpy.management.CreateVectorTilePackage(map, 'Example.vtpk', "ONLINE", "", "INDEXED", 295828763.795777, 564.248588)
CreateVectorTilePackage example 2 (stand-alone script)

This stand-alone script shows an example of using the CreateVectorTilePackage function.

# Name: CreateVectorTilePackage.py
# Description: Find all the maps in the project and
#   create a vector tile package for each map
# import system modules
import os
import arcpy

#set environment settings
arcpy.env.overwriteOutput = True
outputPath = "C://Tilepackages//"

# Loop through the project, find all the maps, and
#   create a vector tile package for each map,
#   using the same name as the map
p = arcpy.mp.ArcGISProject("c:\\temp\\myproject.aprx")
for m in p.listMaps():
    print("Packaging " + m.name)
    arcpy.CreateVectorTilePackage_management(m, outputPath + m.name + '.vtpk', "ONLINE", "", "INDEXED", 295828763.795777, 564.248588)