CDColorAxisMBS class

Online Documentation   -   Statistics   -   FAQ   -   Plugin Parts (All, Dependencies)   -   Class hierarchy

New in Version 22.2 22.3 22.4 22.5 23.0 23.1 23.2 23.3 23.4 23.5 24.0 24.1

The list of the   topics,   classes,   interfaces,   controls,   modules,   global methods by category,   global methods by name,   screenshots,   licenses   and   examples.

Platforms to show: All Mac Windows Linux Cross-Platform

CDColorAxisMBS class

Super class: CDAxisMBS

Type Topic Plugin Version macOS Windows Linux iOS Targets
class ChartDirector MBS ChartDirector Plugin 9.2 ✅ Yes ✅ Yes ✅ Yes ✅ Yes All
The ColorAxis class represents color axes.

It is a subclass of Axis.

A color axis is similar to an x or y axis. However, instead of mapping data values to positions, a color axis maps data values to colors. Color axes are used in CDContourLayerMBS and in CDSurfaceChartMBS objects.

Similar to an x or y axis, a color axis is visually represented as a thin bar that can be horizontal or vertical, and has a scale along its length. The scale can be set explicitly or can be determined by auto-scaling.

If you are using the color axis on a surface chart, please note that by default, the color axis scale is synchronized to the z axis. You need to use CDAxisMBS.syncAxis to cancel the synchronization before you can independently set the color axis scale.

In addition to the scale, a color axis is colored with a continuous color gradient or discrete color steps along its length. This maps the values on the axis with colors.

For an x or y axis, the major and minor ticks correspond to major and minor grid lines on the chart. For a color axis, these ticks correspond to major and minor contour lines on the chart.

Like an x or y axis, you can add marks to the color axis using Axis.addMark. They will become mark contour lines on the chart.

The color axis, if visible, acts as a color legend. The axis stem is a thin rectangle 15 pixels in width, configurable with CDAxisMBS.setWidth. A bounding box can be added to surround the color axis using CDColorAxisMBS.setBoundingBox.

A color axis works normally (determines color mapping and contour levels) even if it is not displayed.
Subclass of the CDAxisMBS class.
This is a subclass of an abstract class. You can't create an instance, but you can get one from various plugin functions.

Super class CDAxisMBS

This class has no sub classes.

Some methods using this class:

Some examples using this class:

Blog Entries

Xojo Developer Magazine

Release notes


The items on this page are in the following plugins: MBS ChartDirector Plugin.


CDCandleStickLayerMBS   -   CDContourLayerMBS


💬 Ask a question or report a problem