Back to Devexpress

ScrollBarOptions.AnnotatedElements Property

wpf-devexpress-dot-xpf-dot-charts-dot-scrollbaroptions.md

latest5.9 KB
Original Source

ScrollBarOptions.AnnotatedElements Property

Gets or sets chart elements for which scroll bar annotations are shown.

Namespace : DevExpress.Xpf.Charts

Assembly : DevExpress.Xpf.Charts.v25.2.dll

NuGet Package : DevExpress.Wpf.Charts

Declaration

csharp
public ScrollBarAnnotationElement AnnotatedElements { get; set; }
vb
Public Property AnnotatedElements As ScrollBarAnnotationElement

Property Value

TypeDescription
ScrollBarAnnotationElement

The chart elements that should be indicated by scroll bar annotations.

|

Available values:

NameDescription
None

Scroll bar annotations are hidden.

| | Strip |

Indicates whether to show scroll bar annotations for strips.

| | ConstantLine |

Indicates whether to show scroll bar annotations for constant lines.

| | CustomLabel |

Indicates whether to show scroll bar annotations for custom axis labels.

| | PaneAnnotation |

Indicates whether to show scroll bar annotations for pane annotations.

| | SeriesPointAnnotation |

Indicates whether to show scroll bar annotations for series point annotations.

|

Property Paths

You can access this nested property as listed below:

Object TypePath to AnnotatedElements
Pane

.AxisXScrollBarOptions .AnnotatedElements

| | Pane |

.AxisYScrollBarOptions .AnnotatedElements

|

Remarks

Scroll bar annotations (not to be confused with Annotations) are colored marks that reflect the position of different chart elements on a scroll bar.

This image shows scroll bar annotations for various elements.

Scroll bar annotations are hidden.

The Chart Control displays scroll bars when the following properties are enabled:

Refer to Zoom and Scroll in 2D XY-Charts for more information on navigation capabilities in charts.

The Chart Control supports scroll bar annotations for the elements below:

To hide all scroll bar annotations, set the AnnotatedElements property to None.

Example

This example shows how to enable scroll bar annotations for various chart elements:

xaml
<dxc:XYDiagram2D>
    <dxc:XYDiagram2D.DefaultPane>
        <dxc:Pane EnableAxisXNavigation="True" EnableAxisYNavigation="True">
            <dxc:Pane.AxisXScrollBarOptions>
                <dxc:ScrollBarOptions AnnotatedElements="Strip, PaneAnnotation, SeriesPointAnnotation, CustomLabel"/>
            </dxc:Pane.AxisXScrollBarOptions>
            <dxc:Pane.AxisYScrollBarOptions>
                <dxc:ScrollBarOptions AnnotatedElements="ConstantLine, PaneAnnotation, SeriesPointAnnotation"/>
            </dxc:Pane.AxisYScrollBarOptions>
        </dxc:Pane>
    </dxc:XYDiagram2D.DefaultPane>
    <!--...-->
</dxc:XYDiagram2D>

Related API Members:

  • Pane.AxisXScrollBarOptions - Settings that define the appearance of a pane scroll bar displayed for the X-Axis.
  • Pane.AxisYScrollBarOptions - Settings that define the appearance of a pane scroll bar displayed for the Y-Axis.
  • ScrollBarOptions.AnnotatedElements - Gets or sets chart elements for which scroll bar annotations are shown.

See Also

ScrollBarOptions Class

ScrollBarOptions Members

DevExpress.Xpf.Charts Namespace