| Label | Explanation | Data Type |
Map Document | The current map or an existing .mxd file to be used for the tiling scheme. | Map |
Tiling origin in map units | The origin (upper left corner) of the tiling scheme in the coordinates of the spatial reference of the source data frame. | Point |
Output Tiling Scheme | The path and file name of the tiling scheme file that will be created. | File |
Number of Scales | The number of scale levels that will be included in the tiling scheme. | Long |
Scales | The scale levels that will be included in the tiling scheme. These are not represented as fractions. Instead, use 500 to represent a scale of 1:500, and so on, for example. | Value Table |
Dots(Pixels) Per Inch | The dots per inch (DPI) of the intended output device. If a DPI is specified that does not match the resolution of the output device, the scale of the map tile will appear incorrect. The default value is 96. | Long |
Tile Size | Specifies the width and height of the cache tiles in pixels. For the best balance between performance and manageability, avoid deviating from standard dimensions of 256 by 256 or 512 by 512.
| String |
Ready To Serve Format
(Optional) | Specifies the file format of the cache schema that will be used and whether it will be generated using the open tile package specification.
| Boolean |
Output Folder
(Optional) | The folder location where the cache schema and iteminfo files will be created in JSON format. | Folder |
Summary
Generates a custom tiling scheme file that defines the scale levels, tile dimensions, and other properties for a web tile layer.
A tiling scheme describes how clients should reference the tiles in a cache and is a mapping between the spatial reference of the source map document and the tiling grid. The tiling grid uses a level of detail (scales), row, and column reference scheme. The scheme also defines the scale levels (levels of detail) at which the cache has tiles, the size of the tiles in pixels, and the screen resolution for which the tiles are intended to be most commonly displayed. A tiling scheme is needed to generate a map cache.
Usage
By default, the tiling origin starts at the upper left of the coordinate system used by the service's source map document.
When the Ready To Serve Format parameter is checked, the cache content schema is generated using the open tile package specification.
Parameters
arcpy.server.GenerateMapServerCacheTilingScheme(in_map, tile_origin, output_tiling_scheme, num_of_scales, scales, dots_per_inch, tile_size, {ready_to_serve_format}, {output_folder})| Name | Explanation | Data Type |
in_map | The current map or an existing .mxd file to be used for the tiling scheme. | Map |
tile_origin | The origin (upper left corner) of the tiling scheme in the coordinates of the spatial reference of the source data frame. | Point |
output_tiling_scheme | The path and file name of the tiling scheme file that will be created. | File |
num_of_scales | The number of scale levels that will be included in the tiling scheme. | Long |
scales [scales,...] | The scale levels that will be included in the tiling scheme. These are not represented as fractions. Instead, use 500 to represent a scale of 1:500, and so on, for example. | Value Table |
dots_per_inch | The dots per inch (DPI) of the intended output device. If a DPI is specified that does not match the resolution of the output device, the scale of the map tile will appear incorrect. The default value is 96. | Long |
tile_size | Specifies the width and height of the cache tiles in pixels. For the best balance between performance and manageability, avoid deviating from standard dimensions of 256 by 256 or 512 by 512.
| String |
ready_to_serve_format (Optional) | Specifies the file format of the cache schema that will be used and whether it will be generated using the open tile package specification.
| Boolean |
output_folder (Optional) | The folder location where the cache schema and iteminfo files will be created in JSON format. | Folder |
Code sample
The following example creates a map cache tiling scheme in XML format.
# Name: GeneateMapServerCacheTilingScheme.py
# Description: The following stand-alone script demonstrates how to create map
# server cache schema using a given map document at a given
# "pathForOutputXml"
# Requirements: os, sys, time & traceback modules
# Any line that begins with a pound sign is a comment and will not be executed
# Empty quotes take the default value.
# To accept arguments from the command line replace values of variables to
# "sys.argv[]"
# Import system modules
import arcpy
from arcpy import env
import os, sys, time, datetime, traceback, string
# Set environment settings
env.workspace = "E:/path/to/myfolder"
# List of input variables for map service properties
# Reference map to use for cache tiling sceheme generation
aprx = arcpy.mp.ArcGISProject(r"E:\Data\path\to\myAPRX.aprx")
mapDocument = aprx.listMaps("myMapName")[0]
outputTilingScheme = "E:/path/to/myschema.xml"
tileOrigin = ""
numOfScales = "4"
scales = "4000000,2000000,100000,50000"
tileSize = "256 x 256"
dotsPerInch = "96"
# print results of the script to a report
file = r'E:\path\to\myreport.txt'
report = open(file,'w')
try:
#starttime = time.clock()
result = arcpy.server.GenerateMapServerCacheTilingScheme(mapDocument,
tileOrigin, outputTilingScheme,
numOfScales, scales,
dotsPerInch, tileSize)
#print messages to a file
while result.status < 4:
time.sleep(0.2)
resultValue = result.getMessages()
report.write ("completed " + str(resultValue))
print(" Created MapServer cache tiling schema successfully using" + \
mapDocument + " at "+ outputTilingScheme )
except Exception as e:
# If an error occurred, print line number and error message
tb = sys.exc_info()[2]
report.write("Failed at step 1 \n" "Line %i" % tb.tb_lineno)
report.write(str(e))
print("Created Map server Cache Tiling schema ")
report.close()The following example creates a map cache tiling scheme in JSON format.
# Name: GeneateMapServerCacheTilingScheme.py
# Description: The following stand-alone script demonstrates how to create map
# server cache schema in ready to serve format using a given map document at a given
# folder
# Requirements: os, sys, time & traceback modules
# Any line that begins with a pound sign is a comment and will not be executed
# Empty quotes take the default value.
# To accept arguments from the command line replace values of variables to
# "sys.argv[]"
# Import system modules
import arcpy
from arcpy import env
import os, sys, time, datetime, traceback, string
# Set environment settings
env.workspace = "E:/path/to/myfolder"
# List of input variables for map service properties
# Reference map to use for cache tiling sceheme generation
aprx = arcpy.mp.ArcGISProject(r"E:\Data\path\to\myAPRX.aprx")
mapDocument = aprx.listMaps("myMapName")[0]
outputTilingScheme = "None"
tileOrigin = ""
numOfScales = "4"
scales = "4000000,2000000,100000,50000"
tileSize = "256 x 256"
dotsPerInch = "96"
ready_to_serve_format = "READY_TO_SERVE_FORMAT"
output_folder = "E:\path\to\myfolder"
# print results of the script to a report
file = r'E:\path\to\myreport.txt'
report = open(file,'w')
try:
#starttime = time.clock()
result = arcpy.server.GenerateMapServerCacheTilingScheme(mapDocument,
tileOrigin, outputTilingScheme,
numOfScales, scales,
dotsPerInch, tileSize,
ready_to_serve_format,
output_folder)
#print messages to a file
while result.status < 4:
time.sleep(0.2)
resultValue = result.getMessages()
report.write ("completed " + str(resultValue))
print(" Created MapServer cache tiling schema successfully using" + \
mapDocument + " at "+ outputTilingScheme )
except Exception as e:
# If an error occurred, print line number and error message
tb = sys.exc_info()[2]
report.write("Failed at step 1 \n" "Line %i" % tb.tb_lineno)
report.write(str(e))
print("Created Map server Cache Tiling schema ")
report.close()Environments
Licensing information
- Basic: Yes
- Standard: Yes
- Advanced: Yes