Package | mx.charts |
Classe | public class CategoryAxis |
Héritage | CategoryAxis AxisBase EventDispatcher Object |
Implémente | IAxis |
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Il n’est pas obligatoire de définir explicitement la propriété dataProvider
d’une classe CategoryAxis. La classe CategoryAxis utilisée dans un graphique hérite de la propriété dataProvider
du graphique conteneur.
Même si vous pouvez utiliser le même fournisseur de données pour fournir des données au graphique et des catégories à la classe CategoryAxis, la classe CategoryAxis peut optimiser le rendu si son fournisseur de données est relativement statique. Si possible, veillez à ce que les catégories restent relativement statiques et à ce que les données couramment modifiées soient stockées dans des fournisseurs de données séparés.
La propriété dataProvider
peut accepter soit un tableau de chaînes, soit un tableau d’enregistrements (objets) contenant une propriété qui spécifie le nom de catégorie. Si vous spécifiez une propriété categoryField
, la classe CategoryAxis suppose que le fournisseur de données est un tableau d’objets. Si la valeur de la propriété categoryField
est null
, la classe CategoryAxis suppose que le fournisseur de données est un tableau de chaînes.
The <mx:CategoryAxis>
tag inherits all the properties
of its parent classes and adds the following properties:
<mx:CategoryAxis Properties categoryField="null" dataFunction="No default" dataProvider="No default" labelFunction="No default" padding="Default depends on chart type" ticksBetweenLabels="true" />
Propriété | Défini par | ||
---|---|---|---|
baseline : Number [lecture seule]
Position de la ligne de base de l’axe. | CategoryAxis | ||
categoryField : String
Spécifie le champ du fournisseur de données qui contient le texte des libellés. | CategoryAxis | ||
chartDataProvider : Object [écriture seule]
Fournisseur de données affecté au graphique conteneur. | AxisBase | ||
constructor : Object
Référence à l’objet de classe ou à la fonction constructeur d’une occurrence donnée d’un objet. | Object | ||
dataFunction : Function
Spécifie une méthode qui renvoie la valeur à utiliser comme valeur categoryValue pour l’élément actuel. Si cette propriété est définie, la valeur de retour de la fonction de données personnalisée est prioritaire par rapport à la propriété categoryField. La fonction dataFunction personnalisée présente la signature suivante : nom_fonction (axis:CategoryAxis, item:Object):Object { ... | CategoryAxis | ||
dataProvider : Object
Spécifie la source de données contenant les noms des libellés. | CategoryAxis | ||
displayName : String
Nom de l’axe. | AxisBase | ||
labelFunction : Function
Spécifie une fonction qui définit les libellés générés pour chaque élément dans le fournisseur dataProvider de l’objet CategoryAxis. | CategoryAxis | ||
padding : Number
Spécifie la marge ajoutée de part et d’autre de l’axe lors du rendu de l’élément à l’écran. | CategoryAxis | ||
ticksBetweenLabels : Boolean
Spécifie la position des graduations principales le long de l’axe, par rapport aux libellés des catégories. | CategoryAxis | ||
title : String
Texte du titre affiché le long de l’axe. | AxisBase | ||
unitSize : Number [lecture seule]
Taille d’une unité de données représentée par cet axe. | AxisBase |
Méthode | Défini par | ||
---|---|---|---|
Constructeur. | CategoryAxis | ||
addEventListener(type:String, listener:Function, useCapture:Boolean = false, priority:int = 0, useWeakReference:Boolean = false):void
Enregistre un objet écouteur d’événement auprès d’un objet EventDispatcher afin que l’écouteur soit averti d’un événement. | EventDispatcher | ||
Déclenche des événements qui signalent à l’objet de plage de valeurs que les données du graphique ont changé. | AxisBase | ||
Distribue un événement dans le flux d’événements. | EventDispatcher | ||
Filtre un ensemble de valeurs de type arbitraire pour produire un ensemble de nombres qui peuvent être mappés. | CategoryAxis | ||
Formate les valeurs pour les afficher dans des objets DataTip. | CategoryAxis | ||
Détermine la plage de valeurs permettant d’estimer les libellés d’axe appropriés. | CategoryAxis | ||
Obtient le texte des libellés rendus. | CategoryAxis | ||
Vérifie si des écouteurs sont enregistrés auprès de l’objet EventDispatcher pour un type spécifique d’événement. | EventDispatcher | ||
Indique si la propriété spécifiée d’un objet est définie. | Object | ||
Mappe une position le long de l’axe à une valeur de données numérique. | CategoryAxis | ||
Indique si une occurrence de la classe Object figure dans la chaîne de prototype de l’objet spécifié en tant que paramètre. | Object | ||
Convertit un ensemble de valeurs de type arbitraire en un ensemble de nombres qui peuvent être transformés en coordonnées d’écran. | CategoryAxis | ||
Détermine la manière dont l’axe traite les libellés qui se chevauchent. | CategoryAxis | ||
Indique si la propriété spécifiée existe et est énumérable. | Object | ||
Appelée lorsqu’un objet AxisRenderer est incapable de rendre correctement les libellés sans chevauchement et qu’il souhaite que l’objet Axis réduise l’ensemble de libellés. | CategoryAxis | ||
Chaque transformation DataTransform qui utilise un axe s’enregistre auprès de cet axe. | AxisBase | ||
Supprime un écouteur de l’objet EventDispatcher. | EventDispatcher | ||
Définit la disponibilité d’une propriété dynamique pour les opérations en boucle. | Object | ||
Renvoie la représentation de chaîne de cet objet, formatée selon les paramètres régionaux en vigueur. | Object | ||
Renvoie la représentation sous forme de chaîne de l’objet spécifié. | Object | ||
Mappe à l’espace d’écran un ensemble de valeurs issues de l’espace de données. | CategoryAxis | ||
Chaque transformation DataTransform qui utilise un axe s’enregistre auprès de cet axe. | AxisBase | ||
Met à jour le graphique. | CategoryAxis | ||
Renvoie la valeur primitive de l’objet spécifié. | Object | ||
Vérifie si un écouteur d’événement est enregistré auprès de cet objet EventDispatcher ou de ses ancêtres pour le type d’événement spécifié. | EventDispatcher |
baseline | propriété |
baseline:Number
[lecture seule] Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Position de la ligne de base de l’axe. Certaines séries telles que ColumnSeries ou AreaSeries utilisent cette valeur pour définir la base d’une région remplie lorsqu’aucune valeur minimale n’est spécifiée.
Implémentation
public function get baseline():Number
categoryField | propriété |
categoryField:String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Spécifie le champ du fournisseur de données qui contient le texte des libellés. Si la valeur de cette propriété est null
, l’objet CategoryAxis suppose que le fournisseur de données contient un tableau de chaînes.
La valeur par défaut est null.
Implémentation
public function get categoryField():String
public function set categoryField(value:String):void
dataFunction | propriété |
dataFunction:Function
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Spécifie une méthode qui renvoie la valeur à utiliser comme valeur categoryValue pour l’élément actuel. Si cette propriété est définie, la valeur de retour de la fonction de données personnalisée est prioritaire par rapport à la propriété categoryField
La fonction dataFunction
personnalisée présente la signature suivante :
function_name (axis:CategoryAxis, item:Object):Object { ... }
axe
correspond à l’axe actuel qui utilise cette fonction dataFunction
. item
correspond à l’élément pris en compte dans le fournisseur dataProvider. Cette fonction renvoie un objet.
Une fonction dataFunction
personnalisée permet par exemple de renvoyer une valeur à partir d’un fournisseur dataProvider contenant des éléments à champs imbriqués
Implémentation
public function get dataFunction():Function
public function set dataFunction(value:Function):void
Exemple
Comment utiliser cet exemple
public function myFunction(axis:CategoryAxis,item:Object):Object { return(item.Country.State); }
dataProvider | propriété |
dataProvider:Object
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Spécifie la source de données contenant les noms des libellés. Le fournisseur dataProvider
peut être un tableau de valeurs, un tableau d’objets ou tout objet implémentant l’interface IList ou ICollectionView. Si le fournisseur dataProvider
est un tableau de chaînes, veillez à ce que la propriété categoryField
soit définie sur null
. Si le fournisseur dataProvider est un tableau d’objets, définissez la propriété categoryField
sur le nom du champ contenant le texte du libellé.
Implémentation
public function get dataProvider():Object
public function set dataProvider(value:Object):void
labelFunction | propriété |
labelFunction:Function
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Spécifie une fonction qui définit les libellés générés pour chaque élément dans le fournisseur dataProvider
de l’objet CategoryAxis. Si aucune fonction labelFunction
n’est fournie, les libellés d’axe prennent par défaut la valeur de la catégorie elle-même.
La méthode labelFunction
d’un objet CategoryAxis présente la signature suivante :
function function_name(categoryValue:Object, previousCategoryValue:Object, axis:CategoryAxis, categoryItem:Object):String { ... }
Où :
categoryValue
correspond à la valeur de la catégorie à représenter.previousCategoryValue
correspond à la valeur de la catégorie précédente sur l’axe.axis
correspond à l’objet CategoryAxis à rendre.categoryItem
correspond à l’élément du fournisseurdataProvider
qui est représenté.
Flex affiche la chaîne renvoyée en tant que libellé de l’axe.
Si la propriété categoryField
n’est pas définie, la valeur est identique à celle de la propriété categoryValue
.
Implémentation
public function get labelFunction():Function
public function set labelFunction(value:Function):void
padding | propriété |
padding:Number
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Spécifie la marge tée de part et d’autre de l’axe lors du rendu de l’élément à l’écran. Définissez cette valeur sur 0 pour placer la première catégorie au tout début de l’axe et la dernière catégorie à la fin. Définissez cette valeur sur 0.5 pour conserver une marge correspondant à la moitié de la largeur d’une catégorie sur l’axe entre le début de l’axe et la première catégorie et entre la dernière catégorie et la fin de l’axe.
Cette propriété est utile pour les types de graphiques dont le rendu s’étend au-delà des limites de la catégorie (colonnes et barres, par exemple). Cependant, lorsque vous l’utilisez comme valeur horizontalAxis dans un contrôle LineChart ou AreaChart, elle est réinitialisée sur 0.
La valeur par défaut est 0.5.
Implémentation
public function get padding():Number
public function set padding(value:Number):void
ticksBetweenLabels | propriété |
ticksBetweenLabels:Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Spécifie la position des graduations principales le long de l’axe, par rapport aux libellés des catégories. Si la valeur est true
, les graduations ainsi que la grille associée apparaissent entre les catégories. Si la valeur est false
, les graduations apparaissent au milieu de la catégorie, dans le prolongement du libellé.
Implémentation
public function get ticksBetweenLabels():Boolean
public function set ticksBetweenLabels(value:Boolean):void
CategoryAxis | () | Constructeur |
public function CategoryAxis()
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Constructeur.
filterCache | () | méthode |
public function filterCache(cache:Array, field:String, filteredField:String):void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Filtre un ensemble de valeurs de type arbitraire pour produire un ensemble de nombres qui peuvent être mappés.
Paramètres
cache:Array — Tableau d’objets à partir duquel les valeurs converties sont lues et dans lequel elles sont stockées.
| |
field:String — Champ des objets du tableau de cache qui contient les valeurs préfiltrées.
| |
filteredField:String — Champ des objets du tableau de cache dans lequel les valeurs filtrées doivent être stockées.
|
formatForScreen | () | méthode |
public function formatForScreen(value:Object):String
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Formate les valeurs pour les afficher dans des objets DataTip. Renvoie une chaîne lisible par l’utilisateur.
Paramètres
value:Object — Valeur à convertir en chaîne.
|
String — Texte de l’objet DataTip.
|
getLabelEstimate | () | méthode |
public function getLabelEstimate():AxisLabelSet
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Détermine la plage de valeurs permettant d’estimer les libellés d’axe appropriés. L’axe appelle presque immédiatement la méthode getLabels()
pour obtenir les valeurs réelles. L’axe utilise les valeurs estimées pour ajuster les marges du graphique. Par conséquent, si les libellés estimés et les libellés réels (renvoyés par la méthode getLabels()
) diffèrent, les libellés sont mis à l’échelle pour que leur taille soit adaptée au graphique.
Pour renvoyer une estimation, un axe a besoin uniquement des libellés minimal et maximal. Si l’ensemble de libellés est relativement statique et ne dépend pas de la taille des axes rendus à l’écran, un axe peut renvoyer l’intégralité de l’ensemble de libellés à partir de cette fonction et marquer l’estimation comme étant exacte.
Valeur renvoyéeAxisLabelSet — Tableau d’objets AxisLabel.
|
getLabels | () | méthode |
public function getLabels(minimumAxisLength:Number):AxisLabelSet
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Obtient le texte des libellés rendus. Lorsque Flex appelle cette méthode, l’axe a déjà déterminé la longueur minimale du libellé.
Paramètres
minimumAxisLength:Number — Longueur minimale de l’axe, en pixels. L’axe peut être plus court que cette valeur, mais pas plus long.
|
AxisLabelSet — Tableau d’objets AxisLabel.
|
invertTransform | () | méthode |
public function invertTransform(value:Number):Object
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Mappe une position le long de l’axe à une valeur de données numérique.
Paramètres
value:Number — Limite de l’axe. La valeur de ce paramètre doit être comprise entre 0 et 1, 0 représentant la limite minimale de l’axe et 1 sa limite maximale.
|
Object — Objet contenant la valeur transformée.
|
mapCache | () | méthode |
public function mapCache(cache:Array, field:String, convertedField:String, indexValues:Boolean = false):void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Convertit un ensemble de valeurs de type arbitraire en un ensemble de nombres qui peuvent être transformés en coordonnées d’écran.
Paramètres
cache:Array — Tableau d’objets à partir duquel les valeurs converties sont lues et dans lequel elles sont stockées.
| |
field:String — Champ des objets du tableau de cache qui contient les valeurs préconverties.
| |
convertedField:String — Champ des objets du tableau de cache dans lequel les valeurs converties doivent être stockées.
| |
indexValues:Boolean (default = false ) — La valeur de ce paramètre est true si les valeurs mappées sont des valeurs d’index et false s’il s’agit de valeurs de données naturelles.
|
preferDropLabels | () | méthode |
public function preferDropLabels():Boolean
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Détermine la manière dont l’axe traite les libellés qui se chevauchent. En général, les plages de valeurs numériques renvoient true
, au contraire des plages de valeurs distinctes. Vous pouvez remplacer cette propriété en la définissant directement sur l’axe.
Boolean — true si les libellés peuvent être omis sans perte de données, false dans le cas contraire.
|
reduceLabels | () | méthode |
public function reduceLabels(intervalStart:AxisLabel, intervalEnd:AxisLabel):AxisLabelSet
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Appelée lorsqu’un objet AxisRenderer est incapable de rendre correctement les libellés sans chevauchement et qu’il souhaite que l’objet Axis réduise l’ensemble de libellés. Les deux libellés qui se chevauchent sont transmis à la méthode.
Paramètres
intervalStart:AxisLabel — Début de l’intervalle de chevauchement des libellés.
| |
intervalEnd:AxisLabel — Fin de l’intervalle de chevauchement des libellés.
|
AxisLabelSet — Nouvel ensemble de libellés résolvant le chevauchement en réduisant le nombre de libellés.
|
transformCache | () | méthode |
public function transformCache(cache:Array, field:String, convertedField:String):void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Mappe à l’espace d’écran un ensemble de valeurs issues de l’espace de données.
Paramètres
cache:Array — Tableau d’objets à partir duquel les valeurs mappées sont lues et dans lequel elles sont stockées.
| |
field:String — Champ des objets du tableau de cache qui contient les valeurs prémappées.
| |
convertedField:String — Champ des objets du tableau de cache dans lequel les valeurs mappées doivent être stockées.
|
update | () | méthode |
public function update():void
Version du langage: | ActionScript 3.0 |
Version du produit: | Flex 3 |
Versions du moteur d’exécution: | Flash Player 9, AIR 1.1 |
Met à jour le graphique. Cette méthode peut être appelée plusieurs fois par image.
<?xml version="1.0"?> <!-- Simple example to demonstrate the HLOCChart control. --> <s:Application xmlns:fx="http://ns.adobe.com/mxml/2009" xmlns:s="library://ns.adobe.com/flex/spark" xmlns:mx="library://ns.adobe.com/flex/mx"> <fx:Script> <![CDATA[ import mx.collections.ArrayCollection; [Bindable] private var stockDataAC:ArrayCollection = new ArrayCollection( [ { Date: "25-Jul", Open: 40.55, High: 40.75, Low: 40.24, Close:40.31}, { Date: "26-Jul", Open: 40.15, High: 40.78, Low: 39.97, Close:40.34}, { Date: "27-Jul", Open: 40.38, High: 40.66, Low: 40, Close:40.63}, { Date: "28-Jul", Open: 40.49, High: 40.99, Low: 40.3, Close:40.98}, { Date: "29-Jul", Open: 40.13, High: 40.4, Low: 39.65, Close:39.95}, { Date: "1-Aug", Open: 39.00, High: 39.50, Low: 38.7, Close:38.6}, { Date: "2-Aug", Open: 38.68, High: 39.34, Low: 37.75, Close:38.84}, { Date: "3-Aug", Open: 38.76, High: 38.76, Low: 38.03, Close:38.12}, { Date: "4-Aug", Open: 37.98, High: 37.98, Low: 36.56, Close:36.69}, { Date: "5-Aug", Open: 36.61, High: 37, Low: 36.48, Close:36.86} ]); ]]> </fx:Script> <fx:Declarations> <!-- Define custom Stroke for the wick and ticks. --> <mx:SolidColorStroke id="s1" color="0x000000" weight="5" joints="bevel" caps="square"/> </fx:Declarations> <mx:Panel title="HLOCChart Control Example" height="100%" width="100%"> <mx:HLOCChart id="hlocchart" height="100%" width="100%" paddingRight="5" paddingLeft="5" showDataTips="true" dataProvider="{stockDataAC}"> <mx:verticalAxis> <mx:LinearAxis id="vaxis" baseAtZero="false" title="Price"/> </mx:verticalAxis> <mx:horizontalAxis> <mx:CategoryAxis id="haxis" categoryField="Date" title="Date"/> </mx:horizontalAxis> <mx:horizontalAxisRenderers> <mx:AxisRenderer axis="{haxis}" canDropLabels="true"/> </mx:horizontalAxisRenderers> <mx:series> <mx:HLOCSeries openField="Open" highField="High" lowField="Low" closeField="Close" stroke="{s1}" openTickStroke="{s1}" closeTickStroke="{s1}" openTickLength="7" closeTickLength="7" /> </mx:series> </mx:HLOCChart> </mx:Panel> </s:Application>
Tue Jun 12 2018, 09:30 AM Z