Expressions documentation single page (locale fr)

Agrégats

Tableaux

Couleur

Conditions

Conversions

Date et Heure

Fichiers et Chemins

Formulaire

Correspondance floue

Général

Géométrie

Mise en page

Couches

Tableaux associatifs

Math

Processing

Python

Rasters

Enregistrement et attributs

Chaîne de caractères

groupe agrégats

Contient des fonctions qui agrègent des valeurs sur des couches et des champs.

fonction aggregate

Renvoie une valeur agrégée calculée en utilisant les entités d'une autre couche.

Syntaxe

aggregate ( layer , aggregate , expression [, filter ][, concatenator ][, order_by ])

[ ] indique des éléments optionnels

Arguments

layer une chaîne de caractères représentant soit un nom de couche ou un ID de couche
aggregate une chaîne correspondant à l'agrégat à calculer. Les options valides sont les suivantes:
  • count
  • count_distinct
  • count_missing
  • min
  • max
  • sum
  • mean
  • median
  • stdev
  • stdevsample
  • range
  • minority
  • majority
  • q1: first quartile
  • q3: third quartile
  • lqr: inter quartile range
  • min_length: longueur minimale de chaîne
  • max_length: longueur maximale de chaîne
  • concatenate: joindre des chaînes avec un concaténateur
  • concatanate_unique : joindre une chaîne unique avec un concaténateur
  • collect: créer une géométrie multi-partie aggrégée
  • array_agg: créé un tableau de valeurs agrégées
expression sous-expression ou nom de champ à aggréger
filter expression de filtrage optionelle pour limiter les entiés utilisées pour le calcul d'agrégation. Les champs et la géométrie proviennent des entités de la couche jointe. L'entité source peut être accédée avec la variable @parent.
concatenator chaîne de caractères optionnelle utilisée pour joindre les valeurs pour l'aggrégat 'concatenate'
order_by expression de filtre optionnelle pour ordonner les entités utilisées pour le calcul de l'agrégat. Les champs et la géométrie proviennent des entités de la couche jointe.

Exemples

  • aggregate(layer:='stations_trains',aggregate:='sum',expression:="passagers") → somme des valeurs du champ passagers dans la couche stations_trains
  • aggregate('stations_trains','sum', "passagers"/7) → calcule une moyenne journalière de "passagers" en divisant le champ "passagers" par 7 avant de faire la somme des valeurs
  • aggregate(layer:='rail_stations',aggregate:='sum',expression:="passengers",filter:="class">3) → fait la somme de toutes les valeurs du champ "passagers" des entités où l'attribut "classe" est supérieur à 3 seulement
  • aggregate(layer:='rail_stations',aggregate:='concatenate', expression:="name", concatenator:=',') → liste séparée par des virgules de noms de champs pour toutes les entités dans la couche trains_stations
  • aggregate(layer:='countries', aggregate:='max', expression:="code", filter:=intersects( $geometry, geometry(@parent) ) ) → Le code d'un pays sécant dans la couche 'countries'

fonction array_agg

Renvoie un tableau de valeurs agrégées à partir d'un champ ou d'une expression.

Syntaxe

