TdxChartLegendAlignment Enum

Enumerates available horizontal or vertical legend pane positions within the parent diagram or Chart area.

Declaration

delphi

TdxChartLegendAlignment = (
    Default,
    NearOutside,
    Near,
    Center,
    Far,
    FarOutside
);

Members

Name	Description
`Default`

Default. The default horizontal or vertical legend pane position.

The default legend pane position can differ depending on the diagram or series type. In most cases, the Default option corresponds to the FarOutside value.

| | NearOutside |

This option works similar to Near. However, unlike Near, FarOutside always positions the legend pane outside the diagram area.

Use this option when you need to avoid diagram area overlapping.

| | Near |

A legend pane is aligned to the near border of its parent diagram or Chart control.

Horizontal Alignment

If the Near value specifies horizontal legend pane alignment, the “near” border position depends on the control’s BiDiMode property value:

bdLeftToRight | bdRightToLeftNoAlign | bdRightToLeftReadingOnlyThe left-to-right (default) application layout: the “near” border position corresponds to the left border of the parent diagram or Chart control.bdRightToLeftThe right-to-left application layout: the “near” border position corresponds to the right border of the parent diagram or Chart control.

Vertical Alignment

If the Near value specifies vertical legend pane alignment, the “near” border position corresponds to the bottom border of the parent diagram or Chart control.

| | Center |

A legend pane is centered horizontally or vertically within the parent diagram or Chart control area.

| | Far |

A legend pane is aligned to the far border of its parent diagram or Chart control.

Horizontal Alignment

If the Far value specifies horizontal legend pane alignment, the “far” border position depends on the control’s BiDiMode property value:

bdLeftToRight | bdRightToLeftNoAlign | bdRightToLeftReadingOnlyThe left-to-right (default) application layout: the “far” border position corresponds to the right border of the parent diagram or Chart control.bdRightToLeftThe right-to-left application layout: the “far” border position corresponds to the left border of the parent diagram or Chart control.

Vertical Alignment

If the Far value specifies vertical legend pane alignment, the “far” border position corresponds to the top border of the parent diagram or Chart control.

| | FarOutside |

This option works similar to Far. However, unlike Far, FarOutside always positions the legend pane outside the diagram area.

Use this option when you need to avoid diagram area overlapping.

Remarks

The following public API members reference the TdxChartLegendAlignment type:

TdxChartCustomLegend.AlignmentHorzSpecifies legend pane position within the Chart control or diagram area.TdxChartCustomLegend.AlignmentVertSpecifies vertical legend pane position within the Chart control or diagram area.

Note

TdxChartLegendAlignment is a scoped enumeration type. Use the type name together with a scope resolution token (. in Delphi or :: in C++Builder) followed by an enumeration value to refer to this value. For example, use TdxChartLegendAlignment.Center (in Delphi) or TdxChartLegendAlignment::Center (in C++Builder) to refer to the Center value in code.