YAxis
[ Interface ]
export interface YAxis {
id: number;
showAxis: boolean;
position: TcHmiCharting.IAxis.Position;
logarithmicScale: boolean;
axisLabeling: ["Number", "Scientific", "Auto"];
mainTickMinValue?: number;
mainTickMaxValue?: number;
showLabels?: boolean;
labelFontColor?: TcHmi.SolidColor;
axisColor?: TcHmi.SolidColor;
showAxisName?: boolean;
axisName?: string;
axisNameFontFamily?: string;
axisNameFontSize?: number;
axisNameFontSizeUnit?: TcHmi.DimensionUnit;
axisNameFontWeight?: TcHmi.FontWeight;
axisNameFontColor?: TcHmi.SolidColor;
decimalPlaces?: number;
unit?: string;
autoScaling?: boolean;
showIfNoData?: boolean;
format?: TcHmi.IFunction<string>;
}Properties
|
Name |
Type |
Description |
|---|---|---|
|
id |
number |
id of the Y-axis. |
|
showAxis |
boolean |
Visibility of the axis. |
|
position |
TcHmiCharting.IAxis.Position |
Position as enumeration. |
|
logarithmicScale |
boolean |
Logarithmic scaling |
|
axisLabeling |
TcHmiCharting.AxisLabeling |
Number format of the axis. |
|
mainTickMinValue |
number |
Minimum value of the main axis marker. |
|
mainTickMaxValue |
number |
Maximum value of the main axis marker. |
|
showLabels |
boolean |
Is the label to be displayed. |
|
labelFontColor (optional) |
TcHmi.SolidColor |
Color of the label text. |
|
axisColor (optional) |
TcHmi.SolidColor |
Axis color |
|
showAxisName (optional) |
boolean |
Is the axis name to be displayed. |
|
axisName (optional) |
string |
Name of the axis. |
|
axisNameFontFamily (optional) |
string |
Font of the axis name. |
|
axisNameFontSize (optional) |
number |
Font size of the axis name. |
|
axisNameFontSizeUnit (optional) |
TcHmi.DimensionUnit |
Unit of the font size of the axis name. |
|
axisNameFontWeight (optional) |
TcHmi.FontWeight |
Font weight of the axis name. |
|
axisNameFontColor (optional) |
TcHmi.SolidColor |
Font color of the axis name. |
|
decimalPlaces (optional) |
number |
Decimal places of the axis labeling. |
|
unit (optional) |
string |
Display unit |
|
autoScaling (optional) |
boolean |
Should the axis adapt automatically. |
|
showAxisIfNoData |
boolean |
Display of the axis when data is available. |
|
Format |
TcHmi.IFunction |
Formatting function of the axis labels. |
See also
Schema: tchmi:framework#/definitions/ChartYAxisDefinition
![]() | Available from version 1.10 |
