Packagecom.amcharts.axes
Classpublic class AxisBase
InheritanceAxisBase Inheritance mx.core.UIComponent
SubclassesCategoryAxis, ValueAxis

AxisBase is the base class for ValueAxis and CategoryAxis. It can not be instantiated explicitly.


Public Properties
 PropertyDefined by
  guides : Array
The array of guides belonging to this axis.
AxisBase
  ignoreAxisWidth : Boolean
If autoMargins property of a chart is set to true but you don't want this axis to be measured when calculating margin width, set ignoreAxisWidth to true
AxisBase
  inside : Boolean
Whether values should be placed inside or outside plot area.
AxisBase
  labelFunction : Function
Label function.
AxisBase
  maxLabelLength : Number
Maximum length (number of symbols) of a label.
AxisBase
  maxLabelWidth : Number
[read-only] returns max width of values
AxisBase
  offset : Number
The distance of the axis to the plot area, in pixels.
AxisBase
  position : String
Position of the axis.
AxisBase
  title : String
Axis title will be displayed next to axis.
AxisBase
  titleAlignment : String
Alignment of axis title.
AxisBase
  titleTextColor : Number
Text color of axis title Will use default axis color style value if not set
AxisBase
  titleTextSize : Number
Text size of axis title
AxisBase
  valueClickHandler : Function
Method which will be called when user clicks on the axis label
AxisBase
Public Methods
 MethodDefined by
  
AxisBase()
Constructor.
AxisBase
  
addGuide(guide:Guide):Guide
Adds guide to the axis
AxisBase
  
removeGuide(guide:Guide):void
Removes guide from the axis
AxisBase
Events
 EventSummaryDefined by
  
axisWidthChanged
Dispatched every time when axis is rebuild.AxisBase
Styles
 StyleDescriptionDefined by
  
autoGridCount
Type: Boolean   CSS Inheritance: no
Specifies whether number of gridCount is specified automatically, acoarding to the axis size. The default value is false.		AxisBase
  
axisAlpha
Type: Number   CSS Inheritance: no
Axis opacity. The default value is 1.		AxisBase
  
axisColor
Type: uint   Format: Color   CSS Inheritance: no
Axis color. The default value is 0x000000.		AxisBase
  
axisThickness
Type: Number   CSS Inheritance: no
Thickness of the axis. 0 means axis will be 1 pixel wide. To make the axis invisible, set axisAlpha to 0. The default value is 1.		AxisBase
  
axisTitleOffset
Type: Number   CSS Inheritance: no
Specifies the distance from Radar axis end to the axis title The default value is 10.		AxisBase
  
color
Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component, including the component label. The default value is 0x0B333C.		AxisBase
  
dashLength
Type: Number   CSS Inheritance: no
length of a dash. By default, the grid line is not dashed. Radar Chart: in case gridType is "circles", they will not be dashed. The default value is 0.		AxisBase
  
disabledColor
Type: uint   Format: Color   CSS Inheritance: yes
Color of text in the component if it is disabled. The default value is 0xAAB3B3.		AxisBase
  
fillAlpha
Type: Number   CSS Inheritance: no
Fill opacity. Every second space between grid lines can be filled with color. Set fillAlpha to a value greater than 0 to see the fills. The default value is 0.		AxisBase
  
fillColor
Type: Number   CSS Inheritance: no
Fill color. Every second space between grid lines can be filled with color. Set fillAlpha to a value greater than 0 to see the fills. The default value is 0xFFFFFF.		AxisBase
  
fontAntiAliasType
Type: String   CSS Inheritance: yes
Sets the antiAliasType property of internal TextFields. The possible values are "normal" (flash.text.AntiAliasType.NORMAL) and "advanced" (flash.text.AntiAliasType.ADVANCED).

The default value is "advanced", which enables advanced anti-aliasing for the font. Set to "normal" to disable the advanced anti-aliasing.

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you cannot apply it to some characters and not others.

The default value is "advanced".		AxisBase
  
fontFamily
Type: String   CSS Inheritance: yes
Name of the font to use. Unlike in a full CSS implementation, comma-separated lists are not supported. You can use any font family name. If you specify a generic font name, it is converted to an appropriate device font. The default value is "Verdana".		AxisBase
  
fontGridFitType
Type: String   CSS Inheritance: yes
Sets the gridFitType property of internal TextFields that represent text in Flex controls. The possible values are "none" (flash.text.GridFitType.NONE), "pixel" (flash.text.GridFitType.PIXEL), and "subpixel" (flash.text.GridFitType.SUBPIXEL).

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is "pixel".		AxisBase
  
