Expressions documentation single page (locale es)

Agregados

Matrices

Color

Condicionales

Conversiones

Fecha y Hora

Files and Paths

Formulario

Concordancia aproximada

General

Geometría

Diseño

Capas de mapa

Mapas

Matemáticas

Processing

Python

Rásters

Registros y atributos

Cadena

grupo agregados

Contiene funciones que agregan valores sobre capas y campos.

función aggregate

Devuelve un valor agregado calculado usando objetos de otra capa.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

layer Una cadena que represente el nombre o la ID de una capa
aggregate a string corresponding to the aggregate to calculate. Valid options are:
  • count
  • count_distinct
  • count_missing
  • min
  • max
  • sum
  • mean
  • median
  • stdev
  • stdevsample
  • range
  • minority
  • majority
  • q1: first quartile
  • q3: third quartile
  • iqr: inter quartile range
  • min_length: minimum string length
  • max_length: maximum string length
  • concatenate: join strings with a concatenator
  • concatenate_unique: join unique strings with a concatenator
  • collect: create an aggregated multipart geometry
  • array_agg: create an array of aggregated values
expression sub expresión o nombre de campo a agregar
filter expresión de filtrado opcional para limitar los objetos usados para calcular el agregado. Los campos y geometrías son de los objetos de la capa unida. Se puede acceder al objeto de origen con la variable @parent.
concatenator cadena opcional a usar para unir valores para el agregado 'concatenar'
order_by optional filter expression to order the features used for calculating the aggregate. Fields and geometry are from the features on the joined layer.

Ejemplos

  • aggregate(layer:='rail_stations',aggregate:='sum',expression:="passengers") → suma de todos los valores del campo passengers de la capa rail_stations
  • aggregate('rail_stations','sum', "passengers"/7) → calcula una media diaria de "passengers" dividiendo el campo "passengers" por 7 antes de sumar los valores
  • aggregate(layer:='rail_stations',aggregate:='sum',expression:="passengers",filter:="class">3) → suma todos los valores del campo "passengers" de los objetos en los que el atributo "class" es mayor que 3
  • aggregate(layer:='rail_stations',aggregate:='concatenate', expression:="name", concatenator:=',') → lista separada por comas del campo name para todos los objetos de la capa rail_stations
  • aggregate(layer:='países', aggregate:='max', expression:="código", filter:=intersects( $geometry, geometry(@parent) ) ) → El código del país de un país que intersecte en la capa 'países'

función array_agg

Devuelve una matriz de valores agregados a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado
order_by optional expression to use to order features used to calculate aggregate

Ejemplos

  • array_agg("name",group_by:="state") → lista de nombres, agrupados por campo de estado

función collect

Devuelve la geometría multiparte de geometrías agregadas a partir una expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression expresión de geometría a agregar.
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • collect( $geometry ) → geometría multiparte de geometrías agregadas

función concatenate

Returns all aggregated strings from a field or expression joined by a delimiter.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado
concatenator cadena opcional a usar para unir valores
order_by optional expression to use to order features used to calculate aggregate

Ejemplos

  • concatenar("nombre_ciudad",agrupar_por:="estado",concatenador:=',') → lista separada por comas de nombres_ciudad, agrupados por el campo estado

función concatenate_unique

Returns all unique strings from a field or expression joined by a delimiter.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado
concatenator cadena opcional a usar para unir valores
order_by optional expression to use to order features used to calculate aggregate

Ejemplos

  • concatenar("nombre_ciudad",agrupar_por:="estado",concatenador:=',') → comma separated list of unique town_names, grouped by state field

función count

Devuelve el recuento de objetos coincidentes.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • contar("estaciones",agrupar_por:="estado") → cuenta de estaciones, agrupados por el campo estado

función count_distinct

Devuelve el recuento de valores distintos.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • contar_distintos("estaciones",agrupar_por:="estado") → cuenta de valores distintos de estaciones, agrupados por el campo estado

función count_missing

Devuelve el recuento de valores que faltan (nulo).

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • contar_faltantes("estaciones",agrupar_por:="estado") → cuenta de valores que faltan (nulos) de estaciones, agrupados por el campo estado

función iqr

Devuelve el rango de intercuartil calculado a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • iqr("population",group_by:="state") → rango de intercuartil del valor de población, agrupado por el campo estado

función majority

Devuelve la mayoría agregada de los valores (valores que aparecen de forma más común) de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • mayoría("clase",agrupar_por:="estado") → valor de clase que ocurre con más frecuencia, agrupado por el campo estado

función max_length

Devuelve la longitud máxima de cadenas a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • longitud_max("nombre_ciudad",agrupar_por:="estado") → longitud máxima de nombre_ciudad, agrupada por el campo estado

función maximum

Devuelve el valor máximo agregado a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • máximo("población",agrupar_por:="estado") → valor máximo de población, agrupado por el campo estado

función mean

Devuelve el valor medio agregado a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • media("población",agrupar_por:="estado") → valor medio de población, agrupado por el campo estado

función median

Devuelve el valor de la mediana agregada a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • mediana("población",agrupar_por:="estado") → valor mediana de población, agrupado por el campo estado

función min_length

Devuelve la longitud mínima de cadenas a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • longitud_min("nombre_ciudad",agrupar_por:="estado") → longitud mínima de nombre_ciudad, agrupada por el campo estado

función minimum

Devuelve el valor mínimo agregado a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • mínimo("población",agrupar_por:="estado") → valor mínimo de población, agrupado por el campo estado

función minority

Devuelve la minoría agregada de valores (valor que ocurre con menos frecuencia) a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • mayoría("clase",agrupar_por:="estado") → valor de clase que ocurre con menos frecuencia, agrupado por el campo estado

función q1

Devuelve el primer cuartil calculado a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • q1("población",agrupar_por:="estado") → primer cuartil del valor de población, agrupado por el campo estado

función q3

Devuelve el tercer cuartil calculado a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • q3("población",agrupar_por:="estado") → tercer cuartil del valor de población, agrupado por el campo estado

función range

Devuelve el rango agregado de valores (máximo - mínimo) de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • rango("población",agrupar_por:="estado") → rango de valores de población, agrupado por el campo estado

función relation_aggregate

Devuelve un valor agregado calculado usando todos los objetos hijos coincidentes de una relación de capas.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

relation una cadena que representa una ID de relación
aggregate a string corresponding to the aggregate to calculate. Valid options are:
  • count
  • count_distinct
  • count_missing
  • min
  • max
  • sum
  • mean
  • median
  • stdev
  • stdevsample
  • range
  • minority
  • majority
  • q1: first quartile
  • q3: third quartile
  • iqr: inter quartile range
  • min_length: minimum string length
  • max_length: maximum string length
  • concatenate: join strings with a concatenator
  • concatenate_unique: join unique strings with a concatenator
  • collect: create an aggregated multipart geometry
  • array_agg: create an array of aggregated values
expression sub expresión o nombre de campo a agregar
concatenator cadena opcional a usar para unir valores para el agregado 'concatenar'
order_by optional expression to order the features used for calculating the aggregate. Fields and geometry are from the features on the joined layer.

Ejemplos

  • relation_aggregate(relation:='my_relation',aggregate:='mean',expression:="passengers") → valor medio de todos los objetos hijos coincidentes usando la relación 'mi_relación'
  • relation_aggregate('my_relation','sum', "passengers"/7) → suma del campo pasajeros dividido por 7 de todos los objetos hijos coincidentes usando la relación 'mi_relación'
  • relation_aggregate('my_relation','concatenate', "towns", concatenator:=',') → lista separada por coma del campo ciudades para todos los objetos hijos coincidentes usando la relación 'mi_relación'
  • relation_aggregate('my_relation','array_agg', "id") → array of the id field from all matching child features using the 'my_relation' relation

función stdev

Devuelve la desviación estándar agregada a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • desv_est("población",agrupar_por:="estado") → desviación estándar del valor de población, agrupado por el campo estado

función sum

Devuelve el valor sumado agregado a partir de un campo o expresión.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

expression subexpresión de campo a agregar
group_by expresión opcional a usar para agrupar cálculos de agregados
filter expresión opcional a usar para filtrar objetos utilizados para calcular el agregado

Ejemplos

  • suma("población",agrupar_por:="estado") → valor de población sumado, agrupado por el campo estado

grupo matrices

Este grupo contiene funciones de expresiones para la creación y manipulación de matrices (también conocidas como estructuras de datos en lista). El orden de los valores dentro de la matriz importa, a diferencia de la estructura de datos de "mapa", en donde el orden de pares clave-valor es irrelevante y los valores se identifican por sus claves.

función array

Devuelve una matriz que contiene todos los valores pasados como parámetros.

Sintaxis

array ( value1 , value2 …)

Argumentos

value un valor

Ejemplos

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

función array_all

Returns true if an array contains all the values of a given array.

Sintaxis

array_all ( array_a , array_b )

Argumentos

array_a una matriz
array_b the array of values to search

Ejemplos

  • array_all(array(1,2,3),array(2,3)) → verdadero
  • array_all(array(1,2,3),array(1,2,4)) → falso

función array_append

Devuelve una matriz con el valor dado añadido al final.

Sintaxis

array_append ( array , value )

Argumentos

array una matriz
value el valor a añadir

Ejemplos

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

función array_cat

Devuelve una matriz que contiene todas las matrices dadas concatenadas.

Sintaxis

array_cat ( array1 , array2 …)

Argumentos

array una matriz

Ejemplos

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

función array_contains

Devuelve verdadero si una matriz contiene el valor dado.

Sintaxis

array_contains ( array , value )

Argumentos

array una matriz
value el valor a buscar

Ejemplos

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

función array_distinct

Devuelve una matriz que contiene los valores distintos de la matriz dada.

Sintaxis

array_distinct ( array )

Argumentos

array una matriz

Ejemplos

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

función array_filter

Devuelve una matriz con sólo los ítems para los cuales la expresión evalúa a verdadero.

Sintaxis

array_filter ( array , expression )

Argumentos

array una matriz
expression an expression to evaluate on each item. The variable `@element` will be replaced by the current value.

Ejemplos

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

función array_find

Devuelve el índice de un valor dentro de una matriz (0 para el primero). Devuelve -1 si no se encuentra el valor.

Sintaxis

array_find ( array , value )

Argumentos

array una matriz
value el valor a buscar

Ejemplos

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

función array_first

Devuelve el primer valor de una matriz.

Sintaxis

array_first ( array )

Argumentos

array una matriz

Ejemplos

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

función array_foreach

Returns an array with the given expression evaluated on each item.

Sintaxis

array_foreach ( array , expression )

Argumentos

array una matriz
expression an expression to evaluate on each item. The variable `@element` will be replaced by the current value.

Ejemplos

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

función array_get

Devuelve el valor N de una matriz (0 para el primero).

Sintaxis

array_get ( array , index )

Argumentos

array una matriz
index el índica a obtener (basado en 0)

Ejemplos

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

función array_insert

Devuelve una matriz con el valor dado añadido en la posición indicada.

Sintaxis

array_insert ( array , pos , value )

Argumentos

array una matriz
pos la posición en la que añadir (basado en 0)
value el valor a añadir

Ejemplos

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

función array_intersect

Devuelve verdadero si un elemento de la matriz1 está presente en la matriz2.

Sintaxis

array_intersect ( array1 , array2 )

Argumentos

array1 una matriz
array2 otra matriz

Ejemplos

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

función array_last

Devuelve el último valor de una matriz.

Sintaxis

array_last ( array )

Argumentos

array una matriz

Ejemplos

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

función array_length

Devuelve el número de elementos de una matriz.

Sintaxis

array_length ( array )

Argumentos

array una matriz

Ejemplos

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

función array_prepend

Devuelve una matriz con el valor dado añadido al principio.

Sintaxis

array_prepend ( array , value )

Argumentos

array una matriz
value el valor a añadir

Ejemplos

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

función array_remove_all

Devuelve una matriz con todas las entradas del valor dado eliminadas.

Sintaxis

array_remove_all ( array , value )

Argumentos

array una matriz
value los valores a eliminar

Ejemplos

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

función array_remove_at

Devuelve una matriz con el índice dado eliminado.

Sintaxis

array_remove_at ( array , pos )

Argumentos

array una matriz
pos la posición a eliminar (basado en 0)

Ejemplos

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

función array_reverse

Devuelve la matriz dada con los valores de la matriz en orden inverso.

Sintaxis

array_reverse ( array )

Argumentos

array una matriz

Ejemplos

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

función array_slice

Devuelve una porción de la matriz. El fragmento es definido por los argumentos start_pos y end_pos.

Sintaxis

array_slice ( array , start_pos , end_pos )

Argumentos

array una matriz
start_pos el índice de la posición inicial del fragmento (basado en 0). El índice de start_pos se incluye en el fragmento. Si se usa una start_pos negativa, el índice se cuenta desde el final de la lista (basado en -1).
end_pos el índice de la posición final del fragmento (basado en 0). El índice de end_pos se incluye en el fragmento. Si se usa una end_pos negativa, el índice se cuenta desde el final de la lista (basado en -1).

Ejemplos

  • 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' ]

función array_sort

Returns the provided array with its elements sorted.

Sintaxis

array_sort ( array [, ascending=true ])

[ ] marque componentes opcionales

Argumentos

array una matriz
ascending set this parameter to false to sort the array in descending order

Ejemplos

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

función array_to_string

Concatenates array elements into a string separated by a delimiter and using optional string for empty values.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

array la matriz de entrada
delimiter el delimitador de cadena utilizado para separa los elementos de la matriz concatenados
empty_value la cadena opcional usada como reemplazo para coincidencias vacías (longitud cero)

Ejemplos

  • 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'

función generate_series

Creates an array containing a sequence of numbers.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

start first value of the sequence
stop value that ends the sequence once reached
step value used as the increment between values

Ejemplos

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

función regexp_matches

Devuelve una matriz de todas las cadenas capturadas por grupos de captura, en el orden en el que los propios grupos aparecen en la expresión regular proporcionada contra la cadena.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

string la cadena para capturar grupos desde la expresión regular
regex la expresión regular usada para capturar grupos
empty_value la cadena opcional usada como reemplazo para coincidencias vacías (longitud cero)

Ejemplos

  • regexp_matches('QGIS=>rocks','(.*)=>(.*)') → [ 'QGIS', 'rocks' ]
  • regexp_matches('key=>','(.*)=>(.*)','empty value') → [ 'key', 'empty value' ]

función string_to_array

Divide una cadena en una matriz usando el delimitador proporcionado y una cadena opcional para valores vacíos.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

string la cadena de entrada
delimiter el delimitador de cadena utilizado para dividir la cadena de entrada
empty_value la cadena opcional usada como reemplazo para coincidencias vacías (longitud cero)

Ejemplos

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

grupo color

Este grupo contiene funciones para manipular colores

función color_cmyk

Devuelve una representación en forma de cadena de un color en base a sus componentes cian, magenta, amarillo y negro

Sintaxis

color_cmyk ( cyan , magenta , yellow , black )

Argumentos

