# Get

Renvoie les propriétés des tableaux et/ou des objets générés par une fonction Script ou une autre fonction Get.

## Get – Présentation

La fonction Get permet d’accéder aux propriétés des objets renvoyés par une fonction Script. Elle requiert au minimum deux arguments : une référence à une fonction Script, ou une autre fonction Get qui renvoie un objet ou un tableau ; et soit une chaîne de caractères qui désigne la propriété d’un objet, soit un chemin séparé par des points vers la propriété d’un sous-objet. Un troisième argument en option peut être spécifié pour accéder à un index de tableau basé sur zéro, lorsqu’un tableau est référencé.

La valeur renvoyée par la fonction Get est la valeur de la propriété (ou de l’élément de tableau indexé), et peut prendre l’un des types suivants :

- Un nombre
- Vrai (1) ou faux (0)
- Une chaîne de caractères
- Une structure de données Binary
- Une structure de données Blob, Edge, Histogram, ou Patterns
- Un objet de forme (Shape)
- Un objet
- Une image
- null, undefined ou pas d’instruction « return » (même traitement qu’un objet vide).

Remarque : La fonction Get ne prend pas en charge le renvoi d’une valeur nulle ou non définie.

### Exemple d’appel de fonction Get

Dans cet exemple, dans la cellule B3 une fonction Script possède une méthode d’exécution qui renvoie un objet :

    Tool.prototype.run = function(n) {
      this.updateStats(n);
      return {
        total: this._total;
    	stats: {
    	  avg: this._avg,
    	  range: {
    	    max: this._max,
    	    min: this._min
    	  },
    	  values: this._valueArray
    	}
       };
    };

Les fonctions Get suivantes renvoient des nombres simples (en supposant que les valeurs renvoyées sont numériques) :

- Get(B3, "total")
- Get(B3, "stats.avg")
- Get(B3, "stats.range.max")
- Get(B3, "stats.range.min")

La fonction Get suivante renvoie le sous-objet "range", qui peut être transmis à une autre fonction Script ou Get :

- Get(B3, "stats.range")

La fonction Get suivante renvoie l’élément 37 du tableau de valeurs :

- Get(B3, "stats.values", 37)

## Get – entrées

Script/Get | Spécifie une référence à une fonction Script ou à une autre fonction Get qui renvoie une structure de données d’objet ou de tableau.
Propriété et/ou tableau d’objets | Spécifie une référence à la propriété d’une structure de données Object, soit sous la forme d’une chaîne de caractères (le nom de la propriété) ou d’un chemin d’accès séparé par des points vers la propriété d’un sous-objet ; ou d’une structure de données Array.
[Index du tableau] | Spécifie un argument facultatif pour l’index d’un tableau lorsqu’une structure de données tableau (Array) est référencée.

## Get – Sorties

Renvoie | La fonction renvoie la valeur de la propriété (ou de l’élément de tableau indexé), et peut renvoyer l’un des types suivants : Un nombre Vrai (1) ou faux (0) Une chaîne de caractères Une structure de données Binary Une structure de données Blob, Edge, Histogram, ou Patterns Un objet de forme (Shape) Un objet Une image null, undefined ou pas d’instruction « return » (même traitement qu’un objet vide).

Remarque : À partir d’une fonction Script, la fonction ne renvoie pas les éléments suivants : null, undefined ou pas d’instruction "return" (même traitement qu’un objet vide).