grAxis object

The PowerBuilder class grAxis is used as part of a graph control. Each graph has three grAxis objects: Category, Series, and Values.

To refer to a property of an axis, use this syntax:

graphcontrolname.axisname.property

For example: gr_1.Series.AutoScale

A grAxis object has no events.

Properties

grAxis property

Datatype

Description

AutoScale

Boolean

Specifies whether PowerBuilder scales the axis automatically. Values are:

  • TRUE – Automatically scale

  • FALSE – Do not automatically scale

ClassDefinition

PowerObject

An object of type PowerObject containing information about the class definition of the object or control.

DataType

grAxisDataType (enumerated)

Specifies the datatype of the axis. Values are:

  • AdtDate!

  • AdtDateTime!

  • AdtDefault!

  • AdtDouble!

  • AdtText!

  • AdtTime!

DispAttr

grDispAttr (object)

Settings that control the appearance of the text that labels the axis divisions.

DisplayEveryNLabels

Integer

Specifies which major axis divisions to label. For example, 2 means label every other tick mark. Use 0 to let the graph select the optimum number of labels to use. If the labels are too long, they are clipped.

DropLines

LineStyle (enumerated)

Specifies the type of drop line for the axis. Values are:

  • Transparent! – No line appears

  • Continuous! – A solid line

  • Dash!

  • Dot!

  • DashDot!

  • DashDotDot!

Frame

LineStyle (enumerated)

Specifies the type of line used for the frame. See DropLines in this table for the list of values.

Label

String

Specifies the axis label.

LabelDispAttr

grDispAttr (object)

Settings that control the appearance of the axis label text.

MajorDivisions

Integer

Specifies the number of major divisions on the axis.

MajorGridLine

LineStyle (enumerated)

Specifies the type of line for the major grid.

See DropLines in this table for the list of values.

MajorTic

grTicType (enumerated)

Specifies the type of the major tick marks. Values are:

  • NoTic!

  • Inside!

  • Outside!

  • Straddle!

MaximumValue

Double

Specifies the maximum value for the axis when its datatype is numeric.

MaxValDateTime

DateTime

Specifies the maximum value for the axis when its datatype is date or time.

MinimumValue

Double

Specifies the minimum value for the axis when its datatype is numeric.

MinorDivisions

Integer

Specifies the number of minor divisions on the axis.

MinorGridLine

LineStyle (enumerated)

Specifies the type of line for the minor grid. See DropLines in this table for the list of values.

MinorTic

grTicType (enumerated)

Specifies the type of the minor tick marks. Values are:

  • NoTic!

  • Inside!

  • Outside!

  • Straddle!

MinValDateTime

DateTime

Specifies the minimum value for the axis when its datatype is date or time.

OriginLine

LineStyle (enumerated)

Specifies the type of origin line for the axis. See DropLines in this table for the list of values.

PrimaryLine

LineStyle (enumerated)

Specifies the type of primary line for the axis. See DropLines in this table for the list of values.

RoundTo

Double

Specifies the value to which you want to round the axis values.

RoundToUnit

grRoundToType (enumerated)

Specifies the units for the rounding value. The units must be appropriate for the axis datatype. Values are listed below.

For an axis of any datatype:

  • RndDefault!

For an axis of any numeric datatype:

  • RndNumber!

For an axis of type date or DateTime:

  • RndYears!

  • RndMonths!

  • RndDays!

For an axis of type time or DateTime:

  • RndHours!

  • RndMinutes!

  • RndSeconds!

  • RndMicroseconds!

ScaleType

grScaleType (enumerated)

Specifies the type of scale used for the axis. Values are:

  • Linear!

  • Log10!

  • Loge!

ScaleValue

grScaleValue (enumerated)

Specifies the scale of values on the axis. Values are:

  • Actual!

  • Cumulative!

  • Percentage!

  • CumPercent!

SecondaryLine

LineStyle (enumerated)

Specifies the type of secondary line for the axis. See DropLines in this table for the list of values.

ShadeBackEdge

Boolean

Specifies whether the back edge of the axis is shaded. Values are:

  • TRUE – Shaded.

  • FALSE – Not shaded.

Functions

grAxis function

Datatype returned

Description

ClassName

String

Returns the name assigned to the object.

GetContextService

Integer

Creates a reference to a context-specific instance of the specified service.

GetParent

PowerObject

Returns a reference to the name of the parent object.

TypeOf

Object

Returns the type of the object.