ListTimeZones

Summary

Lists valid time zone strings to be used with the timeZone or timeZoneIANA properties on the LayerTime class.

Discussion

The timeZone or timeZoneIANA properties on the LayerTime class only work with specific time zone strings. This function allows you to view a valid list of strings.

Syntax

ListTimeZones ({wildcard}, {time_zone_type})
ParameterExplanationData Type
wildcard

A wildcard is based on the time zone string and is not case sensitive. A combination of asterisks (*) and characters can be used to help limit the resulting list.

(The default value is None)

String
time_zone_type

A string constant that controls the list of available time zone types to filter from.

  • IANA Time zones are displayed using Internet Assigned Numbers Authority (IANA) extended names including both standard and daylight offsets.
  • IANA_ABBREVIATED Time zones are displayed using Internet Assigned Numbers Authority (IANA) location names including only the standard offsets.
  • MICROSOFT_WINDOWS Time zones are displayed using the Microsoft Windows operating system names.

(The default value is MICROSOFT_WINDOWS)

String
Return Value
Data TypeExplanation
List

A list of valid time zone strings to be used with the timeZone or timeZoneIANA properties on the LayerTime class.

Code sample

ListTimeZones example

The following script will print all time zones that contain the text Canada.


import arcpy
tzList = arcpy.mp.ListTimeZones("*Canada*")
print(tzList)