Google Git
Sign in
apache / royale-website / refs/heads/asf-staging / . / asdoc / mx / charts / AxisRenderer.js.json
blob: 4ac37b9154afd65cc20f733c5fe244fed55533c6 [file] [log] [blame]
{ "type": "class",
"qname": "mx.charts.AxisRenderer",
"baseClassname": "mx.charts.chartClasses.DualStyleObject"
,
"description": "You use the AxisRenderer class to describe the horizontal and vertical axes of a chart. An axis is responsible for rendering the labels, tick marks, and title along its length. <p>AxisRenderer objects inherit some of their visual properties from the enclosing chart object. The text format of the labels and title defaults to the CSS text properties of the renderer. You can control the formatting of the axis title separately by specifying a <code>axisTitleStyleName</code>, either on the AxisRenderer or on the enclosing chart.</p> <p>When positioning and sizing labels, the AxisRenderer takes a minimum amount of the chart's available space. If labels take too much space, then the AxisRenderer scales them. However, the AxisRenderer does not scale the labels to too small of a point size. To increase readability, the AxisRenderer chooses one of the following layout methods based on the one that requires the least scaling:</p> <ul> <li>Render the labels horizontally end to end.</li> <li>Stagger the labels horizontally in two rows.</li> <li>Rotate the labels to fit them in the space provided. The AxisRenderer rotates the labels to the minimum angle needed to prevent them from overlapping. The maximum angle is 90 degrees.</li> </ul> <p>The AxisRenderer adjusts the boundaries of the chart's data area to ensure that it can draw the labels without pushing outside of the boundaries.</p> <p>The <code>&lt;mx:AxisRenderer&gt;</code> tag inherits all the properties of its parent classes, and adds the following properties:</p> <pre>\\n &lt;mx:AxisRenderer\\n <strong>Properties</strong>\\n axis=&quot;<i>IAxis</i>&quot;\\n chart=&quot;<i>ChartBase</i>&quot;\\n gutters=&quot;<i>Rectangle</i>&quot;\\n heightLimit=&quot;<i>Number</i>&quot;\\n labelRenderer=&quot;<i>IFactory</i>&quot;\\n labelFunction=&quot;<i>Function</i>&quot;\\n length=&quot;<i>Number</i>&quot;\\n otherAxes=&quot;<i>Array</i>&quot;\\n placement=&quot;right|left|bottom|top&quot;\\n ticks=&quot;<i>Array</i>&quot;\\n titleRenderer=&quot;<i>IFactory</i>&quot;\\n \\n <strong>Styles</strong>\\n axisStroke=&quot;<i>No default</i>&quot;\\n axisTitleStyleName=&quot;<i>No default</i>&quot;\\n canDropLabels=&quot;true|false&quot;\\n canStagger=&quot;true|false&quot;\\n labelAlign=&quot;center|left|right&quot; (horizontal axes) or &quot;center|top|bottom&quot; (vertical axes)\\n labelGap=&quot;3&quot;\\n labelRotation=&quot;<i>No default</i>&quot;\\n minorTickLength=&quot;<i>Default depends on axis</i>&quot;\\n minorTickPlacement=&quot;none|inside|outside|cross&quot;\\n minorTickStroke=&quot;<i>No default</i>&quot;\\n showLabels=&quot;true|false&quot;\\n showLine=&quot;true|false&quot;\\n tickLength=&quot;<i>Default depends on axis</i>&quot;\\n tickPlacement=&quot;inside|outside|cross|none&quot;\\n tickStroke=&quot;<i>No default</i>&quot;\\n verticalAxisTitleAlignment=&quot;flippedVertical|vertical&quot;\\n /&gt;\\n </pre>",
"tags": [
{ "tagName": "includeExample",
"values": ["examples/HLOCChartExample.mxml"]},
{ "tagName": "mxml",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"members": [
{ "type": "method",
"qname": "mx.charts.AxisRenderer",
"namespace": "",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Constructor.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "",
"params": []}
,
{ "type": "accessor",
"access": "read-write",
"return": "mx.charts.chartClasses.IAxis",
"qname": "axis",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The axis object associated with this renderer. This property is managed by the enclosing chart, and could be explicitly set if multiple axes renderers are used.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "mx.charts.chartClasses.ChartBase",
"qname": "chart",
"namespace": "protected",
"bindable": [],
"details": [],
"deprecated": {},
"description": "The base chart for this AxisRenderer.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "org.apache.royale.geom.Rectangle",
"qname": "gutters",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Number",
"qname": "heightLimit",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "highlightElements",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Specifies wheter to highlight chart elements like Series on mouse rollover.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Boolean",
"qname": "horizontal",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "Function",
"qname": "labelFunction",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Called to format axis renderer values for display as labels. A <code>labelFunction</code> has the following signature: <pre>\\n function labelFunction(<i>axisRenderer</i>:IAxisRenderer, <i>label</i>:String):String { ... }\\n </pre>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "mx.core.IFactory",
"qname": "labelRenderer",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A reference to the factory used to render the axis labels. This type must implement the IDataRenderer and IFlexDisplayObject interfaces. <p>The AxisRenderer will create one instance of this class for each label on the axis. The labelRenderer's data property is assigned an AxisLabel object containing the value and label to be rendered.</p>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Number",
"qname": "length",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Specifies the length of the axis, in screen coordinates. The default length depends on a number of factors, including the size of the chart, the size of the labels, how the AxisRenderer chooses to lay out labels, and any requirements imposed by other portions of the chart.",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Array",
"qname": "minorTicks",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "write-only",
"return": "Array",
"qname": "otherAxes",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "String",
"qname": "placement",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-only",
"return": "Array",
"qname": "ticks",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "mx.core.IFactory",
"qname": "titleRenderer",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "A reference to the factory used to render the axis title. This type must extend UIComponent and implement the IDataRenderer and IFlexDisplayObject interfaces. <p>The AxisRenderer will create an instance of this class for title of the axis. The titleRenderer's data property is assigned the title to be rendered.</p>",
"tags": [
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "accessor",
"access": "read-write",
"return": "mx.core.IFlexModuleFactory",
"qname": "moduleFactory",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ]},
{ "type": "method",
"qname": "invalidateSize",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "invalidateDisplayList",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "measure",
"namespace": "protected",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": []}
,
{ "type": "method",
"qname": "updateDisplayList",
"namespace": "protected",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "unscaledWidth", "type": "Number"},
{ "name": "unscaledHeight", "type": "Number"}]}
,
{ "type": "method",
"qname": "move",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "x", "type": "Number"},
{ "name": "y", "type": "Number"}]}
,
{ "type": "method",
"qname": "setActualSize",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "w", "type": "Number"},
{ "name": "h", "type": "Number"}]}
,
{ "type": "method",
"qname": "chartStateChanged",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "Called by the chart to indicate when its current transition state has changed.",
"tags": [
{ "tagName": "param",
"values": ["oldState A number representing the old state.", "newState A number representing the new state."]},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "void",
"params": [{ "name": "oldState", "type": "uint"},
{ "name": "newState", "type": "uint"}]}
,
{ "type": "method",
"qname": "adjustGutters",
"namespace": "public",
"bindable": [],
"details": [],
"deprecated": {},
"description": "",
"tags": [
{ "tagName": "inheritDoc",
"values": []},
{ "tagName": "playerversion",
"values": ["Flash 9", "AIR 1.1"]},
{ "tagName": "productversion",
"values": ["Flex 3"]},
{ "tagName": "langversion",
"values": ["3.0"]} ],
"return": "org.apache.royale.geom.Rectangle",
"params": [{ "name": "workingGutters", "type": "org.apache.royale.geom.Rectangle"},
{ "name": "adjustable", "type": "Object"}]}
,
{ "type": "method",
"qname": "addedToParent",
"namespace": "public",
"bindable": [],
"details": ["override"],
"deprecated": {},
"return": "void",
"params": []}
]
}