Category Axis

These IronPython scripts below show how to modify any of the Bar Chart visualization settings found on the Category Axis tab of the Bar Chart Properties dialog box in the Spotfire user interface.

In each of the scripts below, it is assumed that the MyVis variable references the targeted visualization. See here for more information about referencing visualizations.

Change Bar Chart Category Axis Tab Options:

This IronPython script shows how to change the following options, in order from top-left to bottom-right on the category axis tab in the Spotfire user interface:

  1. Change the category axis expression
  2. Set the range min and max
  3. Include origin
  4. Show zoom slider
  5. Show gridlines
  6. Use log scale
  7. Reverse scale
  8. Show (or hide) scale labels
  9. Show labels horizontally or vertically
  10. Set max number of labels

If you aren't sure how to write a specific custom expression correctly from scratch, start by building the expression interactively using the Spotfire user interface. Once your custom expression is working correctly, right-click on the custom expression input box selector(s) and choose Custom Expression. You can then copy the expression shown into your IronPython script.

from Spotfire.Dxp.Application.Visuals import *

myVis = myVis.As[Visualization]()

# 1. Change the axis expression
myVis.XAxis.Expression = "<[My Column]>"

# 2. Set the range min and max
# Enter as AxisRange([minimum], [maximum]) to set the range
myVis.XAxis.Range = AxisRange(50, 250)
# OR
# Enter None keyword to set either end of the range back to "Automatic"
myVis.XAxis.Range = AxisRange(None, None)

# 3. Include origin
myVis.XAxis.IncludeZeroInAutoZoom = True

# 4. Show zoom slider
myVis.XAxis.ManualZoom = True

# 5. Show gridlines
myVis.XAxis.Scale.ShowGridlines = True

# 6. Use log scale
myVis.XAxis.TransformType = AxisTransformType.Log10  #Checked
# OR
myVis.XAxis.TransformType = AxisTransformType.None  #Un-checked

# 7. Reverse scale
myVis.XAxis.Reversed = True
# Note: If axis is reversed, be sure to reverse AxisRange in #2 above as well

# 8. Show (or hide) scale labels
myVis.XAxis.Scale.ShowLabels = True

# 9. Show labels horizontally or vertically
myVis.XAxis.Scale.LabelOrientation = LabelOrientation.Horizontal
# OR
myVis.XAxis.Scale.LabelOrientation = LabelOrientation.Vertical

# 10. Set max number of labels
# To check the "Max number of labels" checkbox and set the number:
myVis.XAxis.Scale.LabelLayout = ScaleLabelLayout.MaximumNumberOfTicks
myVis.XAxis.Scale.MaximumNumberOfTicks = 15
# OR
# To un-check the "Max number of labels" checkbox and ignore the number:
myVis.XAxis.Scale.LabelLayout = ScaleLabelLayout.Automatic

The purpose of this website is to provide a comprehensive, accurate, and efficient IronPython reference for Spotfire developers.