Hint Class

Configures hints the the hints the ChartView displays.

Namespace: DevExpress.XamarinForms.Charts

Assembly: DevExpress.XamarinForms.Charts.dll

Declaration

public class Hint :
    HintBase

Returned By

The ChartView.Hint property returns an instance of Hint.

Remarks

A hint is a small pop-up rectangle that shows information about a tapped series or point. The Chart View can display its hints as Tooltips and as a Crosshair Cursor:

How to: Enable Hints in the ChartView

The following code modifies the general properties of the hint the ChartView displays:

<dxc:ChartView>
    <dxc:ChartView.Hint>
        <dxc:Hint Enabled="True" 
                  ShowMode="OnTap"/>
    </dxc:ChartView.Hint>
</dxc:ChartView>

The code above utilizes the following properties and classes:

Symbol

Description

ChartView.Hint

Gets or sets the chart hints.

Hint

Configures hints the the hints the ChartView displays.

HintBase.Enabled

Gets or sets whether the chart displays hints when a user taps chart, and when a hint is requested in code.

HintBase.ShowMode

Gets or sets a gesture on which the chart shows hints.

How to: Change the Hint Behavior

The Hint provides the following behaviors that manage how the chart displays the hint:

Tooltip Behavior

The chart shows the hint as a tooltip:

NOTE

The Tooltip requests data to display from a series. The series provides the Series.HintOptions property to configure what data the series returns.

The following code configures this hint behavior and manages how the hint interacts with this series:

<dxc:ChartView>
    <dxc:ChartView.Hint>
        <dxc:Hint>
            <dxc:Hint.Behavior>
                <dxc:TooltipHintBehavior/>
            </dxc:Hint.Behavior>
        </dxc:Hint>
    </dxc:ChartView.Hint>
    <dxc:ChartView.Series>
        <dxc:BarSeries>
            <dxc:BarSeries.HintOptions>
                <dxc:SeriesHintOptions PointTextPattern="{}{S}, {A}: {V$0.##}"/>
            </dxc:BarSeries.HintOptions>
        </dxc:BarSeries>
    </dxc:ChartView.Series>
</dxc:ChartView>

The code above utilizes the following classes and properties:

Symbols

Description

Hint.Behavior

Gets or sets the behavior of the hint.

TooltipHintBehavior

Defines the tooltip behavior.

Series.HintOptions

SeriesHintOptions

Stores the series' tooltip settings.

Crosshair Cursor Behavior

The chart shows the hint as the Crosshair Cursor:

NOTE

The Crosshair Cursor requests data to display from a series and axes. The series provides the Series.HintOptions property to configure what data the series returns. The AxisBase.HintOptions property manages how the hint interacts with the axis.

The following code configures this hint behavior and manages how the hint interacts with the series and axes:

<dxc:ChartView>
    <dxc:ChartView.Hint>
        <dxc:Hint>
            <dxc:Hint.Behavior>
                <dxc:CrosshairHintBehavior GroupHeaderTextVisible="False"/>
            </dxc:Hint.Behavior>
        </dxc:Hint>
    </dxc:ChartView.Hint>
    <dxc:ChartView.AxisY>
        <dxc:NumericAxisY>
            <dxc:NumericAxisY.HintOptions>
                <dxc:AxisHintOptions LineVisible="False" LabelVisible="False"/>
            </dxc:NumericAxisY.HintOptions>
        </dxc:NumericAxisY>
    </dxc:ChartView.AxisY>
    <dxc:ChartView.Series>
        <dxc:BarSeries>
            <dxc:BarSeries.HintOptions>
                <dxc:SeriesCrosshairOptions PointTextPattern="{}{S}, {A}: {V$0.##}"/>
            </dxc:BarSeries.HintOptions>
        </dxc:BarSeries>
    </dxc:ChartView.Series>
</dxc:ChartView>

The markup above uses the classes and properties below:

Symbols

Description

Hint.Behavior

Gets or sets the behavior of the hint.

CrosshairHintBehavior

Defines the crosshair hint behavior.

Series.HintOptions

SeriesCrosshairOptions

Stores the series' crosshair cursor settings.

AxisBase.HintOptions

Gets or sets an object that configures how the axis interacts with the Hint.

AxisHintOptions

Stores settings that specify how the axis interacts with the crosshair cursor.

How to: Customize the Hint Appearance

The Hint.Style manages the hint appearance. The style configures the following hint elements:

Hint Element

Property

Description

1. Hint Label

BackgroundColor

Gets or sets the hint label's background color.

ItemsIndent

Gets or sets the indent between crosshair hint label items.

MarkerSize

Gets or sets the hint's marker size.

Padding

Gets or sets the hint's label padding.

TextIndent

Gets or sets the indent between a hint marker and text.

2. Argument Line

ArgumentLineStyle

Gets or sets the options that configure the argument line appearance for the crosshair hint.

3. Value Line

ValueLineStyle

Gets or sets the options that configure the value line appearance for the crosshair hint.

Inheritance

Object
Xamarin.Forms.BindableObject
See Also