FinancialSeriesLabel Class

Stores point label settings for the Candlestick and Stock series.

Namespace: DevExpress.XamarinForms.Charts

Assembly: DevExpress.XamarinForms.Charts.dll

Declaration

public class FinancialSeriesLabel :
    SeriesLabel

Related API Members

The following members accept/return FinancialSeriesLabel objects:

Remarks

You can accompany series' data points with labels to show point values as text on a chart:

Candlestick Series Labels

To enable labels for CandleStickSeries or StockSeries, set the series' Label property to the FinancialSeriesLabel object, and use this object's properties to adjust the label settings:

  • TextPattern - Formats series label text.
    A pattern includes regular text (which is displayed as is) and placeholder strings enclosed in braces. Placeholders define which values are shown in labels. You can use the following placeholders to specify the text pattern for financial series' labels:

    Placeholder

    Description

    {S}

    Displays a series name.

    {A}

    Displays a series point argument.

    {O}

    Displays a financial series point open value.

    {H}

    Displays a financial series point high value.

    {L}

    Displays a financial series point low value.

    {C}

    Displays a financial series point close value.

    NOTE

    To format these values, you can use default format strings after the $ sign.
    For example, in the {C$#.##} string, C is a placeholder, $ is a format string separator, and #.## is a format string.

  • Position , Indent - Specify how a label is positioned relative to a series point.
  • Style - Provides access to the SeriesLabelStyle object that stores label appearance settings (TextStyle).
  • Visible - Allows you to show or hide labels for the series.

For example, the following code configures point labels for the candlestick series.

<dxc:CandleStickSeries>
    <dxc:CandleStickSeries.Label>
        <dxc:FinancialSeriesLabel Position="Top" 
                                  Indent="15" 
                                  TextPattern="{}{C$#.#}"/>
    </dxc:CandleStickSeries.Label>
</dxc:CandleStickSeries>

Inheritance

Object
Xamarin.Forms.BindableObject
See Also