<< Click here to display Table of Contents >> Navigation: Code Documentation > RSCharting > RSChartPanel > Classes > TRSChartAxis:

TRSChartAxis Properties

Contents

Comments (0)

	Name	Description
	Brush	Represents property Brush.
	Charts	Tracks the list of RSChartPanel.TRSCustomChart components that are using this axis, either as their HorizontalAxis or VerticalAxis. Use the Charts property to iterate over all the charts for the axis.
	DateTimeFormat	Specifies the format of the chart values when the axis represents date time values. If the axis does not represent date time values, the Format property specifies the format of the chart values. The two format properties are used by the FormatValue method to return the proper string representation of a chart value. Use the IsDateTime method to determine if the axis is displaying date time values. The DateTimeFormat string is like other Delphi Date-Time Format Strings that specify the formatting of date-time values (such as TDateTime) when they are converted to strings. Date Time Format Strings are composed from specifiers that represent values to be inserted into the formatted string. Some specifiers (such as "d"), simply format numbers or strings. Other specifiers (such as "/") refer to locale-specific strings from global variables. In the following table, specifiers are given in lower case. Case is ignored in formats, except for the "am/pm" and "a/p" specifiers.
c	Displays the date using the format given by the ShortDateFormat global variable, followed by the time using the format given by the LongTimeFormat global variable. The time is not displayed if the date-time value indicates midnight precisely.
d	Displays the day as a number without a leading zero (1-31).
dd	Displays the day as a number with a leading zero (01-31).
ddd	Displays the day as an abbreviation (Sun-Sat) using the strings given by the ShortDayNames global variable.
dddd	Displays the day as a full name (Sunday-Saturday) using the strings given by the LongDayNames global variable.
ddddd	Displays the date using the format given by the ShortDateFormat global variable
dddddd	Displays the date using the format given by the LongDateFormat global variable.
e	(Windows only) Displays the year in the current period/era as a number without a leading zero (Japanese, Korean and Taiwanese locales only).
ee	(Windows only) Displays the year in the current period/era as a number with a leading zero (Japanese, Korean and Taiwanese locales only).
g	(Windows only) Displays the period/era as an abbreviation (Japanese and Taiwanese locales only).
gg	(Windows only) Displays the period/era as a full name. (Japanese and Taiwanese locales only).
m	Displays the month as a number without a leading zero (1-12). If the m specifier immediately follows an h or hh specifier, the minute rather than the month is displayed
mm	Displays the month as a number with a leading zero (01-12). If the mm specifier immediately follows an h or hh specifier, the minute rather than the month is displayed.
mmm	Displays the month as an abbreviation (Jan-Dec) using the strings given by the ShortMonthNames global variable
mmmm	Displays the month as a full name (January-December) using the strings given by the LongMonthNames global variable
yy	Displays the year as a two-digit number (00-99).
yyyy	Displays the year as a four-digit number (0000-9999).
h	Displays the hour without a leading zero (0-23).
hh	Displays the hour with a leading zero (00-23).
n	Displays the minute without a leading zero (0-59).
nn	Displays the minute with a leading zero (00-59).
s	Displays the second without a leading zero (0-59).
ss	Displays the second with a leading zero (00-59).
z	Displays the millisecond without a leading zero (0-999).
zzz	Displays the millisecond with a leading zero (000-999).
t	Displays the time using the format given by the ShortTimeFormat global variable
tt	Displays the time using the format given by the LongTimeFormat global variable.
am/pm	Uses the 12-hour clock for the preceding h or hh specifier, and displays 'am' for any hour before noon, and 'pm' for any hour after noon. The am/pm specifier can use lower, upper, or mixed case, and the result is displayed accordingly
a/p	Uses the 12-hour clock for the preceding h or hh specifier, and displays 'a' for any hour before noon, and 'p' for any hour after noon. The a/p specifier can use lower, upper, or mixed case, and the result is displayed accordingly
ampm	Uses the 12-hour clock for the preceding h or hh specifier, and displays the contents of the TimeAMString global variable for any hour before noon, and the contents of the TimePMString global variable for any hour after noon
/	Displays the date separator character given by the DateSeparator global variable
:	Displays the time separator character given by the TimeSeparator global variable
'xx'/"xx"	Characters enclosed in single or double quotes are displayed as-is, and do not affect formatting

Dimension

Represents property Dimension.

EndPosition

The StartPosition and EndPosition properties specify the end points of the axis, in percentage of the normal axis length. The StartPosition is usually 0%, meaning that, for the BottomAxis for example, the left end of the axis is all the way to the left, aligned against the LeftAxis. The EndPosition is usually 100%, meaning that the BottomAxis' right end is all the way to the right, aligned against with the RightAxis.

Specify a value greater than 0 for the StartPosition or less than 100 for the EndPosition to move the end points in and shorten the length of the axis.

Format

Sspecifies the format of the chart values when the axis represents floating point values. If the axis represents date time values, the DateTimeFormat property specifies the format of the chart values. The two format properties are used by the FormatValue method to return the proper string representation of a chart value. Use the IsDateTime method to determine if the axis is displaying date time values.

Grid

Defines the properties of the axis grid: tick marks, major and minor grid marks, and drawing pens.

Height