cyan componente cian del color, como un valor entero de porcentaje de 0 a 100
magenta componente magenta del color, como un valor entero de porcentaje de 0 a 100
yellow componente amarillo del color, como un valor entero de porcentaje de 0 a 100
black componente negro del color, como un valor entero de porcentaje de 0 a 100

Ejemplos

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

función color_cmyka

Devuelve una representación en forma de cadena de un color en base a sus componentes cian, magenta, amarillo, negro y alfa (transparencia)

Sintaxis

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

Argumentos

cyan componente cian del color, como un valor entero de porcentaje de 0 a 100
magenta componente magenta del color, como un valor entero de porcentaje de 0 a 100
yellow componente amarillo del color, como un valor entero de porcentaje de 0 a 100
black componente negro del color, como un valor entero de porcentaje de 0 a 100
alpha componente alfa como un valor entero de 0 (completamente transparente) a 255 (opaco).

Ejemplos

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

función color_grayscale_average

Applies a grayscale filter and returns a string representation from a provided color.

Sintaxis

color_grayscale_average ( color )

Argumentos

color una cadena de color

Ejemplos

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

función color_hsl

Devuelve una representación en forma de cadena de un color en base a sus atributos de matiz, saturación y luminosidad.

Sintaxis

color_hsl ( hue , saturation , lightness )

Argumentos

hue matiz de un color, como un entero de 0 a 360
saturation porcentaje de saturación del color, como un valor entero de 0 a 100
lightness porcentaje de luminosidad del color, como un valor entero de 0 a 100

Ejemplos

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

función color_hsla

Devuelve una representación en forma de cadena de un color en base a sus atributos de matiz, saturación, luminosidad y canal alfa (transparencia).

Sintaxis

color_hsla ( hue , saturation , lightness , alpha )

Argumentos

hue matiz de un color, como un entero de 0 a 360
saturation porcentaje de saturación del color, como un valor entero de 0 a 100
lightness porcentaje de luminosidad del color, como un valor entero de 0 a 100
alpha componente alfa como un valor entero de 0 (completamente transparente) a 255 (opaco).

Ejemplos

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

función color_hsv

Devuelve una representación en forma de cadena de un color en base a sus atributos de matiz, saturación y valor.

Sintaxis

color_hsv ( hue , saturation , value )

Argumentos

hue matiz de un color, como un entero de 0 a 360
saturation porcentaje de saturación del color, como un valor entero de 0 a 100
value porcentaje de valor del color, como un valor entero de 0 a 100

Ejemplos

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

función color_hsva

Devuelve una representación en forma de cadena de un color en base a sus atributos de matiz, saturación, valor y canal alfa (transparencia).

Sintaxis

color_hsva ( hue , saturation , value , alpha )

Argumentos

hue matiz de un color, como un entero de 0 a 360
saturation porcentaje de saturación del color, como un valor entero de 0 a 100
value porcentaje de valor del color, como un valor entero de 0 a 100
alpha componente alfa como un valor entero de 0 (completamente transparente) a 255 (opaco)

Ejemplos

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

función color_mix_rgb

Returns a string representing a color mixing the red, green, blue, and alpha values of two provided colors based on a given ratio.

Sintaxis

color_mix_rgb ( color1 , color2 , ratio )

Argumentos

color1 una cadena de color
color2 una cadena de color
ratio una relación

Ejemplos

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

función color_part

Devuelve un componente específico de una cadena de color, por ejemplo el componente rojo o el alfa.

Sintaxis

color_part ( color , component )

Argumentos

color una cadena de color
component una cadena que corresponde al componente del color a devolver. Las opciones válidas son:
  • red: componente rojo RGB (0-255)
  • green: componente verde RGB (0-255)
  • blue: componente azul RGB (0-255)
  • alpha: valor alfa (transparencia) (0-255)
  • hue: matiz HSV (0-360)
  • saturation: saturación HSV (0-100)
  • value: valor HSV (0-100)
  • hsl_hue: matiz HSL (0-360)
  • hsl_saturation: saturación HSL (0-100)
  • lightness: luminosidad HSL (0-100)
  • cyan: componente cian CMYK (0-100)
  • magenta: componente magenta CMYK (0-100)
  • yellow: componente amarillo CMYK (0-100)
  • black: componente negro CMYK (0-100)

Ejemplos

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

función color_rgb

Devuelve una representación en forma de cadena de un color en base a sus componentes rojo, verde y azul.

Sintaxis

color_rgb ( red , green , blue )

Argumentos

red componente rojo del color, como un valor entero de 0 a 255
green componente verde del color, como un valor entero de 0 a 255
blue componente azul del color, como un valor entero de 0 a 255

Ejemplos

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

función color_rgba

Devuelve una representación en forma de cadena de un color en base a sus componentes rojo, verde, azul y alfa (transparencia).

Sintaxis

color_rgba ( red , green , blue , alpha )

Argumentos

red componente rojo del color, como un valor entero de 0 a 255
green componente verde del color, como un valor entero de 0 a 255
blue componente azul del color, como un valor entero de 0 a 255
alpha componente alfa como un valor entero de 0 (completamente transparente) a 255 (opaco).

Ejemplos

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

función create_ramp

Devuelve una rampa de gradiente de un mapa de colores y pasos.

Sintaxis

create_ramp ( map [, discrete ])

[ ] marque componentes opcionales

Argumentos

map a map of color strings and steps
discrete declarar si la rampa de color es discreta

Ejemplos

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

función darker

Devuelve una cadena de color más oscura (o más clara)

Sintaxis

darker ( color , factor )

Argumentos

color una cadena de color
factor un número entero que corresponde al factor de oscurecimiento:
  • Si el factor es mayor de 100, esta función devuelve un color más oscuro (por ej., establecer el factor a 300 devuelve un color que tiene un tercio de brillo);
  • Si el factor es menor que 100, el color devuelto es más claro, pero se recomienda usar la función lighter() para este propósito;
  • Si el factor es 0 o negativo, el valor devuelto es inespecífico.

Ejemplos

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

función lighter

Devuelve una cadena de color más clara (o más oscura)

Sintaxis

lighter ( color , factor )

Argumentos

color una cadena de color
factor un número entero que corresponde al factor de aclarado:
  • Si el factor es mayor de 100, esta función devuelve un color más claro (por ej., establecer el factor a 150 devuelve un color que es un 50% más brillante);
  • Si el factor es menor que 100, el color devuelto es más oscuro, pero se recomienda usar la función darker() para este propósito;
  • Si el factor es 0 o negativo, el valor devuelto es inespecífico.

Ejemplos

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

función project_color

Devuelve un color del esquema de color del proyecto.

Sintaxis

project_color ( name )

Argumentos

name el nombre de un color

Ejemplos

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

función ramp_color

Devuelve una cadena que representa un color de una rampa de color.

Variante de rampa guardada

Devuelve una cadena que representa un color de una rampa guardada

Sintaxis

ramp_color ( ramp_name , value )

Argumentos

ramp_name el nombre de la rampa de color como una cadena, por ejemplo 'Spectral'
value la posición en la rampa de la que seleccionar el color, como un número real entre 0 y 1

Ejemplos

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

Notas

Las rampas de color disponibles varían entre instalaciones de QGIS. Esta función puede no dar el resultado esperado su mueve su proyecto de QGIS entre instalaciones.

Variante de rampa creada por expresión

Devuelve una cadena que representa un color de una rampa creada por expresión

Sintaxis

ramp_color ( ramp , value )

Argumentos

ramp la rampa de color
value la posición en la rampa de la que seleccionar el color, como un número real entre 0 y 1

Ejemplos

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

función set_color_part

Establece el componente de un color específico para la cadena de un color, por ejemplo el componente rojo o el alfa.

Sintaxis

set_color_part ( color , component , value )

Argumentos

color una cadena de color
component una cadena que corresponde al componente del color a establecer. Las opciones válidas son:
  • red: componente rojo RGB (0-255)
  • green: componente verde RGB (0-255)
  • blue: componente azul RGB (0-255)
  • alpha: valor alfa (transparencia) (0-255)
  • hue: matiz HSV (0-360)
  • saturation: saturación HSV (0-100)
  • value: valor HSV (0-100)
  • hsl_hue: matiz HSL (0-360)
  • hsl_saturation: saturación HSL (0-100)
  • lightness: luminosidad HSL (0-100)
  • cyan: componente cian CMYK (0-100)
  • magenta: componente magenta CMYK (0-100)
  • yellow: componente amarillo CMYK (0-100)
  • black: componente negro CMYK (0-100)
value valor nuevo para el componente de color, restetando los rangos listados arriba

Ejemplos

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

grupo condicionales

Este grupo contiene funciones para realizar comprobaciones condicionales en expresiones.

función coalesce

Devuelve el primer valor no-NULO de la lista de expresiones
Esta función puede tomar cualquier número de argumentos.

Sintaxis

coalesce ( expression1 , expression2 …)

Argumentos

expression cualquier expresión o valor válidos, sin importar el tipo.

Ejemplos

  • coalesce(NULO, 2) → 2
  • coalesce(NULO, 2, 3) → 2
  • coalesce(7, NULO, 3*2) → 7
  • coalesce("campoA", "fallbackField", 'ERROR') → el valor del campoA si no es NULO, de lo contrario el valor de "fallbackField" o la cadena 'ERROR' si ambos son NULO

función if

Prueba una condición y devuelve un resultado diferente dependiendo de la comprobación condicional.

Sintaxis

if ( condition , result_when_true , result_when_false )

Argumentos

condition la condición que se debe evaluar
result_when_true el resultado que se devolverá cuando la condición sea verdadera u otro valor que no convierta a falso.
result_when_false el resultado que se devolverá cuando la condición sea falsa u otro valor que convierta a falso como 0 o ". NULO también se convertirá a falso.

Ejemplos

  • if( 1+1=2, 'Yes', 'No' ) → 'Sí'
  • if( 1+1=3, 'Yes', 'No' ) → 'No'
  • if( 5 > 3, 1, 0) → 1
  • if( '', 'It is true (not empty)', 'It is false (empty)' ) → 'It is false (empty)'
  • if( ' ', 'It is true (not empty)', 'It is false (empty)' ) → 'It is true (not empty)'
  • if( 0, 'One', 'Zero' ) → 'Cero'
  • if( 10, 'One', 'Zero' ) → 'Uno'

función nullif

Returns a null value if value1 equals value2; otherwise it returns value1. This can be used to conditionally substitute values with NULL.

Sintaxis

nullif ( value1 , value2 )

Argumentos

value1 The value that should either be used or substituted with NULL.
value2 The control value that will trigger the NULL substitution.

Ejemplos

  • nullif('(none)', '(none)') → NULO
  • nullif('text', '(none)') → 'text'
  • nullif("name", '') → NULL, if name is an empty string (or already NULL), the name in any other case.

función regexp_match

Devuelve la primera posición que coincide con una expresión regular dentro de una cadena o 0 si no se encuentra la subcadena.

Sintaxis

regexp_match ( input_string , regex )

Argumentos

input_string La cadena a probar frente a la expresión regular
regex La expresión regular frente a la que probar. El carácter barra invertida se debe escapar doblemente (ej.: "\\s" para capturar un carácter espacio en blanco).

Ejemplos

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

función try

Intenta ejecutar una expresión y devuelve su valor si está libre de error. Si la expresión devuelve un error, se regresará un valor alternativo cuando se proporcione, de otro modo devolverá nulo.

Sintaxis

try ( expression [, alternative ])

[ ] marque componentes opcionales

Argumentos

expression la expresión que debe utilizarse
alternative el resultado que será devuelto si la expresión regresa un error.

Ejemplos

  • try( to_int( '1' ), 0 ) → 1
  • try( to_int( 'a' ), 0 ) → 0
  • try( to_date( 'invalid_date' ) ) → NULO

grupo conversiones

Este grupo contiene funciones para convertir unos tipos de datos en otros, por ejemplo cadena a entero o entero a cadena.

función from_base64

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

Sintaxis

from_base64 ( string )

Argumentos

string the string to decode

Ejemplos

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

función hash

Creates a hash from a string with a given method.

Sintaxis

hash ( string , method )

Argumentos

string the string to hash
method The hash method among 'md4', 'md5', 'sha1', 'sha224', 'sha384', 'sha512', 'sha3_224', 'sha3_256', 'sha3_384', 'sha3_512', 'keccak_224', 'keccak_256', 'keccak_384', 'keccak_512'

Ejemplos

  • 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'

función md5

Creates a md5 hash from a string.

Sintaxis

md5 ( string )

Argumentos

string the string to hash

Ejemplos

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

función sha256

Creates a sha256 hash from a string.

Sintaxis

sha256 ( string )

Argumentos

string the string to hash

Ejemplos

  • sha256('QGIS') → 'eb045cba7a797aaa06ac58830846e40c8e8c780bc0676d3393605fae50c05309'

función to_base64

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

Sintaxis

to_base64 ( value )

Argumentos

value the binary value to encode

Ejemplos

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

función to_date

Convierte una cadena de caracteres en un objeto fecha. Una cadena opcional de formato puede proporcionarse para formatear la cadena; ver QDate::fromString para documentación adicional sobre el formato.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

string cadena que representa un valor de fecha
format format used to convert the string into a date
language idioma (minúsculas, dos- o tres-letras, código de idioma ISO 639) usado para convertir la cadena a fecha

Ejemplos

  • 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

función to_datetime

Convierte una cadena de caracteres en un objeto fecha-hora. Una cadena opcional de formato puede proporcionarse para formatear la cadena; ver QDate::fromString para documentación adicional sobre el formato.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

string cadena que representa un valor de fecha y hora
format formato usado para convertir la cadena a fecha-hora
language idioma (minúsculas, dos- o tres-letras, código de idioma ISO 639) usado para convertir la cadena a fecha-hora

Ejemplos

  • 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

función to_dm

Convertir una coordenada a grados, minutos.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

coordinate Un valor de latitud o longitud.
axis El eje de la coordenada. Ya sea 'x' o 'y'.
precision Número de decimales.
formatting Designa el tipo de formato. Valores aceptables son NULL, 'aligned' o 'suffix'.

Ejemplos

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

función to_dms

Convertir una coordenada a grados, minutos, segundos.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

coordinate Un valor de latitud o longitud.
axis El eje de la coordenada. Ya sea 'x' o 'y'.
precision Número de decimales.
formatting Designa el tipo de formato. Valores aceptables son NULL, 'aligned' o 'suffix'.

Ejemplos

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

función to_int

Convierte una cadena a número entero. No devuelve nada si un valor no se puede convertir a entero (ej.: '123asd' no es válido).

Sintaxis

to_int ( string )

Argumentos

string cadena a convertir a número entero

Ejemplos

  • to_int('123') → 123

función to_interval

Converts a string to a interval type. Can be used to take days, hours, month, etc of a date.

Sintaxis

to_interval ( string )

Argumentos

string una cadena que representa un intervalo. Los formatos permitidos incluyen {n} días {n} horas {n} meses.

Ejemplos

  • to_datetime('2012-05-05 12:00:00') - to_interval('1 día 2 horas') → 2012-05-04T10:00:00

función to_real