array_agg ( expression [, group_by ][, filter ][, order_by ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat
order_by expression facultative pour ordonner les entités utilisées pour calculer l'agrégat

Exemples

  • array_agg("nom",group_by:="état") → liste des valeurs de nom, regroupées par champ d'état

fonction collect

Renvoie la géométrie multipartie des géométries agrégées à partir d'une expression

Syntaxe

collect ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression expression géométrie pour aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • collect( $geometry ) → géométrie multipartie de géométries agrégées

fonction concatenate

Renvoie toutes les chaînes de caractères aggrégées d'un champ ou d'une expression, jointes par un délimiteur.

Syntaxe

concatenate ( expression [, group_by ][, filter ][, concatenator ][, order_by ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat
concatenator chaîne de caractères optionnelle utilisée pour joindre les valeurs
order_by expression facultative pour ordonner les entités utilisées pour calculer l'agrégat

Exemples

  • concatenate("nom_ville",group_by:="etat",concatenator:=',') → liste séparée par des virgules des valeurs du champ nom_ville, groupés sur le champ état

fonction concatenate_unique

Retourne toutes les chaînes uniques d'un champ ou d'une expression jointes par un délimiteur.

Syntaxe

concatenate_unique ( expression [, group_by ][, filter ][, concatenator ][, order_by ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat
concatenator chaîne de caractères optionnelle utilisée pour joindre les valeurs
order_by expression facultative pour ordonner les entités utilisées pour calculer l'agrégat

Exemples

  • concatenate("nom_ville",group_by:="etat",concatenator:=',') → liste séparée par des virgules des valeurs des nom de villes uniques, groupés sur le champ état

fonction count

Renvoie le décompte des entités correspondantes.

Syntaxe

count ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • count("stations",group_by:="état") → compte des stations, regroupées par le champ état

fonction count_distinct

Renvoie le décompte des valeurs distinctes.

Syntaxe

count_distinct ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • count_distinct("stations",group_by:="etat") → compte des valeurs distinctes de stations, regroupées par le champ état

fonction count_missing

Renvoie le décompte des valeurs manquantes (null).

Syntaxe

count_missing ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • count_missing("stations",group_by:="etat") → compte des valeurs manquantes (null) des stations, regroupées par le champ état

fonction iqr

Renvoie la plage inter-quartiles d'un champ ou d'une expression.

Syntaxe

iqr ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • iqr("population",group_by:="etat") → plage inter-quartiles des valeurs de population, regroupées par le champ état

fonction majority

Renvoie l'aggrégat des valeurs majeures (les valeurs les plus fréquentes) d'un champ ou d'une expression.

Syntaxe

majority ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • majority("classe",group_by:="état") → valeur de classe rencontrée la plus fréquemment, groupées selon le champ état

fonction max_length

Renvoie la longueur maximale des chaînes de caractères d'un champ ou d'une expression.

Syntaxe

max_length ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • max_length("nom_ville",group_by:="etat") → longueur maximale de nom_ville, groupée selon le champ état

fonction maximum

Renvoie l'aggrégat de la valeur maximale d'un champ ou d'une expression.

Syntaxe

maximum ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • maximum("population",group_by:="etat") → valeur maximale de population, groupée selon le champ état

fonction mean

Renvoie la valeur moyenne de l'aggrégat d'un champ ou d'une expression.

Syntaxe

mean ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • mean("population",group_by:="etat) → valeur moyenne de population, groupée selon le champ état

fonction median

Renvoie l'aggrégat de la valeur médiane d'un champ ou d'une expression.

Syntaxe

median ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • median("population",group_by:="etat") → valeur médianne de population, groupée selon le champ état

fonction min_length

Renvoie la longueur minimale des chaînes de caractères d'un champ ou d'une expression.

Syntaxe

min_length ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • min_length("nom_ville",group_by:="etat") → longueur minimale des valeurs de nom_ville, groupées selon le champ état

fonction minimum

Renvoie l'aggrégat de la valeur minimale d'un champ ou d'une expression.

Syntaxe

minimum ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • minimum("population",group_by:="etat") → valeur minimale de population, groupées selon le champ etat

fonction minority

Renvoie l'aggrégat des valeurs mineures (les moins fréquentes) d'un champ ou d'une expression.

Syntaxe

minority ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • minority("classe",group_by:="etat") → valeur de classe la moins rencontrée, regroupée par le champ état

fonction q1

Renvoie le premier quartile d'un champ ou d'une expression.

Syntaxe

q1 ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • q1("population",group_by:="etat") → premier quartile de la population, groupé selon le champ etat

fonction q3

Renvoie le troisième quartile d'un champ ou d'une expression.

Syntaxe

q3 ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • q3("population",group_by:="etat") → troisième quartile de la population, groupé selon le champ etat

fonction range

Renvoie l'aggrégat de plage de valeur (maximum - minimum) d'un champ ou d'une expression.

Syntaxe

range ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • range("population",group_by:="etat") → plage des valeurs de population, groupées selon le champ état

fonction relation_aggregate

Renvoie une valeur agrégée, calculée à partir de toutes les entités enfants correspondantes dans la couche en relation.

Syntaxe

relation_aggregate ( relation , aggregate , expression [, concatenator ][, order_by ])

[ ] indique des éléments optionnels

Arguments

relation un texte, représentant un identifiant de relation
aggregate une chaîne correspondant à l'agrégat à calculer. Les options valides sont les suivantes:
  • count
  • count_distinct
  • count_missing
  • min
  • max
  • sum
  • mean
  • median
  • stdev
  • stdevsample
  • range
  • minority
  • majority
  • q1: first quartile
  • q3: third quartile
  • lqr: inter quartile range
  • min_length: longueur minimale de chaîne
  • max_length: longueur maximale de chaîne
  • concatenate: joindre des chaînes avec un concaténateur
  • concatanate_unique : joindre une chaîne unique avec un concaténateur
  • collect: créer une géométrie multi-partie aggrégée
  • array_agg: créé un tableau de valeurs agrégées
expression sous-expression ou nom de champ à aggréger
concatenator chaîne de caractères optionnelle utilisée pour joindre les valeurs pour l'aggrégat 'concatenate'
order_by optional expression to order the features used for calculating the aggregate. Fields and geometry are from the features on the joined layer.

Exemples

  • relation_aggregate(relation:='ma_relation',aggregate:='mean',expression:="passagers") → valeur moyenne de toutes les entités enfants correspondantes, dans la relation 'ma_relation'
  • relation_aggregate('ma_relation','sum', "passagers"/7) → Somme divisée par 7 des passagers de toutes les entités enfants correspondantes, dans la relation 'ma_relation'
  • relation_aggregate('ma_relation','concatenate', "villes", concatenator:=',') → liste séparée par des virgules des valeurs du champ villes pour toutes les entités correspondantes à la relation 'ma_relation'
  • relation_aggregate('my_relation','array_agg', "id") → tableau du champ id de toutes les entités enfant correspondantes liées par la relation 'ma_relation'

fonction stdev

Renvoie l'aggrégat de l'écart-type des valeurs d'un champ ou d'une expression.

Syntaxe

stdev ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • stdev("population",group_by:="etat") → écart-type des valeurs de population, groupées selon le champ état

fonction sum

Renvoie l'aggrégat des sommes de valeurs d'un champ ou d'une expression.

Syntaxe

sum ( expression [, group_by ][, filter ])

[ ] indique des éléments optionnels

Arguments

expression sous-expression du champ à aggréger
group_by expression optionnelle utilisée pour grouper les calculs d'aggrégats
filter expression optionnelle utilisée pour filtrer les entités utilisées lors du calcul d'aggrégat

Exemples

  • sum("population",group_by:="etat") → somme des valeurs de population, groupée selon le champ 'etat'

groupe tableaux

Ce groupe contient des fonctions d'expression pour la création et la manipulation de tableaux (également appelés structures de données de liste). L'ordre des valeurs dans le tableau importe, contrairement à la structure de données «carte», où l'ordre des paires de valeurs-clés n'est pas pertinent et les valeurs sont identifiées par leurs clés.

fonction array

Renvoie un tableau contenant toutes les valeurs passées comme paramètre.

Syntaxe

array ( value1 , value2 …)

Arguments

value une valeur

Exemples

  • array(2,10) → [ 2, 10 ]

fonction array_all

retourne vrai si un tableau contient toutes les valeurs d'un tableau donné.

Syntaxe

array_all ( array_a , array_b )

Arguments

array_a un tableau
array_b La liste des valeurs à chercher

Exemples

  • array_all(array(1,2,3),array(2,3)) → vrai
  • array_all(array(1,2,3),array(1,2,4)) → false

fonction array_append

Renvoie un tableau avec la valeur donnée ajoutée à la fin.

Syntaxe

array_append ( array , value )

Arguments

array un tableau
value la valeur à ajouter

Exemples

  • array_append(array(1,2,3),4) → [ 1, 2, 3, 4 ]

fonction array_cat

Renvoie un tableau contenant tous les tableaux donnés concaténés.

Syntaxe

array_cat ( array1 , array2 …)

Arguments

array un tableau

Exemples

  • array_cat(array(1,2),array(2,3)) → [ 1, 2, 2, 3 ]

fonction array_contains

Renvoie vrai si un tableau contient la valeur donnée.

Syntaxe

array_contains ( array , value )

Arguments

array un tableau
value la valeur à chercher

Exemples

  • array_contains(array(1,2,3),2) → vrai

fonction array_distinct

Renvoie un tableau contenant les valeurs distinctes du tableau donné.

Syntaxe

array_distinct ( array )

Arguments

array un tableau

Exemples

  • array_distinct(array(1,2,3,2,1)) → [ 1, 2, 3 ]

fonction array_filter

Retourne une liste avec l'expression évaluée pour chaque élément.

Syntaxe

array_filter ( array , expression )

Arguments

array un tableau
expression une expression à évaluer sur chaque élément. La variable `@element` sera remplacée par la valeur courante.

Exemples

  • array_filter(array(1,2,3),@element < 3) → [ 1, 2 ]

fonction array_find

Renvoie l'index (0 pour le premier) d'une valeur dans un tableau. Renvoie -1 si la valeur n'est pas trouvée.

Syntaxe

array_find ( array , value )

Arguments

array un tableau
value la valeur à chercher

Exemples

  • array_find(array(1,2,3),2) → 1

fonction array_first

Retourne la première valeur d'un tableau

Syntaxe

array_first ( array )

Arguments

array un tableau

Exemples

  • array_first(array('a','b','c')) → 'a'

fonction array_foreach

Retourne une liste avec l'expression évaluée pour chaque élément.

Syntaxe

array_foreach ( array , expression )

Arguments

array un tableau
expression une expression à évaluer sur chaque élément. La variable `@element` sera remplacée par la valeur courante.

Exemples

  • array_foreach(array('a','b','c'),upper(@element)) → [ 'A', 'B', 'C' ]
  • array_foreach(array(1,2,3),@element + 10) → [ 11, 12, 13 ]

fonction array_get

Renvoie la Nième (0 correspondant à la première) valeur d'une liste.

Syntaxe

array_get ( array , index )

Arguments

array un tableau
index l'index à obtenir (basé sur 0)

Exemples

  • array_get(array('a','b','c'),1) → 'b'

fonction array_insert

Renvoie un tableau avec la valeur ajoutée donnée à la position donnée.

Syntaxe

array_insert ( array , pos , value )

Arguments

array un tableau
pos la position où réaliser l'ajout (basée sur 0)
value la valeur à ajouter

Exemples

  • array_insert(array(1,2,3),1,100) → [ 1, 100, 2, 3 ]

fonction array_intersect

Renvoie true si au moins un élément de array1 est présent dans array2.

Syntaxe

array_intersect ( array1 , array2 )

Arguments

array1 un tableau
array2 un autre tableau

Exemples

  • array_intersect(array(1,2,3,4),array(4,0,2,5)) → vrai

fonction array_last

Renvoie la première valeur d'un tableau.

Syntaxe

array_last ( array )

Arguments

array un tableau

Exemples

  • array_last(array('a','b','c')) → 'c'

fonction array_length

Renvoie le nombre d'éléments d'un tableau

Syntaxe

array_length ( array )

Arguments

array un tableau

Exemples

  • array_length(array(1,2,3)) → 3

fonction array_prepend

Renvoie un tableau avec la valeur donnée ajoutée à son début.

Syntaxe

array_prepend ( array , value )

Arguments

array un tableau
value la valeur à ajouter

Exemples

  • array_prepend(array(1,2,3),0) → [ 0, 1, 2, 3 ]

fonction array_remove_all

Renvoie un tableau dont les entrées correspondantes à la valeur donnée ont été supprimées.

Syntaxe

array_remove_all ( array , value )

Arguments

array un tableau
value la valeur à supprimer

Exemples

  • array_remove_all(array('a','b','c','b'),'b') → [ 'a', 'c' ]

fonction array_remove_at

Renvoie un tableau dont les index donnés ont été supprimés.

Syntaxe

array_remove_at ( array , pos )

Arguments

array un tableau
pos la position à supprimer (basée sur 0)

Exemples

  • array_remove_at(array(1,2,3),1) → [ 1, 3 ]

fonction array_reverse

Renvoie le tableau donné avec des valeurs dans l'ordre inverse.

Syntaxe

array_reverse ( array )

Arguments

array un tableau

Exemples

  • array_reverse(array(2,4,0,10)) → [ 10, 0, 4, 2 ]

fonction array_slice

Renvoie une partie du tableau. La tranche est définie par les arguments start_pos et end_pos.

Syntaxe

array_slice ( array , start_pos , end_pos )

Arguments

array un tableau
start_pos l'index de la position de début de la tranche (basée sur 0). L'index start_pos est inclus dans la tranche. Si vous utilisez un start_pos négatif, l'index est compté à partir de la fin de la liste (basée sur -1).
end_pos l'index de la position de début de la tranche (basée sur 0). L'index end_pos est inclus dans la tranche. Si vous utilisez un end_pos négatif, l'index est compté à partir de la fin de la liste (basée sur -1).

Exemples

  • array_slice(array(1,2,3,4,5),0,3) → [ 1, 2, 3, 4 ]
  • array_slice(array(1,2,3,4,5),0,-1) → [ 1, 2, 3, 4, 5 ]
  • array_slice(array(1,2,3,4,5),-5,-1) → [ 1, 2, 3, 4, 5 ]
  • array_slice(array(1,2,3,4,5),0,0) → [ 1 ]
  • array_slice(array(1,2,3,4,5),-2,-1) → [ 4, 5 ]
  • array_slice(array(1,2,3,4,5),-1,-1) → [ 5 ]
  • array_slice(array('Dufour','Valmiera','Chugiak','Brighton'),1,2) → [ 'Valmiera', 'Chugiak' ]
  • array_slice(array_slice(array('Dufour','Valmiera','Chugiak','Brighton'),-2,-1) → [ 'Chugiak', 'Brighton' ]

fonction array_sort

Renvoie le tableau fourni avec ses éléments triés.

Syntaxe

array_sort ( array [, ascending=true ])

[ ] indique des éléments optionnels

Arguments

array un tableau
ascending mettre ce paramètre à false pour trier le tableau par ordre décroissant

Exemples

  • array_sort(array(3,2,1)) → [ 1, 2, 3 ]

fonction array_to_string

Concatène les éléments d'un tableau en une chaîne de caractères séparée par un délimiteur et utilisant en option une chaîne de caractères pour les valeurs vides.

Syntaxe

array_to_string ( array [, delimiter=',' ][, empty_value='' ])

[ ] indique des éléments optionnels

Arguments

array le tableau initial
delimiter la chaîne de caractères utilisée pour délimiter les éléments concaténés dans un tableau
empty_value la chaîne de caractères optionnelle à utiliser en remplacement des résultats vides (longueur nulle)

Exemples

  • array_to_string(array('1','2','3')) → '1, 2, 3'
  • array_to_string(array(1,2,3),'-') → '1-2-3'
  • array_to_string(array('1','','3'),',','0') → '1, 0, 3'

fonction generate_series

Crée un tableau contenant la suite de chiffres.

Syntaxe

generate_series ( start , stop [, step=1 ])

[ ] indique des éléments optionnels

Arguments

start la première valeur de la suite
stop la dernière valeur qui provoque la fin de la suite
step valeur de l'incrémentation entre les différentes valeurs

Exemples

  • generate_series(1,5) → [ 1, 2, 3, 4, 5 ]
  • generate_series(5,1,-1) → [ 5, 4, 3, 2, 1 ]

fonction regexp_matches

Renvoie un tableau de toutes les chaînes capturées par des groupes de capture, dans l'ordre dans lequel les groupes eux-mêmes apparaissent dans l'expression régulière fournie par une chaîne.

Syntaxe

regexp_matches ( string , regex [, empty_value='' ])

[ ] indique des éléments optionnels

Arguments

string la chaîne de caractères à tester par l'expression régulière pour capturer des groupes
regex l'expression régulière utilisée pour capturer des groupes
empty_value la chaîne de caractères optionnelle à utiliser en remplacement des résultats vides (longueur nulle)

Exemples

  • regexp_matches('qgis=>déchire','(.*)=>(.*)') → [ 'QGIS', 'déchire' ]
  • regexp_matches('key=>','(.*)=>(.*)','empty value') → [ 'clé', 'valeur vide' ]

fonction string_to_array

Découpe une chaîne de caractères en un tableau en utilisant le délimiteur et l'éventuelle chaîne de remplacement pour les valeurs vides.

Syntaxe

string_to_array ( string [, delimiter=',' ][, empty_value='' ])

[ ] indique des éléments optionnels

Arguments

string la chaîne en entrée
delimiter la chaîne de caractères utilisée pour découper la chaîne de caractères d'entrée
empty_value la chaîne de caractères optionnelle à utiliser en remplacement des résultats vides (longueur nulle)

Exemples

  • string_to_array('1,2,3',',') → [ '1', '2', '3' ]
  • string_to_array('1,,3',',','0') → [ '1', '0', '3' ]

groupe couleur

Ce groupe contient des fonctions pour manipuler des couleurs

fonction color_cmyk

Renvoie une chaîne de caractères représentant une couleur basée sur ses composantes cyan, magenta, jaune et noire

Syntaxe

color_cmyk ( cyan , magenta , yellow , black )

Arguments

cyan composante cyan de la couleur sous forme d'une valeur de pourcentage comprise entre 0 et 100
magenta composante magenta de la couleur sous forme d'une valeur de pourcentage comprise entre 0 et 100
yellow composante jaune de la couleur sous forme d'une valeur de pourcentage comprise entre 0 et 100
black composante noire de la couleur sous forme d'une valeur de pourcentage comprise entre 0 et 100

Exemples

  • color_cmyk(100,50,0,10) → 0,115,230

fonction color_cmyka

Renvoie une chaîne de caractères représentant une couleur basée sur ses composantes cyan, magenta, jaune et noire et alpha (transparence)

Syntaxe

color_cmyka ( cyan , magenta , yellow , black , alpha )

Arguments

cyan composante cyan de la couleur sous forme d'une valeur de pourcentage comprise entre 0 et 100
magenta composante magenta de la couleur sous forme d'une valeur de pourcentage comprise entre 0 et 100
yellow composante jaune de la couleur sous forme d'une valeur de pourcentage comprise entre 0 et 100
black composante noire de la couleur sous forme d'une valeur de pourcentage comprise entre 0 et 100
alpha composante alpha sous la forme d'un entier dont la valeur varie de 0 (complètement transparent) à 255 (opaque).

Exemples

  • color_cmyk(100,50,0,10,200) → 0,115,230,200

fonction color_grayscale_average

Applique un filtre par niveau de gris et renvoie une représentation chaîne depuis une couleur en entrée.

Syntaxe

color_grayscale_average ( color )

Arguments

color une chaîne de caractères de couleur

Exemples

  • color_grayscale_average('255,100,50') → 127,127,127,255

fonction color_hsl

Renvoie une chaîne de caractères représentant une couleur basée sur ses attributs de teinte, de saturation et de luminosité.

Syntaxe

color_hsl ( hue , saturation , lightness )

Arguments

hue teinte de la couleur, sous la forme d'un entier compris entre 0 et 360
saturation pourcentage de saturation de la couleur sous forme d'un entier compris entre 0 et 100
lightness pourcentage de luminosité de la couleur sous forme d'un entier compris entre 0 et 100

Exemples

  • color_hsl(100,50,70) → 166,217,140

fonction color_hsla

Renvoie une chaîne de caractères représentant une couleur basée sur ses attributs de teinte, de saturation, de luminosité et alpha (transparence).

Syntaxe

color_hsla ( hue , saturation , lightness , alpha )

Arguments

hue teinte de la couleur, sous la forme d'un entier compris entre 0 et 360
saturation pourcentage de saturation de la couleur sous forme d'un entier compris entre 0 et 100
lightness pourcentage de luminosité de la couleur sous forme d'un entier compris entre 0 et 100
alpha composante alpha sous la forme d'un entier dont la valeur varie de 0 (complètement transparent) à 255 (opaque).

Exemples

  • color_hsla(100,50,70,200) → 166,217,140,200

fonction color_hsv

Renvoie une chaîne de caractères représentant une couleur basée sur ses attributs de teinte, de saturation et de valeur.

Syntaxe

color_hsv ( hue , saturation , value )

Arguments

hue teinte de la couleur, sous la forme d'un entier compris entre 0 et 360
saturation pourcentage de saturation de la couleur sous forme d'un entier compris entre 0 et 100
value pourcentage de valeur de la couleur sous la forme d'un entier compris entre 0 et 100

Exemples

  • color_hsv(40,100,100) → 255,170,0

fonction color_hsva

Renvoie une chaîne de caractères représentant une couleur basée sur ses attributs de teinte, de saturation, de valeur et alpha (transparence).

Syntaxe

color_hsva ( hue , saturation , value , alpha )

Arguments

hue teinte de la couleur, sous la forme d'un entier compris entre 0 et 360
saturation pourcentage de saturation de la couleur sous forme d'un entier compris entre 0 et 100
value pourcentage de valeur de la couleur sous la forme d'un entier compris entre 0 et 100
alpha composante alpha sous la forme d'un entier dont la valeur varie de 0 (complètement transparent) à 255 (opaque)

Exemples

  • color_hsva(40,100,100,200) → 255,170,0,200

fonction color_mix_rgb

Renvoie une chaîne de caractères représentant une couleur basée sur ses composantes rouge, verte, bleue et sur la valeur alpha (transparence).

Syntaxe

color_mix_rgb ( color1 , color2 , ratio )

Arguments

color1 une chaîne de caractères de couleur
color2 une chaîne de caractères de couleur
ratio un ratio

Exemples

  • color_mix_rgb('0,0,0','255,255,255',0.5) → 127,127,127,255

fonction color_part

Renvoie une composante spécifique d'une chaîne de caractères de couleur, ex: la composante rouge ou la composante alpha.

Syntaxe

color_part ( color , component )

Arguments

color une chaîne de caractères de couleur
component une chaîne de caractère correspondant à la composante de la couleur à renvoyer. Les options valide sont :
  • red : composante rouge du RVB (0-255)
  • green : composante verte du RVB (0-255)
  • blue : composante bleue du RVB (0-255)
  • alpha : valeur alpha (transparence) (0-255)
  • hue : composante teinte du TSV (0-360)
  • saturation : composante saturation du TSV (0-100)
  • value : composante valeur du TSV (0-100)
  • hsl_hue : composante teinte du TSL (0-360)
  • hsl_saturation : composante saturation du TSL (0-100)
  • lightness : composante luminosité du TSL (0-100)
  • cyan : composante cyan du CMJN (0-100)
  • magenta : composante magenta du CMJN (0-100)
  • yellow : composante jaune du CMJN (0-100)
  • black : composante noire du CMJN (0-100)

Exemples

  • color_part('200,10,30','green') → 10

fonction color_rgb

Renvoie une chaîne de caractères représentant une couleur basée sur ses composantes rouge, verte, bleue.

Syntaxe

color_rgb ( red , green , blue )

Arguments

red composante rouge sous la forme d'un entier entre 0 et 255
green composante verte sous la forme d'un entier entre 0 et 255
blue composante bleue sous la forme d'un entier entre 0 et 255

Exemples

  • color_rgb(255,127,0) → 255,127,0

fonction color_rgba

Renvoie une chaîne de caractères représentant une couleur basée sur ses composantes rouge, verte, bleue et sur la valeur alpha (transparence).

Syntaxe

color_rgba ( red , green , blue , alpha )

Arguments

red composante rouge sous la forme d'un entier entre 0 et 255
green composante verte sous la forme d'un entier entre 0 et 255
blue composante bleue sous la forme d'un entier entre 0 et 255
alpha composante alpha sous la forme d'un entier dont la valeur varie de 0 (complètement transparent) à 255 (opaque).

Exemples

  • color_rgba(255,127,0,200) → 255,127,0,200

fonction create_ramp

Renvoie une rampe de dégradé à partir d'une carte de chaînes de couleurs et d'étapes.

Syntaxe

create_ramp ( map [, discrete ])

[ ] indique des éléments optionnels

Arguments

map une carte de cordes de couleurs et d'étapes
discrete déclarer si la palette de couleur est discrète

Exemples

  • ramp_color(create_array(map(0,'0,0,0',1,'255,0,0')),1) → '255, 0, 0, 255'

fonction darker

Renvoie une chaîne de caractères de couleur plus sombre (ou plus claire)

Syntaxe

darker ( color , factor )

Arguments

color une chaîne de caractères de couleur
factor un nombre entier correspondant au facteur d'assombrissement.
  • Si le facteur est supérieur à 100, cette fonction renverra une couleur plus sombre (par exemple, utiliser un facteur de 300 renverra une couleur qui aura un tiers de la brillance);
  • Si le facteur est inférieur à 100, la couleur renvoyée sera plus claire mais il est recommandé d'utiliser la fonction lighter() pour cet usage;
  • Si le facteur vaut 0 ou est négatif, la valeur renvoyée est non spécifiée.

Exemples

  • darker('200,10,30',300) → '66,3,10,255'

fonction lighter

Renvoie une chaîne de caractères de couleur plus claire (ou plus sombre)

Syntaxe

lighter ( color , factor )

Arguments

color une chaîne de caractères de couleur
factor un nombre entier correspondant au facteur de clarification:
  • si le facteur est supérieur à 100, cette fonction renvoie une couleur plus claire (par exemple, un facteur de 150 renverra une couleur 50% plus claire);
  • si le facteur est inférieur à 100, la couleur renvoyée sera plus sombre. Il est recommandé d'utiliser la fonction darker() pour ce genre d'opération;
  • si le facteur vaut 0 ou s'il est négatif, la valeur renvoyée est non spécifiée.

Exemples

  • lighter('200,10,30',200) → '255,158,168,255'

fonction project_color

Renvoie une couleur du jeu de couleurs du projet.

Syntaxe

project_color ( name )

Arguments

name un nom de couleur

Exemples

  • project_color('Couleur Logo') → 20,140,50

fonction ramp_color

Renvoie une chaîne de caractères représentant la couleur d'une palette de couleur.

Variante de rampe enregistrée

Renvoie une chaîne représentant une couleur à partir d'une palette enregistrée

Syntaxe

ramp_color ( ramp_name , value )

Arguments

ramp_name le nom de la palette de couleur sous la forme d'une chaîne de caractères, par exemple: 'Spectral'
value la position dans la palette de couleur à partir d'un nombre réel compris entre 0 et 1

Exemples

  • ramp_color('Spectral',0.3) → '253,190,115,255'

Notes

Les palettes de couleur disponibles varient selon les installations de QGIS. Cette fonction peut renvoyer des valeurs erronées si vous utilisez un projet QGIS sur plusieurs installations différentes.

Variante de rampe créée par expression

Renvoie une chaîne représentant une couleur d'une palette créée par une expression

Syntaxe

ramp_color ( ramp , value )

Arguments

ramp la palette de couleurs
value la position dans la palette de couleur à partir d'un nombre réel compris entre 0 et 1

Exemples

  • ramp_color(create_ramp(map(0,'0,0,0',1,'255,0,0')),1) → '255, 0, 0, 255'

fonction set_color_part

Définit une composante spécifique d'une chaîne de caractères de couleur, ex: la composante rouge ou la composante alpha.

Syntaxe

set_color_part ( color , component , value )

Arguments

color une chaîne de caractères de couleur
component une chaîne de caractère correspondant à la composante de la couleur à définir. Les options valide sont :
  • red : composante rouge du RVB (0-255)
  • green : composante verte du RVB (0-255)
  • blue : composante bleue du RVB (0-255)
  • alpha : valeur alpha (transparence) (0-255)
  • hue : composante teinte du TSV (0-360)
  • saturation : composante saturation du TSV (0-100)
  • value : composante valeur du TSV (0-100)
  • hsl_hue : composante teinte du TSL (0-360)
  • hsl_saturation : composante saturation du TSL (0-100)
  • lightness: composante luminosité du TSL (0-100)
  • cyan : composante cyan du CMJN (0-100)
  • magenta : composante magenta du CMJN (0-100)
  • yellow : composante jaune du CMJN (0-100)
  • black : composante noire du CMJN (0-100)
value nouvelle valeur pour la composante de couleur, en respectant les plages listées ci-dessus

Exemples

  • set_color_part('200,10,30','green',50) → 200,50,30

groupe conditions

Ce groupe contient des fonctions permettant de gérer des conditions dans les expressions.

fonction coalesce

Renvoie la première valeur non-NULL de la liste en expression.
Cette fonction peut prendre n'importe quel nombre d'arguments.

Syntaxe

coalesce ( expression1 , expression2 …)

Arguments

expression toute expression ou valeur valide, quel que soit le type.

Exemples

  • coalesce(NULL, 2) → 2
  • coalesce(NULL, 2, 3) → 2
  • coalesce(7, NULL, 3*2) → 7
  • coalesce("fieldA", "fallbackField", 'ERROR') → la valeur de fieldA si celle-ci est non NULL, sinon la valeur de "fallbackfield" ou la chaîne de caractères 'ERROR' si les deux sont nulles

fonction if

Teste une condition et renvoie un résultat selon la condition de vérification.

Syntaxe

if ( condition , result_when_true , result_when_false )

Arguments

condition la condition à vérifier
result_when_true le résultat renvoyé lorsque la condition est évaluée à vrai ou à une valeur non convertible en faux.
result_when_false le résultat renvoyé lorsque la condition est évaluée à faux ou à une valeur convertible en faux, telle que 0 ou ''. NULL est aussi convertie en faux.

Exemples

  • if( 1+1=2, 'Oui', 'Non' ) → 'Oui'
  • if( 1+1=3, 'Oui', 'Non' ) → 'Non'
  • if( 5 > 3, 1, 0) → 1
  • if( '', 'Vrai (non vide)', 'Faux (vide)' ) → 'Faux (vide)'
  • if( ' ', 'Vrai (non vide)', 'Faux (vide)' ) → 'Vrai (non vide)'
  • if( 0, 'Un', 'Zéro' ) → 'Zéro'
  • if( 10, 'Un', 'Zéro' ) → 'One'

fonction nullif

Renvoie la valeur NULL si valeur1 est égale à valeur2 ; sinon, renvoie valeur1. Cela peut être utilisé pour substituer conditionnellement des valeurs par NULL.

Syntaxe

nullif ( value1 , value2 )

Arguments

value1 La valeur qui doit être utilisée ou substituée par NULL.
value2 La valeur de contrôle qui déclenchera la substitution NULL.

Exemples

  • nullif('(none)', '(none)') → NULL
  • nullif('text', '(none)') → 'texte'
  • nullif("name", '') → NULL, si le nom est une chaîne de caractères vide (ou déjà NULL), le nom dans tous les autres cas.

fonction regexp_match

Renvoie la première occurrence correspondante à une expression régulière dans une chaîne de caractères, ou 0 si la sous-chaîne n'a pas été trouvée.

Syntaxe

regexp_match ( input_string , regex )

Arguments

input_string la chaîne à tester selon l'expression rationnelle
regex L'expression régulière de test. Les caractères antislash doivent être échappés deux fois (ex: "\s" correspond à un caractère d'espace).

Exemples

  • regexp_match('QGIS ROCKS','\sROCKS') → 4

fonction try

Essaye une expression et retourne sa valeur si elle est exempte d'erreur. Si l'expression retourne une erreur, une valeur alternative sera retournée, dans le cas contraire la fonction retournera null.

Syntaxe

try ( expression [, alternative ])

[ ] indique des éléments optionnels

Arguments

expression l'expression à exécuter
alternative le résultat à afficher lorsque l'expression renvoie une erreur.

Exemples

  • try( to_int( '1' ), 0 ) → 1
  • try( to_int( 'a' ), 0 ) → 0
  • try( to_date( 'date_invalide' ) ) → NULL

groupe conversions

Cette catégorie contient des fonctions permettant d'effectuer des conversions de types de données telles que la conversion de textes en entiers, d'entiers en textes, etc.

fonction from_base64

Decodes a string in the Base64 encoding into a binary value.

Syntaxe

from_base64 ( string )

Arguments

string the string to decode

Exemples

  • from_base64('UUdJUw==') → 'QGIS'

fonction hash

Crée un hachage depuis une chaîne de caractères avec une méthode donnée

Syntaxe

hash ( string , method )

Arguments

string la chaîne à hacher
method La méthode de hachage parmi 'md4', 'md5', 'sha1', 'sha224', 'sha384', 'sha512', 'sha3_224', 'sha3_256', 'sha3_384', 'sha3_512', 'keccak_224', 'keccak_256', 'keccak_384', 'keccak_512'

Exemples

  • hash('QGIS', md4) → 'c0fc71c241cdebb6e888cbac0e2b68eb'
  • hash('QGIS', md5) → '57470aaa9e22adaefac7f5f342f1c6da'
  • hash('QGIS', sha1) → 'f87cfb2b74cdd5867db913237024e7001e62b114'
  • hash('QGIS', sha224) → '4093a619ada631c770f44bc643ead18fb393b93d6a6af1861fcfece0'
  • hash('QGIS', sha256) → 'eb045cba7a797aaa06ac58830846e40c8e8c780bc0676d3393605fae50c05309'
  • hash('QGIS', sha384) → '91c1de038cc3d09fdd512e99f9dd9922efadc39ed21d3922e69a4305cc25506033aee388e554b78714c8734f9cd7e610'
  • hash('QGIS', sha512) → 'c2c092f2ab743bf8edbeb6d028a745f30fc720408465ed369421f0a4e20fa5e27f0c90ad72d3f1d836eaa5d25cd39897d4cf77e19984668ef58da6e3159f18ac'
  • hash('QGIS', sha3_224) → '467f49a5039e7280d5d42fd433e80d203439e338eaabd701f0d6c17d'
  • hash('QGIS', sha3_256) → '540f7354b6b8a6e735f2845250f15f4f3ba4f666c55574d9e9354575de0e980f'
  • hash('QGIS', sha3_384) → '96052da1e77679e9a65f60d7ead961b287977823144786386eb43647b0901fd8516fa6f1b9d243fb3f28775e6dde6107'
  • hash('QGIS', sha3_512) → '900d079dc69761da113980253aa8ac0414a8bd6d09879a916228f8743707c4758051c98445d6b8945ec854ff90655005e02aceb0a2ffc6a0ebf818745d665349'
  • hash('QGIS', keccak_224) → '5b0ce6acef8b0a121d4ac4f3eaa8503c799ad4e26a3392d1fb201478'
  • hash('QGIS', keccak_256) → '991c520aa6815392de24087f61b2ae0fd56abbfeee4a8ca019c1011d327c577e'
  • hash('QGIS', keccak_384) → 'c57a3aed9d856fa04e5eeee9b62b6e027cca81ba574116d3cc1f0d48a1ef9e5886ff463ea8d0fac772ee473bf92f810d'
  • keccak_512('QGIS') → '6f0f751776b505e317de222508fa5d3ed7099d8f07c74fed54ccee6e7cdc6b89b4a085e309f2ee5210c9'

fonction md5

Crée un hachage md5 depuis une chaîne de caractères

Syntaxe

md5 ( string )

Arguments

string la chaîne à hacher

Exemples

  • md5('QGIS') → '57470aaa9e22adaefac7f5f342f1c6da'

fonction sha256

Crée un hash sha256 depuis une chaîne de caractères.

Syntaxe

sha256 ( string )

Arguments

string la chaîne à hacher

Exemples

  • sha256('QGIS') → 'eb045cba7a797aaa06ac58830846e40c8e8c780bc0676d3393605fae50c05309'

fonction to_base64

Encodes a binary value into a string, using the Base64 encoding.

Syntaxe

to_base64 ( value )

Arguments

value the binary value to encode

Exemples

  • to_base64('QGIS') → 'UUdJUw=='

fonction to_date

Convertit une chaîne de caractères en objet date. Une chaîne de formatage optionnelle peut être fournie pour traiter la chaîne de caractères; voir QDateTime::fromString pour plus d'information sur ce formatage.

Syntaxe

to_date ( string [, format ][, language ])

[ ] indique des éléments optionnels

Arguments

string la chaîne représentant la valeur de date
format format utilisé pour convertir la chaîne de caractères en date
language langue (minuscule, deux ou trois lettres, code de langue ISO 639) utilisée pour convertir une chaîne de caractères en date

Exemples

  • to_date('2012-05-04') → 2012-05-04
  • to_date('June 29, 2019','MMMM d, yyyy') → 2019-06-29
  • to_date('29 juin, 2019','d MMMM, yyyy','fr') → 2019-06-29

fonction to_datetime

Convertit une chaîne de caractères en objet date-heure. Une chaîne de formatage optionnelle peut être fournie pour traiter la chaîne de caractères; voir QDateTime::fromString pour plus d'information sur ce formatage.

Syntaxe

to_datetime ( string [, format ][, language ])

[ ] indique des éléments optionnels

Arguments

string la chaîne représentant la valeur de date et de temps
format format utilisé pour convertir la chaîne de caractères en date-heure
language langue (minuscule, deux ou trois lettres, code de langue ISO 639) utilisée pour convertir une chaîne en date-heure

Exemples

  • to_datetime('2012-05-04 12:50:00') → 2012-05-04T12:50:00
  • to_datetime('June 29, 2019 @ 12:34','MMMM d, yyyy @ HH:mm') → 2019-06-29T12:34
  • to_datetime('29 juin, 2019 @ 12:34','d MMMM, yyyy @ HH:mm','fr') → 2019-06-29T12:34

fonction to_dm

Convertir une coordonnée en degrés, minutes.

Syntaxe

to_dm ( coordinate , axis , precision [, formatting ])

[ ] indique des éléments optionnels

Arguments

coordinate Une longitude ou une latitude.
axis L'axe de la coordonnée. Soit 'x' ou 'y'.
precision Nombre de décimales
formatting Désigne le type de formatage. Les valeurs acceptées sont NULL, 'aligned' ou 'suffix'.

Exemples

  • to_dm(6.3545681, 'x', 3) → 6°21.274′
  • to_dm(6.3545681, 'y', 4, 'suffix') → 6°21.2741′N

fonction to_dms

Convertir une coordonnée en degrés, minutes, secondes.

Syntaxe

to_dms ( coordinate , axis , precision [, formatting ])

[ ] indique des éléments optionnels

Arguments

coordinate Une longitude ou une latitude.
axis L'axe de la coordonnée. Soit 'x' ou 'y'.
precision Nombre de décimales
formatting Désigne le type de formatage. Les valeurs acceptées sont NULL, 'aligned' ou 'suffix'.

Exemples

  • to_dms(6.3545681, 'x', 3) → 6°21′16.445″
  • to_dms(6.3545681, 'y', 4, 'suffix') → 6°21′16.4452″N

fonction to_int

Convertit une chaîne de caractère en nombre entier. Si la valeur ne peut pas être convertie (ex: '123asd' est invalide), cette fonction ne renvoie rien.

Syntaxe

to_int ( string )

Arguments

string la chaîne à convertir en nombre entier

Exemples

  • to_int('123') → 123

fonction to_interval

Convertit une chaîne de caractère en objet d'intervalle de temps. Cette fonction peut être utilisée pour récupérer les jours, heures, mois, etc. d'une date.

Syntaxe

to_interval ( string )

Arguments

string une chaîne de caractères représentant un intervalle de temps. Les formats disponibles incluent {n} jours {n} heures {n} mois.

Exemples

  • to_datetime('2012-05-05 12:00:00') - to_interval('1 day 2 hours') → 2012-05-04T10:00:00

fonction to_real

Convertit une chaîne de caractères en nombre réel. Si la valeur ne peut pas être convertie (ex: '123.56asd' est invalide), cette fonction ne renvoie rien. Les nombres sont arrondis après enregistrement si la précision est inférieure à celle du résultat après conversion.

Syntaxe

to_real ( string )

Arguments

string la chaîne de caractères à convertir en nombre réel

Exemples

  • to_real('123.45') → 123.45

fonction to_string

Convertit un nombre en chaîne de caractères.

Syntaxe

to_string ( number )

Arguments

number Valeur entière ou réelle. Le nombre à convertir en chaîne de caractères.

Exemples

  • to_string(123) → '123'

fonction to_time

Convertit une chaîne de caractères en objet temporel. Une chaîne de format optionnelle peut être fournie pour analyser la chaîne ; voir QTime::fromString pour plus de documentation sur le format.

Syntaxe

to_time ( string [, format ][, language ])

[ ] indique des éléments optionnels

Arguments

string la chaîne de caractères représentant une valeur de temps
format Format utilisé pour convertir une chaîne en heure
language langue (minuscule, deux ou trois lettres, code de langue ISO 639) utilisée pour convertir une chaîne en heure

Exemples

  • to_time('12:30:01') → 12:30:01
  • to_time('12:34','HH:mm') → 12:34:00
  • to_time('12:34','HH:mm','fr') → 12:34:00

groupe date et heure

Ce groupe contient des fonctions permettant de gérer des données de date et d'heure.

fonction age

Renvoie la différence entre deux dates ou deux dates et heures.
La différence est renvoyée sous la forme d'un objet Interval et doit être utilisée avec une des fonctions qui suivent pour pouvoir extraire les informations utiles :

Syntaxe

age ( datetime1 , datetime2 )

Arguments

datetime1 une chaîne de caractères, une date ou une date et un temps représentant la date la plus éloignée dans le temps
datetime2 une chaîne de caractères; une date ou une date et un temps représentant la date la moins éloignée dans le temps

Exemples

  • day(age('2012-05-12','2012-05-02')) → 10
  • hour(age('2012-05-12','2012-05-02')) → 240

fonction datetime_from_epoch

Returns a datetime whose date and time are the number of milliseconds, msecs, that have passed since 1970-01-01T00:00:00.000, Coordinated Universal Time (Qt.UTC), and converted to Qt.LocalTime.

Syntaxe

datetime_from_epoch ( int )

Arguments

int nombre (millisecondes)

Exemples

  • datetime_from_epoch(1483225200000) → 2017-01-01T00:00:00

fonction day

Extrait le jour d'une date ou un nombre de jours depuis un intervalle.

Variante date

Extrait le jour d'une date ou d'une date-heure.

Syntaxe

day ( date )

Arguments

date une valeur date ou datetime

Exemples

  • day('2012-05-12') → 12

Variante intervalle

Calcule la durée en jours d'un intervalle.

Syntaxe

day ( interval )

Arguments

interval Valeur d'intervalle d'où il faut extraire le nombre de jours

Exemples

  • day(to_interval('3 days')) → 3
  • day(to_interval('3 weeks 2 days')) → 23
  • day(age('2012-01-01','2010-01-01')) → 730

fonction day_of_week

Renvoie le jour de la semaine pour une date ou une valeur date et temps. La valeur retournée est comprise entre 0 et 6 où 0 correspond à dimanche et 6 à samedi.

Syntaxe

day_of_week ( date )

Arguments

date valeur de date ou de date et de temps

Exemples

  • day_of_week(to_date('2015-09-21')) → 1

fonction epoch

Retourne l'intervale en millisecondes entre l'epoch unix et une date donnée.

Syntaxe

epoch ( date )

Arguments

date une valeur date ou datetime

Exemples

  • epoch(to_date('2017-01-01')) → 1483203600000

fonction format_date

Formate une date ou une chaîne de caractères selon un format personnalisé. Utilise le formatage des dates/temps de Qt. Consultez QDateTime::toString .

Syntaxe

format_date ( datetime , format [, language ])

[ ] indique des éléments optionnels

Arguments

datetime valeur de date, de temps ou de date et de temps
format String template used to format the string.
Expression Output
d the day as number without a leading zero (1 to 31)
dd the day as number with a leading zero (01 to 31)
ddd the abbreviated localized day name (e.g. 'Mon' to 'Sun')
dddd the long localized day name (e.g. 'Monday' to 'Sunday')
M the month as number without a leading zero (1-12)
MM the month as number with a leading zero (01-12)
MMM the abbreviated localized month name (e.g. 'Jan' to 'Dec')
MMMM the long localized month name (e.g. 'January' to 'December')
yy the year as two digit number (00-99)
yyyy the year as four digit number

These expressions may be used for the time part of the format string:

Expression Output
h the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display)
hh the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display)
H the hour without a leading zero (0 to 23, even with AM/PM display)
HH the hour with a leading zero (00 to 23, even with AM/PM display)
m the minute without a leading zero (0 to 59)
mm the minute with a leading zero (00 to 59)
s the second without a leading zero (0 to 59)
ss the second with a leading zero (00 to 59)
z the milliseconds without trailing zeroes (0 to 999)
zzz the milliseconds with trailing zeroes (000 to 999)
AP or A interpret as an AM/PM time. AP must be either "AM" or "PM".
ap or a Interpret as an AM/PM time. ap must be either "am" or "pm".
language langue (minuscule, deux ou trois lettres, code de langue ISO 639) utilisée pour formater la date en une chaîne personnalisée

Exemples

  • format_date('2012-05-15','dd.MM.yyyy') → '15.05.2012'
  • format_date('2012-05-15','d MMMM yyyy','fr') → '15 juin 2012'

fonction hour

Extrait l'heure d'une variable temps ou de date-heure, ou le nombre d'heures d'un intervalle.

Variante de temps

Extrait l'heure d'une variable temps ou de date-heure.

Syntaxe

hour ( datetime )

Arguments

datetime une valeur de temps ou de date et de temps

Exemples

  • hour('2012-07-22T13:24:57') → 13

Variante intervalle

Calcule la longueur en heures d'un intervalle.

Syntaxe

hour ( interval )

Arguments

interval valeur d'intervalle où calculer le nombre d'heures

Exemples

  • hour(tointerval('3 hours')) → 3
  • hour(age('2012-07-22T13:00:00','2012-07-22T10:00:00')) → 3
  • hour(age('2012-01-01','2010-01-01')) → 17520

fonction make_date

Creates a date value from year, month and day numbers.

Syntaxe

make_date ( year , month , day )

Arguments

year Year number. Years 1 to 99 are interpreted as is. Year 0 is invalid.
month Month number, where 1=January
day Day number, beginning with 1 for the first day in the month

Exemples

  • make_date(2020,5,4) → date value 2020-05-04

fonction make_datetime

Creates a datetime value from year, month, day, hour, minute and second numbers.

Syntaxe

make_datetime ( year , month , day , hour , minute , second )

Arguments

year Year number. Years 1 to 99 are interpreted as is. Year 0 is invalid.
month Month number, where 1=January
day Day number, beginning with 1 for the first day in the month
hour Hour number
minute Minutes
second Seconds (fractional values include milliseconds)

Exemples

  • make_datetime(2020,5,4,13,45,30.5) → datetime value 2020-05-04 13:45:30.500

fonction make_interval

Creates an interval value from year, month, weeks, days, hours, minute and seconds values.

Syntaxe

make_interval ([ years=0 ][, months=0 ][, weeks=0 ][, days=0 ][, hours=0 ][, minutes=0 ][, seconds=0 ])

[ ] indique des éléments optionnels

Arguments

years Number of years (assumes a 365.25 day year length).
months Number of months (assumes a 30 day month length)
weeks Number of weeks
days Number of days
hours Number of hours
minutes Number of minutes
seconds Number of seconds

Exemples

  • make_interval(hours:=3) → 3 hour interval
  • make_interval(days:=2, hours:=3) → 2 day, 3 hour interval

fonction make_time

Creates a time value from hour, minute and second numbers.

Syntaxe

make_time ( hour , minute , second )

Arguments

hour Hour number
minute Minutes
second Seconds (fractional values include milliseconds)

Exemples

  • make_time(13,45,30.5) → time value 13:45:30.500

fonction minute

Extrait les minutes composant un temps ou une date ainsi que le nombre de minutes dans un intervalle.

Variante de temps

Extrait les minutes depuis un temps ou une date.

Syntaxe

minute ( datetime )

Arguments

datetime une valeur de temps ou de date et de temps

Exemples

  • minute('2012-07-22T13:24:57') → 24

Variante intervalle

Calcule la durée en minutes d'un intervalle.

Syntaxe

minute ( interval )

Arguments

interval valeur d'intervalle à convertir en minutes

Exemples

  • minute(tointerval('3 minutes')) → 3
  • minute(age('2012-07-22T00:20:00','2012-07-22T00:00:00')) → 20
  • minute(age('2012-01-01','2010-01-01')) → 1051200

fonction month

Extrait le mois depuis une date ou le nombre de mois dans un intervalle.

Variante date

Extrait le mois d'une date ou d'un temps.

Syntaxe

month ( date )

Arguments

date une valeur date ou datetime

Exemples

  • month('2012-05-12') → 05

Variante intervalle

Calcule le nombre de mois d'un intervalle.

Syntaxe

month ( interval )

Arguments

interval valeur d'intervalle à convertir en nombre de mois

Exemples

  • month(to_interval('3 months')) → 3
  • month(age('2012-01-01','2010-01-01')) → 4.03333

fonction now

Renvoie la date et l'heure courante. C'est une fonction statique qui renvoie des résultats cohérents pendant son évaluation. L'heure renvoyée est celle du moment ou l'expression est préparée.

Syntaxe

now ()

Exemples

  • now() → 2012-07-22T13:24:57

fonction second

Extrait les secondes d'un temps ou d'une date et d'un temps. Extrait le nombres de secondes dans un intervalle.

Variante de temps

Extrait les secondes d'un temps ou d'une date et d'un temps.

Syntaxe

second ( datetime )

Arguments

datetime une valeur de temps ou de date et de temps

Exemples

  • second('2012-07-22T13:24:57') → 57

Variante intervalle

Calcule le nombre de secondes dans un intervalle.

Syntaxe

second ( interval )

Arguments

interval valeur d'intervalle où calculer le nombre de secondes

Exemples

  • second(age('2012-07-22T00:20:00','2012-07-22T00:00:00')) → 1200
  • second(age('2012-01-01','2010-01-01')) → 63072000

fonction to_date

Convertit une chaîne de caractères en objet date. Une chaîne de formatage optionnelle peut être fournie pour traiter la chaîne de caractères; voir QDateTime::fromString pour plus d'information sur ce formatage.

Syntaxe

to_date ( string [, format ][, language ])

[ ] indique des éléments optionnels

Arguments

string la chaîne représentant la valeur de date
format format utilisé pour convertir la chaîne de caractères en date
language langue (minuscule, deux ou trois lettres, code de langue ISO 639) utilisée pour convertir une chaîne de caractères en date

Exemples

  • to_date('2012-05-04') → 2012-05-04
  • to_date('June 29, 2019','MMMM d, yyyy') → 2019-06-29
  • to_date('29 juin, 2019','d MMMM, yyyy','fr') → 2019-06-29

fonction to_datetime

Convertit une chaîne de caractères en objet date-heure. Une chaîne de formatage optionnelle peut être fournie pour traiter la chaîne de caractères; voir QDateTime::fromString pour plus d'information sur ce formatage.

Syntaxe

to_datetime ( string [, format ][, language ])

[ ] indique des éléments optionnels

Arguments

string la chaîne représentant la valeur de date et de temps
format format utilisé pour convertir la chaîne de caractères en date-heure
language langue (minuscule, deux ou trois lettres, code de langue ISO 639) utilisée pour convertir une chaîne en date-heure

Exemples

  • to_datetime('2012-05-04 12:50:00') → 2012-05-04T12:50:00
  • to_datetime('June 29, 2019 @ 12:34','MMMM d, yyyy @ HH:mm') → 2019-06-29T12:34
  • to_datetime('29 juin, 2019 @ 12:34','d MMMM, yyyy @ HH:mm','fr') → 2019-06-29T12:34

fonction to_interval

Convertit une chaîne de caractère en objet d'intervalle de temps. Cette fonction peut être utilisée pour récupérer les jours, heures, mois, etc. d'une date.

Syntaxe

to_interval ( string )

Arguments

string une chaîne de caractères représentant un intervalle de temps. Les formats disponibles incluent {n} jours {n} heures {n} mois.

Exemples

  • to_datetime('2012-05-05 12:00:00') - to_interval('1 day 2 hours') → 2012-05-04T10:00:00

fonction to_time

Convertit une chaîne de caractères en objet temporel. Une chaîne de format optionnelle peut être fournie pour analyser la chaîne ; voir QTime::fromString pour plus de documentation sur le format.

Syntaxe

to_time ( string [, format ][, language ])

[ ] indique des éléments optionnels

Arguments

string la chaîne de caractères représentant une valeur de temps
format Format utilisé pour convertir une chaîne en heure
language langue (minuscule, deux ou trois lettres, code de langue ISO 639) utilisée pour convertir une chaîne en heure

Exemples

  • to_time('12:30:01') → 12:30:01
  • to_time('12:34','HH:mm') → 12:34:00
  • to_time('12:34','HH:mm','fr') → 12:34:00

fonction week

Extrait le numéro de semaine d'une date ou le nombre de semaines dans un intervalle de temps.

Variante date

Extrait le numéro de semaine d'une date ou d'une date et d'un temps.

Syntaxe

week ( date )

Arguments

date une valeur date ou datetime

Exemples

  • week('2012-05-12') → 19

Variante intervalle

Calcule le nombre de semaines dans un intervalle de temps.

Syntaxe

week ( interval )

Arguments

interval valeur d'intervalle à convertir en nombre de mois

Exemples

  • week(tointerval('3 weeks')) → 3
  • week(age('2012-01-01','2010-01-01')) → 104.285

fonction year

Extrait l'année d'une date ou le nombre d'années d'un intervalle de temps.

Variante date

Extrait l'année d'une date ou d'une date et d'un temps.

Syntaxe

year ( date )

Arguments

date une valeur date ou datetime

Exemples

  • year('2012-05-12') → 2012

Variante intervalle

Calcule le nombre d'années d'un intervalle de temps.

Syntaxe

year ( interval )

Arguments

interval valeur d'intervalle où calculer le nombre d'années

Exemples

  • year(to_interval('3 years')) → 3
  • year(age('2012-01-01','2010-01-01')) → 1.9986

groupe fichiers et chemins

Contient des fonctions qui manipulent les noms de fichiers et de chemins.

fonction base_file_name

Renvoie le nom du fichier sans le répertoire ou le suffixe du fichier.

Syntaxe

base_file_name ( path )

Arguments

path Un chemin de fichier

Exemples

  • base_file_name('/home/qgis/data/country_boundaries.shp') → 'country_boundaries'

fonction file_exists

Renvoie vrai si un chemin de fichier existe

Syntaxe

file_exists ( path )

Arguments

path Un chemin de fichier

Exemples

  • file_exists('/home/qgis/data/country_boundaries.shp') → vrai

fonction file_name

Renvoie le nom d'un fichier (y compris l'extension de fichier), à l'exclusion du répertoire.

Syntaxe

file_name ( path )

Arguments

path Un chemin de fichier

Exemples

  • file_name('/home/qgis/data/country_boundaries.shp') → 'country_boundaries.shp'

fonction file_path

Renvoie le répertoire d'un chemin de fichier. Ceci n'inclut pas le nom du fichier.

Syntaxe

file_path ( path )

Arguments

path Un chemin de fichier

Exemples

  • file_path('/home/qgis/data/country_boundaries.shp') → '/home/qgis/data'

fonction file_size

Renvoie la taille (en octets) d'un fichier.

Syntaxe

file_size ( path )

Arguments

path Un chemin de fichier

Exemples

  • file_size('/home/qgis/data/country_boundaries.geojson') → 5674

fonction file_suffix

Renvoie le suffixe (l'extension) d'un chemin de fichier.

Syntaxe

file_suffix ( path )

Arguments

path Un chemin de fichier

Exemples

  • file_suffix('/home/qgis/data/country_boundaries.shp') → 'shp'

fonction is_directory

Renvoie vrai si le chemin correspond à un dossier.

Syntaxe

is_directory ( path )

Arguments

path Un chemin de fichier

Exemples

  • is_directory('/home/qgis/data/country_boundaries.shp') → false
  • is_directory('/home/qgis/data/') → vrai

fonction is_file

Renvoie vrai si le chemin correspond à un fichier.

Syntaxe

is_file ( path )

Arguments

path Un chemin de fichier

Exemples

  • is_file('/home/qgis/data/country_boundaries.shp') → vrai
  • is_file('/home/qgis/data/') → false
Aide manquante pour Form

fonction current_parent_value

Only usable in an embedded form context, this function returns the current, unsaved value of a field in the parent form currently being edited. This will differ from the parent feature's actual attribute values for features which are currently being edited or have not yet been added to a parent layer. When used in a value-relation widget filter expression, this function should be wrapped into a 'coalesce()' that can retrieve the actual parent feature from the layer when the form is not used in an embedded context.

Syntaxe

current_parent_value ( field_name )

Arguments

field_name a field name in the current parent form

Exemples

  • current_parent_value( 'FIELD_NAME' ) → The current value of a field 'FIELD_NAME' in the parent form.

fonction current_value

Renvoie la valeur courante non sauvegardée du champ du formulaire ou de la ligne de table en cours d'édition. Ceci diffère des valeurs d'attribut réelles de l'entité pour les entités en cours d'édition ou qui n'ont pas encore été enregistrée dans une couche.

Syntaxe

current_value ( field_name )

Arguments

field_name un nom de champ dans le formulaire courant ou dans la ligne de la table

Exemples

  • current_value( 'NOM_DU_CHAMP' ) → La valeur du champ 'NOM_DU_CHAMP'.

groupe correspondance floue

Ce groupe contient des fonctions destinées à réaliser des comparaisons floues entre les valeurs.

fonction hamming_distance

Renvoie la distance de Hamming entre deux chaînes. Elle correspond au nombre de caractères aux positions correspondantes des chaînes en entrées où les caractères sont différents. Les chaînes en entrée doivent avoir la même longueur et la comparaison est sensible à la casse.

Syntaxe

hamming_distance ( string1 , string2 )

Arguments

string1 une chaîne de caractères
string2 une chaîne de caractères

Exemples

  • hamming_distance('abc','xec') → 2
  • hamming_distance('abc','ABc') → 2
  • hamming_distance(upper('abc'),upper('ABC')) → 0

fonction levenshtein

Renvoie la distance de Levenshtein entre deux chaînes de caractères. Cela correspond au nombre minimum de modifications (insertions, suppression ou substitution) de caractères pour passer d'une chaîne de caractères à une autre.
La distance de Levenshtein est une mesure de la similarité entre deux chaînes de caractères. Plus la distance est faible, plus les chaînes sont semblables et plus grande est la distance, plus les chaînes sont différentes. Cette distance est sensible à la casse.

Syntaxe

levenshtein ( string1 , string2 )

Arguments

string1 une chaîne de caractères
string2 une chaîne de caractères

Exemples

  • levenshtein('chat','chaton') → 2
  • levenshtein('Chat','chat') → 1
  • levenshtein(upper('Chat'),upper('chat')) → 0

fonction longest_common_substring

Renvoie la sous-chaîne de caractères commune la plus longue entre deux chaînes de caractères. Cette sous-chaîne est la plus longue chaîne de caractères qui est une sous-chaîne des deux chaînes de caractères en entrée. Ex: la sous-chaîne la plus longue entre "ABABC" et "BABCA" est "ABC". La sous-chaîne est sensible à la casse.

Syntaxe

longest_common_substring ( string1 , string2 )

Arguments

string1 une chaîne de caractères
string2 une chaîne de caractères

Exemples

  • longest_common_substring('ABABC','BABCA') → 'ABC'
  • longest_common_substring('abcDeF','abcdef') → 'abc'
  • longest_common_substring(upper('abcDeF'),upper('abcdex')) → 'ABCDE'

fonction soundex

Renvoie la représentation Soundex d'une chaîne de caractères. Soundex est un algorithme de correspondance phonétique. Les chaînes avec des sons semblables seront représentées avec le même code Soundex.

Syntaxe

soundex ( string )

Arguments

string une chaîne de caractères

Exemples

  • soundex('robert') → 'R163'
  • soundex('rupert') → 'R163'
  • soundex('rubin') → 'R150'

groupe général

Ce groupe contient des fonctions génériques.

fonction env

Récupère une variable d'environnement et renvoie son contenu comme chaîne de caractères. Si la variable n'est pas trouvée, `NULL` sera renvoyé. Ceci est pratique pour injecter des configurations système spécifiques comme des lettres de lecteurs ou des préfixes de chemins. La définition des variables d'environnement dépend du système d'exploitation, merci de vérifier avec votre administrateur système ou dans la documentation comment ceci doit être défini.

Syntaxe

env ( name )

Arguments

name Le nom d'une variable d'environnement à récupérer.

Exemples

  • env( 'LANG' ) → 'en_US.UTF-8'
  • env( 'MY_OWN_PREFIX_VAR' ) → 'Z:'
  • env( 'JE_N_EXISTE_PAS' ) → NULL

fonction eval

Évalue une expression passée en chaîne de caractères. Cette fonction est utilisée pour produire les paramètres dynamiques tels que les variables de contexte ou les champs.

Syntaxe

eval ( expression )

Arguments

expression une chaîne de caractère d'expression

Exemples

  • eval(''sympa'') → 'sympa'
  • eval(@variable_expression) → [quel que soit le résultat de l'évaluation de @expression_var…]

fonction eval_template

Evaluates a template which is passed in a string. Useful to expand dynamic parameters passed as context variables or fields.

Syntaxe

eval_template ( template )

Arguments

template a template string

Exemples

  • eval_template('QGIS [% upper(\'rocks\') %]') → QGIS ROCKS

fonction is_layer_visible

Renvoie «vrai» si un calque spécifié est visible.

Syntaxe

is_layer_visible ( layer )

Arguments

layer une chaîne de caractères représentant soit un nom de couche ou un ID de couche

Exemples

  • is_layer_visible('raster de base') → True

fonction layer_property

Renvoie une propriété de couche ou une valeur de métadonnée correspondante.

Syntaxe

layer_property ( layer , property )

Arguments

layer une chaîne de caractères représentant soit un nom de couche ou un ID de couche
property a string corresponding to the property to return. Valid options are:
  • name: layer name
  • id: layer ID
  • title: metadata title string
  • abstract: metadata abstract string
  • keywords: metadata keywords
  • data_url: metadata URL
  • attribution: metadata attribution string
  • attribution_url: metadata attribution URL
  • source: layer source
  • min_scale: minimum display scale for layer
  • max_scale: maximum display scale for layer
  • is_editable: if layer is in edit mode
  • crs: layer CRS
  • crs_definition: layer CRS full definition
  • crs_description: layer CRS description
  • extent: layer extent (as a geometry object)
  • distance_units: layer distance units
  • type: layer type, e.g., Vector or Raster
  • storage_type: storage format (vector layers only)
  • geometry_type: geometry type, e.g., Point (vector layers only)
  • feature_count: approximate feature count for layer (vector layers only)
  • path: File path to the layer data source. Only available for file based layers.

Exemples

  • layer_property('streets','title') → 'Basemap Streets'
  • layer_property('airports','feature_count') → 120
  • layer_property('landsat','crs') → 'EPSG:4326'

fonction var

Renvoie la valeur stockée dans une variable.

Syntaxe

var ( name )

Arguments

name un nom de variable

Exemples

  • var('qgis_version') → '2.12'

fonction with_variable

Cette fonction définit une variable pour tout code d'expression qui sera fourni comme troisième argument. Ceci n'est utile que pour des expressions compliquées, où la même valeur calculée doit être utilisée dans différents endroits.

Syntaxe

with_variable ( name , value , expression )

Arguments

name le nom de la variable à définir
value la valeur à définir
expression l'expression pour laquelle la variable sera disponible

Exemples

  • with_variable('my_sum', 1 + 2 + 3, @my_sum * 2 + @my_sum * 5) → 42

groupe géométrie

Cette catégorie contient des fonctions utilisant la géométrie des entités comme la longueur, l'aire, etc.

fonction $area

Renvoie la surface de l'entité courante. La surface calculée par cette fonction respecte à la fois le paramétrage de l'ellipsoide du projet et l'unité de surface. Ex: si une ellipsoide a été paramétrée pour le projet alors la surface sera ellipsoidale, sinon, elle sera calculée selon un plan.

Syntaxe

$area

Exemples

  • $area → 42

fonction $geometry

Renvoie la géométrie de l'entité courante. Cette fonction peut être utilisée en combinaison avec d'autres fonctions.

Syntaxe

$geometry

Exemples

  • geomToWKT( $geometry ) → POINT(6 50)

fonction $length

Renvoie la longueur d'une polyligne. Si vous souhaitez récupérer la longueur de la bordure d'un polygone, utilisez $perimeter à la place. La longueur calculée par cette fonction respecte les paramètres d’ellipsoïde du projet ainsi que les unités de distances. Ex: si une ellipsoïde a été paramétrée pour le projet alors la longueur sera ellipsoïdale, sinon, elle sera calculée selon un plan.

Syntaxe

$length

Exemples

  • $length → 42.4711

fonction $perimeter

Renvoie le périmètre de l'entité courante. Le périmètre calculé par cette fonction respecte à la fois le paramétrage de l'ellipsoide du projet et l'unité de surface. Ex: si une ellipsoide a été paramétrée pour le projet alors le périmètre sera ellipsoidal, sinon, il sera calculé selon un plan.

Syntaxe

$perimeter

Exemples

  • $perimeter → 42

fonction $x

Renvoie la coordonnée x de l'entité actuelle.

Syntaxe

$x

Exemples

  • $x → 42

fonction $x_at

Récupère une coordonnée en x de la géométrie de l'entité actuelle.

Syntaxe

$x_at ( i )

Arguments

i index du point de la ligne (les index commencent à 0, les valeurs négatives s'appliquent à partir de la fin et commence à -1)

Exemples

  • $x_at (1) → 5

fonction $y

Renvoie la coordonnée y de l'entité courante.

Syntaxe

$y

Exemples

  • $y → 42

fonction $y_at

Renvoie la coordonnée y de la géométrie de l'entité courante.

Syntaxe

$y_at ( i )

Arguments

i index du point de la ligne (les index commencent à 0, les valeurs négatives s'appliquent à partir de la fin et commence à -1)

Exemples

  • $y_at (1) → 2

fonction angle_at_vertex

Renvoie la bissectrice de l'angle (angle moyen) de la géométrie pour un sommet spécifique d'une géométrie de polyligne. Les angles sont en degrés dans le sens des aiguilles d'une montre à partir du nord.

Syntaxe

angle_at_vertex ( geometry , vertex )

Arguments

geometry une géométrie de polyligne
vertex index du sommet, à partir de 0 ; si la valeur est négative, l'index du sommet sélectionné sera le nombre total moins la valeur absolue.

Exemples

  • angle_at_vertex(geometry:=geom_from_wkt('LineString(0 0, 10 0, 10 10)'),vertex:=1) → 45.0

fonction area

Renvoie la surface d'une géométrie polygonale. Les calculs sont toujours planimétriques dans le Système de Coordonnées de Référence (SCR) de la géométrie et les unités de la surface correspondent aux unités du SCR. Cette fonction est différente des caculs effectués par la fonction $area qui réalise des calculs ellipsoïdaux en se basant sur les paramètres d'ellipsoïde du projet et des unités de surface.

Syntaxe

area ( geometry )

Arguments

geometry objet géométrique polygonal

Exemples

  • area(geom_from_wkt('POLYGON((0 0, 4 0, 4 2, 0 2, 0 0))')) → 8.0

fonction azimuth

Renvoie l'azimut par rapport au nord sous forme d'angle en radians mesuré dans le sens des aiguilles d'une montre à partir de la verticale entre point_a et point_b.

Syntaxe

azimuth ( point_a , point_b )

Arguments

point_a géométrie ponctuelle
point_b géométrie ponctuelle

Exemples

  • degrees( azimuth( make_point(25, 45), make_point(75, 100) ) ) → 42.273689
  • degrees( azimuth( make_point(75, 100), make_point(25,45) ) ) → 222.273689

fonction boundary

Renvoie la fermeture de la limite combinatoire de la géométrie (c'est-à-dire la limite topologique de la géométrie). Par exemple, une géométrie de polygone aura une frontière constituée de polylignes pour chaque anneau dans le polygone. Certains types de géométrie n'ont pas de limite définie, par exemple des points ou des collections de géométrie, et renvoient null.

Syntaxe

boundary ( geometry )

Arguments

geometry une géométrie

Exemples

  • geom_to_wkt(boundary(geom_from_wkt('Polygon((1 1, 0 0, -1 1, 1 1))'))) → 'LineString(1 1,0 0,-1 1,1 1)'

fonction bounds

Renvoie une géométrie représentant l'emprise d'une géométrie en entrée. Les calculs sont effectués dans le Système Spatial de Référence de cette géométrie.

Syntaxe

bounds ( geom )

Arguments

geom une géométrie

Exemples

  • bounds($geometry) → emprise de $geometry

fonction bounds_height

Renvoie la hauteur de l'emprise d'une géométrie. Les calculs sont effectués dans le Système Spatial de Référence de cette géométrie.

Syntaxe

bounds_height ( geom )

Arguments

geom une géométrie

Exemples

  • bounds_height($geometry) → hauteur de l'emprise de $geometry

fonction bounds_width

Renvoie la largeur de l'emprise d'une géométrie. Les calculs sont effectués dans le Système Spatial de Référence de cette géométrie.

Syntaxe

bounds_width ( geom )

Arguments

geom une géométrie

Exemples

  • bounds_width($geometry) → largeur de l'emprise de $geometry

fonction buffer

Renvoie une géométrie qui représente l'ensemble des points dont la distance est inférieure ou égale à la distance avec une géométrie en entrée. Les calculs sont effectués dans le Système Spatial de Référence de cette géométrie.

Syntaxe

buffer ( geom , distance [, segments=8 ])

[ ] indique des éléments optionnels

Arguments

geom une géométrie
distance distance tampon dans les unités de la couche
segments nombre de segments utilisés pour représenter un quart de cercle quand le style de raccordement arrondi est actif. Plus le nombre est élevé, plus la ligne apparaitra lisse et contiendra des noeuds.

Exemples

  • buffer($geometry, 10.5) → polygone de $geometry avec un tampon de 10.5 unités

fonction buffer_by_m

Crée autour d'une ligne une zone tampon dont le diamètre varie en fonction des mesures "m" à chaque vertex.

Syntaxe

buffer_by_m ( geometry [, segments=8 ])

[ ] indique des éléments optionnels

Arguments

geometry géométrie en entrée. Doit être de type (multi)ligne avec mesures "m".
segments nombre de segments pour approximer des courbes en quart de cercle dans le tampon.

Exemples

  • buffer_by_m(geometry:=geom_from_wkt('LINESTRINGM(1 2 0.5, 4 2 0.2)'),segments:=8) → Un tampon de taille variable avec un diamètre de 0.5 et finissant par un diamètre de 0.2 le long d'une géométrie de polyligne.

fonction centroid

Renvoie le centre géométrique d'une géométrie.

Syntaxe

centroid ( geom )

Arguments

geom une géométrie

Exemples

  • centroid($geometry) → une géométrie ponctuelle

fonction close_line

Returns a closed line string of the input line string by appending the first point to the end of the line, if it is not already closed. If the geometry is not a line string or multi line string then the result will be null.

Syntaxe

close_line ( geometry )

Arguments

geometry une géométrie linéaire

Exemples

  • geom_to_wkt(close_line(geom_from_wkt('LINESTRING(0 0, 1 0, 1 1)'))) → LineString (0 0, 1 0, 1 1, 0 0)
  • geom_to_wkt(close_line(geom_from_wkt('LINESTRING(0 0, 1 0, 1 1, 0 0)'))) → LineString (0 0, 1 0, 1 1, 0 0)

fonction closest_point

Renvoie le point de la géométrie1 qui est le plus proche de la géométrie2.

Syntaxe

closest_point ( geometry1 , geometry2 )

Arguments

geometry1 géométrie qui contiendra le point le plus proche
geometry2 géométrie vers laquelle trouver le point le plus proche

Exemples

  • geom_to_wkt(closest_point(geom_from_wkt('LINESTRING (20 80, 98 190, 110 180, 50 75 )'),geom_from_wkt('POINT(100 100)'))) → Point(73.0769 115.384)

fonction collect_geometries

Réunit un ensemble de géométries dans un objet géométrique multiparties.

Variante liste d'arguments

Geometry parts are specified as separate arguments to the function.

Syntaxe

collect_geometries ( geometry1 , geometry2 …)

Arguments

geometry une géométrie

Exemples

  • geom_to_wkt(collect_geometries(make_point(1,2), make_point(3,4), make_point(5,6))) → 'MultiPoint ((1 2),(3 4),(5 6))'

Variante tableau

Les parties géométriques sont spécifiées sous la forme d'un tableau.

Syntaxe

collect_geometries ( array )

Arguments

array tableau d'objets géomatiques

Exemples

  • geom_to_wkt(collect_geometries(array(make_point(1,2), make_point(3,4), make_point(5,6)))) → 'MultiPoint ((1 2),(3 4),(5 6))'

fonction combine

Renvoie la combinaison de deux géométries.

Syntaxe

combine ( geometry1 , geometry2 )

Arguments

geometry1 une géométrie
geometry2 une géométrie

Exemples

  • geom_to_wkt( combine( geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 2 1)' ) ) ) → MULTILINESTRING((4 4, 2 1), (3 3, 4 4), (4 4, 5 5))
  • geom_to_wkt( combine( geom_from_wkt( 'LINESTRING(3 3, 4 4)' ), geom_from_wkt( 'LINESTRING(3 3, 6 6, 2 1)' ) ) ) → LINESTRING(3 3, 4 4, 6 6, 2 1)

fonction contains

Teste si une géométrie en contient une autre. Renvoie vraie si et seulement si aucun point de la géométrie b se situe à l'extérieur de la géométrie a et qu'au moins un point de l'intérieur de b est situé à l'intérieur de a.

Syntaxe

contains ( geometry a , geometry b )

Arguments

geometry a une géométrie
geometry b une géométrie

Exemples

  • contains( geom_from_wkt( 'POLYGON((0 0, 0 1, 1 1, 1 0, 0 0))' ), geom_from_wkt( 'POINT(0.5 0.5 )' ) ) → vrai
  • contains( geom_from_wkt( 'POLYGON((0 0, 0 1, 1 1, 1 0, 0 0))' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → false

fonction convex_hull

Renvoie l'enveloppe convexe d'une géométrie. Elle représente la géométrie convexe minimale qui entoure toutes les géométries du jeu de données.

Syntaxe

convex_hull ( geometry )

Arguments

geometry une géométrie

Exemples

  • geom_to_wkt( convex_hull( geom_from_wkt( 'LINESTRING(3 3, 4 4, 4 10)' ) ) ) → POLYGON((3 3,4 10,4 4,3 3))

fonction crosses

Teste si une géométrie en croise une autre. Renvoie vrai si les géométries fournies contiennent quelques points intérieurs en commun sans que tous les points le soient.

Syntaxe

crosses ( geometry a , geometry b )

Arguments

geometry a une géométrie
geometry b une géométrie

Exemples

  • crosses( geom_from_wkt( 'LINESTRING(3 5, 4 4, 5 3)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → vrai
  • crosses( geom_from_wkt( 'POINT(4 5)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → false

fonction difference

Renvoie une géométrie qui représente la partie de la géométrie a qui ne s'intersecte pas avec la géométrie b.

Syntaxe

difference ( geometry_a , geometry_b )

Arguments

geometry_a une géométrie
geometry_b une géométrie

Exemples

  • geom_to_wkt( difference( geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4)' ) ) ) → LINESTRING(4 4, 5 5)

fonction disjoint

Teste si des géométries ne s'intersectent pas. Renvoie vrai si les géométries n'ont aucune surface en commun.

Syntaxe

disjoint ( geometry a , geometry b )

Arguments

geometry a une géométrie
geometry b une géométrie

Exemples

  • disjoint( geom_from_wkt( 'POLYGON((0 0, 0 1, 1 1, 1 0, 0 0 ))' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → vrai
  • disjoint( geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ), geom_from_wkt( 'POINT(4 4)' )) → false

fonction distance

Renvoie la distance minimale (basée sur le référentiel spatial) entre deux géométries dans les unités de la projection.

Syntaxe

distance ( geometry a , geometry b )

Arguments

geometry a une géométrie
geometry b une géométrie

Exemples

  • distance( geom_from_wkt( 'POINT(4 4)' ), geom_from_wkt( 'POINT(4 8)' ) ) → 4

fonction distance_to_vertex

Renvoie la distance le long de la géométrie à un sommet spécifié.

Syntaxe

distance_to_vertex ( geometry , vertex )

Arguments

geometry une géométrie de polyligne
vertex index du sommet, à partir de 0 ; si la valeur est négative, l'index du sommet sélectionné sera le nombre total moins la valeur absolue.

Exemples

  • distance_to_vertex(geometry:=geom_from_wkt('LineString(0 0, 10 0, 10 10)'),vertex:=1) → 10.0

fonction end_point

Renvoie le dernier nœud d'une géométrie.

Syntaxe

end_point ( geometry )

Arguments

geometry objet géométrique

Exemples

  • geom_to_wkt(end_point(geom_from_wkt('LINESTRING(4 0, 4 2, 0 2)'))) → 'Point (0 2)'

fonction extend

Étire d'une valeur spécifiée le début et la fin d'une géométrie de type polyligne. Les lignes sont étirées en prenant en compte l'inclinaison du premier et du dernier lien. Les distances sont exprimées dans le Système Spatial de Référence de cette géométrie.

Syntaxe

extend ( geometry , start_distance , end_distance )

Arguments

geometry une géométrie (multi)polyligne
start_distance la distance d'étirement du début et de la fin de la ligne
end_distance distance d'étirement de la fin de la ligne.

Exemples

  • geom_to_wkt(extend(geom_from_wkt('LineString(0 0, 1 0, 1 1)'),1,2)) → LineString (-1 0, 1 0, 1 3)

fonction exterior_ring

Renvoie une ligne représentant l'anneau extérieur d'une géométrie de polygone. Si la géométrie n'est pas un polygone alors le resultat sera NULL.

Syntaxe

exterior_ring ( geom )

Arguments

geom une géométrie polygonale

Exemples

  • geom_to_wkt(exterior_ring(geom_from_wkt('POLYGON((-1 -1, 4 0, 4 2, 0 2, -1 -1),( 0.1 0.1, 0.1 0.2, 0.2 0.2, 0.2, 0.1, 0.1 0.1))'))) → 'LineString (-1 -1, 4 0, 4 2, 0 2, -1 -1)'

fonction extrude

Renvoie une version extrudée d'une géométrie (Multi-)Courbe ou d'une (Multi-)Polyligne avec une extension indiquée par x et y.

Syntaxe

extrude ( geom , x , y )

Arguments

geom une géométrie polygonale
x extension x, valeur numérique
y extension y, valeur numérique

Exemples

  • extrude(geom_from_wkt('LineString(1 2, 3 2, 4 3)'), 1, 2) → Polygon ((1 2, 3 2, 4 3, 5 5, 4 4, 2 4, 1 2))
  • extrude(geom_from_wkt('MultiLineString((1 2, 3 2), (4 3, 8 3)'), 1, 2) → MultiPolygon (((1 2, 3 2, 4 4, 2 4, 1 2)),((4 3, 8 3, 9 5, 5 5, 4 3)))

fonction flip_coordinates

Retourne une copie de la géométrie avec les valeurs de coordonnées X et Y inversées. Il peut être utilisé pour réparer des géométries dont les valeurs de latitude et de longitude ont été inversées.

Syntaxe

flip_coordinates ( geom )

Arguments

geom une géométrie

Exemples

  • geom_to_wkt(flip_coordinates(make_point(1, 2))) → Point (2 1)

fonction force_rhr

Force une géométrie à respecter la règle de la main droite, dans laquelle la zone délimitée par un polygone se trouve à la droite de la frontière. En particulier, l'anneau extérieur est orienté dans le sens des aiguilles d'une montre et les anneaux intérieurs dans le sens inverse.

Syntaxe

force_rhr ( geom )

Arguments

geom Une géométrie. Toutes les géométries non polygonales sont renvoyées inchangées.

Exemples

  • geom_to_wkt(force_rhr(geometry:=geom_from_wkt('POLYGON((-1 -1, 4 0, 4 2, 0 2, -1 -1))'))) → Polygon ((-1 -1, 0 2, 4 2, 4 0, -1 -1))

fonction geom_from_gml

Renvoie une géométrie à partir d'une représentation géométrique GML.

Syntaxe

geom_from_gml ( gml )

Arguments

gml représentation GML d'une géométrie sous la forme d'une chaîne de caractères

Exemples

  • geom_from_gml('<gml:LineString srsName="EPSG:4326"><gml:coordinates>4,4 5,5 6,6</gml:coordinates></gml:LineString>') → un objet géométrique linéaire

fonction geom_from_wkb

Renvoie une géométrie créée depuis une représentation en Well-Known Binary (WKB).

Syntaxe

geom_from_wkb ( binary )

Arguments

binary Représentation en Well-Known Binary (WKB) d'une géométrie (comme un blob)

Exemples

  • geom_from_wkb( geom_to_wkb( make_point(4,5) ) ) → un objet géométrique ponctuel

fonction geom_from_wkt

Renvoie une géométrie créée à partir d'une représentation Well-Known Text (WKT).

Syntaxe

geom_from_wkt ( text )

Arguments

text Représentation Well-Known Text (WKT) d'une géométrie

Exemples

  • geom_from_wkt( 'POINT(4 5)' ) → un objet géométrique

fonction geom_to_wkb

Returns the Well-Known Binary (WKB) representation of a geometry

Syntaxe

geom_to_wkb ( geometry )

Arguments

geometry une géométrie

Exemples

  • geom_to_wkb( $geometry ) → Un blob contenant un objet géométrique

fonction geom_to_wkt

Renvoie la représentation Well-Known Text (WKT) d'une géométrie sans les métadonnées de SRID.

Syntaxe

geom_to_wkt ( geometry [, precision ])

[ ] indique des éléments optionnels

Arguments

geometry une géométrie
precision précision numérique

Exemples

  • geom_to_wkt( $geometry ) → POINT(6 50)

fonction geometry

Renvoie la géométrie d'une entité.

Syntaxe

geometry ( feature )

Arguments

feature un objet d'entité

Exemples

  • geom_to_wkt( geometry( get_feature( layer, attributeField, value ) ) ) → 'POINT(6 50)'
  • intersects( $geometry, geometry( get_feature( layer, attributeField, value ) ) ) → vrai

fonction geometry_n

Renvoie une géométrie donnée d'une collection de géométrie ou NULL si la géométrie en entrée n'est pas une collection.

Syntaxe

geometry_n ( geometry , index )

Arguments

geometry collection de géométrie
index index de la géométrie à renvoyer où 1 est la première géométrie de la collection

Exemples

  • geom_to_wkt(geometry_n(geom_from_wkt('GEOMETRYCOLLECTION(POINT(0 1), POINT(0 0), POINT(1 0), POINT(1 1))'),3)) → 'Point (1 0)'

fonction hausdorff_distance

Renvoie la distance Hausdorff entre deux géométries. Il s'agit essentiellement d'une mesure de la géométrie similaire ou différente de deux géométries, avec une distance inférieure indiquant des géométries similaires.
La fonction peut être exécutée avec un argument de fraction de densité facultatif. Si elle n'est pas spécifiée, une approximation de la distance standard de Hausdorff est utilisée. Cette approximation est exacte ou assez proche pour un grand sous-ensemble de cas utiles. Des exemples sont:

  • distance de calcul entre les lignes qui sont approximativement parallèles l'une à l'autre et à peu près égales. Cela se produit dans la correspondance de réseaux linéaires.
  • Testant la similitude des géométries.


  • Si l'approximation par défaut fournie par cette méthode est insuffisante, spécifiez l'argument de fraction de densité facultative. La spécification de cet argument effectue une densification de segment avant de calculer la distance séparée de Hausdorff. Le paramètre définit la fraction permettant de densifier chaque segment. Chaque segment sera divisé en plusieurs segments de longueur égale, dont la fraction de la longueur totale est la plus proche de la fraction donnée. Diminuer le paramètre de la fraction de densité fera en sorte que la distance renvoyée approche la distance réelle de Hausdorff pour les géométries.

    Syntaxe

    hausdorff_distance ( geometry a , geometry b [, densify_fraction ])

    [ ] indique des éléments optionnels

    Arguments

    geometry a une géométrie
    geometry b une géométrie
    densify_fraction densifier le montant de la fraction

    Exemples

    • hausdorff_distance( geometry1:= geom_from_wkt('LINESTRING (0 0, 2 1)'),geometry2:=geom_from_wkt('LINESTRING (0 0, 2 0)')) → 2
    • hausdorff_distance( geom_from_wkt('LINESTRING (130 0, 0 0, 0 150)'),geom_from_wkt('LINESTRING (10 10, 10 150, 130 10)')) → 14.142135623
    • hausdorff_distance( geom_from_wkt('LINESTRING (130 0, 0 0, 0 150)'),geom_from_wkt('LINESTRING (10 10, 10 150, 130 10)'),0.5) → 70.0

    fonction inclination

    Renvoie l'inclinaison mesurée du zénith (0) au nadir (180) du point_a au point_b.

    Syntaxe

    inclination ( point_a , point_b )

    Arguments

    point_a géométrie ponctuelle
    point_b géométrie ponctuelle

    Exemples

    • inclination( make_point( 5, 10, 0 ), make_point( 5, 10, 5 ) ) → 0.0
    • inclination( make_point( 5, 10, 0 ), make_point( 5, 10, 0 ) ) → 90.0
    • inclination( make_point( 5, 10, 0 ), make_point( 50, 100, 0 ) ) → 90.0
    • inclination( make_point( 5, 10, 0 ), make_point( 5, 10, -5 ) ) → 180.0

    fonction interior_ring_n

    Renvoie un anneau intérieur donné d'une géométrie polygonale ou NULL si la géométrie n'est pas un polygone.

    Syntaxe

    interior_ring_n ( geometry , index )

    Arguments

    geometry géométrie polygonale
    index index de l'anneau intérieur à renvoyer où 1 est le premier anneau intérieur

    Exemples

    • geom_to_wkt(interior_ring_n(geom_from_wkt('POLYGON((-1 -1, 4 0, 4 2, 0 2, -1 -1),(-0.1 -0.1, 0.4 0, 0.4 0.2, 0 0.2, -0.1 -0.1),(-1 -1, 4 0, 4 2, 0 2, -1 -1))'),1)) → 'LineString (-0.1 -0.1, 0.4 0, 0.4 0.2, 0 0.2, -0.1 -0.1))'

    fonction intersection

    Renvoie une géométrie qui représente la portion commune de deux géométries.

    Syntaxe

    intersection ( geometry1 , geometry2 )

    Arguments

    geometry1 une géométrie
    geometry2 une géométrie

    Exemples

    • geom_to_wkt( intersection( geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4)' ) ) ) → LINESTRING(3 3, 4 4)

    fonction intersects

    Teste si une géométrie en intersecte une autre. Renvoie vrai si les géométries s'intersectent (partage n'importe quelle portion de leur surface) et faux dans le cas contraire.

    Syntaxe

    intersects ( geometry a , geometry b )

    Arguments

    geometry a une géométrie
    geometry b une géométrie

    Exemples

    • intersects( geom_from_wkt( 'POINT(4 4)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → vrai
    • intersects( geom_from_wkt( 'POINT(4 5)' ), geom_from_wkt( 'POINT(5 5)' ) ) → false

    fonction intersects_bbox

    Teste si une emprise de géométrie en chevauche une autre. Renvoie vrai si la géométrie intersecte l'emprise définie et faux dans le cas contraire.

    Syntaxe

    intersects_bbox ( geometry , geometry )

    Arguments

    geometry une géométrie
    geometry une géométrie

    Exemples

    • intersects_bbox( geom_from_wkt( 'POINT(4 5)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → vrai
    • intersects_bbox( geom_from_wkt( 'POINT(6 5)' ), geom_from_wkt( 'POLYGON((3 3, 4 4, 5 5, 3 3))' ) ) → false

    fonction is_closed

    Renvoie true si une ligne est fermée (le point de début et le point de fin sont identiques) ou false si une ligne n'est pas fermée. Si la géométrie n'est pas une ligne, le résultat sera NULL.

    Syntaxe

    is_closed ( geom )

    Arguments

    geom une géométrie linéaire

    Exemples

    • is_closed(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)')) → false
    • is_closed(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2, 0 0)')) → vrai

    fonction is_empty

    Renvoie true si une géométrie est vide (sans coordonnées), false si la géométrie n'est pas vide et NULL s'il y a aucune géométrie. Voir aussi `is_empty_or_null`.

    Syntaxe

    is_empty ( geom )

    Arguments

    geom une géométrie

    Exemples

    • is_empty(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)')) → false
    • is_empty(geom_from_wkt('LINESTRING EMPTY')) → vrai
    • is_empty(geom_from_wkt('POINT(7 4)')) → false
    • is_empty(geom_from_wkt('POINT EMPTY')) → vrai

    fonction is_empty_or_null

    Renvoie true si une géométrie est NULL ou vide (sans coordonnées) ou sinon false. Cette fonction est comme l'expression '$geometry IS NULL or is_empty($geometry)'

    Syntaxe

    is_empty_or_null ( geom )

    Arguments

    geom une géométrie

    Exemples

    • is_empty_or_null(NULL) → vrai
    • is_empty_or_null(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)')) → false
    • is_empty_or_null(geom_from_wkt('LINESTRING VIDE')) → vrai
    • is_empty_or_null(geom_from_wkt('POINT(7 4)')) → false
    • is_empty_or_null(geom_from_wkt('POINT VIDE')) → vrai

    fonction is_multipart

    Returns true if the geometry is of Multi type.

    Syntaxe

    is_multipart ( geometry )

    Arguments

    geometry une géométrie

    Exemples

    • is_multipart(geom_from_wkt('MULTIPOINT ((0 0),(1 1),(2 2))')) → vrai
    • is_multipart(geom_from_wkt('POINT (0 0)')) → false

    fonction is_valid

    Renvoie true si une géométrie est valide ; si elle est bien formée en 2D selon les règles de l'OGC.

    Syntaxe

    is_valid ( geom )

    Arguments

    geom une géométrie

    Exemples

    • is_valid(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2, 0 0)')) → vrai
    • is_valid(geom_from_wkt('LINESTRING(0 0)')) → false

    fonction length

    Renvoie le nombre de caractères d'une chaîne de caractères ou la longueur d'une géométrie de polylignes.

    Variante chaîne de caractères

    Renvoie le nombre de caractères de la chaîne de caractères.

    Syntaxe

    length ( string )

    Arguments

    string chaîne de caractères dont il faut calculer la longueur

    Exemples

    • length('salut') → 5

    Variante géométrique

    Calcule la longueur d'une géométrie linéaire. Les calculs sont toujours planimétriques dans le Système de Coordonnées de Référence (SCR) de la géométrie et les unités de la longueur correspondent aux unités du SCR. Cette fonction est différente des caculs effectués par la fonction $length qui réalise des calculs ellipsoïdaux en se basant sur les paramètres d'ellipsoïde du projet et des unités de distance.

    Syntaxe

    length ( geometry )

    Arguments

    geometry un objet géométrique linéaire

    Exemples

    • length(geom_from_wkt('LINESTRING(0 0, 4 0)')) → 4.0

    fonction line_interpolate_angle

    Renvoie l'angle parallèle à la géométrie à une distance spécifiée le long d'une géométrie de polyligne. Les angles sont en degrés dans le sens des aiguilles d'une montre par rapport au nord.

    Syntaxe

    line_interpolate_angle ( geometry , distance )

    Arguments

    geometry une géométrie de polyligne
    distance distance le long de la ligne à laquelle l'interpolation de l'angle sera réalisée

    Exemples

    • line_interpolate_angle(geometry:=geom_from_wkt('LineString(0 0, 10 0)'),distance:=5) → 90.0

    fonction line_interpolate_point

    Renvoie l'interpolation d'un point situé à une certaine distance le long d'une géométrie de type polyligne.

    Syntaxe

    line_interpolate_point ( geometry , distance )

    Arguments

    geometry une géométrie de polyligne
    distance Distance le long de la ligne à interpoler

    Exemples

    • geom_to_wkt(line_interpolate_point(geometry:=geom_from_wkt('LineString(0 0, 10 0)'),distance:=5)) → 'Point (5 0)'

    fonction line_locate_point

    Renvoie la distance le long d'une géométrie de type polyligne correspondant à la longueur de cette ligne à la plus proche position d'un point spécifié.

    Syntaxe

    line_locate_point ( geometry , point )

    Arguments

    geometry une géométrie de polyligne
    point géométrie de type point utilisée pour situer la plus proche position sur la polyligne

    Exemples

    • line_locate_point(geometry:=geom_from_wkt('LineString(0 0, 10 0)'),point:=geom_from_wkt('Point(5 0)')) → 5.0

    fonction line_merge

    Renvoie une géométrie de type polyligne ou multi-polyligne dans laquelle toutes les polylignes connectées de la geométrie en entrée ont été fusionnées en une seule polyligne. Cette fonction renverra null si la géométrie en argument n'est pas du type polyligne/multi-polyligne.

    Syntaxe

    line_merge ( geometry )

    Arguments

    geometry une géométrie de type polyligne/multi-polyligne

    Exemples

    • geom_to_wkt(line_merge(geom_from_wkt('MULTILINESTRING((0 0, 1 1),(1 1, 2 2))'))) → 'LineString(0 0,1 1,2 2)'
    • geom_to_wkt(line_merge(geom_from_wkt('MULTILINESTRING((0 0, 1 1),(11 1, 21 2))'))) → 'MultiLineString((0 0, 1 1),(11 1, 21 2)'

    fonction line_substring

    Cet algorithme renvoie la partie d'une ligne (ou courbe) comprise entre les distances de début et de fin spécifiées (mesurées à partir du début de la ligne). Les valeurs Z et M sont interpolées linéairement à partir des valeurs existantes.

    Syntaxe

    line_substring ( geometry , start_distance , end_distance )

    Arguments

    geometry une géométrie de polyligne ou de courbe
    start_distance distance pour le début d'un sous segment
    end_distance distance pour la fin d'un sous segment

    Exemples

    • geom_to_wkt(line_substring(geometry:=geom_from_wkt('LineString(0 0, 10 0)'),start_distance:=2,end_distance=6)) → 'LineString (2 0,6 0)'

    fonction m

    Renvoie la valeur m d'une géométrie de type point.

    Syntaxe

    m ( geom )

    Arguments

    geom une géométrie ponctuelle

    Exemples

    • m( geom_from_wkt( 'POINTM(2 5 4)' ) ) → 4

    fonction m_max

    Returns the maximum m (measure) value of a geometry.

    Syntaxe

    m_max ( geometry )

    Arguments

    geometry a geometry containing m values

    Exemples

    • m_max( make_point_m( 0,0,1 ) ) → 1
    • m_max(make_line( make_point_m( 0,0,1 ), make_point_m( -1,-1,2 ), make_point_m( -2,-2,0 ) ) ) → 2

    fonction m_min

    Returns the minimum m (measure) value of a geometry.

    Syntaxe

    m_min ( geometry )

    Arguments

    geometry a geometry containing m values

    Exemples

    • m_min( make_point_m( 0,0,1 ) ) → 1
    • m_min(make_line( make_point_m( 0,0,1 ), make_point_m( -1,-1,2 ), make_point_m( -2,-2,0 ) ) ) → 0

    fonction make_circle

    Crée un polygone circulaire.

    Syntaxe

    make_circle ( center , radius [, segment=36 ]…)

    [ ] indique des éléments optionnels

    Arguments

    center point du centre du cercle
    radius rayon du cercle
    segment argument en option pour la segmentation du polygone. Par défaut, cette valeur vaut 36

    Exemples

    • geom_to_wkt(make_circle(make_point(10,10), 5, 4)) → 'Polygon ((10 15, 15 10, 10 5, 5 10, 10 15))'
    • geom_to_wkt(make_circle(make_point(10,10,5), 5, 4)) → 'PolygonZ ((10 15 5, 15 10 5, 10 5 5, 5 10 5, 10 15 5))'
    • geom_to_wkt(make_circle(make_point(10,10,5,30), 5, 4)) → 'PolygonZM ((10 15 5 30, 15 10 5 30, 10 5 5 30, 5 10 5 30, 10 15 5 30))'

    fonction make_ellipse

    Créé un polygone elliptique.

    Syntaxe

    make_ellipse ( center , semi_major_axis , semi_minor_axis , azimuth [, segment=36 ]…)

    [ ] indique des éléments optionnels

    Arguments

    center point du centre de l'ellipse
    semi_major_axis demi-grand axe de l'ellipse
    semi_minor_axis demi-petit axe de l'ellipse
    azimuth orientation de l'ellipse
    segment argument en option pour la segmentation du polygone. Par défaut, cette valeur vaut 36

    Exemples

    • geom_to_wkt(make_ellipse(make_point(10,10), 5, 2, 90, 4)) → 'Polygon ((15 10, 10 8, 5 10, 10 12, 15 10))'
    • geom_to_wkt(make_ellipse(make_point(10,10,5), 5, 2, 90, 4)) → 'PolygonZ ((15 10 5, 10 8 5, 5 10 5, 10 12 5, 15 10 5))'
    • geom_to_wkt(make_ellipse(make_point(10,10,5,30), 5, 2, 90, 4)) → 'PolygonZM ((15 10 5 30, 10 8 5 30, 5 10 5 30, 10 12 5 30, 15 10 5 30))'

    fonction make_line

    Créé une géométrie linéaire à partir d'une série de géométries ponctuelles.

    Variante liste d'arguments

    Line vertices are specified as separate arguments to the function.

    Syntaxe

    make_line ( point1 , point2 …)

    Arguments

    point une géométrie ponctuelle (ou un tableau de points)

    Exemples

    • geom_to_wkt(make_line(make_point(2,4),make_point(3,5))) → 'LineString (2 4, 3 5)'
    • geom_to_wkt(make_line(make_point(2,4),make_point(3,5),make_point(9,7))) → 'LineString (2 4, 3 5, 9 7)'

    Variante tableau

    Les sommets de la linge sont spécifiés comme un tableau de points.

    Syntaxe

    make_line ( array )

    Arguments

    array tableau de points

    Exemples

    • geom_to_wkt(make_line(array(make_point(2,4),make_point(3,5),make_point(9,7)))) → 'LineString (2 4, 3 5, 9 7)'

    fonction make_point

    Créé une géométrie ponctuelle à partir des valeurs x et y (et optionellement des valeurs z et m).

    Syntaxe

    make_point ( x , y [, z ][, m ])

    [ ] indique des éléments optionnels

    Arguments

    x coordonnée x du point
    y coordonnée y du point
    z coordonnée optionnelle z du point
    m valeur optionnelle m du point

    Exemples

    • geom_to_wkt(make_point(2,4)) → 'Point (2 4)'
    • geom_to_wkt(make_point(2,4,6)) → 'PointZ (2 4 6)'
    • geom_to_wkt(make_point(2,4,6,8)) → 'PointZM (2 4 6 8)'

    fonction make_point_m

    Créé une géométrie ponctuelle à partir d'une valeur en x et en y et d'une valeur m.

    Syntaxe

    make_point_m ( x , y , m )

    Arguments

    x coordonnée x du point
    y coordonnée y du point
    m valeur m du point

    Exemples

    • geom_to_wkt(make_point_m(2,4,6)) → 'PointM (2 4 6)'

    fonction make_polygon

    Créé une géométrie polygonale à partir d'un anneau externe et de séries optionnelles de géométries d'anneaux internes.

    Syntaxe

    make_polygon ( outerRing [, innerRing1 ][, innerRing2 ]…)

    [ ] indique des éléments optionnels

    Arguments

    outerRing géométrie linéaire fermée de l'anneau extérieur du polygone
    innerRing géométrie linéaire fermée optionnelle pour l'anneau intérieur

    Exemples

    • geom_to_wkt(make_polygon(geom_from_wkt('LINESTRING( 0 0, 0 1, 1 1, 1 0, 0 0 )'))) → 'Polygon ((0 0, 0 1, 1 1, 1 0, 0 0))'
    • geom_to_wkt(make_polygon(geom_from_wkt('LINESTRING( 0 0, 0 1, 1 1, 1 0, 0 0 )'),geom_from_wkt('LINESTRING( 0.1 0.1, 0.1 0.2, 0.2 0.2, 0.2 0.1, 0.1 0.1 )'),geom_from_wkt('LINESTRING( 0.8 0.8, 0.8 0.9, 0.9 0.9, 0.9 0.8, 0.8 0.8 )'))) → 'Polygon ((0 0, 0 1, 1 1, 1 0, 0 0),(0.1 0.1, 0.1 0.2, 0.2 0.2, 0.2 0.1, 0.1 0.1),(0.8 0.8, 0.8 0.9, 0.9 0.9, 0.9 0.8, 0.8 0.8))'

    fonction make_rectangle_3points

    Creates a rectangle from 3 points.

    Syntaxe

    make_rectangle_3points ( point1 , point2 , point3 [, option=0 ]…)

    [ ] indique des éléments optionnels

    Arguments

    point1 Premier point.
    point2 Deuxième point.
    point3 Troisième point.
    option Un argument facultatif pour construire le rectangle. Par défaut, cette valeur est 0. La valeur peut être 0 (distance) ou 1 (projeté). Option distance : La seconde distance est égale à la distance entre le 2ème et le 3ème point. Option projeté : La seconde distance est égale à la distance de la projection perpendiculaire du 3ème point sur le segment ou son extension.

    Exemples

    • geom_to_wkt(make_rectangle(make_point(0, 0), make_point(0,5), make_point(5, 5), 0))) → 'Polygon ((0 0, 0 5, 5 5, 5 0, 0 0))'
    • geom_to_wkt(make_rectangle(make_point(0, 0), make_point(0,5), make_point(5, 3), 1))) → 'Polygon ((0 0, 0 5, 5 5, 5 0, 0 0))'

    fonction make_regular_polygon

    Créé un polygone régulier.

    Syntaxe

    make_regular_polygon ( center , radius , number_sides [, circle=0 ]…)

    [ ] indique des éléments optionnels

    Arguments

    center centre du polygone régulier
    radius second point. Premier point si le polygone régulier est inscrit. Le point du milieu du premier côté si le polygone régulier est circonscrit
    number_sides Nombre de côtés/arrêtes du polygone régulier
    circle Argument optionnel pour la construction du polygone régulier. Par défaut, cette valeur vaut 0. Elle peut prendre la valeur 0 (inscrit) ou 1 (circonscrit)

    Exemples

    • geom_to_wkt(make_regular_polygon(make_point(0,0), make_point(0,5), 5)) → 'Polygon ((0 5, 4.76 1.55, 2.94 -4.05, -2.94 -4.05, -4.76 1.55, 0 5))'
    • geom_to_wkt(make_regular_polygon(make_point(0,0), project(make_point(0,0), 4.0451, radians(36)), 5)) → 'Polygon ((0 5, 4.76 1.55, 2.94 -4.05, -2.94 -4.05, -4.76 1.55, 0 5))'

    fonction make_square

    Crée un carré à partir d'une diagonale.

    Syntaxe

    make_square ( point1 , point2 …)

    Arguments

    point1 Premier point du polygone régulier
    point2 Deuxième point

    Exemples

    • geom_to_wkt(make_square( make_point(0,0), make_point(5,5))) → 'Polygon ((0 0, -0 5, 5 5, 5 0, 0 0))'
    • geom_to_wkt(make_square( make_point(5,0), make_point(5,5))) → 'Polygon ((5 0, 2.5 2.5, 5 5, 7.5 2.5, 5 0))'

    fonction make_triangle

    Créer un polygone triangle.

    Syntaxe

    make_triangle ( point 1 , point 2 , point 3 )

    Arguments

    point 1 premier point du triangle
    point 2 second point du triangle
    point 3 troisième point du triangle

    Exemples

    • geom_to_wkt(make_triangle(make_point(0,0), make_point(5,5), make_point(0,10))) → 'Triangle ((0 0, 5 5, 0 10, 0 0))'
    • geom_to_wkt(boundary(make_triangle(make_point(0,0), make_point(5,5), make_point(0,10)))) → 'LineString (0 0, 5 5, 0 10, 0 0)'

    fonction minimal_circle

    Renvoie le cercle de fermeture minimal d'une géométrie. Il représente le cercle minimum qui renferme toutes les géométries dans l'ensemble.

    Syntaxe

    minimal_circle ( geometry [, segment=36 ])

    [ ] indique des éléments optionnels

    Arguments

    geometry une géométrie
    segment argument en option pour la segmentation du polygone. Par défaut, cette valeur vaut 36

    Exemples

    • geom_to_wkt( minimal_circle( geom_from_wkt( 'LINESTRING(0 5, 0 -5, 2 1)' ), 4 ) ) → Polygon ((0 5, 5 -0, -0 -5, -5 0, 0 5))
    • geom_to_wkt( minimal_circle( geom_from_wkt( 'MULTIPOINT(1 2, 3 4, 3 2)' ), 4 ) ) → Polygon ((3 4, 3 2, 1 2, 1 4, 3 4))

    fonction nodes_to_points

    Renvoie une géométrie multi-point composée de chaque nœud de la géométrie en entrée.

    Syntaxe

    nodes_to_points ( geometry [, ignore_closing_nodes=false ])

    [ ] indique des éléments optionnels

    Arguments

    geometry objet géométrique
    ignore_closing_nodes argument optionnel indiquant s'il faut inclure les nœuds dupliqués qui ferment les lignes ou les anneaux de polygones. La valeur par défaut est 'false' et modifiée à 'true' pour éviter que ces nœuds dupliqués soient présent dans la collection de géométrie en sortie.

    Exemples

    • geom_to_wkt(nodes_to_points(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)'))) → 'MultiPoint ((0 0),(1 1),(2 2))'
    • geom_to_wkt(nodes_to_points(geom_from_wkt('POLYGON((-1 -1, 4 0, 4 2, 0 2, -1 -1))'),true)) → 'MultiPoint ((-1 -1),(4 0),(4 2),(0 2))'

    fonction num_geometries

    Renvoie le nombre de géométries dans une collection de géométrie ou NULL si la géométrie en entrée n'est pas une collection.

    Syntaxe

    num_geometries ( geometry )

    Arguments

    geometry collection de géométrie

    Exemples

    • num_geometries(geom_from_wkt('GEOMETRYCOLLECTION(POINT(0 1), POINT(0 0), POINT(1 0), POINT(1 1))')) → 4

    fonction num_interior_rings

    Renvoie le nombre d'anneaux intérieurs dans un polygone ou dans une collection de géométrie ou NULL si la géométrie en entrée n'est pas un polygone ou une collection.

    Syntaxe

    num_interior_rings ( geometry )

    Arguments

    geometry géométrie en entrée

    Exemples

    • num_interior_rings(geom_from_wkt('POLYGON((-1 -1, 4 0, 4 2, 0 2, -1 -1),(-0.1 -0.1, 0.4 0, 0.4 0.2, 0 0.2, -0.1 -0.1))')) → 1

    fonction num_points

    Renvoie le nombre de sommets d'une géométrie.

    Syntaxe

    num_points ( geom )

    Arguments

    geom une géométrie

    Exemples

    • num_points($geometry) → nombre de sommets dans $geometry

    fonction num_rings

    Renvoie le nombre d'anneaux (incluant les anneaux extérieurs) d'un polygone ou d'une collection de géométrie ou bien NULL si la géométrie en entrée n'est pas un polygone ou une collection.

    Syntaxe

    num_rings ( geometry )

    Arguments

    geometry géométrie en entrée

    Exemples

    • num_rings(geom_from_wkt('POLYGON((-1 -1, 4 0, 4 2, 0 2, -1 -1),(-0.1 -0.1, 0.4 0, 0.4 0.2, 0 0.2, -0.1 -0.1))')) → 2

    fonction offset_curve

    Renvoie une géométrie formée en décalant sur un côté une géométrie de type polyligne. Les distances sont exprimées dans le Système Spatial de Référence de cette géométrie.

    Syntaxe

    offset_curve ( geometry , distance [, segments=8 ][, join=1 ][, miter_limit=2.0 ])

    [ ] indique des éléments optionnels

    Arguments

    geometry une géométrie (multi)polyligne
    distance distance de décalage. Les valeurs positives produiront un tampon à gauche des lignes, les valeurs négatives, à droite
    segments nombre de segments utilisés pour représenter un quart de cercle quand le style de raccordement arrondi est actif. Plus le nombre est élevé, plus la ligne apparaitra lisse et contiendra des noeuds.
    join style de raccordement pour les angles, avec 1 = arrondi, 2 = angle droit, 3 = chanfreiné
    miter_limit valeur limite du ratio d'angle droit utilisé pour les angles très vifs (uniquement pour le style de raccordement par angle droit)

    Exemples

    • offset_curve($geometry, 10.5) → décalage de ligne sur la gauche de 10.5 unités
    • offset_curve($geometry, -10.5) → décalage de ligne sur la droite de 10.5 unités
    • offset_curve($geometry, 10.5, segments=16, join=1) → Décalage de ligne vers la gauche de 10.5 unités, en utilisant plus de segments pour obtenir une courbe plus lisse
    • offset_curve($geometry, 10.5, join=3) → décalage de ligne sur la gauche de 10.5 unités, en utilisant une jointure biseautée

    fonction order_parts

    Ré-arrange les parties d'une géométrie multiple selon le critère donné

    Syntaxe

    order_parts ( geom , orderby , ascending )

    Arguments

    geom une géométrie multiple
    orderby une chaîne de caractères d'expression définissant le critère de tri
    ascending booléen, True pour ascendant, False pour descendant

    Exemples

    • order_parts(geom_from_wkt('MultiPolygon (((1 1, 5 1, 5 5, 1 5, 1 1)),((1 1, 9 1, 9 9, 1 9, 1 1)))'), 'area($geometry)', False) → MultiPolygon (((1 1, 9 1, 9 9, 1 9, 1 1)),((1 1, 5 1, 5 5, 1 5, 1 1)))
    • order_parts(geom_from_wkt('LineString(1 2, 3 2, 4 3)'), '1', True) → LineString(1 2, 3 2, 4 3)

    fonction oriented_bbox

    Renvoie une géométrie qui représente la zone de délimitation orientée minimale d'une géométrie en entrée.

    Syntaxe

    oriented_bbox ( geom )

    Arguments

    geom une géométrie

    Exemples

    • geom_to_wkt( oriented_bbox( geom_from_wkt( 'MULTIPOINT(1 2, 3 4, 3 2)' ) ) ) → Polygon ((1 4, 1 2, 3 2, 3 4, 1 4))

    fonction overlaps

    Teste si une géométrie recouvre totalement une autre. Renvoie vrai si les géométries partagent la même surface, sont de même dimension mais ne sont pas complètement contenues l'une dans l'autre.

    Syntaxe

    overlaps ( geometry a , geometry b )

    Arguments

    geometry a une géométrie
    geometry b une géométrie

    Exemples

    • overlaps( geom_from_wkt( 'LINESTRING(3 5, 4 4, 5 5, 5 3)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → vrai
    • overlaps( geom_from_wkt( 'LINESTRING(0 0, 1 1)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → false

    fonction perimeter

    Renvoie le périmètre d'une géométrie polygonale. Les calculs sont toujours planimétriques dans le Système de Coordonnées de Référence (SCR) de la géométrie et les unités du périmètre correspondent aux unités du SCR. Cette fonction est différente des caculs effectués par la fonction $perimeter qui réalise des calculs ellipsoïdaux en se basant sur les paramètres d'ellipsoïde du projet et des unités de longueur.

    Syntaxe

    perimeter ( geometry )

    Arguments

    geometry objet géométrique polygonal

    Exemples

    • perimeter(geom_from_wkt('POLYGON((0 0, 4 0, 4 2, 0 2, 0 0))')) → 12.0

    fonction point_n

    Renvoie un nœud donné d'une géométrie.

    Syntaxe

    point_n ( geometry , index )

    Arguments

    geometry objet géométrique
    index index du sommet à retourner, où 1 est le premier sommet; si la valeur est négative, l'index du sommet sélectionné sera le nombre total moins la valeur absolue

    Exemples

    • geom_to_wkt(point_n(geom_from_wkt('POLYGON((0 0, 4 0, 4 2, 0 2, 0 0))'),2)) → 'Point (4 0)'

    fonction point_on_surface

    Renvoie un point qui est certainement situé à la surface d'une géométrie.

    Syntaxe

    point_on_surface ( geom )

    Arguments

    geom une géométrie

    Exemples

    • point_on_surface($geometry) → une géométrie ponctuelle

    fonction pole_of_inaccessibility

    Calcules le pôle d'inaccessibilité approximatif pour une surface, qui est le point le plus éloigné des frontières de cette surface. Cette fonction utilise l'algorithme 'polylabel' (Vladimir Agafonkin, 2016) qui fonctionne suivant une approche itérative afin de trouver le véritable pôle d'inaccessibilité avec une certaine tolérance. Des tolérances plus précises engendrent plus d'itérations et prennent plus de temps.

    Syntaxe

    pole_of_inaccessibility ( geometry , tolerance )

    Arguments

    geometry une géométrie
    tolerance distance maximale entre le point renvoyé et l'emplacement du vrai pôle

    Exemples

    • geom_to_wkt(pole_of_inaccessibility( geom_from_wkt('POLYGON((0 1,0 9,3 10,3 3, 10 3, 10 1, 0 1))'), 0.1)) → Point(1.55, 1.55)

    fonction project

    Renvoie un point projeté depuis un point de départ en utilisant une distance et une direction (azimuth) en radians.

    Syntaxe

    project ( point , distance , azimuth [, elevation ])

    [ ] indique des éléments optionnels

    Arguments

    point point de départ
    distance distance à projeter
    azimuth direction en radians dans le sens des aiguilles d'une montre, où 0 correspond au Nord
    elevation angle d'inclinaison en radians

    Exemples

    • geom_to_wkt(project(make_point(1, 2), 3, radians(270))) → Point(-2, 2)

    fonction relate

    Teste la représentation du Modèle Dimensionnel Étendu à 9 Intersections (DE-9IM en anglais) de la relation entre deux géométries.

    Variante relationnelle

    Renvoie la représentation du Modèle Dimensionnel Étendu à 9 Intersections (DE-9IM en anglais) de la relation entre deux géométries.

    Syntaxe

    relate ( geometry , geometry )

    Arguments

    geometry une géométrie
    geometry une géométrie

    Exemples

    • relate( geom_from_wkt( 'LINESTRING(40 40,120 120)' ), geom_from_wkt( 'LINESTRING(40 40,60 120)' ) ) → 'FF1F00102'

    Variante de correspondance de motif

    Teste si la représentation du Modèle Dimensionnel Étendu à 9 Intersections (DE-9IM en anglais) de la relation entre deux géométries correspond au motif indiqué.

    Syntaxe

    relate ( geometry , geometry , pattern )

    Arguments

    geometry une géométrie
    geometry une géométrie
    pattern motif de correspondance DE-9IM

    Exemples

    • relate( geom_from_wkt( 'LINESTRING(40 40,120 120)' ), geom_from_wkt( 'LINESTRING(40 40,60 120)' ), '**1F001**' ) → True

    fonction reverse

    Inverse la direction d'une géométrie linéaire en inversant l'ordre de ses sommets.

    Syntaxe

    reverse ( geom )

    Arguments

    geom une géométrie

    Exemples

    • geom_to_wkt(reverse(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)'))) → 'LINESTRING(2 2, 1 1, 0 0)'

    fonction rotate

    Renvoie une version pivotée d'une géométrie. Les calculs sont effectués dans le Système Spatial de Référence de cette géométrie.

    Syntaxe

    rotate ( geom , rotation [, point ])

    [ ] indique des éléments optionnels

    Arguments

    geom une géométrie
    rotation rotation horaire en degrés
    point point central de rotation. S'il n'est pas spécifié, le centre de l'emprise de la géométrie sera utilisé.

    Exemples

    • rotate($geometry, 45, make_point(4, 5)) → géométrie pivotée de 45 degrés dans le sens horaire autour du point (4, 5)
    • rotate($geometry, 45) → géométrie pivotée de 45 degrés dans le sens horaire autour du centre de son emprise

    fonction segments_to_lines

    Renvoie une géométrie multi-ligne composée d'une ligne pour chaque segment de la géométrie en entrée.

    Syntaxe

    segments_to_lines ( geometry )

    Arguments

    geometry objet géométrique

    Exemples

    • geom_to_wkt(segments_to_lines(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)'))) → 'MultiLineString ((0 0, 1 1),(1 1, 2 2))'

    fonction shortest_line

    Renvoie la plus courte ligne joignant la géométrie 1 à la géométrie 2. La ligne résultante commencera sur la géométrie 1 et se terminera sur la géométrie 2.

    Syntaxe

    shortest_line ( geometry1 , geometry2 )

    Arguments

    geometry1 géométrie à partir de laquelle trouver la ligne la plus courte
    geometry2 géométrie vers laquelle trouver la ligne la plus courte

    Exemples

    • geom_to_wkt(shortest_line(geom_from_wkt('LINESTRING (20 80, 98 190, 110 180, 50 75 )'),geom_from_wkt('POINT(100 100)'))) → LineString(73.0769 115.384, 100 100)

    fonction simplify

    Simplifie une géométrie en supprimant les nœuds en utilisant un seuil basé sur la distance (c'est-à-dire l'algorithme de Douglas Peucker). L'algorithme conserve de grands écarts dans les géométries et réduit le nombre de noeuds dans les segments presque droits.

    Syntaxe

    simplify ( geometry , tolerance )

    Arguments

    geometry une géométrie
    tolerance Écart maximum par rapport aux segments droits pour les points devant être supprimés

    Exemples

    • geom_to_wkt(simplify(geometry:=geom_from_wkt('LineString(0 0, 5 0.1, 10 0)'),tolerance:=5)) → 'LineString(0 0, 10 0)'

    fonction simplify_vw

    Simplifie une géométrie par suppression de noeuds en utilisant un seuil basé sur une zone (l'algorithme du Visvalingam-Whyatt). L'algorithme efface les arêtes qui correspondent à des zones trop petites, par exemple les pics très étroits ou les segments quasi alignés.

    Syntaxe

    simplify_vw ( geometry , tolerance )

    Arguments

    geometry une géométrie
    tolerance une mesure de la superficie maximale créée par un nœud pour le nœud à supprimer

    Exemples

    • geom_to_wkt(simplify_vw(geometry:=geom_from_wkt('LineString(0 0, 5 0, 5.01 10, 5.02 0, 10 0)'),tolerance:=5)) → 'LineString(0 0, 10 0)'

    fonction single_sided_buffer

    Renvoie une géométrie formée par un tampon appliqué sur un seul côté d'une géométrie de type polyligne. Les distances sont exprimées dans le Système Spatial de Référence de cette géométrie.

    Syntaxe

    single_sided_buffer ( geometry , distance [, segments=8 ][, join=1 ][, miter_limit=2.0 ])

    [ ] indique des éléments optionnels

    Arguments

    geometry une géométrie (multi)polyligne
    distance distance du tampon. Les valeurs positives produiront un tampon sur la gauche et les négatives sur la droite
    segments nombre de segments utilisés pour représenter un quart de cercle quand le style de raccordement arrondi est actif. Plus le nombre est élevé, plus la ligne apparaitra lisse et contiendra des noeuds.
    join style de raccordement pour les angles, avec 1 = arrondi, 2 = angle droit, 3 = chanfreiné
    miter_limit valeur limite du ratio d'angle droit utilisé pour les angles très vifs (uniquement pour le style de raccordement par angle droit)

    Exemples

    • single_sided_buffer($geometry, 10.5) → tampon de ligne sur la gauche de 10.5 unités
    • single_sided_buffer($geometry, -10.5) → tampon de ligne sur la droite de 10.5 unités
    • single_sided_buffer($geometry, 10.5, segments=16, join=1) → ligne dont un tampon de 10.5 unités a été généré sur la gauche en utilisant plus de segments pour un résultat plus lisse
    • single_sided_buffer($geometry, 10.5, join=3) → ligne dont un tampon de 10.5 unités a été généré sur la gauche en utilisant un raccordement chanfreiné

    fonction smooth

    Lisse une géométrie an ajoutant des vertex supplémentaires qui arrondissent les angles de la géométrie. Si les géométries d'entrée contiennent des valeurs Z ou M, elles seront également lissées et la géométrie de sortie gardera la même dimension que celle d'entrée.

    Syntaxe

    smooth ( geometry [, iterations ][, offset ][, min_length ][, max_angle ])

    [ ] indique des éléments optionnels

    Arguments

    geometry une géométrie
    iterations Nombre d'itérations de lissage à appliquer. De plus grands nombres aboutissent à des géométries plus lisses mais plus complexes.
    offset valeur entre 0 et 0.5 qui détermine à quel point la géométrie lissée se rapproche de la géométrie originale. Des petites valeurs donnent un lissage plus serré, des grandes valeurs un lissage plus lâche.
    min_length longueur minimale des segments sur lesquels appliquer le lissage. Ce paramètre peut être utilisé pour éviter d'ajouter excessivement des noeuds aux plus petits segments de la géométrie.
    max_angle angle maximal au niveau d'un noeud poir appliquer le lissage (0-180). En diminuant volontairement l'angle maximal, les angles vifs de la géométrie peuvent être conservés. Par exemple, une valeur de 80 degrés conservera les angles droits de la géométrie.

    Exemples

    • geom_to_wkt(smooth(geometry:=geom_from_wkt('LineString(0 0, 5 0, 5 5)'),iterations:=1,offset:=0.2,min_length:=-1,max_angle:=180)) → 'LineString (0 0, 4 0, 5 1, 5 5)'

    fonction start_point

    Renvoie le premier nœud d'une géométrie.

    Syntaxe

    start_point ( geometry )

    Arguments

    geometry objet géométrique

    Exemples

    • geom_to_wkt(start_point(geom_from_wkt('LINESTRING(4 0, 4 2, 0 2)'))) → 'Point (4 0)'

    fonction sym_difference

    Renvoie une géométrie qui représente la portion non intersectées de deux géométries.

    Syntaxe

    sym_difference ( geometry1 , geometry2 )

    Arguments

    geometry1 une géométrie
    geometry2 une géométrie

    Exemples

    • geom_to_wkt( sym_difference( geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ), geom_from_wkt( 'LINESTRING(3 3, 8 8)' ) ) ) → LINESTRING(5 5, 8 8)

    fonction tapered_buffer

    Crée autour d'une ligne une zone tampon dont le diamètre varie uniformément du début jusqu'à la fin de la ligne.

    Syntaxe

    tapered_buffer ( geometry , start_width , end_width [, segments=8 ])

    [ ] indique des éléments optionnels

    Arguments

    geometry géométrie en entrée, de type (multi)ligne.
    start_width largeur de la zone tampon en début de ligne,
    end_width largeur de la zone tampon en fin de ligne.
    segments nombre de segments pour approximer des courbes en quart de cercle dans le tampon.

    Exemples

    • tapered_buffer(geometry:=geom_from_wkt('LINESTRING(1 2, 4 2)'),start_width:=1,end_width:=2,segments:=8) → Un tampon de taille variable avec un diamètre de 1 et finissant par un diamètre de 2 le long d'une géométrie de polyligne.

    fonction touches

    Teste si deux géométries se touchent. Renvoie vrai si les géométries ont au moins un point en commun mais que leurs surface intérieures ne s'intersectent pas.

    Syntaxe

    touches ( geometry a , geometry b )

    Arguments

    geometry a une géométrie
    geometry b une géométrie

    Exemples

    • touches( geom_from_wkt( 'LINESTRING(5 3, 4 4)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → vrai
    • touches( geom_from_wkt( 'POINT(4 4)' ), geom_from_wkt( 'POINT(5 5)' ) ) → false

    fonction transform

    Renvoie la géométrie transformée d'un SCR source vers un SCR cible.

    Syntaxe

    transform ( geom , source_auth_id , dest_auth_id )

    Arguments

    geom une géométrie
    source_auth_id Identifiant du SCR source
    dest_auth_id Identifiant du SCR cible

    Exemples

    • geom_to_wkt( transform( $geometry, 'EPSG:2154', 'EPSG:4326' ) ) → POINT(0 51)

    fonction translate

    Renvoie une version translatée d'une géométrie. Les calculs sont effectués dans le Système Spatial de Référence de cette géométrie.

    Syntaxe

    translate ( geom , dx , dy )

    Arguments

    geom une géométrie
    dx delta x
    dy delta y

    Exemples

    • translate($geometry, 5, 10) → une géométrie du même type que la géométrie d'origine

    fonction union

    Renvoie une géométrie qui représente l'ensemble de points unis des géométries.

    Syntaxe

    union ( geometry1 , geometry2 )

    Arguments

    geometry1 une géométrie
    geometry2 une géométrie

    Exemples

    • geom_to_wkt( union( geom_from_wkt( 'POINT(4 4)' ), geom_from_wkt( 'POINT(5 5)' ) ) ) → MULTIPOINT(4 4, 5 5)

    fonction wedge_buffer

    Renvoie un tampon avec angles depuis une géométrie de point.

    Syntaxe

    wedge_buffer ( center , azimuth , width , outer_radius [, inner_radius=0.0 ])

    [ ] indique des éléments optionnels

    Arguments

    center point central (origine) d'un tampon. Doit être une géométrie ponctuelle.
    azimuth angle (en degrés) depuis le milieu du coin vers le point
    width largeur du tampon (en degrés). Notez que le coin s'étendra jusqu'à la moitié de la largeur angulaire de chaque côté de la direction de l'azimut.
    outer_radius rayon extérieur pour les tampons
    inner_radius rayon intérieur optionnel pour les tampons

    Exemples

    • wedge_buffer(center:=geom_from_wkt('POINT(1 2)'),azimuth:=90,width:=180,outer_radius:=1) → Tampon en forme de coin centré sur le point (1,2), orienté vers l'est, d'une largeur de 180 degrés et d'un rayon extérieur de 1.

    fonction within

    Teste si une géométrie est située complètement à l'intérieur d'une autre. Renvoie vrai si la géométrie a est contenue complètement dans la géométrie b.

    Syntaxe

    within ( geometry a , geometry b )

    Arguments

    geometry a une géométrie
    geometry b une géométrie

    Exemples

    • within( geom_from_wkt( 'POINT( 0.5 0.5)' ), geom_from_wkt( 'POLYGON((0 0, 0 1, 1 1, 1 0, 0 0))' ) ) → vrai
    • within( geom_from_wkt( 'POINT( 5 5 )' ), geom_from_wkt( 'POLYGON((0 0, 0 1, 1 1, 1 0, 0 0 ))' ) ) → false

    fonction x

    Renvoie la coordonnée x d'une géométrie ponctuelle ou la coordonnée x du centroïde d'une géométrie non ponctuelle.

    Syntaxe

    x ( geom )

    Arguments

    geom une géométrie

    Exemples

    • x( geom_from_wkt( 'POINT(2 5)' ) ) → 2
    • x( $geometry ) → coordonnée x du centroïde de l'entité courante

    fonction x_max

    Renvoie la coordonnée x maximale d'une géométrie. Les calculs sont effectués dans le Système Spatial de Référence de la géométrie.

    Syntaxe

    x_max ( geom )

    Arguments

    geom une géométrie

    Exemples

    • x_max( geom_from_wkt( 'LINESTRING(2 5, 3 6, 4 8)') ) → 4

    fonction x_min

    Renvoie la coordonnée x minimale d'une géométrie. Les calculs sont effectués dans le Système Spatial de Référence de la géométrie.

    Syntaxe

    x_min ( geom )

    Arguments

    geom une géométrie

    Exemples

    • x_min( geom_from_wkt( 'LINESTRING(2 5, 3 6, 4 8)') ) → 2

    fonction y

    Renvoie la coordonnée y d'une géométrie ponctuelle ou la coordonnée y du centroïde d'une géométrie non ponctuelle.

    Syntaxe

    y ( geom )

    Arguments

    geom une géométrie

    Exemples

    • y( geom_from_wkt( 'POINT(2 5)' ) ) → 5
    • y( $geometry ) → coordonnée y du centroïde de l'entité courante

    fonction y_max

    Renvoie la coordonnée y maximale d'une géométrie. Les calculs sont effectués dans le Système Spatial de Référence de la géométrie.

    Syntaxe

    y_max ( geom )

    Arguments

    geom une géométrie

    Exemples

    • y_max( geom_from_wkt( 'LINESTRING(2 5, 3 6, 4 8)') ) → 8

    fonction y_min

    Renvoie la coordonnée y minimale d'une géométrie. Les calculs sont effectués dans le Système Spatial de Référence de la géométrie.

    Syntaxe

    y_min ( geom )

    Arguments

    geom une géométrie

    Exemples

    • y_min( geom_from_wkt( 'LINESTRING(2 5, 3 6, 4 8)') ) → 5

    fonction z

    Renvoie la coordonnée z d'une géométrie de type point.

    Syntaxe

    z ( geom )

    Arguments

    geom une géométrie ponctuelle

    Exemples

    • z( geom_from_wkt( 'POINTZ(2 5 7)' ) ) → 7

    fonction z_max

    Returns the maximum z coordinate of a geometry.

    Syntaxe

    z_max ( geometry )

    Arguments

    geometry a geometry with z coordinate

    Exemples

    • z_max( geom_from_wkt( 'POINT ( 0 0 1 )' ) ) → 1
    • z_max( make_line( make_point( 0,0,0 ), make_point( -1,-1,-2 ) ) ) → 0

    fonction z_min

    Returns the minimum z coordinate of a geometry.

    Syntaxe

    z_min ( geometry )

    Arguments

    geometry a geometry with z coordinate

    Exemples

    • z_min( geom_from_wkt( 'POINT ( 0 0 1 )' ) ) → 1
    • z_min( make_line( make_point( 0,0,0 ), make_point( -1,-1,-2 ) ) ) → -2
    Aide manquante pour Layout

    fonction item_variables

    Renvoie une table de correspondance des variables d'un élément du composeur à l'intérieur de cette composition.

    Syntaxe

    item_variables ( id )

    Arguments

    id ID d'élément du composeur

    Exemples

    • map_get(item_variables ('carte_principale'), 'map_scale') → 2000

    groupe couches

    Contient une liste de couches cartographiques disponibles dans le projet en cours.

    fonction decode_uri

    Prend une couche et décode l'uri du fournisseur de données sous-jacent. Cela dépend du fournisseur de données, des données qui sont disponibles.

    Syntaxe

    decode_uri ( layer [, part ])

    [ ] indique des éléments optionnels

    Arguments

    layer La couche pour laquelle l'uri doit être décodé.
    part La partie de l'uri à retourner. Si elle n'est pas spécifiée, une carte avec toutes les parties de l'uri sera retournée.

    Exemples

    • decode_uri(@layer) → {'layerId': '0', 'layerName': '', 'path': '/home/qgis/shapefile.shp'}
    • decode_uri(@layer) → {'layerId': NULL, 'layerName': 'layer', 'path': '/home/qgis/geopackage.gpkg'}
    • decode_uri(@layer, 'path') → 'C:\my_data\qgis\shape.shp'

    groupe tableaux associatifs

    Ce groupe contient des fonctions d'expression pour la création et la manipulation de structures de données «table de correspondance» (également appelées objets de dictionnaire, paires de clés-valeurs ou tableaux associatifs). On peut assigner des valeurs à des clés données. L'ordre des paires clé-valeur dans l'objet cartographique n'est pas pertinent.

    fonction from_json

    Charge une chaîne de caractères au format JSON.

    Syntaxe

    from_json ( string )

    Arguments

    string Chaîne de caractères au format JSON

    Exemples

    • from_json('{"qgis":"rocks"}') → { "qgis" : "déchire" }
    • from_json('[1,2,3]') → [1,2,3]

    fonction hstore_to_map

    Créer une table de correspondance depuis une chaîne hstore.

    Syntaxe

    hstore_to_map ( string )

    Arguments

    string la chaîne en entrée

    Exemples

    • hstore_to_map('qgis=>déchire') → { "qgis" : "déchire" }

    fonction json_to_map

    Créer une table de correspondance depuis une chaîne json.

    Syntaxe

    json_to_map ( string )

    Arguments

    string la chaîne en entrée

    Exemples

    • json_to_map('{"qgis":"déchire"}') → { "qgis" : "déchire" }

    fonction map

    Renvoie une table de correspondance contenant toutes les clés et les valeurs passées en paramètres par paires.

    Syntaxe

    map ( key1 , value1 , key2 , value2 …)

    Arguments

    key une clé (chaîne de caractères)
    value une valeur

    Exemples

    • map('1','un','2', 'deux') → { '1': 'one', '2': 'two' }

    fonction map_akeys

    Renvoie toutes les clés d'une table de correspondance sous la forme d'un tableau.

    Syntaxe

    map_akeys ( map )

    Arguments

    map une table de correspondance

    Exemples

    • map_akeys(map('1','un','2','deux')) → [ '1', '2' ]

    fonction map_avals

    Renvoie toutes les valeurs d'une table de correspondance sous la forme d'un tableau.

    Syntaxe

    map_avals ( map )

    Arguments

    map une table de correspondance

    Exemples

    • map_avals(map('1','un','2','deux')) → [ 'one', 'two' ]

    fonction map_concat

    Renvoie une table de correspondance contenant toutes les entrées des tables de correspondances données. Si les deux tables de correspondance contiennent la même clé, la valeur prise en compte sera celle de la seconde table de correspondance.

    Syntaxe

    map_concat ( map1 , map2 …)

    Arguments

    map une table de correspondance

    Exemples

    • map_concat(map('1','un', '2','en plus'),map('2','deux', '3','trois')) → { '1': 'one, '2': 'two', '3': 'three' }

    fonction map_delete

    Renvoie une table de correspondance dont la clé donnée et sa valeur correspondante a été supprimée.

    Syntaxe

    map_delete ( map , key )

    Arguments

    map une table de correspondance
    key la clé à supprimer

    Exemples

    • map_delete(map('1','un','2','deux'),'2') → { '1': 'one' }

    fonction map_exist

    Renvoie vrai si la clé donnée est présente dans la table de correspondance.

    Syntaxe

    map_exist ( map , key )

    Arguments

    map une table de correspondance
    key la clé à rechercher

    Exemples

    • map_exist(map('1','un','2','deux'),'3') → false

    fonction map_get

    Renvoie la valeur d'une table de correspondance, selon la clé.

    Syntaxe

    map_get ( map , key )

    Arguments

    map une table de correspondance
    key la clé à rechercher

    Exemples

    • map_get(map('1','un','2','deux'),'2') → 'deux'

    fonction map_insert

    Renvoie une table de correspondance avec un ensemble clé/valeur ajouté.

    Syntaxe

    map_insert ( map , key , value )

    Arguments

    map une table de correspondance
    key la clé à ajouter
    value la valeur à ajouter

    Exemples

    • map_insert(map('1','un'),'3','trois') → { '1': 'one', '3': 'three' }

    fonction map_to_hstore

    Fusionne les éléments du tableau associatif dans une chaîne hstore.

    Syntaxe

    map_to_hstore ( map )

    Arguments

    map la table de correspondance en entrée

    Exemples

    • map_to_hstore(map('qgis','déchire')) → "qgis"=>"déchire"}

    fonction map_to_json

    Fusionne les éléments du tableau associatif dans une chaîne json.

    Syntaxe

    map_to_json ( map )

    Arguments

    map la table de correspondance en entrée

    Exemples

    • map_to_json(map('qgis','déchire')) → {"qgis":"déchire"}

    fonction to_json

    Crée une chaîne formattée JSON depuis une table de correspondance, un tableau, ou une autre valeur.

    Syntaxe

    to_json ( value )

    Arguments

    value La valeur en entrée

    Exemples

    • to_json(map('qgis','rocks')) → {"qgis":"déchire"}
    • to_json(array(1,2,3)) → [1,2,3]

    groupe math

    Cette catégorie contient des fonctions mathématiques telles que la racine carrée, le sinus, le cosinus, etc.

    fonction abs

    Renvoie la valeur absolue d'un nombre.

    Syntaxe

    abs ( value )

    Arguments

    value un nombre

    Exemples

    • abs(-2) → 2

    fonction acos

    Renvoie le cosinus inverse d'une valeur en radians.

    Syntaxe

    acos ( value )

    Arguments

    value cosinus d'un angle en radians

    Exemples

    • acos(0.5) → 1.0471975511966

    fonction asin

    Renvoie le sinus inverse d'une valeur en radians.

    Syntaxe

    asin ( value )

    Arguments

    value sinus d'un angle en radians

    Exemples

    • asin(1.0) → 1.5707963267949

    fonction atan

    Renvoie la tangeante inverse d'une valeur en radians.

    Syntaxe

    atan ( value )

    Arguments

    value tan d'un angle en radians

    Exemples

    • atan(0.5) → 0.463647609000806

    fonction atan2

    Renvoie la tangente inverse de dy/dx en utilisant les signes des deux arguments pour déterminer le quadrant du résultat.

    Syntaxe

    atan2 ( dy , dx )

    Arguments

    dy différence de coordonnée y
    dx différence de coordonnée x

    Exemples

    • atan2(1.0, 1.732) → 0.523611477769969

    fonction azimuth

    Renvoie l'azimut par rapport au nord sous forme d'angle en radians mesuré dans le sens des aiguilles d'une montre à partir de la verticale entre point_a et point_b.

    Syntaxe

    azimuth ( point_a , point_b )

    Arguments

    point_a géométrie ponctuelle
    point_b géométrie ponctuelle

    Exemples

    • degrees( azimuth( make_point(25, 45), make_point(75, 100) ) ) → 42.273689
    • degrees( azimuth( make_point(75, 100), make_point(25,45) ) ) → 222.273689

    fonction ceil

    Arrondi un nombre vers le haut.

    Syntaxe

    ceil ( value )

    Arguments

    value un nombre

    Exemples

    • ceil(4.9) → 5
    • ceil(-4.9) → -4

    fonction clamp

    Restreint une valeur d'entrée à une plage spécifique.

    Syntaxe

    clamp ( minimum , input , maximum )

    Arguments

    minimum la plus petite valeur que input peut prendre.
    input une valeur qui sera restreinte à la plage indiquée par minimum et maximum
    maximum la plus grande valeur que input peut prendre

    Exemples

    • clamp(1,5,10) → 5 ( input se situe entre 1 et 10 donc la valeur est renvoyée inchangée)
    • clamp(1,0,10) → 1 ( input est inférieure à la valeur minimum de 1, la fonction renvoie 1)
    • clamp(1,11,10) → 10 ( input est supérieure à la valeur maximale de 10, la fonction renvoie 10)

    fonction cos

    Renvoie le cosinus d'un angle

    Syntaxe

    cos ( angle )

    Arguments

    angle angle en radians

    Exemples

    • cos(1.571) → 0.000796326710733263

    fonction degrees

    Convertit des angles en radians vers des degrés.

    Syntaxe

    degrees ( radians )

    Arguments

    radians valeur numérique

    Exemples

    • degrees(3.14159) → 180
    • degrees(1) → 57.2958

    fonction exp

    Renvoie l'exponentiel une valeur

    Syntaxe

    exp ( value )

    Arguments

    value nombre dont il faut renvoyer l'exponentiel

    Exemples

    • exp(1.0) → 2.71828182845905

    fonction floor

    Arrondit un nombre vers le bas.

    Syntaxe

    floor ( value )

    Arguments

    value un nombre

    Exemples

    • floor(4.9) → 4
    • floor(-4.9) → -5

    fonction inclination

    Renvoie l'inclinaison mesurée du zénith (0) au nadir (180) du point_a au point_b.

    Syntaxe

    inclination ( point_a , point_b )

    Arguments

    point_a géométrie ponctuelle
    point_b géométrie ponctuelle

    Exemples

    • inclination( make_point( 5, 10, 0 ), make_point( 5, 10, 5 ) ) → 0.0
    • inclination( make_point( 5, 10, 0 ), make_point( 5, 10, 0 ) ) → 90.0
    • inclination( make_point( 5, 10, 0 ), make_point( 50, 100, 0 ) ) → 90.0
    • inclination( make_point( 5, 10, 0 ), make_point( 5, 10, -5 ) ) → 180.0

    fonction ln

    Renvoie le logarithme népérien d'une valeur.

    Syntaxe

    ln ( value )

    Arguments

    value valeur numérique

    Exemples

    • ln(1) → 0
    • ln(2.7182818284590452354) → 1

    fonction log

    Renvoie la valeur du logarithme selon la valeur et la base en arguments.

    Syntaxe

    log ( base , value )

    Arguments

    base n'importe quel nombre positif
    value n'importe quel nombre positif

    Exemples

    • log(2, 32) → 5
    • log(0.5, 32) → -5

    fonction log10

    Renvoie la valeur du logarithme en base 10 de l'expression en argument.

    Syntaxe

    log10 ( value )

    Arguments

    value n'importe quel nombre positif

    Exemples

    • log10(1) → 0
    • log10(100) → 2

    fonction max

    Renvoie la valeur la plus haute d'un ensemble de valeurs.

    Syntaxe

    max ( value1 , value2 …)

    Arguments

    value un nombre

    Exemples

    • max(2,10.2,5.5) → 10.2
    • max(20.5,NULL,6.2) → 20.5

    fonction min

    Renvoie la valeur la plus faible d'un ensemble de valeurs.

    Syntaxe

    min ( value1 , value2 …)

    Arguments

    value un nombre

    Exemples

    • min(20.5,10,6.2) → 6.2
    • min(2,-10.3,NULL) → -10.3

    fonction pi

    Renvoie la valeur de Pi pour utilisation dans d'autres calculs.

    Syntaxe

    pi ()

    Exemples

    • pi() → 3.14159265358979

    fonction radians

    Convertit des angles en degrés vers des radians.

    Syntaxe

    radians ( degrees )

    Arguments

    degrees valeur numérique

    Exemples

    • radians(180) → 3.14159
    • radians(57.2958) → 1

    fonction rand

    Renvoie un entier aléatoire dans une plage spécifiée par les arguments minimum et maximum (inclus). Si une graine est fournie, le résultat sera toujours le même, en fonction de la graine.

    Syntaxe

    rand ( min , max [, seed=null ])

    [ ] indique des éléments optionnels

    Arguments

    min un entier représentant la plus petite valeur aléatoire possible
    max un entier représentant la plus grande valeur aléatoire possible
    seed N'importe quelle valeur à utiliser comme graine

    Exemples

    • rand(1, 10) → 8

    fonction randf

    Renvoie un nombre flottant aléatoire dans une plage spécifiée par les arguments minimum et maximum (inclus). Si une graine est fournie, le résultat sera toujours le même, en fonction de la graine.

    Syntaxe

    randf ([ min=0.0 ][, max=1.0 ][, seed=null ])

    [ ] indique des éléments optionnels

    Arguments

    min un nombre décimal représentant la plus petite valeur aléatoire possible
    max un nombre décimal représentant la plus grande valeur aléatoire possible
    seed N'importe quelle valeur à utiliser comme graine

    Exemples

    • randf(1, 10) → 4.59258286403147

    fonction round

    Arrondi un nombre au nombre de décimales indiqué.

    Syntaxe

    round ( value [, places=0 ])

    [ ] indique des éléments optionnels

    Arguments

    value nombre décimal à arrondir
    places Entier optionnel représentant le nombre de caractères après la virgule à arrondir. Peut être négatif.

    Exemples

    • round(1234.567, 2) → 1234.57
    • round(1234.567) → 1235

    fonction scale_exp

    Transforme une valeur donnée d'un domaine d'entrée à une plage de sortie en utilisant une courbe exponentielle. Cette fonction peut être utilisée pour supprimer les valeurs en dehors de la plage de sortie.

    Syntaxe

    scale_exp ( val , domain_min , domain_max , range_min , range_max , exponent )

    Arguments

    val Une valeur du domaine d'entrée. La fonction renverra une valeur correspondante à l'échelle dans la plage de sortie.
    domain_min Indique la valeur minimale dans le domaine d'entrée, la plus petite valeur que l'entrée peut prendre.
    domain_max Indique la valeur maximale dans le domaine d'entrée, la plus grande valeur que l'entrée peut prendre.
    range_min Indique la valeur minimale de la plage de sortie, la plus petite valeur qui doit être renvoyée par la fonction.
    range_max Indique la valeur maximale de la plage de sortie, la plus grande valeur qui doit être renvoyée par la fonction.
    exponent Une valeur positive (supérieure à 0) qui dirige la manière dont les valeurs d'entrée sont réparties dans la plage de sortie. De grands exposants entraîneront des valeurs de sortie en 'adoucissement en entrée', démarrant lentement avant d’accélérer à mesure que les valeurs d'entrées approcheront du maximum du domaine. Des exposants faibles (inférieurs à 1) entraîneront des valeurs de sortie en 'adoucissement en sortie' où la répartition commencera rapidement mais ralentira à mesure que l'on s'approche du maximum du domaine.

    Exemples

    • scale_exp(5,0,10,0,100,2) → 25 (adoucissement en entrée, en utilisant un exposant de 2)
    • scale_exp(3,0,10,0,100,0.5) → 54.772 (adoucissement en sortie, en utilisant un exposant de 0.5)

    fonction scale_linear

    Transforme une valeur donnée d'un domaine d'entrée à une plage de sortie en utilisant une interpolation linéaire.

    Syntaxe

    scale_linear ( val , domain_min , domain_max , range_min , range_max )

    Arguments

    val Une valeur du domaine d'entrée. La fonction renverra une valeur correspondante à l'échelle dans la plage de sortie.
    domain_min Indique la valeur minimale dans le domaine d'entrée, la plus petite valeur que l'entrée peut prendre.
    domain_max Indique la valeur maximale dans le domaine d'entrée, la plus grande valeur que l'entrée peut prendre.
    range_min Indique la valeur minimale de la plage de sortie, la plus petite valeur qui doit être renvoyée par la fonction.
    range_max Indique la valeur maximale de la plage de sortie, la plus grande valeur qui doit être renvoyée par la fonction.

    Exemples

    • scale_linear(5,0,10,0,100) → 50
    • scale_linear(0.2,0,1,0,360) → 72 (échelonne une valeur entre 0 et 1 vers un angle entre 0 et 360)
    • scale_linear(1500,1000,10000,9,20) → 9.6111111 (échelonne une population variant entre 1000 et 10000 vers une taille de police entre 9 et 20)

    fonction sin

    Renvoie le sinus d'un angle.

    Syntaxe

    sin ( angle )

    Arguments

    angle angle en radians

    Exemples

    • sin(1.571) → 0.999999682931835

    fonction sqrt

    Renvoie la racine carrée d'une valeur.

    Syntaxe

    sqrt ( value )

    Arguments

    value un nombre

    Exemples

    • sqrt(9) → 3

    fonction tan

    Renvoie la tangente d'un angle.

    Syntaxe

    tan ( angle )

    Arguments

    angle angle en radians

    Exemples

    • tan(1.0) → 1.5574077246549
    Aide manquante pour Processing

    fonction parameter

    Renvoie la valeur des paramètres d'entrée d'un algorithme de traitement

    Syntaxe

    parameter ( name )

    Arguments

    name Nom du paramètre d'entrée correspondant

    Exemples

    • parameter('BUFFER_SIZE') → 5.6
    Aide manquante pour Python

    Aide manquante pour $mask_geometry

    Aide manquante pour in_mask

    groupe rasters

    Contient des fonctions qui calculent des statistiques et des valeurs sur les rasters.

    fonction raster_statistic

    Renvoie des statistiques depuis une couche raster.

    Syntaxe

    raster_statistic ( layer , band , property )

    Arguments

    layer une chaîne de caractères représentant soit un nom de couche raster ou un ID de couche
    band entier représentant le numéro de bande de la couche raster, commençant à 1
    property une chaîne de caractères correspondant à la propriété à retourner. Les options valides sont:
    • min: valeur minimum
    • max: valeur maximum
    • avg: valeur moyenne
    • stdev: déviation standard des valeurs
    • range: plage de valeurs (max - min)
    • sum: somme de toutes les valeurs du raster

    Exemples

    • raster_statistic('lc',1,'avg') → Valeur moyenne de la bande 1 issue de la couche raster 'lc'
    • raster_statistic('ac2010',3,'min') → Valeur minimale de la bande 3 issue de la couche raster 'ac2010'

    fonction raster_value

    Retourne la valeur du pixel dans le raster aux coordonnées du point.

    Syntaxe

    raster_value ( layer , band , point )

    Arguments

    layer le nom ou l'identifiant de la couche raster
    band le numéro de la bande dans laquelle prélever la valeur.
    point Géométrie ponctuelle (Pour les géométries multi-parties ayant plus qu'une partie, une valeur nulle sera renvoyée)

    Exemples

    • raster_value('dem', 1, make_point(1,1)) → 25

    groupe enregistrement et attributs

    Ce groupe contient des fonctions qui permettent d'accéder aux identifiants des enregistrements.

    fonction $currentfeature

    Renvoie l'entité courante évaluée. Cette fonction peut être utilisée en combinaison avec la fonction 'attribute' pour renvoyer les valeurs d'attribut de l'entité courante.

    Syntaxe

    $currentfeature

    Exemples

    • attribute( $currentfeature, 'name' ) → valeur stockée dans l'attribut 'name' de l'entité courante

    fonction $id

    Renvoie l’identifiant de l’entité de la ligne actuelle.

    Syntaxe

    $id

    Exemples

    • $id → 42

    fonction attribute

    Renvoie un attribut d'une entité.

    Variant 1

    Renvoie la valeur d'un attribut de l'entité courante.

    Syntaxe

    attribute ( attribute_name )

    Arguments

    attribute_name nom de l'attribut qui sera retourné

    Exemples

    • attribute( 'name' ) → valeur stockée dans l'attribut 'name' de l'entité courante

    Variant 2

    Permet de spécifier l'entité et le nom de l'attribut cible.

    Syntaxe

    attribute ( feature , attribute_name )

    Arguments

    feature une entité
    attribute_name nom de l'attribut qui sera retourné

    Exemples

    • attribute( @atlas_feature, 'name' ) → valeur stockée dans l'attribut 'name' de l'entité courante de l'atlas

    fonction attributes

    Retourne une table de correspondance contenant tous les attributs d'une entité, avec les noms d'attributs comme clés.

    Variant 1

    Renvoie une table de correspondance de tous les attributs de l'entité courante.

    Syntaxe

    attributes ()

    Exemples

    • attributes()['name'] → valeur stockée dans l'attribut 'name' de l'entité courante

    Variant 2

    Permet de spécifier l'entité cible

    Syntaxe

    attributes ( feature )

    Arguments

    feature une entité

    Exemples

    • attributes( @atlas_feature )['name'] → valeur stockée dans l'attribut 'name' de l'entité courante de l'atlas

    fonction display_expression

    Returns the display expression for a given feature in a layer. If called with no parameters, it evaluates the current feature. The expression is evaluated by default.

    Syntaxe

    display_expression ([ feature=current feature ][, layer=current layer ][, evaluate=true ])

    [ ] indique des éléments optionnels

    Arguments

    feature The feature which should be evaluated.
    layer The layer (or its id or name).
    evaluate If the expression must be evaluated. If false, the expression will be returned as a string literal only (which could potentially be later evaluated using the 'eval' function).

    Exemples

    • display_expression() → The display expression of the current feature.
    • display_expression(get_feature_by_id('streets', 1), 'streets') → The display expression of the feature with the ID 1 on the layer 'streets'.
    • display_expression('a_layer_id', $currentfeature, 'False') → The display expression of the given feature not evaluated.

    fonction get_feature

    Renvoie la première entité d'une couche qui correspond à la valeur d'un attribut donné.

    Syntaxe

    get_feature ( layer , attribute , value )

    Arguments

    layer nom de la couche ou ID
    attribute nom de l'attribut
    value valeur d'attribut à trouver

    Exemples

    • get_feature('rue','nom','de la Libération') → Première entité trouvée dans la couche "rue" avec la valeur "de la Libération" dans le champ "nom"

    fonction get_feature_by_id

    Renvoie l'entité avec un identifiant sur une couche.

    Syntaxe

    get_feature_by_id ( layer , feature_id )

    Arguments

    layer la couche, son nom ou son identifiant
    feature_id L'identifiant de l'entité à renvoyer

    Exemples

    • get_feature('streets', 1) → L'entité de la couche "streets" ayant l'identifiant 1

    fonction is_selected

    Returns True if a feature is selected. Can be used with zero, one or two arguments, see below for details.

    No parameters

    If called with no parameters, the function will return true if the current feature in the current layer is selected.

    Syntaxe

    is_selected ()

    Exemples

    • is_selected() → True if the current feature in the current layer is selected.

    One 'feature' parameter

    If called with a 'feature' parameter only, the function returns true if the specified feature from the current layer is selected.

    Syntaxe

    is_selected ( feature )

    Arguments

    feature L'entité qui sera vérifiée pour sa sélection.

    Exemples

    • is_selected(@atlas_feature) → True if the current atlas feature is selected.

    Two parameters

    If the function is called with both a layer and a feature, it will return true if the specified feature from the specified layer is selected.

    Syntaxe

    is_selected ( layer , feature )

    Arguments

    layer The layer (or its ID or name) on which the selection will be checked.
    feature L'entité qui sera vérifiée pour sa sélection.

    Exemples

    • is_selected( 'streets', get_feature('streets', 'name', "street_name")) → True if the current building's street is selected (assuming the building layer has a field named 'street_name' and the 'streets' layer has a field called 'name').

    fonction maptip

    Returns the maptip for a given feature in a layer. If called with no parameters, it evaluates the current feature. The maptip is evaluated by default.

    Syntaxe

    maptip ([ feature=current feature ][, layer=current layer ][, evaluate=true ])

    [ ] indique des éléments optionnels

    Arguments

    feature The feature which should be evaluated.
    layer The layer (or its id or name).
    evaluate If the expression must be evaluated. If false, the expression will be returned as a string literal only (which could potentially be later evaluated using the 'eval_template' function).

    Exemples

    • maptip() → The maptip of the current feature.
    • maptip(get_feature('streets', 1), 'streets') → The maptip of the feature with the ID 1 on the layer 'streets'.
    • maptip('a_layer_id', $currentfeature, 'False') → The maptip of the given feature not evaluated.

    fonction num_selected

    Renvoie le nombre d'entités sélectionnées d'une couche donnée. Par défaut la fonction agit sur la couche sur laquelle l'expression est évaluée.

    Syntaxe

    num_selected ([ layer=current layer ])

    [ ] indique des éléments optionnels

    Arguments

    layer La couche (ou son identifiant ou nom) sur laquelle la sélection sera vérifiée.

    Exemples

    • num_selected() → Le nombre d'entités sélectionnées sur la couche courante.
    • num_selected('streets') → Le nombre d'entités sélectionnées sur la couche des rues

    fonction represent_value

    Renvoie la valeur de représentation configurée pour une valeur de champ. Cela dépend du type de widget configuré. Souvent, cela est utile pour les widgets 'Carte de la valeur'.

    Syntaxe

    represent_value ( value , fieldName )

    Arguments

    value La valeur qui devrait être résolue. Très probablement un champ.
    fieldName Nom du champ pour lequel la configuration du widget doit être chargée. (Optionnel)

    Exemples

    • represent_value("field_with_value_map") → Description de la valeur
    • represent_value('static value', 'field_name') → Description de la valeur statique

    fonction sqlite_fetch_and_increment

    Manage autoincrementing values in sqlite databases.

    SQlite default values can only be applied on insert and not prefetched.

    This makes it impossible to acquire an incremented primary key via AUTO_INCREMENT before creating the row in the database. Sidenote: with postgres, this works via the option evaluate default values .

    When adding new features with relations, it is really nice to be able to already add children for a parent, while the parents form is still open and hence the parent feature uncommitted.

    To get around this limitation, this function can be used to manage sequence values in a separate table on sqlite based formats like gpkg.

    The sequence table will be filtered for a sequence id (filter_attribute and filter_value) and the current value of the id_field will be incremented by 1 and the incremented value returned.

    If additional columns require values to be specified, the default_value map can be used for this purpose.

    Note
    This function modifies the target sqlite table. It is intended for usage with default value configurations for attributes.

    When the database parameter is a layer and the layer is in transaction mode, the value will only be retrieved once during the lifetime of a transaction and cached and incremented. This makes it unsafe to work on the same database from several processes in parallel.

    Syntaxe

    sqlite_fetch_and_increment ( database , table , id_field , filter_attribute , filter_value [, default_values ])

    [ ] indique des éléments optionnels

    Arguments

    database Chemin vers le fichier sqlite ou la couche geopackage
    table Nom de la table qui gère les séquences
    id_field Nom du champ qui contient la valeur actuelle
    filter_attribute Nommez le champ qui contient un identifiant unique pour cette séquence. Doit avoir un index UNIQUE.
    filter_value Nom de la séquence à utiliser
    default_values Table de correspondance avec valeurs par défaut pour des colonnes supplémentaires dans la table. Les valeurs doivent être encadrées par des apostrophes. Les fonctions sont permises.

    Exemples

    • sqlite_fetch_and_increment(@layer, 'sequence_table', 'last_unique_id', 'sequence_id', 'global', map('last_change','date(''now'')','user','''' || @user_account_name || '''')) → 0
    • sqlite_fetch_and_increment(layer_property(@layer, 'path'), 'sequence_table', 'last_unique_id', 'sequence_id', 'global', map('last_change','date(''now'')','user','''' || @user_account_name || '''')) → 0

    fonction uuid

    Génère un Identifiant Universel Unique (UUID) pour chaque ligne en utilisant la méthode QT QUuid::createUuid . Chaque UUID occupe 38 caractères.

    Syntaxe

    uuid ()

    Exemples

    • uuid() → '{0bd2f60f-f157-4a6d-96af-d4ba4cb366a1}'

    groupe chaîne de caractères

    Cette catégorie contient des fonctions opérant sur des chaînes de caractères par exemple le remplacement ou la conversion en majuscules.

    fonction ascii

    Returns the unicode code associated with the first character of a string.

    Syntaxe

    ascii ( string )

    Arguments

    string the string to convert to unicode code

    Exemples

    • ascii('Q') → 81

    fonction char

    Renvoie le caractère associé à un code Unicode.

    Syntaxe

    char ( code )

    Arguments

    code un code Unicode

    Exemples

    • char(81) → 'Q'

    fonction concat

    Concatène plusieurs chaînes de caractères en une seule. Les valeurs NULL sont converties en chaînes vides. Les autres valeurs (comme les nombres) sont converties en chaînes de caractères.

    Syntaxe

    concat ( string1 , string2 …)

    Arguments

    string une chaîne de caractères

    Exemples

    • concat('pyj', 'ama') → 'pyjama'
    • concat('a','b','c','d','e') → 'abcde'
    • concat('Anno ', 1984) → 'Anno 1984'
    • concat('The Wall', NULL) → 'The Wall'

    fonction format

    Formatte une chaîne de caractères en utilisant les arguments fournis.

    Syntaxe

    format ( string , arg1 , arg2 …)

    Arguments

    string Une chaîne de caractères avec des espaces réservés en arguments. Utilisez %1, %2, etc. comme espaces réservés. Les espaces réservés peuvent être utilisés plusieurs fois.
    arg tout type. Tout nombre d'arguments.

    Exemples

    • format('Ceci %1 un %2', 'est', 'test') → 'Ceci est un test''

    fonction format_date

    Formate une date ou une chaîne de caractères selon un format personnalisé. Utilise le formatage des dates/temps de Qt. Consultez QDateTime::toString .

    Syntaxe

    format_date ( datetime , format [, language ])

    [ ] indique des éléments optionnels

    Arguments

    datetime valeur de date, de temps ou de date et de temps
    format String template used to format the string.
    Expression Output
    d the day as number without a leading zero (1 to 31)
    dd the day as number with a leading zero (01 to 31)
    ddd the abbreviated localized day name (e.g. 'Mon' to 'Sun')
    dddd the long localized day name (e.g. 'Monday' to 'Sunday')
    M the month as number without a leading zero (1-12)
    MM the month as number with a leading zero (01-12)
    MMM the abbreviated localized month name (e.g. 'Jan' to 'Dec')
    MMMM the long localized month name (e.g. 'January' to 'December')
    yy the year as two digit number (00-99)
    yyyy the year as four digit number

    These expressions may be used for the time part of the format string:

    Expression Output
    h the hour without a leading zero (0 to 23 or 1 to 12 if AM/PM display)
    hh the hour with a leading zero (00 to 23 or 01 to 12 if AM/PM display)
    H the hour without a leading zero (0 to 23, even with AM/PM display)
    HH the hour with a leading zero (00 to 23, even with AM/PM display)
    m the minute without a leading zero (0 to 59)
    mm the minute with a leading zero (00 to 59)
    s the second without a leading zero (0 to 59)
    ss the second with a leading zero (00 to 59)
    z the milliseconds without trailing zeroes (0 to 999)
    zzz the milliseconds with trailing zeroes (000 to 999)
    AP or A interpret as an AM/PM time. AP must be either "AM" or "PM".
    ap or a Interpret as an AM/PM time. ap must be either "am" or "pm".
    language langue (minuscule, deux ou trois lettres, code de langue ISO 639) utilisée pour formater la date en une chaîne personnalisée

    Exemples

    • format_date('2012-05-15','dd.MM.yyyy') → '15.05.2012'
    • format_date('2012-05-15','d MMMM yyyy','fr') → '15 juin 2012'

    fonction format_number

    Returns a number formatted with the locale separator for thousands. Also truncates the decimal places to the number of supplied places.

    Syntaxe

    format_number ( number , places [, language ])

    [ ] indique des éléments optionnels

    Arguments

    number nombre à formater
    places entier représentant le nombre d'espaces de décimales à tronquer.
    language language (lowercase, two- or three-letter, ISO 639 language code) used to format the number into a string

    Exemples

    • format_number(10000000.332,2) → '10,000,000.33'

    fonction left

    Renvoie un extrait de chaîne de caractères contenant les n caractères les plus à gauche de la chaîne initiale.

    Syntaxe

    left ( string , length )

    Arguments

    string une chaîne de caractères
    length entier. Le nombre de caractères depuis la gauche de la chaîne à renvoyer.

    Exemples

    • left('Salut tout le monde',5) → 'Salut'

    fonction length

    Renvoie le nombre de caractères d'une chaîne de caractères ou la longueur d'une géométrie de polylignes.

    Variante chaîne de caractères

    Renvoie le nombre de caractères de la chaîne de caractères.

    Syntaxe

    length ( string )

    Arguments

    string chaîne de caractères dont il faut calculer la longueur

    Exemples

    • length('salut') → 5

    Variante géométrique

    Calcule la longueur d'une géométrie linéaire. Les calculs sont toujours planimétriques dans le Système de Coordonnées de Référence (SCR) de la géométrie et les unités de la longueur correspondent aux unités du SCR. Cette fonction est différente des caculs effectués par la fonction $length qui réalise des calculs ellipsoïdaux en se basant sur les paramètres d'ellipsoïde du projet et des unités de distance.

    Syntaxe

    length ( geometry )

    Arguments

    geometry un objet géométrique linéaire

    Exemples

    • length(geom_from_wkt('LINESTRING(0 0, 4 0)')) → 4.0

    fonction lower

    Convertit une chaîne de caractères en caractères minuscules.

    Syntaxe

    lower ( string )

    Arguments

    string la chaîne de caractères à convertir en minuscules

    Exemples

    • lower('SALUT tout le monde') → 'salut tout le monde'

    fonction lpad

    Renvoie une chaîne de caractères complétée à sa gauche avec un caractère de remplissage à la largeur spécifiée. Si la largeur maximale possible est plus petite que la longueur renvoyée, le chaîne de caractères sera tronquée.

    Syntaxe

    lpad ( string , width , fill )

    Arguments

    string chaîne de caractères à remplir
    width longueur de la nouvelle chaîne de caractères
    fill caractère de remplissage

    Exemples

    • lpad('Salut', 10, 'x') → 'xxxxxSalut'
    • lpad('Hello', 3, 'x') → 'Hel'

    fonction regexp_match

    Renvoie la première occurrence correspondante à une expression régulière dans une chaîne de caractères, ou 0 si la sous-chaîne n'a pas été trouvée.

    Syntaxe

    regexp_match ( input_string , regex )

    Arguments

    input_string la chaîne à tester selon l'expression rationnelle
    regex L'expression régulière de test. Les caractères antislash doivent être échappés deux fois (ex: "\s" correspond à un caractère d'espace).

    Exemples

    • regexp_match('QGIS ROCKS','\sROCKS') → 4

    fonction regexp_replace

    Renvoie une chaîne de caractères en utilisant une expression rationnelle de substitution.

    Syntaxe

    regexp_replace ( input_string , regex , replacement )

    Arguments

    input_string la chaîne de caractères à remplacer en cas de correspondance
    regex L'expression régulière de remplacement. Les caractères antislash doivent être échappés deux fois (ex: "\\s" correspond à un caractère d'espace).
    replacement La chaîne de caractères utilisée en remplacement de chaque occurrence renvoyée en correspondance de l'expression régulière donnée. Les groupes capturés peuvent être insérés comme chaîne de remplacement en utilisant \\1, \\2, etc.

    Exemples

    • regexp_replace('QGIS SHOULD ROCK','\\sSHOULD\\s',' DOES ') → 'QGIS EST GENIAL'

    fonction regexp_substr

    Renvoie la portion d'une chaîne de caractères qui correspond à une expression rationnelle fournie.

    Syntaxe

    regexp_substr ( input_string , regex )

    Arguments

    input_string la chaîne où trouver la correspondance
    regex L'expression régulière à comparer. Les caractères antislash doivent être échappés deux fois (ex: "\\s" correspond à un caractère d'espace).

    Exemples

    • regexp_substr('abc123','(\\d+)') → '123'

    fonction replace

    Renvoie une chaîne de caractères où la chaîne, le tableau ou la table de correspondance fournis ont été utilisés pour remplacer des caractères.

    Variante de chaîne & tableau

    Renvoie une chaîne de caractères dont la chaîne ou le tableau de chaînes fournis ont été remplacés par une chaîne ou un tableau de chaînes.

    Syntaxe

    replace ( string , before , after )

    Arguments

    string la chaîne en entrée
    before la chaîne de caractères ou le tableau de chaînes de caractères à remplacer
    after la chaîne de caractères ou le tableau de chaînes de caractères utilisés en remplacement

    Exemples

    • replace('QGIS DOIT ÊTRE GENIAL','DOIT ÊTRE','EST') → 'QGIS EST GENIAL'
    • replace('QGIS ABC',array('A','B','C'),array('X','Y','Z')) → 'QGIS XYZ'
    • replace('QGIS',array('Q','S'),'') → 'GI'

    Variante de couche

    Renvoie une chaîne de caractères où les termes similaires aux clefs d'une table de correspondance ont été remplacées par les valeurs correspondantes.

    Syntaxe

    replace ( string , map )

    Arguments

    string la chaîne en entrée
    map la table de correspondance contenant les clés et valeurs

    Exemples

    • replace('APPLI DEVRAIT GENIAL',map('APPLI','QGIS','DEVRAIT','EST')) → 'QGIS EST GENIAL'

    fonction right

    Renvoie une sous-chaîne de caractères contenant les n caractères les plus à droite.

    Syntaxe

    right ( string , length )

    Arguments

    string une chaîne de caractères
    length entier. Le nombre de caractères à renvoyer depuis la droite de la chaîne.

    Exemples

    • right('Salut tout le monde',5) → 'Monde'

    fonction rpad

    Renvoie une chaîne de caractères complétée à sa droite avec un caractère de remplissage à la largeur spécifiée. Si la largeur maximale possible est plus petite que la longueur renvoyée, le chaîne de caractères sera tronquée.

    Syntaxe

    rpad ( string , width , fill )

    Arguments

    string chaîne de caractères à remplir
    width longueur de la nouvelle chaîne de caractères
    fill caractère de remplissage

    Exemples

    • rpad('Salut', 10, 'x') → 'Salutxxxxx'
    • rpad('Hello', 3, 'x') → 'Hel'

    fonction strpos

    Renvoie la position de la première occurence d'une sous-chaîne dans une chaîne de caractères ou 0 si la sous-chaîne est introuvable.

    Syntaxe

    strpos ( haystack , needle )

    Arguments

    haystack la chaîne dans laquelle effectuer la recherche
    needle la chaîne de caractères recherchée

    Exemples

    • strpos('SALUT TOUT LE MONDE','MONDE') → 7
    • strpos('SALUT TOUT LE MONDE','AU REVOIR') → 0

    fonction substr

    Renvoie une partie de chaîne de caractères.

    Syntaxe

    substr ( string , start [, length ])

    [ ] indique des éléments optionnels

    Arguments

    string la chaîne complète en entrée
    start Entier représentant la position de départ à partir de laquelle procéder à l'extraction en commençant par 1; si la valeur de départ est négative, la chaîne de caractères renvoyée débutera à la fin de la chaîne moins la valeur de départ
    length entier représentant la longueur de la chaîne à extraire; si la longueur est négative, la chaîne renvoyée omettra le nombre de caractères correspondant à cette longueur à partir de la fin de la chaîne

    Exemples

    • substr('SALUT TOUT LE MONDE',3,5) → 'LUT T'
    • substr('HELLO WORLD', 6) → 'WORLD'
    • substr('HELLO WORLD',-5) → 'WORLD'
    • substr('HELLO',3,-1) → 'LL'
    • substr('HELLO WORLD',-5,2) → 'WO'
    • substr('HELLO WORLD',-5,-1) → 'WORL'

    fonction title

    Convertit l'ensemble des mots d'une chaîne de caractères en casse de titre (tous les mots sont en minuscule sauf la première lettre du mot qui est en majuscule).

    Syntaxe

    title ( string )

    Arguments

    string la chaîne à convertir en casse titre

    Exemples

    • title('salut tout le MOnde') → 'Salut Tout Le Monde'

    fonction to_string

    Convertit un nombre en chaîne de caractères.

    Syntaxe

    to_string ( number )

    Arguments

    number Valeur entière ou réelle. Le nombre à convertir en chaîne de caractères.

    Exemples

    • to_string(123) → '123'

    fonction trim

    Supprime tous les caractères d'espace (espaces, tabs, etc.) situés au début ou à la fin d'une chaîne de caractères.

    Syntaxe

    trim ( string )

    Arguments

    string la chaîne de caractères à nettoyer

    Exemples

    • trim(' salut tout le monde ') → 'salut tout le monde'

    fonction upper

    Convertit une chaîne de caractères en caractères majuscules.

    Syntaxe

    upper ( string )

    Arguments

    string la chaîne de caractères à convertir en majuscules

    Exemples

    • upper('salut tout le MOnde') → 'SALUT TOUT LE MONDE'

    fonction wordwrap

    Renvoie une chaîne de caractères découpée par les caractères espace, selon un nombre minimum ou maximum de caractères

    Syntaxe

    wordwrap ( string , wrap_length [, delimiter_string ])

    [ ] indique des éléments optionnels

    Arguments

    string la chaîne à découper
    wrap_length un entier. Si longueur_découpe est positif, le nombre représente le nombre maximum idéal de caractères à découper par des espaces; si négatif, le nombre représente le nombre minimum de caractères à découper par des espaces.
    delimiter_string Chaîne de caractères optionnelle de substitution pour générer un retour à la ligne.

    Exemples

    • wordwrap('UNIVERSITE DE QGIS',13) → 'UNIVERSITE DE
      QGIS'
    • wordwrap('UNIVERSITE DE QGIS',-3) → 'UNIVERSITE
      DE QGIS'