Returns the height (in pixels) of the chart axis. The Height and Width of the axis is calculated by the CalculateBounds method (or every time the axis draws).

InwardPosition

Controls where the chart axis paints within the chart grid. InwardPosition specifies the distance as a percentage from the edge where the axis would normally paint (left, top, right, bottom) towards the middle of the chart drawing area.

If InwardPosition is greater than 0, the chart axis is moved in toward the center, 50% would be the center of the rectangle.

IsDrawing

Represents property IsDrawing.

LabelIncrement

Defines the amount to increment the value for the Labels between each label. When LabelIncrement is 0, the TRSChartAxis calculates the increment for the labels by trying to use MinSpacing and then growing as needed. Set LabelIncrement to a non-zero value to define the amount yourself

Labels

Defines the properties of the chart axis labels, including Font , Alignment, and Angle.

LabelStyle

Defines the style of the chart axes' labels, e.g., whether the labels are numeric or RSChartPanel.TRSChartValue Captions.

Location

Specifies the location (left, right, top, bottom) of the chart axis in the RSChartPanel.TRSChartPanel

LogarithmicType

Defines the logarithmic equation type to apply to the chart axis

LogBase

Defines the log base for when the axis is displaying a grid using the logarithmic Options .

LogCycles

Defines whether the axis should cycle (start over) as it draws a logarithmic grid. If LogCycle is false, one cycle covers the entire axis range.

Maximum

Specifies the maximum value for the range of the axis. The Minimum and Maximum properties specify the full range of the axis, regardless of whether the axis is zoomed or not. The ZoomMinimum and ZoomMaximum properties return the zoomed range of the axis - when the axis is not zoomed, these properties equal the minimum and maximum properties.

Use the Maximum property to set the full maximum range of the axis. Alternatively, you can include axAutomaticMaximum in the Options property and the axis will automatically calculate the maximum value based on the chart values ( RSChartPanel.TRSChartValues class). Setting the Maximum property manually causes the axis to remove the axAutomaticMaximum member from the Options set.

MaxLabelWidth

Represents property MaxLabelWidth.

Minimum

Specifies the minimum value for the range of the axis. The Minimum and Maximum properties specify the full range of the axis, regardless of whether the axis is zoomed or not. The ZoomMinimum and ZoomMaximum properties return the zoomed range of the axis - when the axis is not zoomed, these properties equal the minimum and maximum properties.

Use the Minimum property to set the full mnimum range of the axis. Alternatively, you can include axAutomaticMinimum in the Options property and the axis will automatically calculate the minimum value based on the chart values ( RSChartPanel.TRSChartValues class). Setting the Minimum property manually causes the axis to remove the axAutomaticMinimum member from the Options set.

MinSeparationPct

Specifies the minimum separation between labels in percent of axis size. This property controls how close together the labels will appear on the axis. This property is obviously closely tied to the Labels property as such things as Font and Angle can affect how many labels can be squeezed into an axis.

MinStepIncrement

Specifies the minimum amount, in chart axis values, that the major grid marks and their labels should use. This value is usually 0 to let the chart axis choose the stepping increment. For example, if the chart axis would choose an increment of 10, e.g., 0, 10, 20, 30, etc, for the major grid, by setting this property to 25 you would force the stepping increment to be 0, 25, 50, etc. Note that setting this property to 5 would have no effect on the stepping increment in the above case.

NeedAxisUpdate

Represents property NeedAxisUpdate.

Opacity

Represents property Opacity.

Options

Defines the set of display and computation options for the chart axis. This property allows you to make the chart axis calculate the Minimum and Maximum values automatically, display labels and titles, and other options. Please see RSChartConsts|TAxisOption for more information.

Owner

Returns the RSChartPanel.TRSCustomChartPanel instance that owns the chart axis.

Pen

Represents property Pen.

SnapGrid

Controls whether the grid (and labels) should "snap" to the evenly divisibles of the Spacing (e.g., instead of 13, 23, 33, it would be 10, 20, 30)

StartPosition

Specify a value greater than 0 for the StartPosition or less than 100 for the EndPosition to move the end points in and shorten the length of the axis.

Title

Defines the label and display properties of the chart axis Title. The title is the caption that describes what the axis' value labels mean, e.g., 'Temperature (C)' is a title for an axis that has values running from 0 to 100

TitleMargin

Defines the amount in pixels between the axis Title and the rest of the axis.

Visible

Represents property Visible.

Width

Returns the width (in pixels) of the chart axis. The Height and Width of the axis is calculated by the CalculateBounds method (or every time the axis draws).

Zooming

Indicates if the chart axis is zoomed in or not, (e.g., ZoomMinimum = Minimum and ZoomMaximum = Maximum).

ZoomMaximum

The ZoomMaximum and ZoomMinimum properties allow you to programmatically zoom the chart axis to a portion of the Maximum - Minimum range. It allows you to change the portion of the axis that is being visually displayed. If the chart axis is not being zoomed, then these properties will equal the chart axis range (and Zooming return False).

Use ZoomMaximum and ZoomMinimum to zoom the chart axis or use the Zoom method.

ZoomMinimum

Use ZoomMaximum and ZoomMinimum to zoom the chart axis or use the Zoom method.

Top

Comments (0)