Convierte una cadena a número real. No devuelve nada si un valor no se puede convertir a real (ej.: '123.56asd' no es válido). Los números se redondean después de guardar los cambios si la precisión es menor que el resultado de la conversión.

Sintaxis

to_real ( string )

Argumentos

string cadena a convertir a número real

Ejemplos

  • to_real('123.45') → 123.45

función to_string

Convierte un número en cadena.

Sintaxis

to_string ( number )

Argumentos

number Valor entero o real. El número a convertir en cadena.

Ejemplos

  • to_string(123) → '123'

función to_time

Converts a string into a time object. An optional format string can be provided to parse the string; see QTime::fromString for additional documentation on the format.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

string cadena que representa un valor hora
format formato utilizado para convertir la cadena a hora
language idioma (minúsculas, dos- o tres-letras, código de idioma ISO 639) usado para convertir la cadena a hora

Ejemplos

  • 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

grupo fecha y hora

Este grupo contiene funciones para manipular datos de fecha y hora.

función age

Devuelve la diferencia entre dos fechas o fechas y horas.
La diferencia se devuelve como un Intervalo y es necesario usarla con una de las siguientes funciones para extraer información útil:

Sintaxis

age ( datetime1 , datetime2 )

Argumentos

datetime1 una cadena, fecha o fecha y hora que representa la fecha posterior
datetime2 una cadena, fecha o fecha y hora que representa la fecha anterior

Ejemplos

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

función 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.

Sintaxis

datetime_from_epoch ( int )

Argumentos

int number (milliseconds)

Ejemplos

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

función day

Extracts the day from a date, or the number of days from an interval.

Variante de fecha

Extracts the day from a date or datetime.

Sintaxis

day ( date )

Argumentos

date una fecha o fecha y hora

Ejemplos

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

Variante de intervalo

Calculates the length in days of an interval.

Sintaxis

day ( interval )

Argumentos

interval intervalo del que devolver el número de días

Ejemplos

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

función day_of_week

Devuelve el día de la semana para una fecha o fecha y hora especificadas. El valor devuelto varía entre 0 y 6, donde 0 corresponde a domingo y 6 a sábado.

Sintaxis

day_of_week ( date )

Argumentos

date una fecha o fecha y hora

Ejemplos

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

función epoch

Returns the interval in milliseconds between the unix epoch and a given date value.

Sintaxis

epoch ( date )

Argumentos

date una fecha o fecha y hora

Ejemplos

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

función format_date

Formats a date type or string into a custom string format. Uses Qt date/time format strings. See QDateTime::toString .

Sintaxis

format_date ( datetime , format [, language ])

[ ] marque componentes opcionales

Argumentos

datetime valor de fecha, hora o fecha y hora
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 language (lowercase, two- or three-letter, ISO 639 language code) used to format the date into a custom string

Ejemplos

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

función hour

Extracts the hour part from a datetime or time, or the number of hours from an interval.

Variante de hora

Extracts the hour part from a time or datetime.

Sintaxis

hour ( datetime )

Argumentos

datetime un valor de hora o fecha y hora

Ejemplos

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

Variante de intervalo

Calculates the length in hours of an interval.

Sintaxis

hour ( interval )

Argumentos

interval intervalo del que devolver el número de horas

Ejemplos

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

función make_date

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

Sintaxis

make_date ( year , month , day )

Argumentos

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

Ejemplos

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

función make_datetime

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

Sintaxis

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

Argumentos

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)

Ejemplos

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

función make_interval

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

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

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

Ejemplos

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

función make_time

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

Sintaxis

make_time ( hour , minute , second )

Argumentos

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

Ejemplos

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

función minute

Extracts the minutes part from a datetime or time, or the number of minutes from an interval.

Variante de hora

Extracts the minutes part from a time or datetime.

Sintaxis

minute ( datetime )

Argumentos

datetime un valor de hora o fecha y hora

Ejemplos

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

Variante de intervalo

Calculates the length in minutes of an interval.

Sintaxis

minute ( interval )

Argumentos

interval intervalo del que devolver el número de minutos

Ejemplos

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

función month

Extracts the month part from a date, or the number of months from an interval.

Variante de fecha

Extracts the month part from a date or datetime.

Sintaxis

month ( date )

Argumentos

date una fecha o fecha y hora

Ejemplos

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

Variante de intervalo

Calculates the length in months of an interval.

Sintaxis

month ( interval )

Argumentos

interval intervalo del que devolver el número de meses

Ejemplos

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

función now

Returns the current date and time. The function is static and will return consistent results while evaluating. The time returned is the time when the expression is prepared.

Sintaxis

now ()

Ejemplos

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

función second

Extracts the seconds part from a datetime or time, or the number of seconds from an interval.

Variante de hora

Extracts the seconds part from a time or datetime.

Sintaxis

second ( datetime )

Argumentos

datetime un valor de hora o fecha y hora

Ejemplos

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

Variante de intervalo

Calculates the length in seconds of an interval.

Sintaxis

second ( interval )

Argumentos

interval intervalo del que devolver el número de segundos

Ejemplos

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

función to_date

Convierte una cadena de caracteres en un objeto fecha. Una cadena opcional de formato puede proporcionarse para formatear la cadena; ver QDate::fromString para documentación adicional sobre el formato.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

string cadena que representa un valor de fecha
format format used to convert the string into a date
language idioma (minúsculas, dos- o tres-letras, código de idioma ISO 639) usado para convertir la cadena a fecha

Ejemplos

  • 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

función to_datetime

Convierte una cadena de caracteres en un objeto fecha-hora. Una cadena opcional de formato puede proporcionarse para formatear la cadena; ver QDate::fromString para documentación adicional sobre el formato.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

string cadena que representa un valor de fecha y hora
format formato usado para convertir la cadena a fecha-hora
language idioma (minúsculas, dos- o tres-letras, código de idioma ISO 639) usado para convertir la cadena a fecha-hora

Ejemplos

  • 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

función to_interval

Converts a string to a interval type. Can be used to take days, hours, month, etc of a date.

Sintaxis

to_interval ( string )

Argumentos

string una cadena que representa un intervalo. Los formatos permitidos incluyen {n} días {n} horas {n} meses.

Ejemplos

  • to_datetime('2012-05-05 12:00:00') - to_interval('1 día 2 horas') → 2012-05-04T10:00:00

función to_time

Converts a string into a time object. An optional format string can be provided to parse the string; see QTime::fromString for additional documentation on the format.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

string cadena que representa un valor hora
format formato utilizado para convertir la cadena a hora
language idioma (minúsculas, dos- o tres-letras, código de idioma ISO 639) usado para convertir la cadena a hora

Ejemplos

  • 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

función week

Extracts the week number from a date, or the number of weeks from an interval.

Variante de fecha

Extracts the week number from a date or datetime.

Sintaxis

week ( date )

Argumentos

date una fecha o fecha y hora

Ejemplos

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

Variante de intervalo

Calculates the length in weeks of an interval.

Sintaxis

week ( interval )

Argumentos

interval intervalo del que devolver el número de meses

Ejemplos

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

función year

Extracts the year part from a date, or the number of years from an interval.

Variante de fecha

Extracts the year part from a date or datetime.

Sintaxis

year ( date )

Argumentos

date una fecha o fecha y hora

Ejemplos

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

Variante de intervalo

Calculates the length in years of an interval.

Sintaxis

year ( interval )

Argumentos

interval intervalo del que devolver el número de años

Ejemplos

  • year(to_interval('3 años')) → 3
  • year(age('2012-01-01','2010-01-01')) → 1.9986

grupo files and paths

Contains functions which manipulate file and path names.

función base_file_name

Returns the base name of the file without the directory or file suffix.

Sintaxis

base_file_name ( path )

Argumentos

path a file path

Ejemplos

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

función file_exists

Returns true if a file path exists.

Sintaxis

file_exists ( path )

Argumentos

path a file path

Ejemplos

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

función file_name

Returns the name of a file (including the file extension), excluding the directory.

Sintaxis

file_name ( path )

Argumentos

path a file path

Ejemplos

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

función file_path

Returns the directory component of a file path. This does not include the file name.

Sintaxis

file_path ( path )

Argumentos

path a file path

Ejemplos

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

función file_size

Returns the size (in bytes) of a file.

Sintaxis

file_size ( path )

Argumentos

path a file path

Ejemplos

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

función file_suffix

Returns the file suffix (extension) from a file path.

Sintaxis

file_suffix ( path )

Argumentos

path a file path

Ejemplos

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

función is_directory

Returns true if a path corresponds to a directory.

Sintaxis

is_directory ( path )

Argumentos

path a file path

Ejemplos

  • is_directory('/home/qgis/data/country_boundaries.shp') → falso
  • is_directory('/home/qgis/data/') → verdadero

función is_file

Returns true if a path corresponds to a file.

Sintaxis

is_file ( path )

Argumentos

path a file path

Ejemplos

  • is_file('/home/qgis/data/country_boundaries.shp') → verdadero
  • is_file('/home/qgis/data/') → falso
falta la ayuda de la función para Form

función 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.

Sintaxis

current_parent_value ( field_name )

Argumentos

field_name a field name in the current parent form

Ejemplos

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

función current_value

Returns the current, unsaved value of a field in the form or table row currently being edited. This will differ from the feature's actual attribute values for features which are currently being edited or have not yet been added to a layer.

Sintaxis

current_value ( field_name )

Argumentos

field_name a field name in the current form or table row

Ejemplos

  • current_value( 'FIELD_NAME' ) → The current value of field 'FIELD_NAME'.

grupo concordancia aproximada

Este grupo contiene funciones para comparaciones simples entre valores.

función hamming_distance

Devuelve la distancia de Hamming entre dos cadenas. Esto es igual al número de caracteres en las posiciones correspondientes dentro de las cadenas de entrada donde los caracteres son diferentes. Las cadenas de entrada deben tener la misma longitud y la comparación es sensible a mayúsculas.

Sintaxis

hamming_distance ( string1 , string2 )

Argumentos

string1 una cadena
string2 una cadena

Ejemplos

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

función levenshtein

Devuelve la distancia de edición de Levenshtein entre dos cadenas. Esto es el número mínimo de ediciones de caracteres (inserciones, borrados o sustituciones) necesario para convertir una cadena en otra.
La distancia de Levenshtein es una medida de la similitud entre dos cadenas. Distancias menores significan que las cadenas son más parecidas y distancias mayores indican más diferencia entre las cadenas. La distancia distingue entre mayúsculas y minúsculas.

Sintaxis

levenshtein ( string1 , string2 )

Argumentos

string1 una cadena
string2 una cadena

Ejemplos

  • levenshtein('mínimo','máximo') → 2
  • levenshtein('Mínimo','mínimo') → 1
  • levenshtein(upper('Mínimo'),upper('mínimo')) → 0

función longest_common_substring

Devuelve la subcadena común más larga entre dos cadenas. Esta subcadena es la más larga que es una subcadena de las dos cadenas de entrada. Por ejemplo, la subcadena más larga común de "ABABC" y "BABCA" es "ABC". La subcadena distingue mayúsculas/minúsculas.

Sintaxis

longest_common_substring ( string1 , string2 )

Argumentos

string1 una cadena
string2 una cadena

Ejemplos

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

función soundex

Devuelve la representación Soundex de una cadena. Soundex es un algoritmo de coincidencia fonética, de forma que cadenas con sonidos similares deben representarse por el mismo código Soundex.

Sintaxis

soundex ( string )

Argumentos

string una cadena

Ejemplos

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

grupo general

Este grupo contiene funciones generales variadas.

función env

Obtiene una variable de entorno y devuelve su contenido como cadena. Si la variable no se encuentra devuelve "NULO". Esto es útil para introducir configuraciones específicas del sistema, como la letra de unidad o prefijos de rutas. La definición de variables de entorno depende del sistema operativo, por favor consulte cómo se puede establecer con el administrador de su equipo o en la documentación del sistema operativo.

Sintaxis

env ( name )

Argumentos

name El nombre de la variable de entorno que de debe recuperar.

Ejemplos

  • env( 'LANG' ) → 'en_US.UTF-8'
  • env( 'MY_OWN_PREFIX_VAR' ) → 'Z:'
  • env( 'I_DO_NOT_EXIST' ) → NULO

función eval

Evalúa una expresión que es pasada en una cadena. Útil para expandir parámetros dinámicos pasados como variables de contexto o campos.

Sintaxis

eval ( expression )

Argumentos

expression una cadena de expresión

Ejemplos

  • eval(''nice'') → 'nice'
  • eval(@expression_var) → [whatever the result of evaluating @expression_var might be…]

función eval_template

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

Sintaxis

eval_template ( template )

Argumentos

template a template string

Ejemplos

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

función is_layer_visible

Devuelve verdadero si la capa especificada es visible.

Sintaxis

is_layer_visible ( layer )

Argumentos

layer Una cadena que represente el nombre o la ID de una capa

Ejemplos

  • is_layer_visible('baseraster') → Verdadero

función layer_property

Devuelve el valor de una propiedad o metadato de una capa.

Sintaxis

layer_property ( layer , property )

Argumentos

layer Una cadena que represente el nombre o la ID de una capa
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.

Ejemplos

  • layer_property('calles','title') → 'Mapa base de calles'
  • layer_property('aeropuertos','feature_count') → 120
  • layer_property('landsat','crs') → 'EPSG:4326'

función var

Devuelve el valor guardado dentro de una variable especificada.

Sintaxis

var ( name )

Argumentos

name un nombre de variable

Ejemplos

  • var('qgis_version') → '2.12'

función with_variable

Esta función establece una variable para el código de cualquier expresión que se proporcionará como tercer argumento. Esto solo es útil para expresiones complejas, en las que se necesita usar el mismo valor calculado en diferentes sitios.

Sintaxis

with_variable ( name , value , expression )

Argumentos

name el nombre de la variable a establecer
value el valor a establecer
expression la expresión para la que estará disponible la variable

Ejemplos

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

grupo geometría

Este grupo contiene funciones que operan sobre elementos de geometría, como longitud o área.

función $area

Devuelve el área del objeto actual. El área calculada por esta función respeta tanto la configuración del elipsoide del proyecto actual como la de las unidades de área. Por ejemplo, si se ha establecido un elipsoide para el proyecto, entonces el área calculada será elipsoidal y si no se ha establecido ningún elipsoide, entonces el área calculada será planimétrica.

Sintaxis

$area

Ejemplos

  • $area → 42

función $geometry

Devuelve la geometría del objeto actual. Se puede usar para procesos con otras funciones.

Sintaxis

$geometry

Ejemplos

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

función $length

Devuelve la longitud de una cadena de líneas. Si necesita la longitud del contorno de un polígono, utilice mejor $perimeter. La longitud calculada por esta función respeta tanto la configuración del elipsoide del proyecto actual como la de las unidades de longitud. Por ejemplo, si se ha establecido un elipsoide para el proyecto, entonces la longitud calculada será elipsoidal y si no se ha establecido ningún elipsoide, entonces la longitud calculada será planimétrica.

Sintaxis

$length

Ejemplos

  • $length → 42.4711

función $perimeter

