Picture for tool in Python Toolbox

Question

Hello community members!

I would like to add a picture (an image that displays with the tool summary when you hover over the help icon on the open tool dialog box) to my own script tool in the python toolbox. There isn't the Illustration parameter in the python script tool properties window.

Are there some nuances to show it? Should I type anything additionally in the script tool xml file?

Any advice would be greatly appreciated!

danretired · Answer

I find the validation code and all the other stuff in the "custom" toolbox and tools gets included in the dialog itself, so I can just edit it there rather than coding from scratch.  Once done, it all ends up in the *.aptx and I can edit (not recommended by esri staff ! ) as I see fit.

Besides using the custom toolboxes allows me to do screengrabs to document script parameters and the inputs I used.  A picture goes a long way to refresh the memory 😉

SeaRM · Answer

Thanks, Dan, a lot for your suggestion! I know about the opportunity you mentioned. It might be a workaround. But I'd rather add the picture to my python script in the python toolbox. Is that impossible?

danretired · Answer

You can do it with the new toolbox format (*.atbx)

Document a custom geoprocessing tool—ArcGIS Pro | Documentation

but not for the old format (*.tbx)

Create a script tool—ArcGIS Pro | Documentation

I usually find creating the toolbox and the tools easier using the custom tools dialog rather than the *.pyt format since the *.atbx can be viewed and to some level edited in 7zip