fontSharpness
Type: Number   CSS Inheritance: yes
Sets the sharpness property of internal TextFields that represent text in Flex controls. This property specifies the sharpness of the glyph edges. The possible values are Numbers from -400 through 400.

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This style has no effect for system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is 0.		AxisBase
  
fontSize
Type: Number   Format: Length   CSS Inheritance: yes
Height of the text, in pixels. The default value is 10 for all controls except the ColorPicker control. For the ColorPicker control, the default value is 11. 		AxisBase
  
fontStyle
Type: String   CSS Inheritance: yes
Determines whether the text is italic font. Recognized values are "normal" and "italic". The default value is "normal".		AxisBase
  
fontThickness
Type: Number   CSS Inheritance: yes
Sets the thickness property of internal TextFields that represent text in Flex controls. This property specifies the thickness of the glyph edges. The possible values are Numbers from -200 to 200.

This property only applies when you are using an embedded font and the fontAntiAliasType property is set to "advanced".

This style has no effect on system fonts.

This style applies to all the text in a TextField subcontrol; you can't apply it to some characters and not others.

The default value is 0.		AxisBase
  
fontWeight
Type: String   CSS Inheritance: yes
Determines whether the text is boldface. Recognized values are normal and bold. The default value for Button controls is bold. The default value for all other controls is normal. 		AxisBase
  
gridAlpha
Type: Number   CSS Inheritance: no
Opacity of grid lines. The default value is 0.2.		AxisBase
  
gridColor
Type: uint   Format: Color   CSS Inheritance: no
Color of grid lines. The default value is 0x000000.		AxisBase
  
gridCount
Type: Number   CSS Inheritance: no
Number of grid lines. In case this is value axis, or your categoryAxis parses dates, the number is approximate. The default value is 5.		AxisBase
  
gridThickness
Type: Number   CSS Inheritance: no
Thickness of grid lines. The default value is 0.		AxisBase
  
gridType
Type: String   CSS Inheritance: no
Grid type, used by Radar chart only. The default value is polygons.		AxisBase
  
kerning
Type: Boolean   CSS Inheritance: yes
A Boolean value that indicates whether kerning is enabled (true) or disabled (false). Kerning adjusts the gap between certain character pairs to improve readability, and should be used only when necessary, such as with headings in large fonts. Kerning is supported for embedded fonts only. Certain fonts, such as Verdana, and monospaced fonts, such as Courier New, do not support kerning. The default value is false.		AxisBase
  
labelBackgroundAlpha
Type: Number   CSS Inheritance: yes
Label background opacity. The default value is 0.		AxisBase
  
labelBackgroundColor
Type: Number   Format: Color   CSS Inheritance: yes
Label background color. Set labelBackgroundAlpha to a value greater than 0 to see the background. The default value is 0xDADADA.		AxisBase
  
labelFrequency
Type: Number   CSS Inheritance: no
Frequency at which labels should be placed. Doesn't work for CategoryAxis if parseDates is set to true. The default value is 1.		AxisBase
  
labelRotation
Type: Number   CSS Inheritance: no
Rotation angle of a label. Only horizontal axis' values can be rotated. If you set this for vertical axis, the setting will be ignored. In case you rotate axis' values, you should embed fonts. Check rotatedAxisLabels example to see this in action. The default value is 0.		AxisBase
  
labelsEnabled
Type: Boolean   CSS Inheritance: no
Specifies whether axis displays category axis' labels and value axis' values The default value is true.		AxisBase
  
letterSpacing
Type: Number   CSS Inheritance: yes
The number of additional pixels to appear between each character. A positive value increases the character spacing beyond the normal spacing, while a negative value decreases it. The default value is 0.		AxisBase
  
radarCategoriesEnabled
Type: Boolean   CSS Inheritance: no
Specifies whether Radar chart displays categories at the end of the axis The default value is true.		AxisBase
  
showFirstLabel
Type: Boolean   CSS Inheritance: no
Whether to show first axis label or not. The default value is true.		AxisBase
  
showLastLabel
Type: Boolean   CSS Inheritance: no
Whether to show last axis label or not. The default value is true.		AxisBase
  
textAlign
Type: String   CSS Inheritance: yes
Alignment of text within a container. Possible values are "left", "right", or "center".