Devuelve la longitud del perímetro del objeto actual. El perímetro calculado por esta función respeta tanto la configuración del elipsoide del proyecto actual como la de las unidades de distancia. Por ejemplo, si se ha establecido un elipsoide para el proyecto, entonces el perímetro calculado será elipsoidal y si no se ha establecido ningún elipsoide, entonces el perímetro calculado será planimétrico.

Sintaxis

$perimeter

Ejemplos

  • $perimeter → 42

función $x

Devuelve la coordenada X del objeto actual.

Sintaxis

$x

Ejemplos

  • $x → 42

función $x_at

Obtiene una coordenada X de la geometría del objeto actual.

Sintaxis

$x_at ( i )

Argumentos

i index of point of a line (indices start at 0; negative values apply from the last index, starting at -1)

Ejemplos

  • $x_at(1) → 5

función $y

Devuelve la coordenada Y del objeto actual.

Sintaxis

$y

Ejemplos

  • $y → 42

función $y_at

Obtiene una coordenada Y de la geometría del objeto actual.

Sintaxis

$y_at ( i )

Argumentos

i index of point of a line (indices start at 0; negative values apply from the last index, starting at -1)

Ejemplos

  • $y_at(1) → 2

función angle_at_vertex

Devuelve un ángulo bisectriz (ángulo medio) a la geometría para un vértice especificado en una geometría de cadena de línea. Los ángulos están en grados en sentido horario a partir del norte.

Sintaxis

angle_at_vertex ( geometry , vertex )

Argumentos

geometry una geometría de cadena de línea
vertex vertex index, starting from 0; if the value is negative, the selected vertex index will be its total count minus the absolute value

Ejemplos

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

función area

Devuelve el área de un objeto de geometría de tipo polígono. Los cálculos siempre son planimétricos en el Sistema de Rerefencia Espacial (SRE) de esta geometría y las unidades del área devuelta coincidirán con las unidades del SRE. Esto difiere de los cálculos hechos por la función $area, que hará cálculos elipsoidales basados en el elipsoide del proyecto y la configuración de las unidades de superficie.

Sintaxis

area ( geometry )

Argumentos

geometry objeto de geometría poligonal

Ejemplos

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

función azimuth

Devuelve el azimut basado en el Norte como el ángulo en radianes medido en sentido horario desde la vertical en el punto_A al Punto_b.

Sintaxis

azimuth ( point_a , point_b )

Argumentos

point_a geometría de punto
point_b geometría de punto

Ejemplos

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

función boundary

Devuelve el cierre del límite combinatorio de la geometría (es decir, el límite topológico de la geometría). Por ejemplo, una geometría de polígono tendrá un límite que consta de líneas para cada anillo en el polígono. Algunos tipos de geometría no tienen un límite definido, por ejemplo, puntos o colecciones de geometrías, y se devolverán nulos.

Sintaxis

boundary ( geometry )

Argumentos

geometry una geometría

Ejemplos

  • 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)'

función bounds

Devuelve una geometría que representa el recuadro delimitador de una geometría de entrada. Los cálculos están en el Sistema de Referencia Espacial de esta geometría.

Sintaxis

bounds ( geom )

Argumentos

geom una geometría

Ejemplos

  • bounds($geometry) → recuadro delimitador de $geometry

función bounds_height

Devuelve la altura del recuadro delimitador de una geometría. Los cálculos están en el Sistema de Referencia Espacial de esta geometría.

Sintaxis

bounds_height ( geom )

Argumentos

geom una geometría

Ejemplos

  • bounds_height($geometry) → altura del recuadro delimitador de $geometry

función bounds_width

Devuelve la anchura del recuadro delimitador de una geometría. Los cálculos están en el Sistema de Referencia Espacial de esta geometría.

Sintaxis

bounds_width ( geom )

Argumentos

geom una geometría

Ejemplos

  • bounds_width($geometry) → anchura del recuadro delimitador de $geometry

función buffer

Devuelve una geometría que representa todos los puntos cuya distancia desde esta geometría es menor o igual que distancia. Los cálculos están en el Sistema de Referencia Espacial de esta geometría.

Sintaxis

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

[ ] marque componentes opcionales

Argumentos

geom una geometría
distance distancia de buffer en unidades de la capa
segments número de segmentos a usar para representar un cuarto de círculo cuando se utilice un estilo de unión redondo. Un número mayor da como resultado un buffer más suave con más nodos.

Ejemplos

  • buffer($geometry, 10.5) → polígono de $geometry con un buffer de 10.5 unidades

función buffer_by_m

Creates a buffer along a line geometry where the buffer diameter varies according to the m-values at the line vertices.

Sintaxis

buffer_by_m ( geometry [, segments=8 ])

[ ] marque componentes opcionales

Argumentos

geometry geometría de entrada. Debe ser una geometría (de varias líneas) con valores m.
segments número de segmentos para aproximar las curvas del un cuarto de círculo en el buffer.

Ejemplos

  • buffer_by_m(geometry:=geom_from_wkt('LINESTRINGM(1 2 0.5, 4 2 0.2)'),segments:=8) → Un búfer de ancho variable que comienza con un diámetro de 0.5 y termina con un diámetro de 0.2 a lo largo de la geometría lineal.

función centroid

Devuelve el centro geométrico de una geometría.

Sintaxis

centroid ( geom )

Argumentos

geom una geometría

Ejemplos

  • centroid($geometry) → una geometría de punto

función 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.

Sintaxis

close_line ( geometry )

Argumentos

geometry una geometría de cadena de línea

Ejemplos

  • 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)

función closest_point

Returns the point on geometry1 that is closest to geometry2.

Sintaxis

closest_point ( geometry1 , geometry2 )

Argumentos

geometry1 geometría en la que encontrar el punto más cercano
geometry2 geometría a la que encontrar el punto más cercano

Ejemplos

  • 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)

función collect_geometries

Collects a set of geometries into a multi-part geometry object.

List of arguments variant

Geometry parts are specified as separate arguments to the function.

Sintaxis

collect_geometries ( geometry1 , geometry2 …)

Argumentos

geometry una geometría

Ejemplos

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

Array variant

Geometry parts are specified as an array of geometry parts.

Sintaxis

collect_geometries ( array )

Argumentos

array array of geometry objects

Ejemplos

  • 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))'

función combine

Devuelve la combinación de dos geometrías.

Sintaxis

combine ( geometry1 , geometry2 )

Argumentos

geometry1 una geometría
geometry2 una geometría

Ejemplos

  • 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)

función contains

Comprueba si una geometría contiene a otra. Devuelve verdadero si y solo si ningún punto de la geometría b cae en el exterior de la geometría a y al menos un punto del interior de b cae en el interior de a.

Sintaxis

contains ( geometry a , geometry b )

Argumentos

geometry a una geometría
geometry b una geometría

Ejemplos

  • contains( geom_from_wkt( 'POLYGON((0 0, 0 1, 1 1, 1 0, 0 0))' ), geom_from_wkt( 'POINT(0.5 0.5 )' ) ) → verdadero
  • 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)' ) ) → falso

función convex_hull

Devuelve la envolvente convexa de una geometría. Representa la geometría convexa mínima que encierra todas las geometrías del conjunto.

Sintaxis

convex_hull ( geometry )

Argumentos

geometry una geometría

Ejemplos

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

función crosses

Comprueba si una geometría cruza otra. Devuelve verdadero si las geometrías proporcionadas tienen algún punto interior en común, pero no todos.

Sintaxis

crosses ( geometry a , geometry b )

Argumentos

geometry a una geometría
geometry b una geometría

Ejemplos

  • crosses( geom_from_wkt( 'LINESTRING(3 5, 4 4, 5 3)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → verdadero
  • crosses( geom_from_wkt( 'POINT(4 5)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → falso

función difference

Devuelve una geometría que representa la parte de la geometría_a que no interseca con la geometría_b.

Sintaxis

difference ( geometry_a , geometry_b )

Argumentos

geometry_a una geometría
geometry_b una geometría

Ejemplos

  • 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)

función disjoint

Comprueba si las geometría no se intersecan espacialmente. Devuelve verdadero si las geometrías no comparten ningún espacio en común.

Sintaxis

disjoint ( geometry a , geometry b )

Argumentos

geometry a una geometría
geometry b una geometría

Ejemplos

  • 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)' ) ) → verdadero
  • disjoint( geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ), geom_from_wkt( 'POINT(4 4)' )) → falso

función distance

Devuelve la distancia mínima (basada en la referencia espacial) entre dos geometrías en unidades proyectadas.

Sintaxis

distance ( geometry a , geometry b )

Argumentos

geometry a una geometría
geometry b una geometría

Ejemplos

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

función distance_to_vertex

Devuelve la distancia a lo largo de la geometría a un vértice especificado.

Sintaxis

distance_to_vertex ( geometry , vertex )

Argumentos

geometry una geometría de cadena de línea
vertex vertex index, starting from 0; if the value is negative, the selected vertex index will be its total count minus the absolute value

Ejemplos

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

función end_point

Devuelve el último nodo de una geometría.

Sintaxis

end_point ( geometry )

Argumentos

geometry objeto de geometría

Ejemplos

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

función extend

Extiende el inicio y final de una geometría de cadena de líneas en una cantidad especificada. Las líneas se extienden usando el rumbo del primer y último segmentos de la línea. Las distancias están el Sistema de Referencia Espacial de esta geometría.

Sintaxis

extend ( geometry , start_distance , end_distance )

Argumentos

geometry una geometría de (multi)cadena de líneas
start_distance distancia a extender el inicio de la línea
end_distance distancia a extender el final de la línea.

Ejemplos

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

función exterior_ring

Devuelve una cadena de línea que representa el anillo exterior de una geometría de tipo polígono. Si la geometría no es un polígono entonces el resultado será nulo.

Sintaxis

exterior_ring ( geom )

Argumentos

geom una geometría de polígono

Ejemplos

  • 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)'

función extrude

Devuelve una versión extruida de la geometría de entrada (multi)curva o (multi)línea, con una extensión especificada por X e Y.

Sintaxis

extrude ( geom , x , y )

Argumentos

geom una geometría de polígono
x extensión X, valor numérico
y extensión Y, valor numérico

Ejemplos

  • 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)))

función flip_coordinates

Returns a copy of the geometry with the x and y coordinates swapped. Useful for repairing geometries which have had their latitude and longitude values reversed.

Sintaxis

flip_coordinates ( geom )

Argumentos

geom una geometría

Ejemplos

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

función force_rhr

Forces a geometry to respect the Right-Hand-Rule, in which the area that is bounded by a polygon is to the right of the boundary. In particular, the exterior ring is oriented in a clockwise direction and the interior rings in a counter-clockwise direction.

Sintaxis

force_rhr ( geom )

Argumentos

geom a geometry. Any non-polygon geometries are returned unchanged.

Ejemplos

  • 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))

función geom_from_gml

Devuelve una geometría a partir de una representación GML de geometría.

Sintaxis

geom_from_gml ( gml )

Argumentos

gml Representación GML de una geometría como una cadena

Ejemplos

  • geom_from_gml('<gml:LineString srsName="EPSG:4326"><gml:coordinates>4,4 5,5 6,6</gml:coordinates></gml:LineString>') → a line geometry object

función geom_from_wkb

Returns a geometry created from a Well-Known Binary (WKB) representation.

Sintaxis

geom_from_wkb ( binary )

Argumentos

binary Well-Known Binary (WKB) representation of a geometry (as a binary blob)

Ejemplos

  • geom_from_wkb( geom_to_wkb( make_point(4,5) ) ) → a point geometry object

función geom_from_wkt

Devuelve una geometría creada a partir de una representación WKT (Texto Bien Conocido).

Sintaxis

geom_from_wkt ( text )

Argumentos

text Representación WKT (Texto Bien Conocido) de una geometría

Ejemplos

  • geom_from_wkt( 'POINT(4 5)' ) → un objeto de geometría

función geom_to_wkb

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

Sintaxis

geom_to_wkb ( geometry )

Argumentos

geometry una geometría

Ejemplos

  • geom_to_wkb( $geometry ) → binary blob containing a geometry object

función geom_to_wkt

Devuelve una representación WKT (Texto Bien Conocido) de la geometría sin metadatos SRID.

Sintaxis

geom_to_wkt ( geometry [, precision ])

[ ] marque componentes opcionales

Argumentos

geometry una geometría
precision numeric precision

Ejemplos

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

función geometry

Devuelve la geometría de un objeto.

Sintaxis

geometry ( feature )

Argumentos

feature un objeto espacial

Ejemplos

  • geom_to_wkt( geometry( get_feature( capa, campo, valor ) ) ) → 'PUNTO(6 50)'
  • intersects( $geometry, geometry( get_feature( capa, campo, valor ) ) ) → verdadero

función geometry_n

Devuelve una geometría específica a partir de una colección de geometrías o nulo si la geometría de entrada no es una colección.

Sintaxis

geometry_n ( geometry , index )

Argumentos

geometry colección de geometrías
index índice de la geometría a devolver, donde 1 es la primera geometría de la colección

Ejemplos

  • 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)'

función hausdorff_distance

