Version

Formatting Timeline

The xamTimeline™ control accepts the standard .NET format strings to format the dates and numbers that it displays. This allows you to have a custom display that meets your requirements. The NumericTimeSeries and DateTimeSeries objects' EventTitle and the NumericTimeAxis or DateTimeAxis objects' AxisLabel properties are prime candidates where formatting applies.

SL DV xamWebTimeline About Formatting xamWebTimeline 01.png
SL DV xamWebTimeline About Formatting xamWebTimeline 02.png
SL DV xamWebTimeline About Formatting xamWebTimeline 03.png

Formatting in xamTimeline is done through the use of Styles and is set through the Axis for both the Axis label and event title. This means that the event title of your time series will take on the format you set for the Axis label.

The following list represents the properties to set in order to format DateTime values for the EventTitle and AxisLabel properties:

The xamTimeline control uses one of the above formats depending on the DateTimeAxis object’s UnitType. For example, if the UnitType is Months, the control uses MonthsUnitStringFormat to format the values. This makes it possible for you to set up multiple format options that can be used depending on the units you wish to display. For more information on formatting DateTime values, see Format Date Time Values.

The NumericTimeSeries object has one property that handles formatting: StringFormat. This property takes string formats for Double values. For more information on formatting numeric values, see Format Numeric Time Values.

There are two more properties to target concerning the display of values:

The PointStringFormat property allows you to customize the display of each point value, while the SpanStringFormat does the same for span values. For more information on using these properties, see Format Point and Span Values.