topic Re: Set number formatting in Python in ARCGIS Pro in Python Questions

Set number formatting in Python in ARCGIS Pro

LeandraGordon — Thu, 10 Dec 2020 03:12:01 GMT

Hi All,

Is there any way set the default numeric formatting s in Arcpy for pro?

I am using ArcPro 2.4.0

I have a number of layers in a map that I am preparing for sharing into Portal and we wish to format the number of decimal places and enable/disable the thousands separators

I am using .LRYX files to style the features and this is set in the layer file e.g.:
{
"type" : "CIMFieldDescription",
"alias" : "SVCurr",
"fieldName" : "AllData_SVCurr",
"numberFormat" : {
"type" : "CIMNumericFormat",
"alignmentOption" : "esriAlignRight",
"alignmentWidth" : 0,
"roundingOption" : "esriRoundNumberOfDecimals",
"roundingValue" : 0,
"useSeparator" : true
},

but it does not seem to be reading the layer file for this setting ( I am running Apply Symbology from Layer)

https://pro.arcgis.com/en/pro-app/tool-reference/data-management/alter-field-properties.htm does not seem to have these options

Thanks in advance.

Re: Set number formatting in Python in ARCGIS Pro

DanPatterson — Thu, 10 Dec 2020 05:09:01 GMT

I haven't tried, but "roundingValue" : 0,

suggests to me to not use any rounding... what if you change it to 2 or 3? does it have any affect?

Re: Set number formatting in Python in ARCGIS Pro

LeandraGordon — Thu, 10 Dec 2020 23:55:17 GMT

Changing it to 2 in the layer file is possible, then you get 2 decimal places, e.g.
{
"type" : "CIMFieldDescription",
"alias" : "Ld",
"fieldName" : "AllData_Ld",
"numberFormat" : {
"type" : "CIMNumericFormat",
"alignmentOption" : "esriAlignRight",
"alignmentWidth" : 0,
"roundingOption" : "esriRoundNumberOfDecimals",
"roundingValue" : 2,
"useSeparator" : true
},

The layerx file is saved with the correct number of decimal places if you alter the data in Fields View manually as well but then using Apply Symbology from Layer to apply those formatting settings doesn't work. The data is back at 6 decimal places so I'm looking for a way to make the changes in the Python script.

The only way to change the number formatting seems to be via Fields View - select each field, alter manually.... Not an ideal workflow when preparing multiple maps a week to upload to Portal for our users.
We are generating the tables via a join to excel spreadsheets and there doesn't seem to be a way to alter the number formats when we do the join either.

Even if we could modify the default formatting in Pro from 6 decimal places, no comma it would help.

Re: Set number formatting in Python in ARCGIS Pro

DanPatterson — Fri, 11 Dec 2020 00:57:12 GMT

Leandra... long been a complaint that the column formatting from spreadsheets isn't retained.

I tend to use numpy arrays, or you can try *.csv format. If you format the columns in the spreadsheet then the number of decimals is retained in the output. Attached is a file that contained an id column and two originally identical columns. The first was free-range formatted and the second with 4 decimal places to show. With ExcelToTable, everything was displayed to 6 decimal places and there was no numeric truncation. With the csv, the output truncated to the display width

A0,B1,C3 1,1.012345679,1.0123 2,1.012345678,1.0123 3,1.01234567,1.0123 4,1.0123456,1.0123 5,1.012345,1.0123 6,1.01234,1.0123 9,1.0123,1.0123

Re: Set number formatting in Python in ARCGIS Pro

LeandraGordon — Mon, 14 Dec 2020 02:54:10 GMT

I'm thinking now that the only way to address issues like this is to export the data as layer files, hack into the layer files and then redraw the whole map. e.g. https://community.esri.com/t5/python-questions/turn-off-fields-with-python/td-p/403316

I really don't know why ESRI has such limited functionality in arcpy.

Re: Set number formatting in Python in ARCGIS Pro

DanPatterson — Mon, 14 Dec 2020 11:29:22 GMT

The limitation is how to deal with excel. csv is a far safer format since there are no surprises

Re: Set number formatting in Python in ARCGIS Pro

LeandraGordon — Thu, 21 Jan 2021 04:00:32 GMT

Unfortunately that means actually rounding the data itself, which means that any calculations we want to do in pro will be inaccurate. What I need is the data to be stored with x decimals but display to users as a rounded value. It's not really a solution I'm afraid.

Re: Set number formatting in Python in ARCGIS Pro

LeandraGordon — Tue, 30 Nov 2021 01:07:32 GMT

Worked out how to do this using the Cartographic Information Model (https://pro.arcgis.com/en/pro-app/latest/arcpy/mapping/python-cim-access.htm) :

------------------------------------------------------------------------------------------------------------

#List of Fields to Format with comma delimiters SpCommaDelimFields=["AllData_Ld","AllData_P", "AllData_SR"] #List of Fields to Format with 2 decimal places SpTwoDecFields=["AllData_Ld","AllData_P", "AllData_SR"] currentProject = arcpy.mp.ArcGISProject("CURRENT") currentMap = currentProject.listMaps()[0] #I think this assumes there is only one map layers = currentMap.listLayers() for layer in layers: lyrCIM = layer.getDefinition('V2') if layer.name == "TheLayer": lyrCIM.showPopups = True # show popups lyrCIM.expanded = True # At least one of these seems to help the map refresh # Modify the display of numeric fields for fd in lyrCIM.featureTable.fieldDescriptions: fdNumFmt = fd.numberFormat if fd.fieldName in SpCommaDelimFields: fdNumFmt.useSeparator = True #Use a comma as a thousands separator if fd.fieldName in SpTwoDecFields: fdNumFmt.roundingValue = 2 #Two decimal places ------------------------------------------------------------------------------------------------------------------- # Push the changes back to the layer object layer.setDefinition(lyrCIM) #Get the layer definition again to check that it has changed lyrCIMNew = layer.getDefinition('V2') messages.addMessage( layer.name + " showPopups after: " + str(lyrCIMNew.showPopups)) messages.addMessage( layer.name + " showMapTips after: " + str(lyrCIMNew.showMapTips)) currentProject.save

Note that this is ArcPro 2.4 - the portion of the lyrx file that handles the format looks like this:
{
"type" : "CIMFieldDescription",
"alias" : "Ld",
"fieldName" : "AllData_Ld",
"numberFormat" : {
"type" : "CIMNumericFormat",
"alignmentOption" : "esriAlignRight",
"alignmentWidth" : 0,
"roundingOption" : "esriRoundNumberOfDecimals",
"roundingValue" : 2,
"useSeparator" : true
},

It's a good idea to export the Lyrx file and check the Json to see if it matches this example or check out the specification https://github.com/esri/cim-spec

EDIT: in 2.8 I use a script to check the Layer file directly - see below

Re: Set number formatting in Python in ARCGIS Pro

LeandraGordon — Tue, 30 Nov 2021 01:10:00 GMT

Edit - Actually the code runs fine, but for whatever reason the change to the layer CIM isn't saved when I use

layer.setDefinition(lyrCIM) the changes aren't written back in 2.8.1 BUT I have also added lyrCIM.expanded = True to a few of the layers and ??maybe?? that forces a map refresh

Re: Set number formatting in Python in ARCGIS Pro

JaredPilbeam2 — Wed, 18 Aug 2021 20:09:06 GMT

I'm using Pro v. 2.8 and I don't see anything related to the Number Format menu in the exported *.lyrx file? I am trying to do the same thing as you, which is to have a faster way to set the decimal place to 0 and check the Show thousands separators box.

Re: Set number formatting in Python in ARCGIS Pro

LeandraGordon — Tue, 26 Oct 2021 08:11:16 GMT

I think you are right. I can't get my script to work in 2.8.1...

Re: Set number formatting in Python in ARCGIS Pro

LeandraGordon — Thu, 11 Nov 2021 05:57:50 GMT

I think you are right Jared - 'UseSeparator' seems to have disappeared from my .LYRX files in 2.8.

Re: Set number formatting in Python in ARCGIS Pro

LeandraGordon — Tue, 30 Nov 2021 01:11:54 GMT

delete this..

Re: Set number formatting in Python in ARCGIS Pro

LeandraGordon — Tue, 30 Nov 2021 01:00:07 GMT

Hi Jared - they look like they are missing from the layer file but they are still in the CIM. I created a script in a Python Toolbox to check the LayerCIM as it seems that LYRX files might be abbreviated:

class ShowCIMforLayer(object): def __init__(self): """Define the tool (tool name is the name of the class).""" self.label = "ShowCIMforLayer" self.description = "" self.canRunInBackground = False def getParameterInfo(self): """Define parameter definitions""" # parameter 0 - this is just a text value, not the layer param0 = arcpy.Parameter( displayName="Layer Name", name ="DATA_LYR_NAME", datatype="GPString", parameterType="Required", direction="Input") param0.filter.list = ['SPATIALDATA_LYR', 'HEADERSPATIAL_LYR', 'LGA_LYR','HD_LV_M_LYR'] param0.value = "SPATIALDATA_LYR" #DEFAULT params = [param0] #params = None return params def isLicensed(self): """Set whether tool is licensed to execute.""" return True def updateParameters(self, parameters): """Modify the values and properties of parameters before internal validation is performed. This method is called whenever a parameter has been changed.""" return def updateMessages(self, parameters): """Modify the messages created by internal validation for each tool parameter. This method is called after internal validation.""" return def execute(self, parameters, messages): DATA_LYR_NAME=parameters[0].valueAsText #FEATURE_CLASS = parameters[1].valueAsText currentProject = arcpy.mp.ArcGISProject("CURRENT") currentMap = currentProject.listMaps()[0] #I think this assumes there is only one map theActiveMap = currentProject.activeMap theFilePath = arcpy.mp.ArcGISProject("CURRENT").filePath #This works for the active map only TheMap = currentProject.activeMap if TheMap.name == "Map": # Layer ---------------------- messages.addMessage("Map: " + TheMap.name) #This will trap errors where layers are missing layers = TheMap.listLayers() for layer in layers: messages.addMessage(layer.name) if layer.name == DATA_LYR_NAME: lyrCIM = layer.getDefinition('V2') #showPopups#MapTips don't seem to show up in Portal messages.addMessage( layer.name + " showPopups: " + str(lyrCIM.showPopups)) messages.addMessage( layer.name + " showMapTips: " + str(lyrCIM.showMapTips)) #If the layer has a featureTable, this will exclude the vicmap basemaps#.fieldDescriptions if hasattr(lyrCIM, 'featureTable') : #https://community.esri.com/t5/python-questions/cim-lyr-featuretable-fielddescriptions-returns-an/td-p/1046116 messages.addMessage ("number of fieldDescriptions: " + str(len(lyrCIM.featureTable.fieldDescriptions))) #https://community.esri.com/t5/python-questions/cim-lyr-featuretable-fielddescriptions-returns-an/td-p/1046116 for fd in lyrCIM.featureTable.fieldDescriptions: messages.addMessage ("-----------fieldName: "+ fd.fieldName) messages.addMessage ("alias: "+ fd.alias) messages.addMessage ("visible: " + str(fd.visible)) if hasattr(fd, 'numberFormat'): messages.addMessage(fd.fieldName + "------------numberFormat:") fdNumFmt = fd.numberFormat if hasattr(fdNumFmt, 'roundingOption'): messages.addMessage( " roundingOption: " + str(fdNumFmt.roundingOption)) messages.addMessage( " roundingValue: " + str(fdNumFmt.roundingValue)) if hasattr(fdNumFmt, 'useSeparator'): messages.addMessage( " useSeparator: " + str(fdNumFmt.useSeparator)) #messages.addMessage ("--- ---lyrCIM.featureTable.fieldDescriptions: " + str(lyrCIM.featureTable.fieldDescriptions)) #Have a look at whats available #if hasattr(lyrCIM.featureTable.fieldDescriptions, 'fields'): #messages.addMessage ("--- ---lyrCIM.featureTable.fieldDescriptions.fields[0]: " + str(lyrCIM.featureTable.fieldDescriptions.fields[0])) messages.addMessage("Finish") return

Re: Set number formatting in Python in ARCGIS Pro

AntoinePrince1805 — Thu, 03 Oct 2024 13:08:07 GMT

I created a new ESRI IDEA for this problem that is not really yet resolved when using in stand-alone python script.

Consider upvoting.