Devuelve la distancia de Hausdorff entre dos geometrías. Esto es básicamente una medida de cómo de similares o diferentes son dos geometrías, con una distancia menor indicando geometrías más parecidas.
La función se puede ejecutar con un argumento fracción de densificación opcional. Si no se especifica se usará una aproximación de la distancia estándar de Hausdorff. Esta aproximación es exacta o suficientemente aproximada para un gran subconjunto de casos útiles. Ejemplos de esto son:

  • procesar la distancia entre cadenas de líneas que son aproximadamente paralelas entre sí y aproximadamente iguales en longitud. Esto ocurre en redes lineales coincidentes.
  • Probar similitud de geometrías.


  • Si la aproximación predeterminada por este método es insuficiente, especifique el argumento opcional fracción de densificación. Al especificar este argumento se realiza una densificación de segmentos antes de procesar la distancia discreta de Hausdorff. El parámetro establece la fracción por la que densificar cada segmento. Cada segmento se dividirá en un número de subsegmentos de igual longitud, cuya fracción de la longitud total es la más cercana a la fracción dada. Disminuir el parámetro fracción de densificación hará que la distancia devuelta se aproxime a la distancia de Hausdorff verdadera para las geometrías.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    geometry a una geometría
    geometry b una geometría
    densify_fraction Densificar la cantidad de fracciones

    Ejemplos

    • 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

    función inclination

    Devuelve la inclinación medida desde el cénit (0) al nadir (180) en el punto A al punto B.

    Sintaxis

    inclination ( point_a , point_b )

    Argumentos

    point_a geometría de punto
    point_b geometría de punto

    Ejemplos

    • 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

    función interior_ring_n

    Devuelve un anillo interior específico de una geometría de tipo polígono o nulo si la geometría no es un polígono.

    Sintaxis

    interior_ring_n ( geometry , index )

    Argumentos

    geometry geometría de tipo polígono
    index índice del interior a devolver, donde 1 es el primer anillo interior

    Ejemplos

    • 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))'

    función intersection

    Devuelve una geometría que representa la parte compartida de dos geometrías.

    Sintaxis

    intersection ( geometry1 , geometry2 )

    Argumentos

    geometry1 una geometría
    geometry2 una geometría

    Ejemplos

    • 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)

    función intersects

    Comprueba si una geometría se interseca con otra. Devuelve verdadero si las geometrías se intersecan espacialmente (comparten alguna porción de espacio) y falso en caso contrario.

    Sintaxis

    intersects ( geometry a , geometry b )

    Argumentos

    geometry a una geometría
    geometry b una geometría

    Ejemplos

    • intersects( geom_from_wkt( 'POINT(4 4)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → verdadero
    • intersects( geom_from_wkt( 'POINT(4 5)' ), geom_from_wkt( 'POINT(5 5)' ) ) → falso

    función intersects_bbox

    Comprueba si el recuadro delimitador de una geometría solapa con el de otra geometría. Devuelve verdadero si los recuadros delimitadores de las geometrías se intersecan espacialmente y falso en caso contrario.

    Sintaxis

    intersects_bbox ( geometry , geometry )

    Argumentos

    geometry una geometría
    geometry una geometría

    Ejemplos

    • intersects_bbox( geom_from_wkt( 'POINT(4 5)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → verdadero
    • intersects_bbox( geom_from_wkt( 'POINT(6 5)' ), geom_from_wkt( 'POLYGON((3 3, 4 4, 5 5, 3 3))' ) ) → falso

    función is_closed

    Devuelve verdadero si una cadena de línea está cerrada (los puntos de inicio y final coinciden) o falso si la cadena de línea no está cerrada. Si la geometría no es una cadena de línea entonces el resultado será nulo.

    Sintaxis

    is_closed ( geom )

    Argumentos

    geom una geometría de cadena de línea

    Ejemplos

    • is_closed(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)')) → falso
    • is_closed(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2, 0 0)')) → verdadero

    función is_empty

    Returns true if a geometry is empty (without coordinates), false if the geometry is not empty and NULL if there is no geometry. See also `is_empty_or_null`.

    Sintaxis

    is_empty ( geom )

    Argumentos

    geom una geometría

    Ejemplos

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

    función is_empty_or_null

    Returns true if a geometry is NULL or empty (without coordinates) or false otherwise. This function is like the expression '$geometry IS NULL or is_empty($geometry)'

    Sintaxis

    is_empty_or_null ( geom )

    Argumentos

    geom una geometría

    Ejemplos

    • is_empty_or_null(NULL) → verdadero
    • is_empty_or_null(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2)')) → falso
    • is_empty_or_null(geom_from_wkt('LINESTRING EMPTY')) → verdadero
    • is_empty_or_null(geom_from_wkt('POINT(7 4)')) → falso
    • is_empty_or_null(geom_from_wkt('POINT EMPTY')) → verdadero

    función is_multipart

    Returns true if the geometry is of Multi type.

    Sintaxis

    is_multipart ( geometry )

    Argumentos

    geometry una geometría

    Ejemplos

    • is_multipart(geom_from_wkt('MULTIPOINT ((0 0),(1 1),(2 2))')) → verdadero
    • is_multipart(geom_from_wkt('POINT (0 0)')) → falso

    función is_valid

    Returns true if a geometry is valid; if it is well-formed in 2D according to the OGC rules.

    Sintaxis

    is_valid ( geom )

    Argumentos

    geom una geometría

    Ejemplos

    • is_valid(geom_from_wkt('LINESTRING(0 0, 1 1, 2 2, 0 0)')) → verdadero
    • is_valid(geom_from_wkt('LINESTRING(0 0)')) → falso

    función length

    Devuelve el número de caracteres de una cadena o la longitud de la cadena que define una geometría.

    Variante de cadena

    Devuelve el número de caracteres de una cadena.

    Sintaxis

    length ( string )

    Argumentos

    string cadena de la que medir la longitud

    Ejemplos

    • length('hola') → 5

    Variante de geometría

    Calcula la longitud de un objeto de geometría lineal. Los cálculos siempre son planimétricos en el Sistema de Rerefencia Espacial (SRE) de esta geometría y las unidades de la longitud devuelta coincidirán con las unidades del SRE. Esto difiere de los cálculos hechos por la función $lenght, que hará cálculos elipsoidales basados en el elipsoide del proyecto y la configuración de las unidades de longitud.

    Sintaxis

    length ( geometry )

    Argumentos

    geometry objeto de geometría lineal

    Ejemplos

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

    función line_interpolate_angle

    Devuelve el ángulo paralelo a la geometría a una distancia especificada a lo largo de una geometría cadena de líneas (linestring). Los ángulos están en grados en sentido horario desde el Norte.

    Sintaxis

    line_interpolate_angle ( geometry , distance )

    Argumentos

    geometry una geometría de cadena de línea
    distance distancia a lo largo de la línea a la que interpolar el ángulo

    Ejemplos

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

    función line_interpolate_point

    Devuelve el punto interpolado a una distancia especificada a lo largo de una geometría cadena de líneas (linestring).

    Sintaxis

    line_interpolate_point ( geometry , distance )

    Argumentos

    geometry una geometría de cadena de línea
    distance distancia a lo largo de la línea a la que interpolar

    Ejemplos

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

    función line_locate_point

    Devuelve la distancia a lo largo de un cadena de líneas que corresponde a la posición más cercana a la que llega la línea de una geometría de punto especificada.

    Sintaxis

    line_locate_point ( geometry , point )

    Argumentos

    geometry una geometría de cadena de línea
    point geometría de punto a la que encontrar la posición más cercana desde la cadena de líneas

    Ejemplos

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

    función line_merge

    Devuelve una cadena de líneas o multicadena de líneas en la que cualquier cadena de líneas conectada desde la geometría de entrada se ha combinado en una única cadena de líneas. Esta función devolverá nulo si se pasa una geometría que no es una cadena de líneas/multicadena de líneas.

    Sintaxis

    line_merge ( geometry )

    Argumentos

    geometry una geometría cadena de líneas/multicadena de líneas

    Ejemplos

    • 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)'

    función line_substring

    Returns the portion of a line (or curve) geometry which falls between the specified start and end distances (measured from the beginning of the line). Z and M values are linearly interpolated from existing values.

    Sintaxis

    line_substring ( geometry , start_distance , end_distance )

    Argumentos

    geometry a linestring or curve geometry
    start_distance distancia al inicio de la subcadena
    end_distance distancia al final de la subcadena

    Ejemplos

    • 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)'

    función m

    Devuelve el valor m de una geometría de punto.

    Sintaxis

    m ( geom )

    Argumentos

    geom una geometría de punto

    Ejemplos

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

    función m_max

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

    Sintaxis

    m_max ( geometry )

    Argumentos

    geometry a geometry containing m values

    Ejemplos

    • 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

    función m_min

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

    Sintaxis

    m_min ( geometry )

    Argumentos

    geometry a geometry containing m values

    Ejemplos

    • 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

    función make_circle

    Crea un polígono circular.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    center punto centro del círculo
    radius radio del círculo
    segment argumento opcional para la segmentación de polígonos. Por omisión, este valor es 36.

    Ejemplos

    • 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))'

    función make_ellipse

    Crea un polígono elíptico.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    center punto centro de la elipse
    semi_major_axis semieje mayor de la elipse
    semi_minor_axis semieje menor de la elipse
    azimuth orientación de la elipse
    segment argumento opcional para la segmentación de polígonos. Por omisión, este valor es 36.

    Ejemplos

    • 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))'

    función make_line

    Crea una geometría de línea a partir de una serie de geometrías de puntos.

    List of arguments variant

    Line vertices are specified as separate arguments to the function.

    Sintaxis

    make_line ( point1 , point2 …)

    Argumentos

    point a point geometry (or array of points)

    Ejemplos

    • 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)'

    Array variant

    Line vertices are specified as an array of points.

    Sintaxis

    make_line ( array )

    Argumentos

    array array of points

    Ejemplos

    • 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)'

    función make_point

    Crea una geometría de punto a partir de unos valores de X e Y (y opcionalmente Z).

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    x Coordenada X del punto
    y Coordenada Y del punto
    z coordenada Z opcional del punto
    m valor m opcional de punto

    Ejemplos

    • 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)'

    función make_point_m

    Crea una geometría de punto a partir de una coordenada X, Y y un valor m.

    Sintaxis

    make_point_m ( x , y , m )

    Argumentos

    x Coordenada X del punto
    y Coordenada Y del punto
    m valor m de punto

    Ejemplos

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

    función make_polygon

    Crea una geometría de polígono a partir de un anillo exterior y series opcionales de geometrías interiores de anillo.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    outerRing geometría de línea cerrada para anillo exterior del polígono
    innerRing geometría de línea cerrada opcional para anillo interior

    Ejemplos

    • 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))'

    función make_rectangle_3points

    Creates a rectangle from 3 points.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    point1 Primer punto.
    point2 Segundo punto.
    point3 Tercer punto.
    option An optional argument to construct the rectangle. By default this value is 0. Value can be 0 (distance) or 1 (projected). Option distance: Second distance is equal to the distance between 2nd and 3rd point. Option projected: Second distance is equal to the distance of the perpendicular projection of the 3rd point on the segment or its extension.

    Ejemplos

    • 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))'

    función make_regular_polygon

    Crea un polígono regular.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    center centro del polígono regular
    radius segundo punto. El primero si el polígono regular es inscrito. El punto central de la primera cara si el polígono regular es circunscrito.
    number_sides Número de caras/bordes del polígono regular
    circle Argumento opcional para construir el polígono regular. Por omisión este valor es 0. El valor puede ser 0 (inscrito) o 1 (circunscrito).

    Ejemplos

    • 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))'

    función make_square

    Creates a square from a diagonal.

    Sintaxis

    make_square ( point1 , point2 …)

    Argumentos

    point1 First point of the regular polygon
    point2 Segundo punto

    Ejemplos

    • 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))'

    función make_triangle

    Crea un polígono triangular.

    Sintaxis

    make_triangle ( point 1 , point 2 , point 3 )

    Argumentos

    point 1 primer punto del triángulo
    point 2 segundo punto del triángulo
    point 3 tercer punto del triángulo

    Ejemplos

    • 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)'

    función minimal_circle

    Devuelve el círculo envolvente mínimo de una geometría. Representa el círculo mínimo que encierra todas las geometrías del conjunto.

    Sintaxis

    minimal_circle ( geometry [, segment=36 ])

    [ ] marque componentes opcionales

    Argumentos

    geometry una geometría
    segment argumento opcional para la segmentación de polígonos. Por omisión, este valor es 36.

    Ejemplos

    • 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))

    función nodes_to_points

    Devuelve una geometría multipunto consistente en cada nodo de la geometría de entrada.

    Sintaxis

    nodes_to_points ( geometry [, ignore_closing_nodes=false ])

    [ ] marque componentes opcionales

    Argumentos

    geometry objeto de geometría
    ignore_closing_nodes argumento opcional que especifica si incluir nodos duplicados que cierran líneas o anillos de polígonos. El valor predeterminado es falso, establecer a verdadero para evitar incluir estos nodos duplicados en la colección de salida.

    Ejemplos

    • 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))'

    función num_geometries

    Devuelve el número de geometrías en una colección de geometrías o nulo si la geometría de entrada no es una colección.

    Sintaxis

    num_geometries ( geometry )

    Argumentos

    geometry colección de geometrías

    Ejemplos

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

    función num_interior_rings

    Devuelve el número de anillos interiores de un polígono o una colección de geometrías o nulo si la geometría de entrada no es un polígono o una colección.

    Sintaxis

    num_interior_rings ( geometry )

    Argumentos

    geometry geometría de entrada

    Ejemplos

    • 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

    función num_points

    Devuelve el número de vértices de una geometría.

    Sintaxis

    num_points ( geom )

    Argumentos

    geom una geometría

    Ejemplos

    • num_points($geometry) → número de vértices en $geometry

    función num_rings

    Devuelve el número de anillos (incluidos los anillos exteriores) de un polígono o una colección de geometrías o nulo si la geometría de entrada no es un polígono o una colección.

    Sintaxis

    num_rings ( geometry )

    Argumentos

    geometry geometría de entrada

    Ejemplos

    • 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

    función offset_curve

    Devuelve una geometría formada desplazando una geometría de línea hacia un lado. Las distancias están en el Sistema de Referencia Espacial de esta geometría.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    geometry una geometría de (multi)cadena de líneas
    distance distancia de desplazamiento. Para valores positivos se hará un buffer a la izquierda de las líneas y para valores negativos para la derecha.
    segments número de segmentos a usar para representar un cuarto de círculo cuando se utilice un estilo de unión redondo. Un número mayor da como resultado una línea más suave con más nodos.
    join estilo de unión para esquinas, donde 1 = redondo, 2 = inglete y 3 = bisel
    miter_limit límite en el radio del inglete utilizado para esquinas muy agudas (solamente al utilizar uniones en inglete)

    Ejemplos

    • offset_curve($geometry, 10.5) → desplazamiento de línea a la izquierda en 10,5 unidades
    • offset_curve($geometry, -10.5) → desplazamiento de línea a la derecha en 10,5 unidades
    • offset_curve($geometry, 10.5, segments=16, join=1) → desplazamiento de línea a la izquierda en 10,5 unidades, usando más segmentos para obtener una curva más suave
    • offset_curve($geometry, 10.5, join=3) → desplazamiento de línea a la izquierda por 10.5 unidades, usando una unión en bisel

    función order_parts

    Ordena las partes de una MultiGeometría por los criterios dados

    Sintaxis

    order_parts ( geom , orderby , ascending )

    Argumentos

    geom una geometría multi tipo
    orderby una cadena de expresión que define los criterios de ordenación
    ascending lógico, Verdadero para ascendente, Falso para descendente

    Ejemplos

    • 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)

    función oriented_bbox

    Devuelve una geometría que representa el recuadro delimitador orientado mínimo de una geometría de entrada.

    Sintaxis

    oriented_bbox ( geom )

    Argumentos

    geom una geometría

    Ejemplos

    • 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))

    función overlaps

    Comprueba si una geometría solapa con otra. Devuelve verdadero si las geometrías comparten espacio, son de la misma dimensión, pero no están contenidas en la otra.

    Sintaxis

    overlaps ( geometry a , geometry b )

    Argumentos

    geometry a una geometría
    geometry b una geometría

    Ejemplos

    • overlaps( geom_from_wkt( 'LINESTRING(3 5, 4 4, 5 5, 5 3)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → verdadero
    • overlaps( geom_from_wkt( 'LINESTRING(0 0, 1 1)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → falso

    función perimeter

    Devuelve el perímetro de un objeto de geometría de tipo polígono. Los cálculos siempre son planimétricos en el Sistema de Rerefencia Espacial (SRE) de esta geometría y las unidades del perímetro devuelto coincidirán con las unidades del SRE. Esto difiere de los cálculos hechos por la función $perimeter, que hará cálculos elipsoidales basados en el elipsoide del proyecto y la configuración de las unidades de distancia.

    Sintaxis

    perimeter ( geometry )

    Argumentos

    geometry objeto de geometría poligonal

    Ejemplos

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

    función point_n

    Devuelve un nodo específico de una geometría.

    Sintaxis

    point_n ( geometry , index )

    Argumentos

    geometry objeto de geometría
    index index of node to return, where 1 is the first node; if the value is negative, the selected vertex index will be its total count minus the absolute value

    Ejemplos

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

    función point_on_surface

    Devuelve un punto garantizando que cae en la superficie de una geometría.

    Sintaxis

    point_on_surface ( geom )

    Argumentos

    geom una geometría

    Ejemplos

    • point_on_surface($geometry) → una geometría de punto

    función pole_of_inaccessibility

    Calcula el polo aproximado de inaccesibilidad para una superficie, que es el punto interno de una superficie más distante del borde de la superficie. Esta función usa el algoritmo "polylabel" (Vladimir Agafonkin, 2016), que es una aproximación iterativa que garantiza encontrar el polo real de inaccesibilidad dentro de una tolerancia especificada. Tolerancias más precisas requieren más iteraciones y llevará más tiempo calcularlas.

    Sintaxis

    pole_of_inaccessibility ( geometry , tolerance )

    Argumentos

    geometry una geometría
    tolerance distancia máxima entre el punto devuelto y la localización del polo verdadero

    Ejemplos

    • 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)

    función project

    Returns a point projected from a start point using a distance, a bearing (azimuth) and an elevation in radians.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    point punto de inicio
    distance distancia a proyectar
    azimuth azimuth in radians clockwise, where 0 corresponds to north
    elevation angle of inclination in radians

    Ejemplos

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

    función relate

    Prueba la representación del Modelo de Intersección 9 Extendido Dimensional (DE-9IM) de la relación entre dos geometrías.

    Variante de relación

    Devuelve la representación del Modelo de Intersección 9 Extendido Dimensional (DE-9IM) de la relación entre dos geometrías.

    Sintaxis

    relate ( geometry , geometry )

    Argumentos

    geometry una geometría
    geometry una geometría

    Ejemplos

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

    Variante de coincidencia de patrón

    Prueba si la relación DE-9IM entre dos geometrías coincide con el patrón especificado.

    Sintaxis

    relate ( geometry , geometry , pattern )

    Argumentos

    geometry una geometría
    geometry una geometría
    pattern Patrón DE-9IM con el que coincidir

    Ejemplos

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

    función reverse

    Cambia el sentido de una línea invirtiendo el orden de sus vértices.

    Sintaxis

    reverse ( geom )

    Argumentos

    geom una geometría

    Ejemplos

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

    función rotate

    Returns a rotated version of a geometry. Calculations are in the Spatial Reference System of this geometry.

    Sintaxis

    rotate ( geom , rotation [, point ])

    [ ] marque componentes opcionales

    Argumentos

    geom una geometría
    rotation clockwise rotation in degrees
    point rotation center point. If not specified, the center of the geometry's bounding box is used.

    Ejemplos

    • rotate($geometry, 45, make_point(4, 5)) → geometry rotated 45 degrees clockwise around the (4, 5) point
    • rotate($geometry, 45) → geometry rotated 45 degrees clockwise around the center of its bounding box

    función segments_to_lines

    Devuelve una geometría multilínea que consiste en una línea para cada segmento de la geometría de entrada.

    Sintaxis

    segments_to_lines ( geometry )

    Argumentos

    geometry objeto de geometría

    Ejemplos

    • 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))'

    función shortest_line

    Returns the shortest line joining geometry1 to geometry2. The resultant line will start at geometry1 and end at geometry2.

    Sintaxis

    shortest_line ( geometry1 , geometry2 )

    Argumentos

    geometry1 geometría desde la que encontrar la línea más corta
    geometry2 geometría hasta la que encontrar la línea más corta

    Ejemplos

    • 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)

    función simplify

    Simplifica una geometría eliminando nodos usando un margen basado en distancia (esto es, el algoritmo Douglas Peucker). El algoritmo conserva grandes desviaciones de las geometrías y reduce el número de vértices en segmentos prácticamente rectos.

    Sintaxis

    simplify ( geometry , tolerance )

    Argumentos

    geometry una geometría
    tolerance desviación máxima de segmentos rectos para eliminar puntos

    Ejemplos

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

    función simplify_vw

    Simplifica una geometría eliminando nodos usando un margen basado en área (esto es, el algoritmo Visvalingam-Whyatt). El algoritmo elimina vértices que crean pequeñas áreas en las geometrías, por ejemplo salientes estrechos o segmentos prácticamente rectos.

    Sintaxis

    simplify_vw ( geometry , tolerance )

    Argumentos

    geometry una geometría
    tolerance una medida del área máxima creada por un nodo para eliminar el nodo

    Ejemplos

    • 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)'

    función single_sided_buffer

    Devuelve una geometría formada haciendo un buffer de una geometría de línea hacia un lado. Las distancias están en el Sistema de Referencia Espacial de esta geometría.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    geometry una geometría de (multi)cadena de líneas
    distance distancia de buffer. Para valores positivos se hará un buffer a la izquierda de las líneas y para valores negativos a la derecha.
    segments número de segmentos a usar para representar un cuarto de círculo cuando se utilice un estilo de unión redondo. Un número mayor da como resultado un buffer más suave con más nodos.
    join estilo de unión para esquinas, donde 1 = redondo, 2 = inglete y 3 = bisel
    miter_limit límite en el radio del inglete utilizado para esquinas muy agudas (solamente al utilizar uniones en inglete)

    Ejemplos

    • single_sided_buffer($geometry, 10.5) → línea hecha buffer a la izquierda en 10,5 unidades
    • single_sided_buffer($geometry, -10.5) → línea hecha buffer a la derecha en 10,5 unidades
    • single_sided_buffer($geometry, 10.5, segments=16, join=1) → buffer de línea a la izquierda en 10.5 unidades, usando más segmentos para obtener un buffer más suabe.
    • single_sided_buffer($geometry, 10.5, join=3) → línea hecha buffer a la izquierda por 10.5 unidades, usando una unión en bisel

    función smooth

    Smooths a geometry by adding extra nodes which round off corners in the geometry. If input geometries contain Z or M values, these will also be smoothed and the output geometry will retain the same dimensionality as the input geometry.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    geometry una geometría
    iterations número de iteraciones de suavizado a aplicar. Números grandes dan lugar a geometrías más suaves, pero más complejas.
    offset valor entre 0 y 0,5 que controla hasta qué punto se ajusta la geometría suavizada a la original. Número pequeños dan lugar a un suavizado más ajustado, mientras que números mayores dan lugar a un ajustado más laxo.
    min_length longitud mínima de segmento a la que aplicar el suavizado. Este parámetro se puede usar para evitar colocar un número excesivo de nodos adicionales en los segmentos más cortos de la geometría.
    max_angle ángulo máximo en el nodo para aplicar suavizado (0-180). Disminuyendo el ángulo máximo se pueden conservar esquinas intencionadamente agudas de la geometría. Por ejemplo, un valor de 80 grados conservará los ángulos rectos de la geometría.

    Ejemplos

    • 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)'

    función start_point

    Devuelve el primer nodo de una geometría.

    Sintaxis

    start_point ( geometry )

    Argumentos

    geometry objeto de geometría

    Ejemplos

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

    función sym_difference

    Devuelve una geometría que representa las partes de dos geometrías que no se intersecan.

    Sintaxis

    sym_difference ( geometry1 , geometry2 )

    Argumentos

    geometry1 una geometría
    geometry2 una geometría

    Ejemplos

    • 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)

    función tapered_buffer

    Crea un búfer a lo largo de una geometría lineal donde el diámetro del búfer varía uniformemente sobre la longitud de la línea.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    geometry geometría de entrada. Debe ser una geometría de (varias) líneas.
    start_width ancho del búfer al inicio de la línea,
    end_width ancho del búfer al final de la línea.
    segments número de segmentos para aproximar las curvas del un cuarto de círculo en el buffer.

    Ejemplos

    • tapered_buffer(geometry:=geom_from_wkt('LINESTRING(1 2, 4 2)'),start_width:=1,end_width:=2,segments:=8) → Un búfer estrechado comenzando con un diámetro de 1 y terminando con un diámetro de 2 a lo largo de una geometría de cadena de líneas.

    función touches

    Comprueba si una geometría toca a otra. Devuelve verdadero si las geometrías tienen al menos un punto en común, pero sus interiores no se intersecan.

    Sintaxis

    touches ( geometry a , geometry b )

    Argumentos

    geometry a una geometría
    geometry b una geometría

    Ejemplos

    • touches( geom_from_wkt( 'LINESTRING(5 3, 4 4)' ), geom_from_wkt( 'LINESTRING(3 3, 4 4, 5 5)' ) ) → verdadero
    • touches( geom_from_wkt( 'POINT(4 4)' ), geom_from_wkt( 'POINT(5 5)' ) ) → falso

    función transform

    Devuelve la geometría transformada desde un SRC de origen a otro de destino.

    Sintaxis

    transform ( geom , source_auth_id , dest_auth_id )

    Argumentos

    geom una geometría
    source_auth_id ID del SRC de origen
    dest_auth_id ID del SRC de destino

    Ejemplos

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

    función translate

    Devuelve una versión convertida de una geometría. Los cálculos se hacen en el Sistema de Referencia Espacial de la geometría.

    Sintaxis

    translate ( geom , dx , dy )

    Argumentos

    geom una geometría
    dx delta x
    dy delta y

    Ejemplos

    • convertir($geometría,5,10) → una geometría del mismo tipo que la original

    función union

    Devuelve una geometría que representa el conjunto unión de los puntos de las geometrías.

    Sintaxis

    union ( geometry1 , geometry2 )

    Argumentos

    geometry1 una geometría
    geometry2 una geometría

    Ejemplos

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

    función wedge_buffer

    Regresa un búfer en forma de cuña originado de una geometría de punto.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    center punto central (origen) del buffer. Debe ser una geometría de punto.
    azimuth ángulo (en grados) desde la mitad de la cuña a un punto.
    width ancho de búfer (en grados). Note que la cuña se extenderá a la mitad de la anchura angular por ambos lados en la dirección azimutal.
    outer_radius radio exterior para los buffers
    inner_radius radio interno opcional para buffers

    Ejemplos

    • wedge_buffer(center:=geom_from_wkt('POINT(1 2)'),azimuth:=90,width:=180,outer_radius:=1) → Un búfer en forma de cuña centrado en el punto (1,2), apuntando hacia el Este, con un ancho de 180 grados y radio externo de 1.

    función within

    Comprueba si una geometría está dentro de otra. Devuelve verdadero si la geometría a está completamente dentro de la geometría b.

    Sintaxis

    within ( geometry a , geometry b )

    Argumentos

    geometry a una geometría
    geometry b una geometría

    Ejemplos

    • within( geom_from_wkt( 'POINT( 0.5 0.5)' ), geom_from_wkt( 'POLYGON((0 0, 0 1, 1 1, 1 0, 0 0))' ) ) → verdadero
    • within( geom_from_wkt( 'POINT( 5 5 )' ), geom_from_wkt( 'POLYGON((0 0, 0 1, 1 1, 1 0, 0 0 ))' ) ) → falso

    función x

    Devuelve la coordenada X de una geometría de tipo punto o la coordenada X del centroide de una geometría que no sea de puntos.

    Sintaxis

    x ( geom )

    Argumentos

    geom una geometría

    Ejemplos

    • x( geom_from_wkt( 'POINT(2 5)' ) ) → 2
    • x( $geometría) → coordenada X del centroide del objeto actual

    función x_max

    Devuelve la coordenada X máxima de una geometría. Los cálculos están en el Sistema de Referencia Espacial de esta geometría.

    Sintaxis

    x_max ( geom )

    Argumentos

    geom una geometría

    Ejemplos

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

    función x_min

    Devuelve la coordenada X mínima de una geometría. Los cálculos están en el Sistema de Referencia Espacial de esta geometría.

    Sintaxis

    x_min ( geom )

    Argumentos

    geom una geometría

    Ejemplos

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

    función y

    Devuelve la coordenada Y de una geometría de tipo punto o la coordenada Y del centroide de una geometría que no sea de puntos.

    Sintaxis

    y ( geom )

    Argumentos

    geom una geometría

    Ejemplos

    • y( geom_from_wkt( 'POINT(2 5)' ) ) → 5
    • y( $geometría ) → coordenada Y del centroide del objeto actual

    función y_max

    Devuelve la coordenada Y máxima de una geometría. Los cálculos están en el Sistema de Referencia Espacial de esta geometría.

    Sintaxis

    y_max ( geom )

    Argumentos

    geom una geometría

    Ejemplos

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

    función y_min

    Devuelve la coordenada Y mínima de una geometría. Los cálculos están en el Sistema de Referencia Espacial de esta geometría.

    Sintaxis

    y_min ( geom )

    Argumentos

    geom una geometría

    Ejemplos

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

    función z

    Devuelve la coordenada Z de una geometría de punto.

    Sintaxis

    z ( geom )

    Argumentos

    geom una geometría de punto

    Ejemplos

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

    función z_max

    Returns the maximum z coordinate of a geometry.

    Sintaxis

    z_max ( geometry )

    Argumentos

    geometry a geometry with z coordinate

    Ejemplos

    • 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

    función z_min

    Returns the minimum z coordinate of a geometry.

    Sintaxis

    z_min ( geometry )

    Argumentos

    geometry a geometry with z coordinate

    Ejemplos

    • 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
    falta la ayuda de la función para Layout

    función item_variables

    Devuelve un mapa de variables a partir de un elemento del diseñador dentro de esta composición.

    Sintaxis

    item_variables ( id )

    Argumentos

    id ID del elemento del diseñador

    Ejemplos

    • map_get(item_variables('mapa_principal'), 'escala_de_mapa') → 2000

    grupo capas de mapa

    Contiene una lista de capas de mapa disponibles en el proyecto actual.

    función decode_uri

    Takes a layer and decodes the uri of the underlying data provider. It depends on the dataprovider, which data is available.

    Sintaxis

    decode_uri ( layer [, part ])

    [ ] marque componentes opcionales

    Argumentos

    layer The layer for which the uri should be decoded.
    part The part of the uri to return. If unspecified, a map with all uri parts will be returned.

    Ejemplos

    • 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'

    grupo mapas

    Este grupo contiene funciones de expresiones para la creación y manipulación de estructuras de datos de "mapa" (también conocidos como objetos de diccionario, pares clave-valor o matrices asociativas). Se pueden asignar valores a las claves dadas. El orden de los pares clave-valor en el objeto de mapa es irrelevante.

    función from_json

    Loads a JSON formatted string.

    Sintaxis

    from_json ( string )

    Argumentos

    string JSON texto

    Ejemplos

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

    función hstore_to_map

    Creates a map from a hstore-formatted string.

    Sintaxis

    hstore_to_map ( string )

    Argumentos

    string la cadena de entrada

    Ejemplos

    • hstore_to_map('qgis=>rocks') → { "qgis" : "rocks" }

    función json_to_map

    Creates a map from a json-formatted string.

    Sintaxis

    json_to_map ( string )

    Argumentos

    string la cadena de entrada

    Ejemplos

    • json_to_map('{"qgis":"rocks"}') → { "qgis" : "rocks" }

    función map

    Devuelve un mapa que contiene todas las claves y valores pasados como pares de parámetros.

    Sintaxis

    map ( key1 , value1 , key2 , value2 …)

    Argumentos

    key una clave (cadena)
    value un valor

    Ejemplos

    • map('1','uno','2', 'dos') → { '1': 'uno', '2': 'dos' }

    función map_akeys

    Devuelve todas las claves de un mapa como una matriz.

    Sintaxis

    map_akeys ( map )

    Argumentos

    map un mapa

    Ejemplos

    • map_akeys(map('1','uno','2','dos')) → [ '1', '2' ]

    función map_avals

    Devuelve todos los valores de un mapa como una matriz.

    Sintaxis

    map_avals ( map )

    Argumentos

    map un mapa

    Ejemplos

    • map_avals(map('1','uno','2','dos')) → [ 'uno', 'dos' ]

    función map_concat

    Devuelve un mapa que contiene todas las entradas de los mapas dados. Si dos mapas contienen la misma clave, se toma el valor del segundo mapa.

    Sintaxis

    map_concat ( map1 , map2 …)

    Argumentos

    map un mapa

    Ejemplos

    • map_concat(map('1','uno', '2','sobreescrito'),map('2','dos', '3','tres')) → { '1': 'uno, '2': 'dos', '3': 'tres' }

    función map_delete

    Devuelve un mapa con las claves dadas y sus valores correspondientes borrados.

    Sintaxis

    map_delete ( map , key )

    Argumentos

    map un mapa
    key la clave a borrar

    Ejemplos

    • map_delete(map('1','uno','2','dos'),'2') → { '1': 'uno' }

    función map_exist

    Devuelve verdadero si la clave dada existe en el mapa.

    Sintaxis

    map_exist ( map , key )

    Argumentos

    map un mapa
    key la clave a buscar

    Ejemplos

    • map_exist(map('1','uno','2','dos'),'3') → falso

    función map_get

    Devuelve el valor de un mapa, dada su clave.

    Sintaxis

    map_get ( map , key )

    Argumentos

    map un mapa
    key la clave a buscar

    Ejemplos

    • map_get(map('1','uno','2','dos'),'2') → 'dos'

    función map_insert

    Devuelve un mapa con una clave/valor añadidos.

    Sintaxis

    map_insert ( map , key , value )

    Argumentos

    map un mapa
    key la clave a añadir
    value el valor a añadir

    Ejemplos

    • map_insert(map('1','uno'),'3','tres') → { '1': 'uno', '3': 'tres' }

    función map_to_hstore

    Merge map elements into a hstore-formatted string.

    Sintaxis

    map_to_hstore ( map )

    Argumentos

    map el mapa de entrada

    Ejemplos

    • map_to_hstore(map('qgis','rocks')) → "qgis"=>"rocks"}

    función map_to_json

    Merge map elements into a json-formatted string.

    Sintaxis

    map_to_json ( map )

    Argumentos

    map el mapa de entrada

    Ejemplos

    • map_to_json(map('qgis','rocks')) → {"qgis":"rocks"}

    función to_json

    Crear una cadena en formato JSON a partir de un mapa, arreglo u otro valor.

    Sintaxis

    to_json ( value )

    Argumentos

    value El valor de entrada

    Ejemplos

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

    grupo matemáticas

    Este grupo contiene funciones matemáticas, por ejemplo raíz cuadrada, seno y coseno

    función abs

    Devuelve el valor absoluto de un número.

    Sintaxis

    abs ( value )

    Argumentos

    value un número

    Ejemplos

    • abs(-2) → 2

    función acos

    Devuelve el arco coseno de un valor en radianes.

    Sintaxis

    acos ( value )

    Argumentos

    value coseno de un ángulo en radianes

    Ejemplos

    • acos(0.5) → 1.0471975511966

    función asin

    Devuelve el arcoseno de un valor en radianes.

    Sintaxis

    asin ( value )

    Argumentos

    value seno de un ángulo en radianes

    Ejemplos

    • arcsen(1.0) → 1.5707963267949

    función atan

    Devuelve la arcotangente de un valor en radianes.

    Sintaxis

    atan ( value )

    Argumentos

    value tangente de un ángulo en radianes

    Ejemplos

    • arctan(0.5) → 0.463647609000806

    función atan2

    Devuelve la arcotangente de dy/dx usandi los signos de los dos argumentos para determinar el cuadrante del resultado.

    Sintaxis

    atan2 ( dy , dx )

    Argumentos

    dy diferencia de la coordenada Y
    dx diferencia de la coordenada Y

    Ejemplos

    • arctan2(1.0, 1.732) → 0.523611477769969

    función azimuth

    Devuelve el azimut basado en el Norte como el ángulo en radianes medido en sentido horario desde la vertical en el punto_A al Punto_b.

    Sintaxis

    azimuth ( point_a , point_b )

    Argumentos

    point_a geometría de punto
    point_b geometría de punto

    Ejemplos

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

    función ceil

    Redondea un número por arriba.

    Sintaxis

    ceil ( value )

    Argumentos

    value un número

    Ejemplos

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

    función clamp

    Restringe un valor de entrada a un rango especificado.

    Sintaxis

    clamp ( minimum , input , maximum )

    Argumentos

    minimum el valor más pequeño que puede tomar entrada .
    input un valor que se puede restringir al intervalo especificado por mínimo y máximo
    maximum el valor más grande que puede tomar entrada .

    Ejemplos

    • clamp(1,5,10) → 5 ( entrada está entre 1 y 10 así que se devuelve sin cambio)
    • clamp(1,0,10) → 1 ( entrada es menor que el valor mínimo de 1, así que la función devuelve 1)
    • clamp(1,11,10) → 10 ( entrada es mayor que el valor máximo de 10, así que la función devuelve 10)

    función cos

    Devuelve el coseno de un ángulo.

    Sintaxis

    cos ( angle )

    Argumentos

    angle ángulo en radianes

    Ejemplos

    • cos(1.571) → 0.000796326710733263

    función degrees

    Convierte de radianes a grados.

    Sintaxis

    degrees ( radians )

    Argumentos

    radians valor numérico

    Ejemplos

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

    función exp

    Devuelve la exponencial de un valor.

    Sintaxis

    exp ( value )

    Argumentos

    value número del que devolver la exponencial

    Ejemplos

    • exp(1.0) → 2.71828182845905

    función floor

    Redondea un número por abajo.

    Sintaxis

    floor ( value )

    Argumentos

    value un número

    Ejemplos

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

    función inclination

    Devuelve la inclinación medida desde el cénit (0) al nadir (180) en el punto A al punto B.

    Sintaxis

    inclination ( point_a , point_b )

    Argumentos

    point_a geometría de punto
    point_b geometría de punto

    Ejemplos

    • 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

    función ln

    Devuelve el logaritmo neperiano de un valor.

    Sintaxis

    ln ( value )

    Argumentos

    value valor numérico

    Ejemplos

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

    función log

    Devuelve el logaritmo del valor y la base pasados.

    Sintaxis

    log ( base , value )

    Argumentos

    base cualquier número positivo
    value cualquier número positivo

    Ejemplos

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

    función log10

    Devuelve el logaritmo en base 10 de la expresión pasada.

    Sintaxis

    log10 ( value )

    Argumentos

    value cualquier número positivo

    Ejemplos

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

    función max

    Devuelve el valor más grande de un conjunto de valores.

    Sintaxis

    max ( value1 , value2 …)

    Argumentos

    value un número

    Ejemplos

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

    función min

    Devuelve el valor más pequeño de un conjunto de valores.

    Sintaxis

    min ( value1 , value2 …)

    Argumentos

    value un número

    Ejemplos

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

    función pi

    Devuelve el valor de Pi para cálculos.

    Sintaxis

    pi ()

    Ejemplos

    • pi() → 3.14159265358979

    función radians

    Convierte de grados a radianes.

    Sintaxis

    radians ( degrees )

    Argumentos

    degrees valor numérico

    Ejemplos

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

    función rand

    Returns a random integer within the range specified by the minimum and maximum argument (inclusive). If a seed is provided, the returned will always be the same, depending on the seed.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    min un entero que representa el menor número aleatorio posible deseado
    max un entero que representa el mayor número aleatorio posible deseado
    seed any value to use as seed

    Ejemplos

    • rand(1, 10) → 8

    función randf

    Returns a random float within the range specified by the minimum and maximum argument (inclusive). If a seed is provided, the returned will always be the same, depending on the seed.

    Sintaxis

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

    [ ] marque componentes opcionales

    Argumentos

    min un número de coma flotante que representa el menor número aleatorio posible deseado
    max un número de coma flotante que representa el mayor número aleatorio posible deseado
    seed any value to use as seed

    Ejemplos

    • randf(1, 10) → 4.59258286403147

    función round

    Redondea un número al número de posiciones decimales.

    Sintaxis

    round ( value [, places=0 ])

    [ ] marque componentes opcionales

    Argumentos

    value número decimal a redondear
    places Entero opcional que representa el número de posiciones decimales al que redondear. Puede ser negativo.

    Ejemplos

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

    función scale_exp

    Transforma un valor dado de un dominio de entrada a un rango de salida usando una curva exponencial. Esta función se puede usar para facilitar valores dentro o fuera del rango de salida especificado.

    Sintaxis

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

    Argumentos

    val Un valor del dominio de entrada. La función devolverá un valor escalado correspondiente en el rango de salida.
    domain_min Especifica el valor mínimo del dominio de entrada, el valor más pequeño que debería tomar el valor de entrada.
    domain_max Especifica el valor máximo del dominio de entrada, el valor más grande que debería tomar el valor de entrada.
    range_min Especifica el valor mínimo del dominio de salida, el valor más pequeño que debería producir la función.
    range_max Especifica el valor máximo del dominio de salida, el valor más grande que debería producir la función.
    exponent Un valor positivo (mayor que 0) que dicta la forma en la que los valores de entrada son trasladados al rango de salida. Exponentes grandes harán que los valores de salida "converjan", comenzando lentamente antes de acelerar a medida que los valores de entrada se acercan al máximo del dominio. Exponentes más pequeños (menores que 1) harán que los valores de salida "diverjan", de forma que el traslado comienza rápidamente pero se ralentiza a medida que se aproxima al máximo del dominio.

    Ejemplos

    • scale_exp(5,0,10,0,100,2) → 25 ("convergiendo", usando un exponente de 2)
    • scale_exp(3,0,10,0,100,0.5) → 54.772 ("divergiendo", usando un exponente de 0,5)

    función scale_linear

    Transforma un valor dado de un dominio de entrada a un rango de salida usando interpolación lineal.

    Sintaxis

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

    Argumentos

    val Un valor del dominio de entrada. La función devolverá un valor escalado correspondiente en el rango de salida.
    domain_min Especifica el valor mínimo del dominio de entrada, el valor más pequeño que debería tomar el valor de entrada.
    domain_max Especifica el valor máximo del dominio de entrada, el valor más grande que debería tomar el valor de entrada.
    range_min Especifica el valor mínimo del dominio de salida, el valor más pequeño que debería producir la función.
    range_max Especifica el valor máximo del dominio de salida, el valor más grande que debería producir la función.

    Ejemplos

    • scale_linear(5,0,10,0,100) → 50
    • scale_linear(0.2,0,1,0,360) → 72 (escalando un valor entre 0 y 1 a un ángulo entre 0 y 360)
    • scale_linear(1500,1000,10000,9,20) → 9.6111111 (escalando una poblacion que varía entre 1000 y 10000 a un tamaño de letra entre 9 y 20)

    función sin

    Devuelve el seno de un ángulo.

    Sintaxis

    sin ( angle )

    Argumentos

    angle ángulo en radianes

    Ejemplos

    • sin(1.571) → 0.999999682931835

    función sqrt

    Devuelve la raíz cuadrada de un valor.

    Sintaxis

    sqrt ( value )

    Argumentos

    value un número

    Ejemplos

    • sqrt(9) → 3

    función tan

    Devuelve la tangente de un ángulo.

    Sintaxis

    tan ( angle )

    Argumentos

    angle ángulo en radianes

    Ejemplos

    • tan(1.0) → 1.5574077246549
    falta la ayuda de la función para Processing

    función parameter

    Devuelve el valor del parámetro de entrada de un algoritmo de procesos

    Sintaxis

    parameter ( name )

    Argumentos

    name nombre del parámetro de entrada correspondiente

    Ejemplos

    • parameter('BUFFER_SIZE') → 5.6
    falta la ayuda de la función para Python

    falta la ayuda de la función para $mask_geometry

    falta la ayuda de la función para in_mask

    grupo rásters

    Contains functions which calculate raster statistics and values.

    función raster_statistic

    Devuelve estadísticas de una capa ráster.

    Sintaxis

    raster_statistic ( layer , band , property )

    Argumentos

    layer una cadena que representa bien el nombre de una capa ráster o el ID de la capa
    band entero que representa el número de banda de la capa ráster, comenzando por 1
    property una cadena que corresponde a la propiedad a devolver. Las opciones válidas son:
    • min: valor mínimo
    • max: valor máximo
    • avg: valor medio
    • stdev: desviación estándar de los valores
    • range: intervalo de valores (max - min)
    • sum: suma de todos los valores del ráster

    Ejemplos

    • raster_statistic('lc',1,'avg') → Valor promedio de la banda 1 de la capa ráster 'lc'
    • raster_statistic('ac2010',3,'min') → Valor mínimo de la banda 3 de la capa ráster 'ac2010'

    función raster_value

    Devuelve el valor ráster encontrado en el punto suministrado.

    Sintaxis

    raster_value ( layer , band , point )

    Argumentos

    layer el nombre o id de una capa ráster
    band the band number to sample the value from.
    point point geometry (for multipart geometries having more than one part, a null value will be returned)

    Ejemplos

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

    grupo registros y atributos

    Este grupo contiene funciones que operan sobre identificadores de registros.

    función $currentfeature

    Devuelve el objeto espacial que está siendo evaluado. Se puede usar con la función 'attribute' para evaluar los valores de atributo del objeto actual.

    Sintaxis

    $currentfeature

    Ejemplos

    • attribute( $currentfeature, 'nombre' ) → valor guardado en el atributo 'nombre' del objeto actual

    función $id

    Devuelve el ID del objeto de la fila actual.

    Sintaxis

    $id

    Ejemplos

    • $id → 42

    función attribute

    Returns an attribute from a feature.

    Variante 1

    Devuelve el valor de un atributo del objeto actual.

    Sintaxis

    attribute ( attribute_name )

    Argumentos

    attribute_name nombre del atributo a devolver

    Ejemplos

    • attribute( 'name' ) → valor guardado en el atributo 'nombre' del objeto actual

    Variante 2

    Allows the target feature and attribute name to be specified.

    Sintaxis

    attribute ( feature , attribute_name )

    Argumentos

    feature un objeto espacial
    attribute_name nombre del atributo a devolver

    Ejemplos

    • attribute( @atlas_feature, 'nombre' ) → valor guardado en el atributo 'nombre' del objeto de atlas actual

    función attributes

    Returns a map containing all attributes from a feature, with field names as map keys.

    Variante 1

    Returns a map of all attributes from the current feature.

    Sintaxis

    attributes ()

    Ejemplos

    • attributes()['name'] → valor guardado en el atributo 'nombre' del objeto actual

    Variante 2

    Allows the target feature to be specified.

    Sintaxis

    attributes ( feature )

    Argumentos

    feature un objeto espacial

    Ejemplos

    • attributes( @atlas_feature )['name'] → valor guardado en el atributo 'nombre' del objeto de atlas actual

    función 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.

    Sintaxis

    display_expression ([ feature=current feature ][, layer=current layer ][, evaluate=true ])

    [ ] marque componentes opcionales

    Argumentos

    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).

    Ejemplos

    • 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.

    función get_feature

    Devuelve el primer objeto de una capa que coincide con un valor de atributo dado.

    Sintaxis

    get_feature ( layer , attribute , value )

    Argumentos

    layer nombre o ID de capa
    attribute nombre del atributo
    value valor de atributo con el que coincidir

    Ejemplos

    • get_feature('calles','nombre','calle principal') → primer objeto encontrado en la capa "calles" con el valor "calle principal" en el campo "nombre"

    función get_feature_by_id

    Devuelve el objeto de una capa con una ID.

    Sintaxis

    get_feature_by_id ( layer , feature_id )

    Argumentos

    layer capa, nombre de capa o ID de capa
    feature_id la ID del objeto que se debe devolver

    Ejemplos

    • get_feature('calles', 1) → el objeto con ID 1 de la capa "calles"

    función 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.

    Sintaxis

    is_selected ()

    Ejemplos

    • está_seleccionado() → 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.

    Sintaxis

    is_selected ( feature )

    Argumentos

    feature El objeto que se debería comprobar si está o no seleccionado.

    Ejemplos

    • 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.

    Sintaxis

    is_selected ( layer , feature )

    Argumentos

    layer The layer (or its ID or name) on which the selection will be checked.
    feature El objeto que se debería comprobar si está o no seleccionado.

    Ejemplos

    • 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').

    función 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.

    Sintaxis

    maptip ([ feature=current feature ][, layer=current layer ][, evaluate=true ])

    [ ] marque componentes opcionales

    Argumentos

    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).

    Ejemplos

    • 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.

    función num_selected

    Devuelve el número de objetos seleccionados de una capa dada. Por omisión se aplica a la capa en la que se evalúa la expresión.

    Sintaxis

    num_selected ([ layer=current layer ])

    [ ] marque componentes opcionales

    Argumentos

    layer La capa (o su ID o nombre) sobre la que se comprobará la selección.

    Ejemplos

    • num_selected() → El número de objetos seleccionados de la capa actual.
    • num_selected('calles') → El ńumero de objetos seleccionados de la capa calles

    función represent_value

    Returns the configured representation value for a field value. It depends on the configured widget type. Often, this is useful for 'Value Map' widgets.

    Sintaxis

    represent_value ( value , fieldName )

    Argumentos

    value El valor que se debe resolver. Probablemente un campo.
    fieldName El nombre de campo para el que se debe cargar la configuración del control. (Opcional).

    Ejemplos

    • represent_value("field_with_value_map") → Descripción para valor
    • represent_value('static value', 'field_name') → Descripción para valor estático

    función 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.

    Sintaxis

    sqlite_fetch_and_increment ( database , table , id_field , filter_attribute , filter_value [, default_values ])

    [ ] marque componentes opcionales

    Argumentos

    database Path to the sqlite file or geopackage layer
    table Name of the table that manages the sequences
    id_field Name of the field that contains the current value
    filter_attribute Name the field that contains a unique identifier for this sequence. Must have a UNIQUE index.
    filter_value Name of the sequence to use.
    default_values Map with default values for additional columns on the table. The values need to be fully quoted. Functions are allowed.

    Ejemplos

    • 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

    función uuid

    Genera un Identificador Universal Único (UUID) para cada fila usando el método QUuid::createUuid de Qt. Cada UUID tiene 38 caracteres de longitud.

    Sintaxis

    uuid ()

    Ejemplos

    • uuid() → '{0bd2f60f-f157-4a6d-96af-d4ba4cb366a1}'

    grupo cadena

    Este grupo contiene funciones que operan sobre cadenas, por ejemplo reemplazar, convertir a mayúsculas.

    función ascii

    Returns the unicode code associated with the first character of a string.

    Sintaxis

    ascii ( string )

    Argumentos

    string the string to convert to unicode code

    Ejemplos

    • ascii('Q') → 81

    función char

    Devuelve el carácter asociado con un código unicode.

    Sintaxis

    char ( code )

    Argumentos

    code un número de código unicode

    Ejemplos

    • char(81) → 'Q'

    función concat

    Concatena varias cadenas en una. Los valores NULO se convierten a cadenas vacías. Otros valores (como números) se convierten en cadenas.

    Sintaxis

    concat ( string1 , string2 …)

    Argumentos

    string un valor de cadena

    Ejemplos

    • concat('para', 'sol') → 'parasol'
    • concat('a','b','c','d','e') → 'abcde'
    • concat('Año ', 1984) → 'Año 1984'
    • concat('El Muro', NULO) → 'El Muro'

    función format

    Da formato a una cadena usando los argumentos proporcionados.

    Sintaxis

    format ( string , arg1 , arg2 …)

    Argumentos

    string Una cadena con localizadores de posición para los argumentos. Utilice %1, %2, etc. para los localizadores de posición. Los localizadores se pueden repetir.
    arg Cualquier tipo. Cualquier número de argumentos.

    Ejemplos

    • format('Esto %1 una %2','es', 'prueba') → 'Esto es una prueba'

    función format_date

    Formats a date type or string into a custom string format. Uses Qt date/time format strings. See QDateTime::toString .

    Sintaxis

    format_date ( datetime , format [, language ])

    [ ] marque componentes opcionales

    Argumentos

    datetime valor de fecha, hora o fecha y hora
    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 language (lowercase, two- or three-letter, ISO 639 language code) used to format the date into a custom string

    Ejemplos

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

    función format_number

    Returns a number formatted with the locale separator for thousands. Also truncates the decimal places to the number of supplied places.

    Sintaxis

    format_number ( number , places [, language ])

    [ ] marque componentes opcionales

    Argumentos

    number número al que aplicar el formato
    places entero que representa el número de posiciones decimales al que truncar la cadena.
    language language (lowercase, two- or three-letter, ISO 639 language code) used to format the number into a string

    Ejemplos

    • format_number(10000000.332,2) → '10.000.000.33'

    función left

    Devuelve una subcadena que contiene los n caracteres más a la izquierda de la cadena.

    Sintaxis

    left ( string , length )

    Argumentos

    string una cadena
    length Entero. El número de caracteres a devolver desde la izquierda de la cadena.

    Ejemplos

    • left('Hola Mundo',4) → 'Hola'

    función length

    Devuelve el número de caracteres de una cadena o la longitud de la cadena que define una geometría.

    Variante de cadena

    Devuelve el número de caracteres de una cadena.

    Sintaxis

    length ( string )

    Argumentos

    string cadena de la que medir la longitud

    Ejemplos

    • length('hola') → 5

    Variante de geometría

    Calcula la longitud de un objeto de geometría lineal. Los cálculos siempre son planimétricos en el Sistema de Rerefencia Espacial (SRE) de esta geometría y las unidades de la longitud devuelta coincidirán con las unidades del SRE. Esto difiere de los cálculos hechos por la función $lenght, que hará cálculos elipsoidales basados en el elipsoide del proyecto y la configuración de las unidades de longitud.

    Sintaxis

    length ( geometry )

    Argumentos

    geometry objeto de geometría lineal

    Ejemplos

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

    función lower

    Convierte una cadena a letras minúsculas.

    Sintaxis

    lower ( string )

    Argumentos

    string la cadena a convertir a minúsculas

    Ejemplos

    • lower('HOLA Mundo') → 'hola mundo'

    función lpad

    Returns a string padded on the left to the specified width, using a fill character. If the target width is smaller than the string's length, the string is truncated.

    Sintaxis

    lpad ( string , width , fill )

    Argumentos

    string cadena a ampliar
    width longitud de la nueva cadena
    fill carácter con el que rellenar los espacios restantes

    Ejemplos

    • lpad('Hola', 10, 'x') → 'xxxxxxHola'
    • lpad('Hola', 3, 'x') → 'Hel'

    función regexp_match

    Devuelve la primera posición que coincide con una expresión regular dentro de una cadena o 0 si no se encuentra la subcadena.

    Sintaxis

    regexp_match ( input_string , regex )

    Argumentos

    input_string La cadena a probar frente a la expresión regular
    regex La expresión regular frente a la que probar. El carácter barra invertida se debe escapar doblemente (ej.: "\\s" para capturar un carácter espacio en blanco).

    Ejemplos

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

    función regexp_replace

    Devuelve una cadena en la que se ha remplazado la expresión regular proporcionada.

    Sintaxis

    regexp_replace ( input_string , regex , replacement )

    Argumentos

    input_string la cadena a remplazar en las coincidencias
    regex La expresión regular a reemplazar. El carácter barra invertida se debe escapar doblemente (ej.: "\\s" para capturar un carácter espacio en blanco).
    replacement La cadena que remplazará cualquier coincidencia con la expresión regular. Los grupos capturados se pueden insertar en la cadena de remplazo usando \\1, \\2, etc.

    Ejemplos

    • regexp_replace('QGIS SERÍA GUAY','\\sSERÍA\\s',' ES ') → 'QGIS ES GUAY'

    función regexp_substr

    Devuelve la parte de una cadena que coincide con una expresión regular proporcionada.

    Sintaxis

    regexp_substr ( input_string , regex )

    Argumentos

    input_string la cadena en la que encontrar coincidencias
    regex La expresión regular frente a la que coincidir. El carácter barra invertida se debe escapar doblemente (ej.: "\\s" para capturar un carácter espacio en blanco).

    Ejemplos

    • regexp_substr('abc123','(\\d+)') → '123'

    función replace

    Devuelve una cadena con la cadena, matriz o mapa de cadenas proporcionados reemplazados.

    Variante de cadena y matriz

    Devuelve una cadena con la cadena o matriz de cadenas reemplazados por una cadena o una matriz de cadenas.

    Sintaxis

    replace ( string , before , after )

    Argumentos

    string la cadena de entrada
    before la cadena o matriz de cadenas a reemplazar
    after la cadena o matriz de cadenas a usar como reemplazo

    Ejemplos

    • replace('QGIS SERÍA GUAY','SERÍA','ES') → 'QGIS ES GUAY'
    • replace('QGIS ABC',array('A','B','C'),array('X','Y','Z')) → 'QGIS XYZ'
    • replace('QGIS',array('Q','S'),'') → 'GI'

    Variante del mapa

    Devuelve una cadena con las claves del mapa proporcionadas sustituidas por valores por pares.

    Sintaxis

    replace ( string , map )

    Argumentos

    string la cadena de entrada
    map el mapa que contiene claves y valores

    Ejemplos

    • replace('APP SERÍA GUAY',map('APP','QGIS','SERÍA','ES')) → 'QGIS ES GUAY'

    función right

    Devuelve una subcadena que contiene los n caracteres más a la derecha de la cadena.

    Sintaxis

    right ( string , length )

    Argumentos

    string una cadena
    length Entero. El número de caracteres a devolver desde la derecha de la cadena.

    Ejemplos

    • right('Hola Mundo',5) → 'Mundo'

    función rpad

    Returns a string padded on the right to the specified width, using a fill character. If the target width is smaller than the string's length, the string is truncated.

    Sintaxis

    rpad ( string , width , fill )

    Argumentos

    string cadena a ampliar
    width longitud de la nueva cadena
    fill carácter con el que rellenar los espacios restantes

    Ejemplos

    • rpad('Hola', 10, 'x') → 'Holaxxxxxx'
    • rpad('Hola', 3, 'x') → 'Hel'

    función strpos

    Devuelve la primera posición coincidente de una subcadena dentro de otra cadena o 0 si no se encuentra la subcadena.

    Sintaxis

    strpos ( haystack , needle )

    Argumentos

    haystack cadena en la que buscar
    needle cadena a buscar

    Ejemplos

    • strpos('ADIÓS MUNDO','MUNDO') → 7
    • strpos('HOLA MUNDO','ADIÓS') → 0

    función substr

    Devuelve una parte de una cadena.

    Sintaxis

    substr ( string , start [, length ])

    [ ] marque componentes opcionales

    Argumentos

    string la cadena de entrada completa
    start integer representing start position to extract beginning with 1; if start is negative, the return string will begin at the end of the string minus the start value
    length entero que representa la longitud de cadena a extraer; si la longitud es negativa, la cadena devuelta omitirá la longitud de caracteres indicada desde el final de la cadena

    Ejemplos

    • substr('HOLA MUNDO'',3,5) → 'LA MU'
    • substr('HOLA MUNDO',6) → ' MUNDO'
    • substr('HOLA MUNDO',-5) → 'MUNDO'
    • substr('HOLA',3,-1) → 'LL'
    • substr('HOLA MUNDO',-5,2) → 'MU'
    • substr('HOLA MUNDO',-5,-1) → 'MUND'

    función title

    Convierte todas las palabras de una cadena a formato de título (todas las palabras en minúscula con la primera letra en mayúscula).

    Sintaxis

    title ( string )

    Argumentos

    string la cadena a convertir a formato de título

    Ejemplos

    • title('hola MUndo') → 'Hola Mundo'

    función to_string

    Convierte un número en cadena.

    Sintaxis

    to_string ( number )

    Argumentos

    number Valor entero o real. El número a convertir en cadena.

    Ejemplos

    • to_string(123) → '123'

    función trim

    Elimina todos los espacios en blanco (espacios, tabuladores, etc.) de comienzo y final de una cadena.

    Sintaxis

    trim ( string )

    Argumentos

    string cadena a limpiar

    Ejemplos

    • trim(' hola mundo ') → 'hola mundo'

    función upper

    Convierte una cadena a letras mayúsculas.

    Sintaxis

    upper ( string )

    Argumentos

    string la cadena a convertir a mayúsculas

    Ejemplos

    • upper('hola MUndo') → 'HOLA MUNDO'

    función wordwrap

    Devuelve una cadena ajustada un número de caracteres máximo/mínimo

    Sintaxis

    wordwrap ( string , wrap_length [, delimiter_string ])

    [ ] marque componentes opcionales

    Argumentos

    string la cadena a ajustar
    wrap_length un entero. Si wrap_lenght es positivo el número representa el número máximo ideal de caracteres a ajustar; si es negativo, el número representa el número mínimo de caracteres a ajustar.
    delimiter_string Optional delimiter string to wrap to a new line.

    Ejemplos

    • wordwrap('UNIVERSIDAD DE QGIS',14) → 'UNIVERSIDAD DE
      QGIS'
    • wordwrap('UNIVERSIDAD DE QGIS',-3) → 'UNIVERSIDAD
      DE QGIS'