DateTimeLabelFormatCollection Class

The collection of DateTimeLabelFormat objects.

Namespace: DevExpress.XamarinForms.Charts

Assembly: DevExpress.XamarinForms.Charts.dll

NuGet Package: DevExpress.XamarinForms.Charts

Declaration

public class DateTimeLabelFormatCollection :
    ObservableCollection<DateTimeLabelFormat>

The following members return DateTimeLabelFormatCollection objects:

Remarks

The ChartView can detect if adjacent date-time argument values belong to different time intervals (for example, days of different months) and automatically display a transition label on a date-time axis (for example, the first-day label of the next month) with a different format.

To enable this functionality, assign an AxisLabelFormatAutoReplaceOptions object to the DateTimeAxisX.LabelFormatAutoReplaceOptions property and use the AxisLabelFormatAutoReplaceOptions.LabelFormats property to access and manage the collection of label formats for date-time arguments of different measurement units. An individual item of this collection is a DateTimeLabelFormat object.

Note

LabelFormats is a content property. You can skip property tags in the markup.

If you do not populate the LabelFormats collection explicitly, the following default formats are used depending on the axis’s MeasureUnit and GridAlignment settings:

Measurement Unit*	Label Format
Millisecond	Millisecond - “SSS” Second - “HH:mm:ss SSS” Day - “dd MMMM HH:mm:ss SSS” Year - “dd/MM/yyyy HH:mm:ss SSS”
Second Minute Hour	Second - “HH:mm:ss” Day - “dd MMMM HH:mm:ss” Year - “dd/MM/yyyy HH:mm:ss”
Day Week	Day - “dd MMMM” Year - “dd MMMM yyyy”
Month Quarter	Month - “MMMM” Year - “MMMM yyyy”
Year	Year - “yyyy”

Measurement Unit* - the larger measurement unit assigned to the MeasureUnit and GridAlignment properties.

Example

The following example configures a date-time axis so that it automatically shows when the next month starts:

Axis Label Format Auto Replace

XAML

<dxc:DateTimeAxisX x:Name="xAxis" GridAlignment="Day" GridSpacing="5">
    <dxc:DateTimeAxisX.LabelFormatAutoReplaceOptions>
        <dxc:AxisLabelFormatAutoReplaceOptions>
            <dxc:DateTimeLabelFormat MeasureUnit="Day" Format="d"/>
            <dxc:DateTimeLabelFormat MeasureUnit="Month" Format="MMM, d"/>
        </dxc:AxisLabelFormatAutoReplaceOptions>
    </dxc:DateTimeAxisX.LabelFormatAutoReplaceOptions>
</dxc:DateTimeAxisX>