constructor(position?: Position): Axis
Initializes a new instance of the Axis class.
The position of the axis on the chart.
Gets the actual axis maximum.
It returns a number or a Date object (for time-based data).
Gets the actual axis minimum.
It returns a number or a Date object (for time-based data).
Gets or sets a value indicating whether the axis line is visible.
The default value for this property is true.
Gets or sets the comma-separated property names for the itemsSource property to use in axis labels.
The first name specifies the value on the axis, the second represents the corresponding axis label. The default value is 'value,text'.
Gets or sets label groups settings for the axis.
Label groups are created by modifying the groupDescriptions property of the ICollectionView object used as an itemsSource.
The default value is **null** and the axis label groups are not displayed.
To display groups you should create groups in collection view and specify the groupsOptions for the axis.
For example,
let view = new CollectionView( getData(), {
groupDescriptions: [
new PropertyGroupDescription('category'),
new PropertyGroupDescription('subCategory')]
});
const chart = new FlexChart('#theChart', {
itemsSource: view,
bindingX: 'product',
series: [ { binding:'sales' } ],
axisX: { groupsOptions: { display : AxisGroupsDisplay.Show } },
});
Gets or sets the itemFormatter function for the axis labels.
If specified, the function takes two parameters:
The function returns the label parameters of labels for which properties are modified.
For example:
chart.axisY.itemFormatter = function(engine, label) {
if (label.val > 5){
engine.textFill = 'red'; // red text
label.cls = null; // no default CSS
}
return label;
}
Gets or sets the items source for the axis labels.
Names of the properties are specified by the binding property.
For example:
// default value for Axis.binding is 'value,text'
chart.axisX.itemsSource = [ { value:1, text:'one' }, { value:2, text:'two' } ];
Gets or sets the label alignment.
By default the labels are centered. The supported values are 'left' and 'right for the X-axis, 'top' and 'bottom' for the Y-axis.
Gets or sets the rotation angle of the axis labels.
The angle is measured in degrees with valid values ranging from -90 to 90.
Gets or sets a value that determines whether the maximum axis value should be always labeled.
The default value for this property is **false**.
Gets or sets a value that determines whether the minimum axis value should be always labeled.
The default value for this property is **false**.
Gets or sets the label padding, in pixels.
The default value for this property is 5 pixels.
Gets or sets a value indicating whether the axis labels are visible.
The default value for this property is true.
Gets or sets the logarithmic base of the axis.
If the base is not specified the axis uses a linear scale.
Use the logBase property to spread data that is clustered around the origin. This is common in several financial and economic data sets.
Gets or sets the number of units between axis labels.
If the axis contains date values, then the units are expressed in days.
Gets or sets the maximum value shown on the axis.
The value can be a number or a Date object (for time-based data).
The default value for this property is null, which causes the chart to calculate the maximum value based on the data.
Gets or sets the minimum value shown on the axis.
The value can be a number or a Date object (for time-based data).
The default value for this property is null, which causes the chart to calculate the minimum value based on the data.
Gets or sets the number of units between minor axis ticks.
If the axis contains date values, then the units are expressed in days.
Gets or sets a value indicating how to handle overlapping axis labels.
The default value for this property is OverlappingLabels.Auto.
Gets or sets a value indicating whether the axis is reversed (top to bottom or right to left).
The default value for this property is false.
convert(val: number, maxValue?: number, minValue?: number): number
Converts the specified value from data to pixel coordinates.
The data value to convert.
The max value of the data, it's optional.
The min value of the data, it's optional.
convertBack(val: number): number
Converts the specified value from pixel to data coordinates.
The pixel coordinates to convert back.
onRangeChanged(e?: EventArgs): void
Raises the rangeChanged event.
Represents an axis in the chart.