YAxis

Engineering

This dialog can be used to add and parameterize the different Y-axes.

Items

List of all objects added

YAxis 1:

Delete the selected object

YAxis 2:

Change the object order (top = left)

YAxis 3:

Add a new object

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

Schema: tchmi:framework#/definitions/ChartYAxisDefinitionList

Attribute getter

public getYAxis(): TcHmi.Controls.Beckhoff.TcHmiLineChart.YAxis[] | null;

Parameter

Name

Type

Description

-

-

-

Return value

Type

Description

TcHmi.Controls.Beckhoff.TcHmiLineChart.YAxis[], null

The current value of the attribute.

Attribute setter

public setYAxis(valueNew: TcHmi.Controls.Beckhoff.TcHmiLineChart.YAxis[] | null): void;

Parameter

Name

Type

Description

valueNew

TcHmi.Controls.Beckhoff.TcHmiLineChart.YAxis[], null

The new value of the attribute. If null is passed, the internal default value is used.

Return value

Type

Description

void

No return value.

YAxis 4:

Available from 1.8