ReferenceArea Class Properties

These properties are used by the ReferenceArea class. The properties are described in alphabetic order.

Description

Use this property to specify which chart axis the reference area will be associated with. There is no default value; you must explicitly set the value of this property or the reference area will not appear in the chart. You can specify either an Integer or constant value for this property.

The values are:

Numeric Value

Constant Value

Description

1

%Ref_Association_Y1

Associate the reference area with the y-axis.

2

%Ref_Association_X1

Associate the reference area with the x-axis.

Note: This association can be made only if the x-axis is numeric.

This property is read/write.

Description

Use this property to specify a description of the reference area as a String value. This text will appear in the chart legend and should describe what the reference area represents in the chart. The text will be displayed only when the IsDisplayedTextInLegend property is True.

See “Setting Chart Legends” in the Chart class design guidelines for more information on creating chart legends.

This property is read/write.

Description

Use this property to specify a Boolean value indicating whether the Description property is displayed in the chart legend. The default value is True.

This property is read/write.

Description

Use this property to specify the color of the reference area as an Integer or constant value.

The following lists all the values you can specify. You can use either the numeric or constant value.

Numeric Value

Constant Value

Description

-1

%ChartColor_Series_Default

Default series color. When a data point is set to this, the default series color or the color that has been set by the programmer for that series is used instead. This value works only with the SetColorArray method of the Chart class.

0

%ChartColor_Black

Black

1

%ChartColor_Blue

Blue

2

%ChartColor_Cyan

Cyan

3

%ChartColor_DarkGray

Dark gray

4

%ChartColor_Gray

Gray

5

%ChartColor_Green

Green

6

%ChartColor_LightGray

Light gray

7

%ChartColor_Magenta

Magenta

8

%ChartColor_Orange

Orange

9

%ChartColor_Pink

Pink

10

%ChartColor_Red

Red

11

%ChartColor_White

White

12

%ChartColor_Yellow

Yellow

13

%ChartColor_Red_Orange

Red-orange

14

%ChartColor_Yellow_Green

Yellow-green

15

%ChartColor_Blue_Violet

Blue-violet

16

%ChartColor_Purple

Purple

17

%ChartColor_Yellow_Orange

Yellow-orange

This property is read/write.

Description

Use this property to specify whether the reference area is displayed in front of or behind the chart. You can specify either an Integer or constant value for this property.

The values are:

Numeric Value

Constant Value

Description

2

%Ref_Back

Display the reference area behind the chart.

Note: %Ref_Back is the default value.

1

%Ref_Front

Display the reference area on top of the chart.

This property is read/write.

Description

Use this property to specify an array of two numeric values. The values indicate the minimum and maximum for the reference area. The order of the values does not matter.

This property is read/write.

Description

Use this property to specify a short description for the reference area as a String value. This text will be displayed as the data hint for the reference area.

This property is read/write.