ScriptAxisSettings

class ScriptAxisSettings.ScriptAxisSettings

Bases: object

Bundles settings of the x-axis of a traceObject or the y-axis of a diagram.
property mode: AxisScaleMode
Scale mode of the axis. Possible values and their behaviours are:
Auto: the axis range is determined based on the range of the data.
FixedLength: the length of the range is fixed, but the position is based on the data.
Fixed: The axis range is explicitly given.
property min_val: float
Gets or sets the minimum value of the axis range.
This is only used, if mode == Fixed.
For the time axis, the resolution is ms.
property max_val: float
Gets or sets the maximum value of the axis range.
This is only used, if mode == Fixed.
For the time axis, the resolution is ms.
property range: float
Gets or sets the range of the axis.
This is only used, if mode == FixedLength.
For the time axis, the resolution is ms.
property draw_description: bool
Gets or sets wether the description text is drawn.
property description: str
Gets or sets the description text.
property color: int
Gets or sets the 32bit-ARGB representation of the color, used to draw the axis, tick marks, and labels.
property font: ScriptFontDesc
Contains settings for font, used for the label and axis descriptions.
property draw_grid: bool
Gets or sets, wether the grid is drawn.
property grid_color: int
Gets or sets the 32bit-ARGB representation of the color, used to draw the grid lines of the major tick.
property tickmark_fixed_spacing: bool
Gets or sets, wether a fixed spacing is used for the tick marks.
property tickmark_fixed_distance: float
Gets or sets the distance of major tick marks, if tickmark_fixed_spacing is true.
For the time axis, the resolution is ms.
property tickmark_fixed_subdivisions: int
Gets or sets the number of subdivisions of a major tick mark, if tickmark_fixed_spacing is true.
copy_from(source: ScriptAxisSettings) → None
Convenient method for copying all properties, accessable by scripting, from the source to this ScriptAxisSettings.