The default value for most components is "left". For the FormItem component, the default value is "right". For the Button, LinkButton, and AccordionHeader components, the default value is "center", and this property is only recognized when the labelPlacement property is set to "left" or "right". If labelPlacement is set to "top" or "bottom", the text and any icon are centered.

AxisBase
  
textDecoration
Type: String   CSS Inheritance: yes
Determines whether the text is underlined. Possible values are "none" and "underline". The default value is "none".		AxisBase
  
textIndent
Type: Number   Format: Length   CSS Inheritance: yes
Offset of first line of text from the left side of the container, in pixels. The default value is 0.		AxisBase
  
tickLength
Type: Number   CSS Inheritance: no
Tick length. The default value is 5.		AxisBase
  
valueRollOverColor
Type: uint   Format: Color   CSS Inheritance: no
value roll over color (only works if valueClickHandler is set) The default value is #CC0000.		AxisBase
Property detail
guidesproperty
guides:Array  [read-write]

The array of guides belonging to this axis.

Implementation
    public function get guides():Array
    public function set guides(value:Array):void
ignoreAxisWidthproperty 
ignoreAxisWidth:Boolean  [read-write]

If autoMargins property of a chart is set to true but you don't want this axis to be measured when calculating margin width, set ignoreAxisWidth to true

The default value is false.

Implementation
    public function get ignoreAxisWidth():Boolean
    public function set ignoreAxisWidth(value:Boolean):void
insideproperty 
inside:Boolean  [read-write]

Whether values should be placed inside or outside plot area. In Radar chart this property defines whether values shuold be placed on the left or on the right of the axis (false=left).

The default value is false.

Implementation
    public function get inside():Boolean
    public function set inside(value:Boolean):void
labelFunctionproperty 
labelFunction:Function  [read-write]

Label function. Value of axis label will be passed to it and this function should return string which will be displayed instead of the value.

The default value is undefined.

Implementation
    public function get labelFunction():Function
    public function set labelFunction(value:Function):void
maxLabelLengthproperty 
maxLabelLength:Number  [read-write]

Maximum length (number of symbols) of a label. If label is longer, it will be truncated. 0 means that labels won't be truncated.

The default value is 0.

Implementation
    public function get maxLabelLength():Number
    public function set maxLabelLength(value:Number):void
maxLabelWidthproperty 
maxLabelWidth:Number  [read-only]

returns max width of values

Implementation
    public function get maxLabelWidth():Number
offsetproperty 
offset:Number  [read-write]

The distance of the axis to the plot area, in pixels. Useful if you have more then one axis on the same side. This property has no effect on Radar chart.

The default value is 0.

Implementation
    public function get offset():Number
    public function set offset(value:Number):void
positionproperty 
position:String  [read-write]

Position of the axis. Category axis' default position is "bottom". Value axis' default position is "left". This property has no effect on Radar chart.

Implementation
    public function get position():String
    public function set position(value:String):void
titleproperty 
title:String  [read-write]

Axis title will be displayed next to axis. Note, in order title to be visible near vertical axis, you'll need to embed fonts.

Implementation
    public function get title():String
    public function set title(value:String):void
titleAlignmentproperty 
titleAlignment:String  [read-write]

Alignment of axis title. Possivle values are: "center", "left", "right"

Implementation
    public function get titleAlignment():String
    public function set titleAlignment(value:String):void
titleTextColorproperty 
titleTextColor:Number  [read-write]

Text color of axis title Will use default axis color style value if not set

Implementation
    public function get titleTextColor():Number
    public function set titleTextColor(value:Number):void
titleTextSizeproperty 
titleTextSize:Number  [read-write]

Text size of axis title

The default value is 12.

Implementation
    public function get titleTextSize():Number
    public function set titleTextSize(value:Number):void
valueClickHandlerproperty 
valueClickHandler:Function  [read-write]

Method which will be called when user clicks on the axis label

The default value is null.

Implementation
    public function get valueClickHandler():Function
    public function set valueClickHandler(value:Function):void
Constructor detail
AxisBase()constructor
public function AxisBase()

Constructor.

Method detail
addGuide()method
public function addGuide(guide:Guide):Guide

Adds guide to the axis

Parameters
guide:Guide

Returns
Guide
fixPosition()method 
amcharts_com_internal function fixPosition():void
removeGuide()method 
public function removeGuide(guide:Guide):void

Removes guide from the axis

Parameters
guide:Guide
Event detail
axisWidthChangedevent 
Event object type: com.amcharts.events.AxisEvent

Dispatched every time when axis is rebuild. AxisEvent has property width which is width of axis labels.