Class pvc.options.axes.SizeAxis

Class Summary
Constructor Attributes	Constructor Name and Description
	SizeAxis The options documentation class of the size axis.

Field Summary
Field Attributes	Field Name and Description
Numeric > Scale
	domainAlign The domain alignment to use when the domain has a fixed or implied length (applies to continuous axes).
	fixedLength The fixed domain length that the axis will show (applies to continuous axes).
	fixedMax The fixed maximum domain value that the axis will show (applies to continuous axes).
	fixedMin The fixed minimum domain value that the axis will show (applies to continuous axes).
	originIsZero Indicates if it should be ensured that zero domain value is shown (applies to numeric axes).
	useAbs Indicates if the axis scale is applied over the absolute value of the domain values (applies to numeric domain axes).

Class Detail

pvc.options.axes.SizeAxis

The options documentation class of the size axis.

A size axis panel and its properties can be referred to by using its full id, which is the word size, followed by it's index (when >= 2), and terminated by the word Axis (ex: sizeAxis, size2Axis, size3Axis, ...).

The domain of size axes is evaluated at the leaf chart level. When in a small multiples chart, sizes are local to each small chart.

Currently, size axes only support numeric domain values.

Field Detail

{pvc.options.varia.AxisDomainAlign} domainAlign

The domain alignment to use when the domain has a fixed or implied length (applies to continuous axes).

For more information, see: #fixedLength.

Default Value:: 'center'

{number|string} fixedLength

The fixed domain length that the axis will show (applies to continuous axes).

A string value is converted to a number.

The value may be bigger or smaller than the actual length of the data.

This property takes precedence over the property originIsZero, if specified either with fixedMin, fixedMax or domainAlign.

This property can be specified with several options to define the initial domain, so that its length corresponds to the defined value. They take the following precedence order:

If fixedLength is not specified:
1. If neither fixedMin and fixedMax are specified, the axis domain is the data domain; option originIsZero may augment the axis domain, on one of its sides;
2. If both fixedMin and fixedMax are specified, the axis domain is fully determined; it's length is implied; option originIsZero is ignored;
3. If fixedMin is specified (and fixedMax is not) the axis domain minimum is fixedMin and the axis domain maximum is the data domain maximum, possibly corrected by option originIsZero;
4. Else, (if fixedMax is specified and fixedMin is not,) the axis domain maximum is fixedMax and the axis domain minimum is the data domain minimum, possibly corrected by option originIsZero;
If fixedLength is specified, option originIsZero is ignored.
The limits of the axis domain are determined as follows:
1. If fixedMin is specified, the axis domain maximum is implied:
  
  max = fixedMin + fixedLength;
  
  options originIsZero, fixedMax are ignored; option domainAlign is ignored in this phase;
2. If fixedMax is specified, the axis domain minimum is implied:
  
  min = fixedMax - fixedLength;
  
  option originIsZero is ignored; option domainAlign is ignored in this phase;
3. Else, domainAlign is either specified or defaults to center. The axis domain is aligned to either the minimum, maximum or center of the data domain and then taken to have the specified fixed length.
  It is determined as follows:
  - If domainAlign is min, the axis domain minimum is that of the actual data and the axis domain maximum is implied:
    
    max = min(data) + fixedLength;
  - If domainAlign is max, the axis domain maximum is that of the actual data and the axis domain minimum is implied:
    
    min = max(data) - fixedLength;
  - Else, domainAlign is center, or defaults to it, and both axis domain limits are determined from the actual data domain, as follows:
    - min = center(data) - fixedLength / 2
    - max = center(data) + fixedLength / 2
    where center(data) is determined as:
    
    center(data) = (max(data) - min(data)) / 2.

For more information, see: #fixedMin, #fixedMax, #domainAlign and #originIsZero.

{number|string} fixedMax

The fixed maximum domain value that the axis will show (applies to continuous axes).

A string value is converted to a number.

The value may be bigger or smaller than the actual maximum value of the data.

This property takes precedence over the property originIsZero.

This property is ignored if fixedMin and fixedLength are both specified. The behavior is described as follows:

fixedMin, fixedLength specified: a fixed maximum is implied from the min and length values; fixedMin is ignored
fixedMax, fixedLength specified, without fixedMin: a fixed minimum is implied from the max and length values
fixedMin, fixedMax specified, without fixedLength: the fixed maximum and minimum are set directly

For more information, see: #fixedMin and #fixedLength.

{number|string} fixedMin

The fixed minimum domain value that the axis will show (applies to continuous axes).

A string value is converted to a number.

The value may be bigger or smaller than the actual minimum value of the data.

This property can be specified with the following options, in order of precedence:

fixedLength - The fixed minimum is set and a fixed maximum is calculated, so that the length shown corresponds to the defined fixed length
fixedMax - The fixed minimum and maximum are set

This property takes precedence over the property originIsZero.

For more information, see: #fixedLength and #fixedMax.

{boolean} originIsZero

Indicates if it should be ensured that zero domain value is shown (applies to numeric axes).

The properties fixedMin and fixedMax have precedence over this one. If this property is true and respecting it would require changing the minimum value, but the option fixedMin is also specified, then this property is ignored. The same would apply if it were required to change the maximum value, but the property fixedMax was also specified.

For more information, see: #fixedLength.

{boolean} useAbs

Indicates if the axis scale is applied over the absolute value of the domain values (applies to numeric domain axes).

Default Value:: false

Types By Namespace

cdo

def

pvc

pvc.data

pvc.options

pvc.options.axes

pvc.options.charts

pvc.options.ext

pvc.options.format

pvc.options.marks

pvc.options.panels

pvc.options.plots

pvc.options.varia

pvc.options.visualRoles

pvc.visual

Class pvc.options.axes.SizeAxis