13.2. Lista de funciones
Las funciones, operadores y variables disponibles en QGIS están listadas abajo, agrupadas por categorías.
13.2.1. Agregar Funciones
Este grupo contiene funciones que agregan valores sobre campos y capas.
13.2.1.1. aggregate
Devuelve un valor agregado calculado usando objetos espaciales de otra capa.
Sintaxis |
aggregate(layer, aggregate, expression, [filter], [concatenator=””], [order_by]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.2. array_agg
Devuelve una matriz de valores agregados de un campo o expresión.
Sintaxis |
array_agg(expression, [group_by], [filter], [order_by]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.3. recolectar
Devuelve la geometría multiparte de geometrías agregadas desde una expresión
Sintaxis |
collect(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.4. concatenate
Devuelve todas las cadenas agregadas de un campo o expresión unidos por un delimitador.
Sintaxis |
concatenate(expression, [group_by], [filter], [concatenator], [order_by]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.5. concatenate_unique
cadena opcional para usar para unir valores. Vacío por defecto.
Sintaxis |
concatenate_unique(expression, [group_by], [filter], [concatenator], [order_by]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.6. count
Devuelve el recuento de objetos coincidentes.
Sintaxis |
count(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.7. count_distinct
Devuelve el recuento de valores distintos.
Sintaxis |
count_distinct(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.8. count_missing
Devuelve el recuento de valores perdidos (NULL).
Sintaxis |
count_missing(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.9. iqr
Devuelve el rango intercuartil calculado de un campo o expresión.
Sintaxis |
iqr(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.10. majority
Devuelve la mayoría agregada de valores (valor que ocurre con más frecuencia) de un campo o expresión.
Sintaxis |
majority(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.11. max_length
Devuelve la longitud máxima de cadenas de un campo o expresión.
Sintaxis |
max_length(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.12. maximum
Devuelve el valor máximo agregado de un campo o expresión.
Sintaxis |
maximum(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.13. mean
Devuelve el valor medio agregado de un campo o expresión.
Sintaxis |
mean(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.14. median
Devuelve el valor medio agregado de un campo o expresión.
Sintaxis |
median(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.15. min_length
Devuelve la longitud mínima de cadenas de un campo o expresión.
Sintaxis |
min_length(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.16. minimum
Devuelve el valor mínimo agregado de un campo o expresión.
Sintaxis |
minimum(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.17. minority
Devuelve la minoría agregada de valores (valor que ocurre menos) de un campo o expresión.
Sintaxis |
minority(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.18. q1
Devuelve el primer cuartil calculado de un campo o expresión.
Sintaxis |
q1(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.19. q3
Devuelve el tercer cuartil calculado de un campo o expresión.
Sintaxis |
q3(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.20. range
Devuelve el rango agregado de valores (máximo - mínimo) de un campo o expresión.
Sintaxis |
range(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.21. relation_aggregate
Devuelve un valor agregado calculado utilizando todas las entidades secundarias coincidentes de una relación de capa.
Sintaxis |
relation_aggregate(relation, aggregate, expression, [concatenator=””], [order_by]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: Creando una o muchas de muchas relaciones
13.2.1.22. stdev
Devuelve el valor de desviación estándar agregado de un campo o expresión.
Sintaxis |
stdev(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.1.23. sum
Devuelve el valor sumado agregado de un campo o expresión.
Sintaxis |
sum(expression, [group_by], [filter]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.2. Funciones Arreglo
Este grupo contiene funciones para crear y manipular matrices (también conocidas como estructuras de datos de lista). El orden de los valores dentro de la matriz es importante, a diferencia de “map” data structure, donde el orden de los pares clave-valor es irrelevante y los valores se identifican por sus claves.
13.2.2.1. array
Devuelve una matriz que contiene todos los valores pasados como parámetro.
Sintaxis |
array(value1, value2, …) |
Argumentos |
|
Ejemplos |
|
13.2.2.2. array_all
Devuelve TRUE si un arreglo contiene todos los valores de un arreglo dado.
Sintaxis |
array_all(array_a, array_b) |
Argumentos |
|
Ejemplos |
|
13.2.2.3. array_append
Devuelve una matriz con el valor dado agregado al final.
Sintaxis |
array_append(array, value) |
Argumentos |
|
Ejemplos |
|
13.2.2.4. array_cat
Devuelve una matriz que contiene todas las matrices dadas concatenadas.
Sintaxis |
array_cat(array1, array2, …) |
Argumentos |
|
Ejemplos |
|
13.2.2.5. array_contains
Devuelve TRUE si un array contiene el valor dado.
Sintaxis |
array_contains(array, value) |
Argumentos |
|
Ejemplos |
|
13.2.2.6. array_count
Cuenta el número de ocurrencias de un valor dado en una matriz.
Sintaxis |
array_count(array, value) |
Argumentos |
|
Ejemplos |
|
13.2.2.7. array_distinct
Devuelve una matriz que contiene valores distintos de la matriz dada.
Sintaxis |
array_distinct(array) |
Argumentos |
|
Ejemplos |
|
13.2.2.8. array_filter
Devuelve una matriz con solo los elementos para los que la expresión se evalúa como verdadera.
Sintaxis |
array_filter(array, expression, [limit=0]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.2.9. array_find
Devuelve el índice más bajo (0 para el primero) de un valor dentro de una matriz. Devuelve -1 si no se encuentra el valor.
Sintaxis |
array_find(array, value) |
Argumentos |
|
Ejemplos |
|
13.2.2.10. array_first
Devuelve el primer valor de una matriz.
Sintaxis |
array_first(array) |
Argumentos |
|
Ejemplos |
|
13.2.2.11. array_foreach
Devuelve una matriz con la expresión dada evaluada en cada elemento.
Sintaxis |
array_foreach(array, expression) |
Argumentos |
|
Ejemplos |
|
13.2.2.12. array_get
Devuelve el valor N (0 para el primero) o el último valor -N (-1 para el último) de una matriz.
Sintaxis |
array_get(array, pos) |
Argumentos |
|
Ejemplos |
|
Consejo
También puede utilizar el index operator ([]) para obtener un valor de una matriz.
13.2.2.13. array_insert
Devuelve una matriz con el valor dado agregado en la posición dada.
Sintaxis |
array_insert(array, pos, value) |
Argumentos |
|
Ejemplos |
|
13.2.2.14. array_intersect
Devuelve TRUE si al menos un elemento de array1 existe en array2.
Sintaxis |
array_intersect(array1, array2) |
Argumentos |
|
Ejemplos |
|
13.2.2.15. array_last
Devuelve el último valor de una matriz.
Sintaxis |
array_last(array) |
Argumentos |
|
Ejemplos |
|
13.2.2.16. array_length
Devuelve el número de elementos de una matriz.
Sintaxis |
array_length(array) |
Argumentos |
|
Ejemplos |
|
13.2.2.17. array_majority
Devuelve los valores más comunes en una matriz.
Sintaxis |
array_majority(array, [option=”all”]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.2.18. array_max
Devuelve el valor máximo de una matriz.
Sintaxis |
array_max(array) |
Argumentos |
|
Ejemplos |
|
13.2.2.19. array_mean
Devuelve la media de los valores aritméticos de una matriz. Los valores no numéricos de la matriz se ignoran.
Sintaxis |
array_mean(array) |
Argumentos |
|
Ejemplos |
|
13.2.2.20. array_median
Devuelve la mediana de los valores aritméticos de una matriz. Los valores no aritméticos de la matriz se ignoran.
Sintaxis |
array_median(array) |
Argumentos |
|
Ejemplos |
|
13.2.2.21. array_min
Devuelve el valor mínimo de una matriz.
Sintaxis |
array_min(array) |
Argumentos |
|
Ejemplos |
|
13.2.2.22. array_minority
Devuelve los valores menos comunes en una matriz.
Sintaxis |
array_minority(array, [option=”all”]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.2.23. array_prepend
Devuelve una matriz con el valor dado añadido al principio.
Sintaxis |
array_prepend(array, value) |
Argumentos |
|
Ejemplos |
|
13.2.2.24. array_prioritize
Devuelve una matriz ordenada según el orden especificado en otra matriz. Los valores que están presentes en la primera matriz pero que faltan en la segunda matriz se agregarán al final del resultado.
Sintaxis |
array_prioritize(array, array_prioritize) |
Argumentos |
|
Ejemplos |
|
13.2.2.25. array_remove_all
Devuelve una matriz con todas las entradas del valor dado borradas.
Sintaxis |
array_remove_all(array, value) |
Argumentos |
|
Ejemplos |
|
13.2.2.26. array_remove_at
Devuelve una matriz con el elemento en el índice dado eliminado. Admite índice positivo (0 para el primer elemento) y negativo (el último valor -N, -1 para el último elemento).
Sintaxis |
array_remove_at(array, pos) |
Argumentos |
|
Ejemplos |
|
13.2.2.27. array_replace
Devuelve una matriz con el valor proporcionado, la matriz o el mapa de valores reemplazado.
Valor & variante de matriz
Devuelve una matriz con el valor proporcionado o la matriz de valores reemplazada por otro valor o una matriz de valores.
Sintaxis |
array_replace(array, before, after) |
Argumentos |
|
Ejemplos |
|
Map variant
Devuelve una matriz con las claves de mapa proporcionadas reemplazadas por sus valores emparejados.
Sintaxis |
array_replace(array, map) |
Argumentos |
|
Ejemplos |
|
13.2.2.28. array_reverse
Devuelve la matriz dada con los valores de la matriz en orden inverso.
Sintaxis |
array_reverse(array) |
Argumentos |
|
Ejemplos |
|
13.2.2.29. array_slice
Devuelve una parte de la matriz. El segmento está definido por los argumentos start_pos y end_pos.
Sintaxis |
array_slice(array, start_pos, end_pos) |
Argumentos |
|
Ejemplos |
|
13.2.2.30. array_sort
Devuelve la matriz proporcionada con sus elementos ordenados.
Sintaxis |
array_sort(array, [ascending=true]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.2.31. array_sum
Devuelve la suma de los valores aritméticos de una matriz. Los valores no numéricos de la matriz se ignoran.
Sintaxis |
array_sum(array) |
Argumentos |
|
Ejemplos |
|
13.2.2.32. array_to_string
Concatena los elementos de la matriz en una cadena separada por un delimitador y utiliza una cadena opcional para valores vacíos.
Sintaxis |
array_to_string(array, [delimiter=”,”], [empty_value=””]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.2.33. generate_series
Crea una matriz que contiene una secuencia de números.
Sintaxis |
generate_series(start, stop, [step=1]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.2.34. geometries_to_array
Divide una geometría en geometrías más simples en una matriz.
Sintaxis |
geometries_to_array(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.2.35. regexp_matches
Devuelve una matriz de todas las cadenas capturadas mediante la captura de grupos, en el orden en que los propios grupos aparecen en la expresión regular proporcionada contra una cadena.
Sintaxis |
regexp_matches(string, regex, [empty_value=””]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.2.36. string_to_array
Divide la cadena en una matriz utilizando el delimitador proporcionado y la cadena opcional para valores vacíos.
Sintaxis |
string_to_array(string, [delimiter=”,”], [empty_value=””]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.3. Funciones de Color
Este grupo contiene funciones para manipular colores.
13.2.3.1. 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 |
|
Ejemplos |
|
13.2.3.2. color_cmyka
Devuelve una representación de cadena de un color basada en sus componentes cian, magenta, amarillo, negro y alfa (transparencia)
Sintaxis |
color_cmyka(cyan, magenta, yellow, black, alpha) |
Argumentos |
|
Ejemplos |
|
13.2.3.3. color_grayscale_average
Aplica un filtro de escala de grises y devuelve una representación de cadena de un color proporcionado.
Sintaxis |
color_grayscale_average(color) |
Argumentos |
|
Ejemplos |
|
13.2.3.4. color_hsl
Devuelve una representación de cadena de un color en función de sus atributos de tono, saturación y luminosidad.
Sintaxis |
color_hsl(hue, saturation, lightness) |
Argumentos |
|
Ejemplos |
|
13.2.3.5. 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 |
|
Ejemplos |
|
13.2.3.6. color_hsv
Devuelve una representación de cadena de un color en función de sus atributos de matiz, saturación y valor.
Sintaxis |
color_hsv(hue, saturation, value) |
Argumentos |
|
Ejemplos |
|
13.2.3.7. color_hsva
Devuelve una representación de cadena de un color en función de sus atributos de tono, saturación, valor y alfa (transparencia).
Sintaxis |
color_hsva(hue, saturation, value, alpha) |
Argumentos |
|
Ejemplos |
|
13.2.3.8. color_mix_rgb
Devuelve una cadena que representa un color que mezcla los valores rojo, verde, azul y alfa de dos colores proporcionados según una proporción determinada.
Sintaxis |
color_mix_rgb(color1, color2, ratio) |
Argumentos |
|
Ejemplos |
|
13.2.3.9. color_part
Devuelve un componente específico de una cadena de colores, por ejemplo, el componente rojo o el componente alfa.
Sintaxis |
color_part(color, component) |
Argumentos |
|
Ejemplos |
|
13.2.3.10. color_rgb
Devuelve una representación de cadena de un color según sus componentes rojo, verde y azul.
Sintaxis |
color_rgb(red, green, blue) |
Argumentos |
|
Ejemplos |
|
13.2.3.11. color_rgba
Devuelve una representación de cadena de un color basada en sus componentes rojo, verde, azul y alfa (transparencia).
Sintaxis |
color_rgba(red, green, blue, alpha) |
Argumentos |
|
Ejemplos |
|
13.2.3.12. create_ramp
Devuelve una rampa de degradado de un mapa de cadenas de colores y pasos.
Sintaxis |
create_ramp(map, [discrete=false]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.3.13. darker
Devuelve una cadena de color más oscura (o más clara)
Sintaxis |
darker(color, factor) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: lighter
13.2.3.14. lighter
Devuelve una cadena de color más clara (o más oscura)
Sintaxis |
lighter(color, factor) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: darker
13.2.3.15. project_color
Devuelve un color del esquema de colores del proyecto.
Sintaxis |
project_color(name) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: setting project colors
13.2.3.16. 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 |
|
Ejemplos |
|
Nota
Las rampas de colores disponibles varían entre las instalaciones de QGIS. Es posible que esta función no dé los resultados esperados si mueve su proyecto QGIS entre instalaciones.
Expression-created ramp variant
Devuelve una cadena que representa un color de una rampa creada por expresión
Sintaxis |
ramp_color(ramp, value) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: Estableciendo una Rampa de Color, El atajo de la rampa de color desplegable
13.2.3.17. set_color_part
Establece un componente de color específico para una cadena de colores, por ejemplo, el componente rojo o el componente alfa.
Sintaxis |
set_color_part(color, component, value) |
Argumentos |
|
Ejemplos |
|
13.2.4. Funciones Condicionales
Este grupo contiene funciones para manejar comprobaciones condicionales en expresiones.
13.2.4.1. CASE
CASE se utiliza para evaluar una serie de condiciones y devolver un resultado para la primera condición cumplida. Las condiciones se evalúan secuencialmente y, si una condición es verdadera, la evaluación se detiene y se devuelve el resultado correspondiente. Si ninguna de las condiciones es verdadera, se devuelve el valor de la cláusula ELSE. Además, si no se establece ninguna cláusula ELSE y no se cumple ninguna de las condiciones, se devuelve NULL.
CASE
WHEN condición THEN resultado
[ …n ]
[ ELSE resultado ]
END
[ ] marca componentes opcionales
Argumentos |
|
Ejemplos |
|
13.2.4.2. coalesce
Devuelve el primer valor no NULO de la lista de expresiones.
Esta función puede aceptar cualquier número de argumentos.
Sintaxis |
coalesce(expression1, expression2, …) |
Argumentos |
|
Ejemplos |
|
13.2.4.3. if
Prueba una condición y devuelve un resultado diferente según la verificación condicional.
Sintaxis |
if(condition, result_when_true, result_when_false) |
Argumentos |
|
Ejemplos |
|
13.2.4.4. nullif
Devuelve un valor NULO si valor1 es igual a valor2; de lo contrario, devuelve value1. Esto se puede usar para sustituir valores condicionalmente por NULL.
Sintaxis |
nullif(value1, value2) |
Argumentos |
|
Ejemplos |
|
13.2.4.5. regexp_match
Devuelve la primera posición coincidente que coincide con una expresión regular dentro de una cadena Unicode, o 0 si no se encuentra la subcadena.
Sintaxis |
regexp_match(input_string, regex) |
Argumentos |
|
Ejemplos |
|
13.2.4.6. try
Prueba una expresión y devuelve su valor si no tiene errores. Si la expresión devuelve un error, se devolverá un valor alternativo cuando se proporcione; de lo contrario, la función devolverá NULL.
Sintaxis |
try(expression, [alternative]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.5. Funciones de conversión
Este grupo contiene funciones para convertir un tipo de datos a otro (por ejemplo, cadena de/a entero, binario de/a cadena, cadena a fecha, …).
13.2.5.1. from_base64
Decodifica una cadena en la codificación Base64 en un valor binario.
Sintaxis |
from_base64(string) |
Argumentos |
|
Ejemplos |
|
13.2.5.2. hash
Crea un hash a partir de una cadena con un método determinado. Un byte (8 bits) se representa con dos “”dígitos”” hexadecimales, por lo que “md4” (16 bytes) produce una cadena hexadecimal de 16*2 = 32 caracteres y “keccak_512” (64 bytes) produce un 64 * 2 = Cadena hexadecimal de 128 caracteres.
Sintaxis |
hash(string, method) |
Argumentos |
|
Ejemplos |
|
13.2.5.3. md5
Crea un hash md5 a partir de una cadena.
Sintaxis |
md5(string) |
Argumentos |
|
Ejemplos |
|
13.2.5.4. sha256
Crea un hash sha256 a partir de una cadena.
Sintaxis |
sha256(string) |
Argumentos |
|
Ejemplos |
|
13.2.5.5. to_base64
Codifica un valor binario en una cadena, utilizando la codificación Base64.
Sintaxis |
to_base64(value) |
Argumentos |
|
Ejemplos |
|
13.2.5.6. to_date
Convierte una cadena en un objeto de fecha. Se puede proporcionar una cadena de formato opcional para analizar la cadena; ver QDate::fromString o la documentación de la función format_date para obtener documentación adicional sobre el formato. De forma predeterminada, se utiliza la configuración regional actual del usuario de QGIS.
Sintaxis |
to_date(string, [format], [language]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.5.7. to_datetime
Convierte una cadena en un objeto de fecha y hora. Se puede proporcionar una cadena de formato opcional para analizar la cadena; ver QDate::fromString, QTime::fromString o la documentación de la función format_date para obtener documentación adicional sobre el formato. De forma predeterminada, se utiliza la configuración regional actual del usuario de QGIS.
Sintaxis |
to_datetime(string, [format], [language]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.5.8. to_decimal
Convierte una coordenada en grados, minutos, segundos a su equivalente decimal.
Sintaxis |
to_decimal(value) |
Argumentos |
|
Ejemplos |
|
13.2.5.9. to_dm
Convierte una coordenada a grados, minutos.
Sintaxis |
to_dm(coordinate, axis, precision, [formatting=]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.5.10. to_dms
Convierte una coordenada a grados, minutos, segundos.
Sintaxis |
to_dms(coordinate, axis, precision, [formatting=]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.5.11. to_int
Convierte una cadena en un número entero. No se devuelve nada si un valor no se puede convertir a entero (p.ej. “123asd” es inválido).
Sintaxis |
to_int(string) |
Argumentos |
|
Ejemplos |
|
13.2.5.12. to_interval
Convierte una cadena en un tipo de intervalo. Puede usarse para tomar días, horas, meses, etc. de una fecha.
Sintaxis |
to_interval(string) |
Argumentos |
|
Ejemplos |
|
13.2.5.13. to_real
Convierte una cadena en un número real. No se devuelve nada si un valor no se puede convertir a real (por ejemplo, “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 |
|
Ejemplos |
|
13.2.5.14. to_string
Convierte un número en cadena.
Sintaxis |
to_string(number) |
Argumentos |
|
Ejemplos |
|
13.2.5.15. to_time
Convierte una cadena en un objeto de tiempo. Se puede proporcionar una cadena de formato opcional para analizar la cadena; ver QTime::fromString para obtener documentación adicional sobre el formato.
Sintaxis |
to_time(string, [format], [language]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.6. Funciones personalizadas
Este grupo contiene funciones creadas por el usuario. Ver Editor de Funciones para mas detalles.
13.2.7. Funciones de Fecha y Hora
Este grupo contiene funciones para manejar datos de fecha y hora. Este grupo comparte varias funciones con las Funciones de conversión (to_date, to_time, to_datetime, to_interval) y grupos Funciones de cadena (format_date).
Nota
Almacenamiento de fecha, fecha y hora e intervalos en campos
La capacidad de almacenar valores de fecha, hora y fecha y hora directamente en los campos depende del proveedor de la fuente de datos (por ejemplo, Shapefile acepta el formato fecha, pero no el formato fecha y hora o hora). Las siguientes son algunas sugerencias para superar esta limitación:
fecha, fecha y hora hora pueden ser convertidos y alamcenados en campos de tipo texto usando la función format_date().
Intervalos pueden ser almacenados en tipo entero o decimaldespues de usar una de las funciones de extracción (p.ej., day() para obtener el intervalo expresado en días)
13.2.7.1. age
Devuelve la diferencia entre dos fechas o fecha-hora.
La diferencia se devuelve como un Intervalo
y debe usarse con una de las siguientes funciones para extraer información útil:
year
month
week
day
hour
minute
second
Sintaxis |
age(datetime1, datetime2) |
Argumentos |
|
Ejemplos |
|
13.2.7.2. datetime_from_epoch
Devuelve una fecha y hora cuya fecha y hora son el número de milisegundos, ms, que han pasado desde 1970-01-01T00:00:00.000, Hora universal coordinada (Qt.UTC) y convertida a Qt.LocalTime.
Sintaxis |
datetime_from_epoch(int) |
Argumentos |
|
Ejemplos |
|
13.2.7.3. day
Extrae el día de una fecha o el número de días de un intervalo.
Variante fecha
Extrae el día de una fecha o fecha-hora.
Sintaxis |
day(date) |
Argumentos |
|
Ejemplos |
|
Variante intervalo
Calcula la longitud en días de un intervalo.
Sintaxis |
day(interval) |
Argumentos |
|
Ejemplos |
|
13.2.7.4. day_of_week
Devuelve el día de la semana para una fecha o fecha y hora especificadas. El valor devuelto va de 0 a 6, donde 0 corresponde a un domingo y 6 a un sábado.
Sintaxis |
day_of_week(date) |
Argumentos |
|
Ejemplos |
|
13.2.7.5. epoch
Devuelve el intervalo en milisegundos entre la época de Unix y un valor de fecha dado.
Sintaxis |
epoch(date) |
Argumentos |
|
Ejemplos |
|
13.2.7.6. format_date
Formatea un tipo de fecha o una cadena en un formato de cadena personalizado. Utiliza cadenas de formato de fecha/hora Qt. Ver QDateTime::toString.
Sintaxis |
format_date(datetime, format, [language]) [] marca argumentos opcionales |
||||||||||||||||||||||||||||||||||||||||||||||||
Argumentos |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ejemplos |
|
13.2.7.7. hour
Extrae la parte de la hora de una fecha y hora u hora, o el número de horas de un intervalo.
Time variant
Extrae la parte de la hora de una hora o una fecha y hora.
Sintaxis |
hour(datetime) |
Argumentos |
|
Ejemplos |
|
Variante intervalo
Calcula la duración en horas de un intervalo.
Sintaxis |
hour(interval) |
Argumentos |
|
Ejemplos |
|
13.2.7.8. make_date
Crea un valor fecha a partir de números año, mes y día.
Sintaxis |
make_date(year, month, day) |
Argumentos |
|
Ejemplos |
|
13.2.7.9. make_datetime
Crea un valor de fecha y hora a partir de números de año, mes, día, hora, minuto y segundo.
Sintaxis |
make_datetime(year, month, day, hour, minute, second) |
Argumentos |
|
Ejemplos |
|
13.2.7.10. make_interval
Crea un valor de intervalo a partir de valores de año, mes, semanas, días, horas, minutos y segundos.
Sintaxis |
make_interval([years=0], [months=0], [weeks=0], [days=0], [hours=0], [minutes=0], [seconds=0]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.7.11. make_time
Crea un valore temporal a partir de cifras de hora, minuto y segundo.
Sintaxis |
make_time(hour, minute, second) |
Argumentos |
|
Ejemplos |
|
13.2.7.12. minute
Extrae la parte de minutos de una fecha y hora u hora, o el número de minutos de un intervalo.
Time variant
Extrae la parte de los minutos de una hora o una fecha y hora.
Sintaxis |
minute(datetime) |
Argumentos |
|
Ejemplos |
|
Variante intervalo
Calcula la duración en minutos de un intervalo.
Sintaxis |
minute(interval) |
Argumentos |
|
Ejemplos |
|
13.2.7.13. month
Extrae la parte del mes de una fecha o el número de meses de un intervalo.
Variante fecha
Extrae la parte del mes de una fecha o una fecha y hora.
Sintaxis |
month(date) |
Argumentos |
|
Ejemplos |
|
Variante intervalo
Calcula la duración en meses de un intervalo.
Sintaxis |
month(interval) |
Argumentos |
|
Ejemplos |
|
13.2.7.14. now
Devuelve la fecha y hora actuales. La función es estática y devolverá resultados consistentes durante la evaluación. La hora devuelta es la hora en que se prepara la expresión.
Sintaxis |
now() |
Ejemplos |
|
13.2.7.15. second
Extrae la parte de segundos de una fecha y hora u hora, o el número de segundos de un intervalo.
Time variant
Extrae la parte de los segundos de una hora o una fecha y hora.
Sintaxis |
second(datetime) |
Argumentos |
|
Ejemplos |
|
Variante intervalo
Calcula la longitud en segundos de un intervalo.
Sintaxis |
second(interval) |
Argumentos |
|
Ejemplos |
|
13.2.7.16. to_date
Convierte una cadena en un objeto de fecha. Se puede proporcionar una cadena de formato opcional para analizar la cadena; ver QDate::fromString o la documentación de la función format_date para obtener documentación adicional sobre el formato. De forma predeterminada, se utiliza la configuración regional actual del usuario de QGIS.
Sintaxis |
to_date(string, [format], [language]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.7.17. to_datetime
Convierte una cadena en un objeto de fecha y hora. Se puede proporcionar una cadena de formato opcional para analizar la cadena; ver QDate::fromString, QTime::fromString o la documentación de la función format_date para obtener documentación adicional sobre el formato. De forma predeterminada, se utiliza la configuración regional actual del usuario de QGIS.
Sintaxis |
to_datetime(string, [format], [language]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.7.18. to_interval
Convierte una cadena en un tipo de intervalo. Puede usarse para tomar días, horas, meses, etc. de una fecha.
Sintaxis |
to_interval(string) |
Argumentos |
|
Ejemplos |
|
13.2.7.19. to_time
Convierte una cadena en un objeto de tiempo. Se puede proporcionar una cadena de formato opcional para analizar la cadena; ver QTime::fromString para obtener documentación adicional sobre el formato.
Sintaxis |
to_time(string, [format], [language]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.7.20. week
Extrae el número de semana de una fecha o el número de semanas de un intervalo.
Variante fecha
Extrae el número de semana de una fecha o fecha y hora..
Sintaxis |
week(date) |
Argumentos |
|
Ejemplos |
|
Variante intervalo
Calcula la longitud en semanas de un inervalo.
Sintaxis |
week(interval) |
Argumentos |
|
Ejemplos |
|
13.2.7.21. year
Extrae la parte del año de una fecha o el número de años de un intervalo.
Variante fecha
Extrae la parte del año de una fecha o una fecha y hora.
Sintaxis |
year(date) |
Argumentos |
|
Ejemplos |
|
Variante intervalo
Calcula la duración en años de un intervalo.
Sintaxis |
year(interval) |
Argumentos |
|
Ejemplos |
|
Algún ejemplo:
Además de estas funciones, restar fechas, fechas y horas utilizando el operador `` -`` (menos) devolverá un intervalo.
Sumar o restar un intervalo a fechas, fechas y horas, utilizando los operadores `` + “” (más) y `` -`` (menos), devolverá una fecha y hora.
Obtener el número de días hasta el lanzamiento de QGIS 3.0
to_date('2017-09-29') - to_date(now()) -- Returns <interval: 203 days>
Lo mismo con la hora:
to_datetime('2017-09-29 12:00:00') - now() -- Returns <interval: 202.49 days>
Obtener la fecha con hora de ahora a 100 días:
now() + to_interval('100 days') -- Returns <datetime: 2017-06-18 01:00:00>
13.2.8. Campos y Valores
Contiene una lista de campos de la capa activa y valores especiales. La lista de campos incluye los almacenados en el conjunto de datos, virtual y auxiliar así como los de uniones.
Doble-click en el nombre de un campo para añadirlo a tu expresión. También puede escribir el nombre del campo (preferiblemente entre comillas dobles) o su alias.
Para recuperar los valores de los campos para usar en una expresión, seleccione el campo apropiado y, en el widget que se muestra, elija entre 10 Samples y All Unique. Los valores solicitados se muestran y puede usar el cuadro Search en la parte superior de la lista para filtrar el resultado. También se puede acceder a los valores de muestra haciendo clic derecho en un campo.
Para añadir un valor a una expresión que esté escribiendo, doble-click en él en la lista. Si el valor es del tipo cadena, debe ir con comillas simples, en otro caso no se necesitan comillas.
13.2.8.1. NULL
Equivale a un valor NULL.
Sintaxis |
NULL |
Ejemplos |
|
Nota
Para probar NULL use una expresión IS NULL o IS NOT NULL.
13.2.9. Funciones de Archivos y Rutas
Este grupo contiene funciones que manipulan nombres de archivos y rutas.
13.2.9.1. base_file_name
Devuelve el nombre base de un archivo sin el directorio o el sufijo del archivo.
Sintaxis |
base_file_name(path) |
Argumentos |
|
Ejemplos |
|
13.2.9.2. exif
Recupera valores de etiquetas exif de un archivo de imagen.
Sintaxis |
exif(path, [tag]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.9.3. file_exists
Devuelve TRUE si existe una ruta de archivo.
Sintaxis |
file_exists(path) |
Argumentos |
|
Ejemplos |
|
13.2.9.4. file_name
Devuelve el nombre de un archivo (incluyendo la extensión del archivo), excluyendo el directorio.
Sintaxis |
file_name(path) |
Argumentos |
|
Ejemplos |
|
13.2.9.5. file_path
Devuelve el componente de directorio de una ruta de archivo. Esto no incluye el nombre del archivo.
Sintaxis |
file_path(path) |
Argumentos |
|
Ejemplos |
|
13.2.9.6. file_size
Devuelve el tamaño (en bytes) de un archivo.
Sintaxis |
file_size(path) |
Argumentos |
|
Ejemplos |
|
13.2.9.7. file_suffix
Devuelve el sufijo (extensión) del archivo de una ruta de archivo.
Sintaxis |
file_suffix(path) |
Argumentos |
|
Ejemplos |
|
13.2.9.8. is_directory
Devuelve TRUE si una ruta corresponde a un directorio.
Sintaxis |
is_directory(path) |
Argumentos |
|
Ejemplos |
|
13.2.9.9. is_file
Devuelve TRUE si una ruta corresponde a un archivo.
Sintaxis |
is_file(path) |
Argumentos |
|
Ejemplos |
|
13.2.10. Funciones de formulario
Este grupo contiene funciones que operan exclusivamente en el contexto de formulario de atributos. Por ejemplo, en la configuración de controles de campo.
13.2.10.1. current_parent_value
Solo se puede usar en un contexto de formulario incrustado, esta función devuelve el valor actual no guardado de un campo en el formulario principal que se está editando actualmente. Esto diferirá de los valores de atributo reales de la entidad principal para las entidades que se están editando actualmente o que aún no se han agregado a una capa principal. Cuando se usa en una expresión de filtro de widget de relación de valor, esta función debe estar envuelta en un “coalesce()” que puede recuperar la característica principal real de la capa cuando el formulario no se usa en un contexto incrustado.
Sintaxis |
current_parent_value(field_name) |
Argumentos |
|
Ejemplos |
|
13.2.10.2. current_value
Devuelve el valor actual, no guardado, de un campo en el formulario o fila de la tabla que se está editando actualmente. Esto diferirá de los valores de atributo reales de la entidad para las entidades que se están editando actualmente o que aún no se han agregado a una capa.
Sintaxis |
current_value(field_name) |
Argumentos |
|
Ejemplos |
|
13.2.11. Funciones Concordancia aproximada
Este grupo contiene funciones para comparaciones difusas entre valores.
13.2.11.1. hamming_distance
Devuelve la distancia Hamming entre dos cadenas. Esto equivale 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 distingue entre mayúsculas y minúsculas.
Sintaxis |
hamming_distance(string1, string2) |
Argumentos |
|
Ejemplos |
|
13.2.11.2. levenshtein
Devuelve la distancia de edición de Levenshtein entre dos cadenas. Esto equivale al número mínimo de ediciones de caracteres (inserciones, eliminaciones o sustituciones) necesarias para cambiar una cadena a otra.
La distancia de Levenshtein es una medida de la similitud entre dos cadenas. Las distancias más pequeñas significan que las cadenas son más similares y las distancias más grandes indican cadenas más diferentes. La distancia distingue entre mayúsculas y minúsculas.
Sintaxis |
levenshtein(string1, string2) |
Argumentos |
|
Ejemplos |
|
13.2.11.3. longest_common_substring
Devuelve la subcadena común más larga entre dos cadenas. Esta subcadena es la cadena más larga que es una subcadena de las dos cadenas de entrada. Por ejemplo, la subcadena común más larga de «ABABC» y «BABCA» es «BABC». La subcadena distingue entre mayúsculas y minúsculas.
Sintaxis |
longest_common_substring(string1, string2) |
Argumentos |
|
Ejemplos |
|
13.2.11.4. soundex
Devuelve la representación Soundex de una cadena. Soundex es un algoritmo de coincidencia fonética, por lo que las cadenas con sonidos similares deben estar representadas por el mismo código Soundex.
Sintaxis |
soundex(string) |
Argumentos |
|
Ejemplos |
|
13.2.12. Funciones Generales
Este grupo contiene un surtido de funciones generales.
13.2.12.1. env
Obtiene una variable de entorno y devuelve su contenido como una cadena. Si no se encuentra la variable, se devolverá NULL. Esto es útil para inyectar una configuración específica del sistema, como letras de unidad o prefijos de ruta. La definición de las variables de entorno depende del sistema operativo; consulte con el administrador del sistema o con la documentación del sistema operativo cómo se puede configurar.
Sintaxis |
env(name) |
Argumentos |
|
Ejemplos |
|
13.2.12.2. eval
Evalúa una expresión que es pasada como una cadena. Útil para expandir parámetros dinámicos pasados como variables de contexto o campos.
Sintaxis |
eval(expression) |
Argumentos |
|
Ejemplos |
|
13.2.12.3. eval_template
Evalúa una plantilla que se pasa en una cadena. Útil para expandir parámetros dinámicos pasados como variables de contexto o campos.
Sintaxis |
eval_template(template) |
Argumentos |
|
Ejemplos |
|
13.2.12.4. is_layer_visible
Devuelve TRUE si la capa especificada es visible.
Sintaxis |
is_layer_visible(layer) |
Argumentos |
|
Ejemplos |
|
13.2.12.5. mime_type
Devuelve el tipo mime de los datos binarios.
Sintaxis |
mime_type(bytes) |
Argumentos |
|
Ejemplos |
|
13.2.12.6. var
Devuelve el valor almacenado dentro de una variable especificada.
Sintaxis |
var(name) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: Lista de variables predeterminadas
13.2.12.7. with_variable
Esta función establece una variable para cualquier código de expresión que se proporcionará como 3er argumento. Esto solo es útil para expresiones complicadas, donde el mismo valor calculado debe usarse en diferentes lugares.
Sintaxis |
with_variable(name, value, expression) |
Argumentos |
|
Ejemplos |
|
13.2.13. Funciones de Geometría
Este grupo contiene funciones que operan en objetos geométricos. (p.ej. buffer, transform, $area).
13.2.13.1. affine_transform
Devuelve la geometría después de una transformación afín. Los cálculos están en el Sistema de Referencia Espacial de esta geometría. Las operaciones se realizan en un orden de escala, rotación y traslación. Si hay un desplazamiento Z o M pero la coordenada no está presente en la geometría, se agregará.
Sintaxis |
affine_transform(geometry, delta_x, delta_y, rotation_z, scale_x, scale_y, [delta_z=0], [delta_m=0], [scale_z=1], [scale_m=1]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.2. angle_at_vertex
Devuelve el ángulo de la bisectriz(ángulo medio) de la geometría para un vértice especificado en una geometría de cadena lineal. Los ángulos están en grados en el sentido de las agujas del reloj desde el norte.
Sintaxis |
angle_at_vertex(geometry, vertex) |
Argumentos |
|
Ejemplos |
|
13.2.13.3. apply_dash_pattern
Aplica un patrón de guiones a una geometría, devolviendo una geometría MultiLineString que es la geometría de entrada trazada a lo largo de cada línea/anillo con el patrón especificado.
Sintaxis |
apply_dash_pattern(geometry, pattern, [start_rule=no_rule], [end_rule=no_rule], [adjustment=both], [pattern_offset=0]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.4. $area
Devuelve el área de la entidad actual. El área calculada por esta función respeta tanto la configuración del elipsoide del proyecto actual como la configuración de la unidad de área. Por ejemplo, si se ha configurado un elipsoide para el proyecto, el área calculada será elipsoidal, y si no se establece ningún elipsoide, el área calculada será planimétrica.
Sintaxis |
$area |
Ejemplos |
|
13.2.13.5. area
Devuelve el área de un objeto poligonal de geometría. Los cálculos son siempre planimétricos en el Sistema de referencia espacial (SRS) de esta geometría, y las unidades del área devuelta coincidirán con las unidades del SRS. Esto difiere de los cálculos realizados por la función $ area, que realizará cálculos elipsoidales basados en la configuración de unidad de área y elipsoide del proyecto.
Sintaxis |
area(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.6. azimuth
Devuelve el acimut basado en el norte como el ángulo en radianes medido en el sentido de las agujas del reloj desde la vertical en point_a hasta point_b.
Sintaxis |
azimuth(point_a, point_b) |
Argumentos |
|
Ejemplos |
|
13.2.13.7. 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 las cadenas 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ía, y devolverán NULL.
Sintaxis |
boundary(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Contorno
13.2.13.8. bounds
Devuelve una geometría que representa el cuadro delimitador de una geometría de entrada. Los cálculos están en el Sistema de Referencia eSpacial de esta geometría.
Sintaxis |
bounds(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Recuadros delimitadores
13.2.13.9. bounds_height
Devuelve la altura del cuadro delimitador de una geometría. Los cálculos están en el Sistema de Referencia eSpacial de esta geometría.
Sintaxis |
bounds_height(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.10. bounds_width
Devuelve el ancho del cuadro delimitador de una geometría. Los cálculos están en el Sistema de Referencia eSpacial de esta geometría.
Sintaxis |
bounds_width(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.11. buffer
Devuelve una geometría que representa todos los puntos cuya distancia desde esta geometría es menor o igual que la distancia. Los cálculos están en el Sistema de referencia espacial de esta geometría.
Sintaxis |
buffer(geometry, distance, [segments=8], [cap=”round”], [join=”round”], [miter_limit=2]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Buffer
13.2.13.12. buffer_by_m
Crea una zona de influencia a lo largo de una geometría de línea donde el diámetro del búfer varía según los valores m en los vértices de la línea.
Sintaxis |
buffer_by_m(geometry, [segments=8]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Ancura de buffer variable (por valor de M)
13.2.13.13. centroid
Devuelve el centro geométrico de una geometría.
Sintaxis |
centroid(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Centroides
13.2.13.14. close_line
Devuelve una cadena de línea cerrada de la cadena de línea de entrada agregando el primer punto al final de la línea, si aún no está cerrada. Si la geometría no es una cadena de líneas o una cadena de varias líneas, el resultado será NULL.
Sintaxis |
close_line(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.15. closest_point
Devuelve el punto de geometría1 más cercano a geometría2.
Sintaxis |
closest_point(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
13.2.13.16. collect_geometries
Recopila un conjunto de geometrías en un objeto de geometría multiparte.
Lista de argumentos variantes
Las partes de geometría son especificadas como argumentos separados a la función.
Sintaxis |
collect_geometries(geometry1, geometry2, …) |
Argumentos |
|
Ejemplos |
|
Matriz variante
Partes de geometría son especificadas como una matriz de partes de geometría.
Sintaxis |
collect_geometries(array) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Coleccionar geometrías
13.2.13.17. combine
Devuelve la combinación de dos geometrías.
Sintaxis |
combine(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
13.2.13.18. concave_hull
Devuelve un polígono posiblemente cóncavo que contiene todos los puntos de la geometría
Sintaxis |
concave_hull(geometry, target_percent, [allow_holes=False]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Lectura adicional: convex_hull
13.2.13.19. contains
Comprueba si una geometría contiene a otra. Devuelve TRUE si y sólo si ningún punto de geometría2 se encuentra en el exterior de geometría1, y al menos un punto del interior de geometría2 se encuentra en el interior de geometría1.
Sintaxis |
contains(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: overlay_contains
13.2.13.20. convex_hull
Devuelve el casco convexo de una geoemtría. REpresenta la geoemtría convexa mínima que encierra todas las geometrías dentro del conjunto.
Sintaxis |
convex_hull(geometry) |
Argumentos |
|
Ejemplos |
|
Lectura adicional: algoritmo concave_hull, :ref:`qgisconvexhull
13.2.13.21. crosses
Comprueba si una geometría cruza a otra. Devuelve TRUE si las geometrías suministradas tienen algunos puntos interiores en común, pero no todos.
Sintaxis |
crosses(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: overlay_crosses
13.2.13.22. densify_by_count
Toma una geometría de capa poligonal o lineal y genera una nueva en la que las geometrías tienen un mayor número de vértices que la original.
Sintaxis |
densify_by_count(geometry, vertices) |
Argumentos |
|
Ejemplos |
|
Lectura adicional: algoritmo Densificar por conteo
13.2.13.23. densify_by_distance
Toma una geometría de capa poligonal o lineal y genera una nueva en la que las geometrías se densifican añadiendo vértices adicionales en las aristas que tienen una distancia máxima de la distancia de intervalo especificada.
Sintaxis |
densify_by_distance(geometry, distance) |
Argumentos |
|
Ejemplos |
|
Lectura adicional: algoritmo Densificar por intervalo
13.2.13.24. difference
Devuelve una geometría que representa la parte de geometry1 que no se cruza con geometry2.
Sintaxis |
difference(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Diferencia
13.2.13.25. disjoint
Comprueba si las geometrías no se cruzan espacialmente. Devuelve TRUE si las geometrías no comparten ningún espacio.
Sintaxis |
disjoint(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: overlay_disjoint
13.2.13.26. distance
Devuelve la distancia mínima (basada en la referencia espacial) entre dos geometrías en unidades proyectadas.
Sintaxis |
distance(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
13.2.13.27. distance_to_vertex
Devuelve la distancia a lo largo de la geometría hasta un vértice especificado.
Sintaxis |
distance_to_vertex(geometry, vertex) |
Argumentos |
|
Ejemplos |
|
13.2.13.28. end_point
Devuelve el último nodo de una geoemtría.
Sintaxis |
end_point(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Extráe vértices específicos
13.2.13.29. exif_geotag
Crea una geometría de punto a partir de las etiquetas geográficas exif de un archivo de imagen.
Sintaxis |
exif_geotag(path) |
Argumentos |
|
Ejemplos |
|
13.2.13.30. extend
Extiende el inicio y el final de una geometría de cadena lineal en una cantidad especificada. Las líneas se extienden utilizando el rumbo del primer y último segmento de la línea. Para una multilínea, todas las partes están extendidas. Las distancias están en el sistema de referencia espacial de esta geometría.
Sintaxis |
extend(geometry, start_distance, end_distance) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Extender líneas
13.2.13.31. exterior_ring
Devuelve una cadena lineal que representa el anillo exterior de una geometría poligonal. Si la geometría no es un polígono, el resultado será NULO.
Sintaxis |
exterior_ring(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.32. extrude
Devuelve una versión extruida de la geometría de entrada (Multi-)Curva o (Multi-)Linea con una extensión especificada por x e y.
Sintaxis |
extrude(geometry, x, y) |
Argumentos |
|
Ejemplos |
|
13.2.13.33. flip_coordinates
Devuelve una copia de la geometría con las coordenadas xey intercambiadas. Útil para reparar geometrías cuyos valores de latitud y longitud se han invertido.
Sintaxis |
flip_coordinates(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Intercmbiar coordenadas X e Y
13.2.13.34. force_polygon_ccw
Obliga a una geometría a respetar la convención según la cual los anillos exteriores van en el sentido contrario a las agujas del reloj y los interiores en el sentido de las agujas del reloj.
Sintaxis |
force_polygon_ccw(geometry) |
Argumentos |
|
Ejemplos |
|
Lectura adicional: force_polygon_cw, force_rhr
13.2.13.35. force_polygon_cw
Obliga a una geometría a respetar la convención según la cual los anillos exteriores van en el sentido de las agujas del reloj y los interiores en sentido contrario.
Sintaxis |
force_polygon_cw(geometry) |
Argumentos |
|
Ejemplos |
|
Lectura adicional: force_polygon_ccw, force_rhr
13.2.13.36. force_rhr
Obliga a una geometría a respetar la regla de la mano derecha, según la cual el área delimitada por un polígono se encuentra a la derecha del límite. En particular, el anillo exterior se orienta en el sentido de las agujas del reloj y los anillos interiores en sentido contrario. Debido a la inconsistencia en la definición de la Regla de la Mano Derecha en algunos contextos se recomienda utilizar la función explícita force_polygon_cw en su lugar.
Sintaxis |
force_rhr(geometry) |
Argumentos |
|
Ejemplos |
|
Lecturas adicionales: algoritmo Fuerza la regla de la mano derecha, force_polygon_ccw, force_polygon_cw
13.2.13.37. geom_from_gml
Devuelve una geoemtría de una representación GML de geoemtría.
Sintaxis |
geom_from_gml(gml) |
Argumentos |
|
Ejemplos |
|
13.2.13.38. geom_from_wkb
Devuelve una geoemtría creada desde un a representación Well-Known Binary (WKB).
Sintaxis |
geom_from_wkb(binary) |
Argumentos |
|
Ejemplos |
|
13.2.13.39. geom_from_wkt
Devuelve una geoemtría creada desde una representación Well-Known Text (WKT).
Sintaxis |
geom_from_wkt(text) |
Argumentos |
|
Ejemplos |
|
13.2.13.40. geom_to_wkb
Devuelve la representación Well-Known Binary (WKB) de una geometría
Sintaxis |
geom_to_wkb(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.41. geom_to_wkt
Devuelve la representación Well-Known Text (WKT) de una geoemtría sin metadatos SRID.
Sintaxis |
geom_to_wkt(geometry, [precision=8]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.42. $geometry
Devuelve la geometría del objeto espacial actual. Puede utilizarse para procesarla con otras funciones. **AVISO: Esta función está obsoleta. Se recomienda utilizar la variable @geometry en su lugar.
Sintaxis |
$geometry |
Ejemplos |
|
13.2.13.43. geometry
Devuelve la geometría de una función.
Sintaxis |
geometry(feature) |
Argumentos |
|
Ejemplos |
|
13.2.13.44. geometry_n
Devuelve una geometría específica de una colección de geometrías, o NULL si la geometría de entrada no es una colección. También devuelve una parte de una geometría multiparte.
Sintaxis |
geometry_n(geometry, index) |
Argumentos |
|
Ejemplos |
|
13.2.13.45. geometry_type
Devuelve un valor de cadena que describe el tipo de geometría (Punto, Línea o Polígono)
Sintaxis |
geometry_type(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.46. hausdorff_distance
Devuelve la distancia de Hausdorff entre dos geometrías. Esta es básicamente una medida de cuán similares o diferentes son 2 geometrías, con una distancia menor indicando geometrías más similares.
La función se puede ejecutar con un argumento opcional de fracción densificar. Si no se especifica, se utiliza una aproximación a la distancia estándar de Hausdorff. Esta aproximación es lo suficientemente exacta o cercana para un gran subconjunto de casos útiles. Ejemplos de estos son:
calcular la distancia entre líneas lineales que son aproximadamente paralelas entre sí y aproximadamente iguales en longitud. Esto ocurre en redes lineales coincidentes.
Prueba de similitud de geometrías.
Si el valor aproximado predeterminado proporcionado por este método es insuficiente, especifique el argumento opcional de fracción densificar. Al especificar este argumento, se realiza una densificación de segmento antes de calcular la distancia discreta de Hausdorff. El parámetro establece la fracción por la cual densificar cada segmento. Cada segmento se dividirá en varios 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 de fracción de densificación hará que la distancia devuelta se acerque a la distancia real de Hausdorff para las geometrías.
Sintaxis |
hausdorff_distance(geometry1, geometry2, [densify_fraction]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.47. inclination
Devuelve la inclinación medida desde el cenit (0) al nadir (180) desde el punto_a al punto_b.
Sintaxis |
inclination(point_a, point_b) |
Argumentos |
|
Ejemplos |
|
13.2.13.48. interior_ring_n
Devuelve un anillo interior específico de una geometría poligonal o NULL si la geometría no es un polígono.
Sintaxis |
interior_ring_n(geometry, index) |
Argumentos |
|
Ejemplos |
|
13.2.13.49. intersection
Devuelve una geometría que representa la parte compartida de dos geometrías.
Sintaxis |
intersection(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Intersección
13.2.13.50. intersects
Comprueba si una geometría interseca a otra. Devuelve TRUE si las geometrías se intersecan espacialmente (comparten cualquier parte del espacio) y false si no lo hacen.
Sintaxis |
intersects(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: overlay_intersects
13.2.13.51. intersects_bbox
Comprueba si la caja delimitadora de una geometría se solapa con la caja delimitadora de otra geometría. Devuelve TRUE si las geometrías intersecan espacialmente la caja delimitadora definida y false si no lo hacen.
Sintaxis |
intersects_bbox(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
13.2.13.52. is_closed
Devuelve TRUE si una cadena de líneas está cerrada (coinciden os puntos de inicio y final), o false si la cadena de líneas no está cerradai. Si la geometría no es un a cadena de líneas el resultado será NULL.
Sintaxis |
is_closed(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.53. is_empty
Devuelve TRUE si una geometría está vacía (sin coordenadas), false sí la geometría no está vacía y NULL sí no hay geometría. Vea también is_empty_or_null.
Sintaxis |
is_empty(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: is_empty_or_null
13.2.13.54. is_empty_or_null
Devuelve TRUE si una geometría es NULL o vacía (sin corrdenadas) o false en otros casos. Esta función es como la expresión “$geometry IS NULL or is_empty($geometry)”
Sintaxis |
is_empty_or_null(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.55. is_multipart
Devuelve TRUE sí la geometría es de tipo Multi.
Sintaxis |
is_multipart(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.56. is_valid
Devuelve TRUE sí la geometría es válida; sí está bien formada en 2D de acuerdo a las reglas OGC.
Sintaxis |
is_valid(geometry) |
Argumentos |
|
Ejemplos |
|
Lectura adicional: make_valid, algoritmo :ref:`qgischeckvalidity
13.2.13.57. $length
Devuelve la longitud de una cadena de líneas. Si necesita la longitud de un borde de un polígono, use $perimeter en su lugar. La longitud calculada por esta función respeta tanto la configuración del elipsoide del proyecto actual como la configuración de la unidad de distancia. Por ejemplo, si se ha establecido un elipsoide para el proyecto, la longitud calculada será elipsoidal, y si no se establece ningún elipsoide, la longitud calculada será planimétrica.
Sintaxis |
$length |
Ejemplos |
|
13.2.13.58. length
Devuelve el número de caracteres de una cadena o la longitud de una cadena de líneas geométricas.
Variante de cadena
Devuelve el número de caracteres de una cadena.
Sintaxis |
length(string) |
Argumentos |
|
Ejemplos |
|
Variante Geometría
Calcula la longitud de un objeto de línea geométrica. Los cálculos son siempre planimétricos en el Sistema de referencia espacial (SRS) de esta geometría, y las unidades de la longitud devuelta coincidirán con las unidades del SRS. Esto difiere de los cálculos realizados por la función $length, que realizará cálculos elipsoidales basados en la configuración de unidad de distancia y elipsoide del proyecto.
Sintaxis |
length(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: straight_distance_2d
13.2.13.59. length3D
Calcula la longitud 3D de un objeto de línea de geometría. Si la geometría no es un objeto de línea 3D, devuelve su longitud 2D. Los cálculos siempre son planimétricos en el Sistema de referencia espacial (SRS) de esta geometría, y las unidades de la longitud devuelta coincidirán con las unidades del SRS. Esto difiere de los cálculos realizados por la función $length, que realizará cálculos elipsoidales basados en la configuración de unidad de distancia y elipsoide del proyecto.
Sintaxis |
length3D(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.60. line_interpolate_angle
Devuelve el ángulo paralelo a la geometría a una distancia especificada a lo largo de una geometría de cadena lineal. Los ángulos están en grados en sentido horario desde el norte.
Sintaxis |
line_interpolate_angle(geometry, distance) |
Argumentos |
|
Ejemplos |
|
13.2.13.61. line_interpolate_point
Devuelve el punto interpolado por una distancia especificada a lo largo de una geometría de cadena lineal.
Sintaxis |
line_interpolate_point(geometry, distance) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Interpolar puntos en línea
13.2.13.62. line_locate_point
Devuelve la distancia a lo largo de una cadena lineal correspondiente a la posición más cercana a la que la cadena lineal llega a una geometría de punto especificada.
Sintaxis |
line_locate_point(geometry, point) |
Argumentos |
|
Ejemplos |
|
13.2.13.63. line_merge
Devuelve una geometría LineString o MultiLineString, donde cualquier LineString conectado de la geometría de entrada se ha fusionado en una única cadena lineal. Esta función devolverá NULL si se le pasa una geometría que no sea LineString/MultiLineString.
Sintaxis |
line_merge(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.64. line_substring
Devuelve la parte de una geometría de línea (o curva) que se encuentra entre las distancias inicial y final especificadas (medidas desde el principio de la línea). Los valores Z y M se interpolan linealmente a partir de los valores existentes.
Sintaxis |
line_substring(geometry, start_distance, end_distance) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Subcadena de línea
13.2.13.65. m
Devuelve el valor m (medida) de un punto de geometría.
Sintaxis |
m(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.66. m_max
Devuelve el valor m máximo (medida) de una geoemtría.
Sintaxis |
m_max(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.67. m_min
Devuelve el valor mínimo m (medida) de una geometría.
Sintaxis |
m_min(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.68. main_angle
Devuelve el ángulo del eje largo (en el sentido de las agujas del reloj, en grados desde el norte) del rectángulo delimitador mínimo orientado, que cubre completamente la geometría.
Sintaxis |
main_angle(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.69. make_circle
Crea un polígono circular.
Sintaxis |
make_circle(center, radius, [segments=36]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.70. make_ellipse
Crea un polígono elíptico.
Sintaxis |
make_ellipse(center, semi_major_axis, semi_minor_axis, azimuth, [segments=36]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.71. make_line
Crea una geometría de línea a partir de una serie de geometrías de puntos.
Lista de argumentos variantes
Los vértices de línea se especifican como argumentos separados para la función.
Sintaxis |
make_line(point1, point2, …) |
Argumentos |
|
Ejemplos |
|
Matriz variante
Los vértices de línea se especifican como una matriz de puntos.
Sintaxis |
make_line(array) |
Argumentos |
|
Ejemplos |
|
13.2.13.72. make_point
Crea una geometría de punto a partir de un valor xey (y z y m opcionales).
Sintaxis |
make_point(x, y, [z], [m]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.73. 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 |
|
Ejemplos |
|
13.2.13.74. make_polygon
Crea una geometría poligonal a partir de un anillo exterior y una serie opcional de geometrías de anillo interior.
Sintaxis |
make_polygon(outerRing, [innerRing1], [innerRing2], …) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.75. make_rectangle_3points
Crea un rectángulo desde 3 puntos.
Sintaxis |
make_rectangle_3points(point1, point2, point3, [option=0]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.76. make_regular_polygon
Crea un polígono regular.
Sintaxis |
make_regular_polygon(center, radius, number_sides, [circle=0]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.77. make_square
Crea un cuadrado a partir de diagonal.
Sintaxis |
make_square(point1, point2) |
Argumentos |
|
Ejemplos |
|
13.2.13.78. make_triangle
Crea un polígono triangular.
Sintaxis |
make_triangle(point1, point2, point3) |
Argumentos |
|
Ejemplos |
|
13.2.13.79. make_valid
Devuelve una geometría válida o una geometría vacía si la geometría no se pudiera hacer válida.
Sintaxis |
make_valid(geometry, [method=structure], [keep_collapsed=false]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: is_valid, Corregir geometrías algorithm
13.2.13.80. 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 dentro del conjunto.
Sintaxis |
minimal_circle(geometry, [segments=36]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Cícrculos mínimos cercantes
13.2.13.81. nodes_to_points
Devuelve una geometría multipunto que consta de todos los nodos de la geometría de entrada.
Sintaxis |
nodes_to_points(geometry, [ignore_closing_nodes=false]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Extraer vértices
13.2.13.82. num_geometries
Devuelve el número de geometrías en una colección de geometrías o el número de partes en una geometría multiparte. La función devuelve NULL si la geometría de entrada no es una colección.
Sintaxis |
num_geometries(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.83. num_interior_rings
Devuelve el número de anillos interiores en un polígono o colección de geometría, o NULL si la geometría de entrada no es un polígono o colección.
Sintaxis |
num_interior_rings(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.84. num_points
Devuelve el número de vértices en una geoemtría.
Sintaxis |
num_points(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.85. num_rings
Devuelve el número de anillos (incluidos los anillos exteriores) en un polígono o colección de geometría, o NULL si la geometría de entrada no es un polígono o colección.
Sintaxis |
num_rings(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.86. offset_curve
Devuelve una geometría formada desplazando una geometría de cadena de líneas 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]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Compensado de líneas
13.2.13.87. order_parts
Ordena las partes de una MultiGeometría por los criterios dados
Sintaxis |
order_parts(geometry, orderby, [ascending=true]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.88. oriented_bbox
Devuelve una geometría que representa el cuadro delimitador orientado mínimo de una geometría de entrada.
Sintaxis |
oriented_bbox(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Cuador delimitador mínimo orientado
13.2.13.89. overlaps
Prueba sí una geometría se superpone a otra. Devuelve TRUE si la geometrías comparten especios, son de la misma dimensión, pero no se contienen completamente una a otra.
Sintaxis |
overlaps(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
13.2.13.90. overlay_contains
Devuelve si la entidad actual contiene espacialmente al menos una entidad de una capa de destino o una matriz de resultados basados en expresiones para las entidades de la capa de destino contenidas en la entidad actual.
Más información sobre el predicado «Contiene» de GEOS subyacente, como se describe en la función PostGIS ST_Contains.
Sintaxis |
overlay_contains(layer, [expression], [filter], [limit], [cache=false]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: contains, manipulación de array, algoritmo Seleccionar por ubicacion
13.2.13.91. overlay_crosses
Devuelve si la entidad actual cruza espacialmente al menos una entidad de una capa de destino o una matriz de resultados basados en expresiones para las entidades de la capa de destino cruzadas por la entidad actual.
Más información sobre el predicado «cruces» de GEOS subyacente, como se describe en la función PostGIS`ST_Crosses <https://postgis.net/docs/ST_Crosses.html>`_.
Sintaxis |
overlay_crosses(layer, [expression], [filter], [limit], [cache=false]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: crosses, manipulación de array, algoritmo Seleccionar por ubicacion
13.2.13.92. overlay_disjoint
Devuelve si la entidad actual está separada espacialmente de todas las entidades de una capa de destino o una matriz de resultados basados en expresiones para las entidades de la capa de destino que están separadas de la entidad actual.
Más información sobre el predicado «Disjoint» de GEOS subyacente, como se describe en la función PostGIS ST_Disjoint.
Sintaxis |
overlay_disjoint(layer, [expression], [filter], [limit], [cache=false]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: disjoint, manipulación array, algoritmo Seleccionar por ubicacion
13.2.13.93. overlay_equals
Devuelve si la entidad actual es espacialmente igual a al menos una entidad de una capa de destino o una matriz de resultados basados en expresiones para las entidades de la capa de destino que son espacialmente iguales a la entidad actual.
Lea más sobre el predicado «Equals» de GEOS subyacente, como se describe en la función ST_Equals de PostGIS <https://postgis.net/docs/ST_Equals.html>`_.
Sintaxis |
overlay_equals(layer, [expression], [filter], [limit], [cache=false]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: manipulación array, algoritmo Seleccionar por ubicacion
13.2.13.94. overlay_intersects
Devuelve si la entidad actual interseca espacialmente al menos una entidad de una capa de destino o una matriz de resultados basados en expresiones para las entidades de la capa de destino intersectadas por la entidad actual.
Más información sobre el predicado subyacente «Intersects» de GEOS, como se describe en la función PostGIS ST_Intersects.
Sintaxis |
overlay_intersects(layer, [expression], [filter], [limit], [cache=false], [min_overlap], [min_inscribed_circle_radius], [return_details], [sort_by_intersection_size]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: intersects, manipulación array, algoritmo Seleccionar por ubicacion
13.2.13.95. overlay_nearest
Devuelve si la entidad actual tiene entidades de una capa de destino dentro de una distancia determinada, o una matriz de resultados basados en expresiones para las entidades en la capa de destino dentro de una distancia de la entidad actual.
Nota: esta función puede ser lenta y consumir mucha memoria para capas grandes.
Sintaxis |
overlay_nearest(layer, [expression], [filter], [limit=1], [max_distance], [cache=false]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: manipulación array, algoritmo Unir atributos por proximidad
13.2.13.96. overlay_touches
Devuelve si la entidad actual toca espacialmente al menos una entidad de una capa de destino o una matriz de resultados basados en expresiones para las entidades de la capa de destino tocadas por la entidad actual.
Obtenga más información sobre el predicado subyacente «Toques» de GEOS, como se describe en la función PostGIS. ST_Touches.
Sintaxis |
overlay_touches(layer, [expression], [filter], [limit], [cache=false]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: touches, manipulación array, algoritmo Seleccionar por ubicacion
13.2.13.97. overlay_within
Devuelve si la entidad actual está espacialmente dentro de al menos una entidad de una capa de destino o una matriz de resultados basados en expresiones para las entidades de la capa de destino que contienen la entidad actual.
Obtenga más información sobre el predicado subyacente «Dentro» de GEOS, como se describe en la función PostGIS ST_Within.
Sintaxis |
overlay_within(layer, [expression], [filter], [limit], [cache=false]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: within, manipulación array, algoritmo Seleccionar por ubicacion
13.2.13.98. $perimeter
Devuelve la longitud del perímetro de la entidad actual. El perímetro calculado por esta función respeta tanto la configuración del elipsoide del proyecto actual como la configuración de la unidad de distancia. Por ejemplo, si se ha establecido un elipsoide para el proyecto, el perímetro calculado será elipsoidal, y si no se establece ningún elipsoide, el perímetro calculado será planimétrico.
Sintaxis |
$perimeter |
Ejemplos |
|
13.2.13.99. perimeter
Devuelve el perímetro de un objeto poligonal de geometría. Los cálculos son siempre planimétricos en el Sistema de referencia espacial (SRS) de esta geometría, y las unidades del perímetro devuelto coincidirán con las unidades del SRS. Esto difiere de los cálculos realizados por la función $perimeter, que realizará cálculos elipsoidales basados en la configuración de unidad de distancia y elipsoide del proyecto.
Sintaxis |
perimeter(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.100. point_n
Devuelve un nodo especiífico de una geometría
Sintaxis |
point_n(geometry, index) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Extráe vértices específicos
13.2.13.101. point_on_surface
Devuelve un punto que se garantiza que se encuentra en la superficie de una geometría.
Sintaxis |
point_on_surface(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Punto en la superficie
13.2.13.102. pole_of_inaccessibility
Calcula el polo de inaccesibilidad aproximado de una superficie, que es el punto interno más distante del límite de la superficie. Esta función utiliza el algoritmo “polylabel” (Vladimir Agafonkin, 2016), que es un enfoque iterativo garantizado para encontrar el verdadero polo de inaccesibilidad dentro de una tolerancia especificada. Las tolerancias más precisas requieren más iteraciones y tomará más tiempo calcularlas.
Sintaxis |
pole_of_inaccessibility(geometry, tolerance) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Polo de inaccesibilidad
13.2.13.103. project
Devuelve un punto proyextado desde un punto inicial usando una distancia, una dirección (azimut) y una elevación en radianes.
Sintaxis |
project(point, distance, azimuth, [elevation]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Proyección de puntos (Cartesiano)
13.2.13.104. relate
Prueba la representación del modelo dimensional extendido de 9 intersecciones (DE-9IM) de la relación entre dos geometrías.
Variante de relación
Devuelve la representación del modelo dimensional extendido de 9 intersecciones (DE-9IM) de la relación entre dos geometrías.
Sintaxis |
relate(geometry, geometry) |
Argumentos |
|
Ejemplos |
|
Variante de patrón coincidente
Comprueba si la relación DE-9IM entre dos geometrías coincide con un patrón especificado.
Sintaxis |
relate(geometry, geometry, pattern) |
Argumentos |
|
Ejemplos |
|
13.2.13.105. reverse
Invierte la dirección de una cadena lineal invirtiendo el orden de sus vértices.
Sintaxis |
reverse(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Línea de dirección reversible
13.2.13.106. rotate
Devuelve una versión rotada de una geometría. Los cálculos son en el SRS de esta geometría.
Sintaxis |
rotate(geometry, rotation, [center=NULL], [per_part=false]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.107. roundness
Calcula lo cerca que está una forma poligonal de un círculo. La función devuelve TRUE cuando el polígono es un círculo perfecto y 0 cuando es completamente plano.
Sintaxis |
roundness(geometry) |
Argumentos |
|
Ejemplos |
|
Más información: Redondez algoritmo
13.2.13.108. scale
Devuelve una versión a escala de una geometría. Los cálculos se realizan en el Sistema de Referencia Espacial de esta geometría.
Sintaxis |
scale(geometry, x_scale, y_scale, [center]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.109. segments_to_lines
Devuelve una geometría multilínea que consta de una línea para todos los segmentos en la geoemtría entrante.
Sintaxis |
segments_to_lines(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Explotar lineas
13.2.13.111. shortest_line
Devuelve la línea mas corta uniendo geometria1 a geometría2. La línea resultante empezará en geometría1 y finalizará en geometría2.
Sintaxis |
shortest_line(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
13.2.13.112. simplify
Simplifica una geometría eliminando nodos mediante un umbral basado en la distancia (es decir, el algoritmo de Douglas Peucker). El algoritmo conserva grandes desviaciones en las geometrías y reduce el número de vértices en segmentos casi rectos.
Sintaxis |
simplify(geometry, tolerance) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Simplificar
13.2.13.113. simplify_vw
Simplifica una geometría eliminando nodos utilizando un umbral basado en áreas (es decir, el algoritmo Visvalingam-Whyatt). El algoritmo elimina los vértices que crean áreas pequeñas en geometrías, por ejemplo, picos estrechos o segmentos casi rectos.
Sintaxis |
simplify_vw(geometry, tolerance) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Simplificar
13.2.13.114. single_sided_buffer
Devuelve una geometría formada al almacenar en búfer solo un lado de una geometría de cadena lineal. 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]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Buffer a un solo lado
13.2.13.115. sinuosity
Devuelve la sinuosidad de una curva, que es la relación entre la longitud de la curva y la distancia recta (2D) entre sus extremos.
Sintaxis |
sinuosity(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.116. smooth
Suaviza una geometría agregando nodos adicionales que redondean las esquinas de la geometría. Si las geometrías de entrada contienen valores Z o M, estos también se suavizarán y la geometría de salida conservará la misma dimensionalidad que la geometría de entrada.
Sintaxis |
smooth(geometry, [iterations=1], [offset=0.25], [min_length=-1], [max_angle=180]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Suavizar
13.2.13.117. square_wave
Construye ondas cuadradas/rectangulares a lo largo de la frontera de una geometría.
Sintaxis |
square_wave(geometry, wavelength, amplitude, [strict=False]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.118. square_wave_randomized
Construye ondas cuadradas/rectangulares aleatorias a lo largo de la frontera de una geometría.
Sintaxis |
square_wave_randomized(geometry, min_wavelength, max_wavelength, min_amplitude, max_amplitude, [seed=0]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.119. start_point
Devuelve el primer nodo de una geoemtría.
Sintaxis |
start_point(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Extráe vértices específicos
13.2.13.120. straight_distance_2d
Devuelve la distancia directa/euclidiana entre el primer y el último vértice de una geometría. La geometría debe ser una curva (cadena circular, cadena lineal).
Sintaxis |
straight_distance_2d(geometry) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: length
13.2.13.121. sym_difference
Devuelve una geometría que representa las partes de dos geometrías que no se intersecan.
Sintaxis |
sym_difference(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Diferencia simétrica
13.2.13.122. tapered_buffer
Crea una zona de influencia a lo largo de una geometría de línea donde el diámetro de la zona de influencia varía uniformemente a lo largo de la línea.
Sintaxis |
tapered_buffer(geometry, start_width, end_width, [segments=8]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Zonas de influencia estrechas
13.2.13.123. touches
Comprueba si una geometría toca a otra. Devuelve TRUE si las geometrías tienen al menos un punto en común, pero sus interiores no se cruzan.
Sintaxis |
touches(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: overlay_touches
13.2.13.124. transform
Devuelve la geometría transformada de un CRS de origen a un CRS de destino.
Sintaxis |
transform(geometry, source_auth_id, dest_auth_id) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Capa reproyectada
13.2.13.125. translate
Devuelve una versión traducida de una geometría. Los cálculos están en el Sistema de referencia espacial de esta geometría.
Sintaxis |
translate(geometry, dx, dy) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Traslado
13.2.13.126. triangular_wave
Construye ondas triangulares a lo largo de la frontera de una geometría.
Sintaxis |
triangular_wave(geometry, wavelength, amplitude, [strict=False]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.127. triangular_wave_randomized
Construye ondas triangulares aleatorias a lo largo de la frontera de una geometría.
Sintaxis |
triangular_wave_randomized(geometry, min_wavelength, max_wavelength, min_amplitude, max_amplitude, [seed=0]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.128. union
Devuelve una geometría que representa la unión de conjuntos de puntos de las geometrías.
Sintaxis |
union(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
13.2.13.129. wave
Construye ondas redondeadas (sinusoidales) a lo largo del límite de una geometría.
Sintaxis |
wave(geometry, wavelength, amplitude, [strict=False]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.130. wave_randomized
Construye ondas curvas aleatorias (sinusoidales) a lo largo de la frontera de una geometría.
Sintaxis |
wave_randomized(geometry, min_wavelength, max_wavelength, min_amplitude, max_amplitude, [seed=0]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.13.131. wedge_buffer
Devuelve una zona de influencia en forma de cuña que se origina en una geometría de puntos.
Sintaxis |
wedge_buffer(center, azimuth, width, outer_radius, [inner_radius=0.0]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: algoritmo Crear buffer de cuñas
13.2.13.132. within
Comprueba si una geometría está dentro de otra. Devuelve TRUE si la geometry1 está completamente dentro de la geometry2.
Sintaxis |
within(geometry1, geometry2) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: overlay_within
13.2.13.133. $x
Devuelve la coordenada x de la entidad de punto actual. Si la entidad es una entidad multipunto, se devolverá la coordenada x del primer punto.
Sintaxis |
$x |
Ejemplos |
|
13.2.13.134. x
Devuelve la coordenada x de una geometría puntual, o la coordenada x del centroide para una geometría no puntual.
Sintaxis |
x(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.135. $x_at
Recupera una coordenada x de la geometría de la entidad actual.
Sintaxis |
$x_at(i) |
Argumentos |
|
Ejemplos |
|
13.2.13.136. 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(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.137. 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(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.138. $y
Devuelve la coordenada y de la entidad de punto actual. Si la entidad es una entidad multipunto, se devolverá la coordenada y del primer punto.
Sintaxis |
$y |
Ejemplos |
|
13.2.13.139. y
Devuelve la coordenada y de una geometría puntual, o la coordenada y del centroide para una geometría no puntual.
Sintaxis |
y(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.140. $y_at
Recupera una coordenada y de la geometría de la entidad actual.
Sintaxis |
$y_at(i) |
Argumentos |
|
Ejemplos |
|
13.2.13.141. 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(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.142. 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(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.143. $z
Devuelve el valor z de la característica de punto actual si es 3D. Si la entidad es una entidad multipunto, se devolverá el valor z del primer punto.
Sintaxis |
$z |
Ejemplos |
|
13.2.13.144. z
Devuelve la coordenada z de una geometría de punto, o NULL si la geometría no tiene valor z.
Sintaxis |
z(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.145. z_max
Devuelve la coordenada z máxima de una geometría, o NULL si la geometría no tiene valor z.
Sintaxis |
z_max(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.13.146. z_min
Devuelve la coordenada z mínima de una geometría, o NULL si la geometría no tiene valor z.
Sintaxis |
z_min(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.14. Funciones de diseño
Este grupo contiene funciones para manipular las propiedades de elementos del diseño de impresión.
13.2.14.1. item_variables
Devuelve un mapa de variables de un elemento de diseño dentro de este diseño de impresión.
Sintaxis |
item_variables(id) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: Lista de variables predeterminadas
13.2.14.2. map_credits
Devuelve una lista de cadenas de crédito (derechos de uso) para las capas que se muestran en un elemento de mapa de diseño.
Sintaxis |
map_credits(id, [include_layer_names=false], [layer_name_separator=”: “]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Esta función requiere que se hayan rellenado las Access metadata properties de las capas.
13.2.15. Capas de mapa
Este grupo contiene una lista de las capas disponibles en el proyecto actual y, para cada capa, sus campos (almacenados en el conjunto de datos, los virtuales o auxiliares así como las uniones). Con los campos se puede interactuar de la misma forma que se ha mencionado en Campos y Valores, excepto que la doble pulsación añadirá el nombre como una cadena (cita simple) a la expresión en lugar de com o una referencia de campo dado que no pertenece a la capa activa. Esto ofrece una manera conveniente de escribir expresiones que se refieran a diferentes capas, como cuando se llevan a cabo consultas aggregates, attribute o spatial.
También proporciona algunas funciones convenientes para manipular capas.
13.2.15.1. decode_uri
Toma una capa y decodifica el uri del proveedor de datos subyacente. Depende del proveedor de datos, qué datos están disponibles.
Sintaxis |
decode_uri(layer, [part]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.15.2. layer_property
Devuelve una propiedad de capa coincidente o un valor de metadatos.
Sintaxis |
layer_property(layer, property) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: vector, raster and mesh propiedades de la capa
13.2.16. Funciones de Mapas
Este grupo contiene funciones para crear o manipular claves y valores de estructuras de datos de mapas (también conocidos como objetos de diccionario, pares clave-valor o matrices asociativas). A diferencia del list data structure donde importa el orden de valores, el orden de los pares clave-valor en el objeto de mapa no es relevante y los valores se identifican por sus claves.
13.2.16.1. from_json
Carga una cadena con formato JSON.
Sintaxis |
from_json(string) |
Argumentos |
|
Ejemplos |
|
13.2.16.2. hstore_to_map
Crea un mapa de una cadena con formato hstore.
Sintaxis |
hstore_to_map(string) |
Argumentos |
|
Ejemplos |
|
13.2.16.3. map
Devuelve un mapa conteniendo todas las claves y valores pasados como para de parámetros.
Sintaxis |
map(key1, value1, key2, value2, …) |
Argumentos |
|
Ejemplos |
|
13.2.16.4. map_akeys
Devuelve todas las claves de un mapa como una matriz.
Sintaxis |
map_akeys(map) |
Argumentos |
|
Ejemplos |
|
13.2.16.5. map_avals
Devuelve todos los valore de un mapa como una matriz.
Sintaxis |
map_avals(map) |
Argumentos |
|
Ejemplos |
|
13.2.16.6. 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 |
|
Ejemplos |
|
13.2.16.7. map_delete
Devuelve un mapa con la clave dada y su valor borrado correspondiente.
Sintaxis |
map_delete(map, key) |
Argumentos |
|
Ejemplos |
|
13.2.16.8. map_exist
Devuelve TRUE si la clave dada existe en el mapa.
Sintaxis |
map_exist(map, key) |
Argumentos |
|
Ejemplos |
|
13.2.16.9. map_get
Devuelve el valor de un mapa, dada su clave. Devuelve NULL si la clave no existe.
Sintaxis |
map_get(map, key) |
Argumentos |
|
Ejemplos |
|
Consejo
También puede utilizar el index operator ([]) para obtener un valor de un mapa.
13.2.16.10. map_insert
Devuelve un mapa con una clave/valor agregado. Si la clave ya existe, su valor se anula.
Sintaxis |
map_insert(map, key, value) |
Argumentos |
|
Ejemplos |
|
13.2.16.11. map_prefix_keys
Devuelve un mapa con todas las claves prefijadas por una cadena dada.
Sintaxis |
map_prefix_keys(map, prefix) |
Argumentos |
|
Ejemplos |
|
13.2.16.12. map_to_hstore
Mezclar elementos de mapa en una cadena de formato hstore.
Sintaxis |
map_to_hstore(map) |
Argumentos |
|
Ejemplos |
|
13.2.16.13. to_json
Crea una cedena con formato JSON a partir de un mapa, matriz u otro valor.
Sintaxis |
to_json(value) |
Argumentos |
|
Ejemplos |
|
13.2.16.14. url_encode
Devuelve una cadena URL codificada a partir de un mapa. Transforma todos los caracteres en su forma correctamente codificada produciendo una cadena de consulta totalmente compatible.
Tenga en cuenta que el signo «+» no se convierte.
Sintaxis |
url_encode(map) |
Argumentos |
|
Ejemplos |
|
13.2.17. Funciones Matemáticas
Este grupo contiene funciones matemáticas (por ejemplo raíz cuadrada, seno y coseno).
13.2.17.1. abs
Devuelve el valor absoluto de un número.
Sintaxis |
abs(value) |
Argumentos |
|
Ejemplos |
|
13.2.17.2. acos
Devuelve el arcocoseno de un valor en radianes.
Sintaxis |
acos(value) |
Argumentos |
|
Ejemplos |
|
13.2.17.3. asin
Devuelve el arcoseno de un valor en radianes.
Sintaxis |
asin(value) |
Argumentos |
|
Ejemplos |
|
13.2.17.4. atan
Devuelve el arcotangente de un valor en radianes.
Sintaxis |
atan(value) |
Argumentos |
|
Ejemplos |
|
13.2.17.5. atan2
Devuelve el arcotangente de dy/dx usando los signos de dos argumentos para determinar el cuadrante del resultado.
Sintaxis |
atan2(dy, dx) |
Argumentos |
|
Ejemplos |
|
13.2.17.6. ceil
Redondea un número hacia arriba.
Sintaxis |
ceil(value) |
Argumentos |
|
Ejemplos |
|
13.2.17.7. clamp
Restringe un valor de entrada a un rango especificado.
Sintaxis |
clamp(minimum, input, maximum) |
Argumentos |
|
Ejemplos |
|
13.2.17.8. cos
Devuelve el coseno de un ángulo.
Sintaxis |
cos(angle) |
Argumentos |
|
Ejemplos |
|
13.2.17.9. degrees
Convierte de radianes a grados.
Sintaxis |
degrees(radians) |
Argumentos |
|
Ejemplos |
|
13.2.17.10. exp
Devuelve exponencial de un valor.
Sintaxis |
exp(value) |
Argumentos |
|
Ejemplos |
|
13.2.17.11. floor
Redondea un número hacia abajo.
Sintaxis |
floor(value) |
Argumentos |
|
Ejemplos |
|
13.2.17.12. ln
Devuelve el logaritmo natural de un valor.
Sintaxis |
ln(value) |
Argumentos |
|
Ejemplos |
|
13.2.17.13. log
Devuelve el valor del logaritmo del valor pasado y la base.
Sintaxis |
log(base, value) |
Argumentos |
|
Ejemplos |
|
13.2.17.14. log10
Devuelve el valor del logaritmo de base 10 de la expresión pasada.
Sintaxis |
log10(value) |
Argumentos |
|
Ejemplos |
|
13.2.17.15. max
Devuelve el valor más grande de un conjunto de valores.
Sintaxis |
max(value1, value2, …) |
Argumentos |
|
Ejemplos |
|
13.2.17.16. min
Devuelve el valor más pequeño de un conjunto de valores.
Sintaxis |
min(value1, value2, …) |
Argumentos |
|
Ejemplos |
|
13.2.17.17. pi
Devuelve el valor de pi para los cálculos.
Sintaxis |
pi() |
Ejemplos |
|
13.2.17.18. radians
Convierte de grados a radianes.
Sintaxis |
radians(degrees) |
Argumentos |
|
Ejemplos |
|
13.2.17.19. rand
Devuelve un número entero aleatorio dentro del rango especificado por el argumento mínimo y máximo (inclusive). Si se proporciona una semilla, la devolución siempre será la misma, dependiendo de la semilla.
Sintaxis |
rand(min, max, [seed=NULL]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.17.20. randf
Devuelve un flotante aleatorio dentro del rango especificado por el argumento mínimo y máximo (inclusive). Si se proporciona una semilla, la devolución siempre será la misma, dependiendo de la semilla.
Sintaxis |
randf([min=0.0], [max=1.0], [seed=NULL]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.17.21. round
Redondea un número al número de posiciones decimales.
Sintaxis |
round(value, [places=0]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.17.22. 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 utilizar para facilitar valores dentro o fuera del rango de salida especificado.
Sintaxis |
scale_exp(value, domain_min, domain_max, range_min, range_max, exponent) |
Argumentos |
|
Ejemplos |
|
13.2.17.23. scale_linear
Transforma un valor dado de un dominio de entrada a un rango de salida mediante interpolación lineal.
Sintaxis |
scale_linear(value, domain_min, domain_max, range_min, range_max) |
Argumentos |
|
Ejemplos |
|
13.2.17.24. sin
Devuelve el seno de un ángulo.
Sintaxis |
sin(angle) |
Argumentos |
|
Ejemplos |
|
13.2.17.25. sqrt
Devuelve la raiz cuadrada de un valor.
Sintaxis |
sqrt(value) |
Argumentos |
|
Ejemplos |
|
13.2.17.26. tan
Devuelve la tangente de un ángulo.
Sintaxis |
tan(angle) |
Argumentos |
|
Ejemplos |
|
13.2.18. Funciones de mallas
Este grupo contiene funciones que calculan o devuelven valores relacionados con la malla.
13.2.18.1. $face_area
Devuelve el área de la cara de malla actual. El área calculada por esta función respeta tanto la configuración del elipsoide del proyecto actual como la configuración de la unidad de área. Por ejemplo, si se ha establecido un elipsoide para el proyecto, el área calculada será elipsoidal, y si no se establece ningún elipsoide, el área calculada será planimétrica.
Sintaxis |
$face_area |
Ejemplos |
|
13.2.18.2. $face_index
Devuelve el índice de la cara de malla actual.
Sintaxis |
$face_index |
Ejemplos |
|
13.2.18.3. $vertex_as_point
Devuelve el vértice actual como una geometría de punto.
Sintaxis |
$vertex_as_point |
Ejemplos |
|
13.2.18.4. $vertex_index
Devuelve el índice del vértice de la malla actual.
Sintaxis |
$vertex_index |
Ejemplos |
|
13.2.18.5. $vertex_x
Devuelve la coordenada X del vértice de la malla actual.
Sintaxis |
$vertex_x |
Ejemplos |
|
13.2.18.6. $vertex_y
Devuelve la coordenada Y del vértice de la malla actual.
Sintaxis |
$vertex_y |
Ejemplos |
|
13.2.18.7. $vertex_z
Devuelve el valor Z del vértice de malla actual.
Sintaxis |
$vertex_z |
Ejemplos |
|
13.2.19. Operadores
Este grupo contiene operadores (por ejemplo, +, -, *). Tenga en cuenta que para la mayoría de las funciones matemáticas a continuación, si una de las entradas es NULL, el resultado es NULL.
13.2.19.1. %
Resto de la división. Toma el signo del dividendo.
Sintaxis |
a % b |
Argumentos |
|
Ejemplos |
|
13.2.19.2. *
Multiplicación de dos valores
Sintaxis |
a * b |
Argumentos |
|
Ejemplos |
|
13.2.19.3. +
Suma de dos valores. Si uno de los valores es NULL, el resultado será NULL.
Sintaxis |
a + b |
Argumentos |
|
Ejemplos |
|
13.2.19.4. -
Resta de dos valores. Si uno de los valores es NULL, el resultado será NULL.
Sintaxis |
a - b |
Argumentos |
|
Ejemplos |
|
13.2.19.5. /
División de dos valores
Sintaxis |
a / b |
Argumentos |
|
Ejemplos |
|
13.2.19.6. <
Compara dos valores y evalúa a 1 si el valor de la izquierda es menor que el valor de la derecha.
Sintaxis |
a < b |
Argumentos |
|
Ejemplos |
|
13.2.19.7. <=
Compara dos valores y evalúa a 1 si el valor de la izquierda es menor o igual que el valor de la derecha.
Sintaxis |
a <= b |
Argumentos |
|
Ejemplos |
|
13.2.19.8. <>
Compara dos valores y evalúa a 1 si no son iguales.
Sintaxis |
a <> b |
Argumentos |
|
Ejemplos |
|
13.2.19.9. =
Compara dos valores y evalúa a 1 si son iguales.
Sintaxis |
a = b |
Argumentos |
|
Ejemplos |
|
13.2.19.10. >
Compara dos valores y evalúa a 1 si el valor de la izquierda es mayor que el valor de la derecha.
Sintaxis |
a > b |
Argumentos |
|
Ejemplos |
|
13.2.19.11. >=
Compara dos valores y evalúa a 1 si el valor de la izquierda es mayor o igual que el valor de la derecha.
Sintaxis |
a >= b |
Argumentos |
|
Ejemplos |
|
13.2.19.12. AND
Devuelve TRUE cuando las condiciones a y b son verdaderas.
Sintaxis |
a AND b |
Argumentos |
|
Ejemplos |
|
13.2.19.13. BETWEEN
Devuelve TRUE si el valor está dentro del rango especificado. El rango se considera inclusivo de los límites. Para comprobar la exclusión se puede utilizar NOT BETWEEN.
Sintaxis |
valor lower_bound AND higher_bound |
Argumentos |
|
Ejemplos |
|
Nota
value BETWEEN lower_bound AND higher_bound es lo mismo que «value >= lower_bound AND value <= higher_bound».
Lectura adicional: NOT BETWEEN
13.2.19.14. ILIKE
Devuelve TRUE si el primer parámetro coincide con el patrón suministrado sin distinguir mayúsculas de minúsculas. Se puede utilizar LIKE en lugar de ILIKE para que la coincidencia distinga entre mayúsculas y minúsculas. También funciona con números.
Sintaxis |
cadena de texto/número ILIKE patrón |
Argumentos |
|
Ejemplos |
|
13.2.19.15. IN
Devuelve TRUE si el valor se encuentra dentro de una lista de valores.
Sintaxis |
a IN b |
Argumentos |
|
Ejemplos |
|
13.2.19.16. IS
Devuelve TRUE si a es igual a b.
Sintaxis |
a IS b |
Argumentos |
|
Ejemplos |
|
13.2.19.17. IS NOT
Devuelve TRUE si a no es igual a b.
Sintaxis |
a IS NOT b |
Argumentos |
|
Ejemplos |
|
13.2.19.18. LIKE
Devuelve TRUE si el primer parámetro coincide con el patrón suministrado. También funciona con números.
Sintaxis |
cadena de texto/número ILIKE patrón |
Argumentos |
|
Ejemplos |
|
13.2.19.19. NOT
Niega una condición.
Sintaxis |
NOT a |
Argumentos |
|
Ejemplos |
|
13.2.19.20. NOT BETWEEN
Devuelve TRUE si el valor no está dentro del rango especificado. El rango se considera inclusivo de los límites.
Sintaxis |
value NOT BETWEEN lower_bound AND higher_bound |
Argumentos |
|
Ejemplos |
|
Nota
value NOT BETWEEN lower_bound AND higher_bound es lo mismo que «value < lower_bound OR value > higher_bound».
Lectura adicional: BETWEEN
13.2.19.21. OR
Devuelve TRUE cuando la condición a o b es verdadera.
Sintaxis |
a OR b |
Argumentos |
|
Ejemplos |
|
13.2.19.22. []
Index operator. Devuelve un elemento de una matriz o un valor de mapa.
Sintaxis |
[índice] |
Argumentos |
|
Ejemplos |
|
13.2.19.23. ^
Potencia de dos valores.
Sintaxis |
a ^ b |
Argumentos |
|
Ejemplos |
|
13.2.19.24. ||
Une dos valores en una cadena.
Si uno de los valores es NULL, el resultado será NULL. Ver la función CONCAT para un comportamiento diferente.
Sintaxis |
a || b |
Argumentos |
|
Ejemplos |
|
13.2.19.25. ~
Realiza una coincidencia de expresión regular en un valor de cadena. Los caracteres de barra invertida deben tener doble escape (por ejemplo, «\\s» para que coincida con un carácter de espacio en blanco).
Sintaxis |
string ~ regex |
Argumentos |
|
Ejemplos |
|
Otras lecturas: regexp_match
13.2.20. Funciones de Procesamiento
Este grupo contiene funciones que operan en algoritmos de procesamiento.
13.2.20.1. parameter
Devuelve el valor de un parámetro de entrada del algoritmo de procesamiento.
Sintaxis |
parameter(name) |
Argumentos |
|
Ejemplos |
|
13.2.21. Funciones Ráster
Este grupo contiene funciones a operar en una capa ráster.
13.2.21.1. raster_statistic
Devuelve estadísticas de una capa ráster.
Sintaxis |
raster_statistic(layer, band, property) |
Argumentos |
|
Ejemplos |
|
13.2.21.2. raster_value
Devuelve el valor de ráster encontrado en el punto proporcionado.
Sintaxis |
raster_value(layer, band, point) |
Argumentos |
|
Ejemplos |
|
13.2.22. Funciones de Registro y Atributos
Este grupo contiene funciones que operan sobre identificadores de registros.
13.2.22.1. attribute
Devuelve un atributo de un objeto.
Variante 1
Devuelve el valor de un atributo de la entidad actual.
Sintaxis |
attribute(attribute_name) |
Argumentos |
|
Ejemplos |
|
Variante 2
Permite ser especificados a la entidad objjetivo y al nombre de atributo.
Sintaxis |
attribute(feature, attribute_name) |
Argumentos |
|
Ejemplos |
|
13.2.22.2. attributes
Devuelve un mapa conteniendo todos los atributos para una entidad, con nombres de campo como claves de mapa.
Variante 1
Devuelve un mapa de todos los atributos de la entidad actual.
Sintaxis |
attributes() |
Ejemplos |
|
Variante 2
Permite ser especificada a la entidad objetivo.
Sintaxis |
attributes(feature) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: Funciones de Mapas
13.2.22.3. $currentfeature
Devuelve la característica actual que se está evaluando. Puede utilizarse con la función «attribute» para evaluar los valores de los atributos de la característica actual. AVISO: Esta función está obsoleta. Se recomienda utilizar en su lugar la variable de sustitución @característica.
Sintaxis |
$currentfeature |
Ejemplos |
|
13.2.22.4. display_expression
Devuelve la expresión de visualización de una entidad determinada en una capa. La expresión se evalúa de forma predeterminada. Se puede utilizar con cero, uno o más argumentos; consulte los detalles a continuación.
Sin parámetros
Si se llama sin parámetros, la función evaluará la expresión de visualización de la entidad actual en la capa actual.
Sintaxis |
display_expression() |
Ejemplos |
|
** Un parámetro de “entidad” **
Si se llama solo con un parámetro de “entidad”, la función evaluará la característica especificada de la capa actual.
Sintaxis |
display_expression(feature) |
Argumentos |
|
Ejemplos |
|
Parámetros de capa y entidad
Si se llama a la función con una capa y una entidad, evaluará la entidad especificada de la capa especificada.
Sintaxis |
display_expression(layer, feature, [evaluate=true]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.22.5. get_feature
Devuelve la primera entidad de una capa coincidente con un valor de atributo dado.
Variante de valor único
Junto con el ID de la capa, se especifican una única columna y un valor.
Sintaxis |
get_feature(layer, attribute, value) |
Argumentos |
|
Ejemplos |
|
Map variant
Junto con el ID de la capa, un mapa que contiene las columnas (clave) y su respectivo valor a utilizar.
Sintaxis |
get_feature(layer, attribute) |
Argumentos |
|
Ejemplos |
|
13.2.22.6. get_feature_by_id
vuelve la entidad con una id en una capa.
Sintaxis |
get_feature_by_id(layer, feature_id) |
Argumentos |
|
Ejemplos |
|
Otras lecturas: $id
13.2.22.7. $id
Devuelve el id del objeto espacial de la fila actual. **AVISO: Esta función está obsoleta. Se recomienda utilizar la variable @id en su lugar.
Sintaxis |
$id |
Ejemplos |
|
13.2.22.8. is_selected
Devuelve TRUE si se ha seleccionado un objeto espacial. Se puede utilizar con cero, uno o dos argumentos, véase más abajo para más detalles.
Sin parámetros
Si se llama sin parámetros, la función devolverá TRUE si la característica actual en la capa actual está seleccionada.
Sintaxis |
is_selected() |
Ejemplos |
|
** Un parámetro de “entidad” **
Si se invoca sólo con el parámetro “feature”, la función devuelve TRUE si se ha seleccionado la característica especificada de la capa actual.
Sintaxis |
is_selected(feature) |
Argumentos |
|
Ejemplos |
|
Dos parámetros
Si se llama a la función con una capa y un objeto espacial, devolverá TRUE si se selecciona la característica especificada de la capa especificada.
Sintaxis |
is_selected(layer, feature) |
Argumentos |
|
Ejemplos |
|
13.2.22.9. maptip
Devuelve el maptip para una entidad determinada en una capa. La expresión se evalúa de forma predeterminada. Se puede utilizar con cero, uno o más argumentos; consulte los detalles a continuación.
Sin parámetros
Si se llama sin parámetros, la función evaluará el mapa de la entidad actual en la capa actual.
Sintaxis |
maptip() |
Ejemplos |
|
** Un parámetro de “entidad” **
Si se llama solo con un parámetro de “entidad”, la función evaluará la característica especificada de la capa actual.
Sintaxis |
maptip(feature) |
Argumentos |
|
Ejemplos |
|
Parámetros de capa y entidad
Si se llama a la función con una capa y una entidad, evaluará la entidad especificada de la capa especificada.
Sintaxis |
maptip(layer, feature, [evaluate=true]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.22.10. num_selected
Devuelve el número de entidades seleccionadas en una capa determinada. Por defecto funciona en la capa en la que se evalúa la expresión.
Sintaxis |
num_selected([layer=current layer]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.22.11. represent_attributes
Devuelve un mapa con los nombres de los atributos como claves y los valores de representación configurados como valores. El valor de representación de los atributos depende del tipo de widget configurado para cada atributo. Se puede utilizar con cero, uno o más argumentos, véase más abajo para más detalles.
Sin parámetros
Si se llama sin parámetros, la función devolverá la representación de los atributos de la característica actual en la capa actual.
Sintaxis |
represent_attributes() |
Ejemplos |
|
** Un parámetro de “entidad” **
Si se llama sólo con el parámetro “feature”, la función devolverá la representación de los atributos del objeto espacial especificado de la capa actual.
Sintaxis |
represent_attributes(feature) |
Argumentos |
|
Ejemplos |
|
Parámetros de capa y entidad
Si se invoca con un parámetro «layer» y «feature», la función devolverá la representación de los atributos del objeto espacial especificado a partir de la capa especificada.
Sintaxis |
represent_attributes(layer, feature) |
Argumentos |
|
Ejemplos |
|
Lectura adicional: represent_value
13.2.22.12. represent_value
Devuelve el valor de representación configurado para un valor de campo. Depende del tipo de widget configurado. A menudo, esto es útil para los widgets “Value Map”.
Sintaxis |
represent_value(value, [fieldName]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: widget types, represent_attributes
13.2.22.13. sqlite_fetch_and_increment
Administrar valores de autoincremento en bases de datos sqlite.
Los valores predeterminados de SQlite solo se pueden aplicar en la inserción y no se pueden obtener previamente.
Esto hace que sea imposible adquirir una clave primaria incrementada a través de AUTO_INCREMENT antes de crear la fila en la base de datos. Nota al margen: con postgres, esto funciona a través de la opción evaluar valores predeterminados.
Al agregar nuevas entidades con relaciones, es realmente bueno poder agregar hijos para un padre, mientras que el formulario de los padres todavía está abierto y, por lo tanto, la función de los padres no está comprometida.
Para evitar esta limitación, esta función se puede utilizar para administrar valores de secuencia en una tabla separada en formatos basados en sqlite como gpkg.
La tabla de secuencia se filtrará por un ID de secuencia (filter_attribute y filter_value) y el valor actual del id_field se incrementará en 1 y el valor incrementado se devolverá.
Si las columnas adicionales requieren que se especifiquen valores, el mapa default_values se puede utilizar para este propósito.
Nota
Esta función modifica la tabla sqlite de destino. Está diseñado para su uso con configuraciones de valores predeterminados para atributos.
Cuando el parámetro de la base de datos es una capa y la capa está en modo de transacción, el valor solo se recuperará una vez durante la vida útil de una transacción y se almacenará en caché y se incrementará. Esto hace que no sea seguro trabajar en la misma base de datos desde varios procesos en paralelo.
Sintaxis |
sqlite_fetch_and_increment(database, table, id_field, filter_attribute, filter_value, [default_values]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
Otras lecturas: Propiedades de Fuentes de Datos, Creando una o muchas de muchas relaciones
13.2.22.14. uuid
Genera un identificador único universal (UUID) para cada fila usando el Qt QUuid::createUuid method.
Sintaxis |
uuid([format=”WithBraces”]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.23. Relaciones
Este grupo contiene la lista de relaciones disponibles en el proyecto actual, con su descripción. Proporciona un acceso rápido al ID de relación para escribir una expresión (con p.ej. la función relation_aggregate) o personalizando un formulario.
13.2.24. Funciones de cadena
Este grupo contiene funciones que operan sobre cadenas (por ejemplo that replace, convert to upper case).
13.2.24.1. ascii
Devuelve el código Unicode asociado con el primer carácter de una cadena.
Sintaxis |
ascii(string) |
Argumentos |
|
Ejemplos |
|
13.2.24.2. char
Devuelve el carácter asociado con un código Unicode.
Sintaxis |
char(code) |
Argumentos |
|
Ejemplos |
|
13.2.24.3. concat
Concatena varias cadenas en una. Los valores NULL se convierten en cadenas vacías. Otros valores (como números) se convierten en cadenas.
Sintaxis |
concat(string1, string2, …) |
Argumentos |
|
Ejemplos |
|
Sobre concatenación de campos
También puede concatenar cadenas o valores de campo usando los operadores ||
o +
, con algunas características especiales:
El operador
+
también significa expresión resumida, por lo que si tiene un operando entero (campo o valor numérico), puede ser propenso a errores y es mejor usar los otros:'My feature id is: ' + "gid" => triggers an error as gid returns an integer
Cuando cualquiera de los argumentos sea un valor NULL,
||
o+
devolverán un valor NULL. Para devolver los otros argumentos independientemente del valor NULL, es posible que desee utilizar la funciónconcat
'My feature id is: ' + NULL ==> NULL 'My feature id is: ' || NULL => NULL concat('My feature id is: ', NULL) => 'My feature id is: '
13.2.24.4. format
Formatee una cadena utilizando los argumentos proporcionados.
Sintaxis |
format(string, arg1, arg2, …) |
Argumentos |
|
Ejemplos |
|
13.2.24.5. format_date
Formatea un tipo de fecha o una cadena en un formato de cadena personalizado. Utiliza cadenas de formato de fecha/hora Qt. Ver QDateTime::toString.
Sintaxis |
format_date(datetime, format, [language]) [] marca argumentos opcionales |
||||||||||||||||||||||||||||||||||||||||||||||||
Argumentos |
|
||||||||||||||||||||||||||||||||||||||||||||||||
Ejemplos |
|
13.2.24.6. format_number
Devuelve un número formateado con el separador de configuración regional de miles. De forma predeterminada, se utiliza la configuración regional actual del usuario de QGIS. También trunca los lugares decimales al número de lugares proporcionados.
Sintaxis |
format_number(number, [places=0], [language], [omit_group_separators=false], [trim_trailing_zeroes=false]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.24.7. left
Devuelve una subcadena que contiene los n caracteres más a la izquierda de la cadena.
Sintaxis |
left(string, length) |
Argumentos |
|
Ejemplos |
|
13.2.24.8. length
Devuelve el número de caracteres de una cadena o la longitud de una cadena de líneas geométricas.
Variante de cadena
Devuelve el número de caracteres de una cadena.
Sintaxis |
length(string) |
Argumentos |
|
Ejemplos |
|
Variante Geometría
Calcula la longitud de un objeto de línea geométrica. Los cálculos son siempre planimétricos en el Sistema de referencia espacial (SRS) de esta geometría, y las unidades de la longitud devuelta coincidirán con las unidades del SRS. Esto difiere de los cálculos realizados por la función $length, que realizará cálculos elipsoidales basados en la configuración de unidad de distancia y elipsoide del proyecto.
Sintaxis |
length(geometry) |
Argumentos |
|
Ejemplos |
|
13.2.24.9. lower
Convierte una cadena en minúsculas.
Sintaxis |
lower(string) |
Argumentos |
|
Ejemplos |
|
13.2.24.10. lpad
Devuelve una cadena rellenada a la izquierda hasta el ancho especificado, utilizando un carácter de relleno. Si el ancho objetivo es menor que la longitud de la cadena, la cadena se trunca.
Sintaxis |
lpad(string, width, fill) |
Argumentos |
|
Ejemplos |
|
13.2.24.11. regexp_match
Devuelve la primera posición coincidente que coincide con una expresión regular dentro de una cadena Unicode, o 0 si no se encuentra la subcadena.
Sintaxis |
regexp_match(input_string, regex) |
Argumentos |
|
Ejemplos |
|
13.2.24.12. regexp_replace
Devuelve una cadena con la expresión regular proporcionada reemplazada.
Sintaxis |
regexp_replace(input_string, regex, replacement) |
Argumentos |
|
Ejemplos |
|
13.2.24.13. regexp_substr
Devuelve la parte de una cadena que coincide con una expresión regular proporcionada.
Sintaxis |
regexp_substr(input_string, regex) |
Argumentos |
|
Ejemplos |
|
13.2.24.14. replace
Devuelve una cadena con la cadena, matriz o mapa de cadenas reemplazados.
String & array variant
Devuelve una cadena con la cadena proporcionada o la matriz de cadenas reemplazada por una cadena o una matriz de cadenas.
Sintaxis |
replace(string, before, after) |
Argumentos |
|
Ejemplos |
|
Map variant
Devuelve una cadena con las claves de mapa proporcionadas reemplazadas por valores emparejados. Las claves de mapa más largas se evalúan primero.
Sintaxis |
replace(string, map) |
Argumentos |
|
Ejemplos |
|
13.2.24.15. right
Devuelve una subcadena que contiene los n caracteres del extremo derecho de la cadena.
Sintaxis |
right(string, length) |
Argumentos |
|
Ejemplos |
|
13.2.24.16. rpad
Devuelve una cadena rellenada a la derecha hasta el ancho especificado, utilizando un carácter de relleno. Si el ancho objetivo es menor que la longitud de la cadena, la cadena se trunca.
Sintaxis |
rpad(string, width, fill) |
Argumentos |
|
Ejemplos |
|
13.2.24.17. 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 |
|
Ejemplos |
|
13.2.24.18. substr
Devuelve una parte de una cadena.
Sintaxis |
substr(string, start, [length]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.24.19. title
Convierte todas las palabras de una cadena a tipo de título (todas las palabras en minúsculas con mayúscula inicial).
Sintaxis |
title(string) |
Argumentos |
|
Ejemplos |
|
13.2.24.20. to_string
Convierte un número en cadena.
Sintaxis |
to_string(number) |
Argumentos |
|
Ejemplos |
|
13.2.24.21. trim
Elimina todos los espacios en blanco iniciales y finales (espacios, tabulaciones, etc.) de una cadena.
Sintaxis |
trim(string) |
Argumentos |
|
Ejemplos |
|
13.2.24.22. upper
Convierte una cadena a letras mayúsculas.
Sintaxis |
upper(string) |
Argumentos |
|
Ejemplos |
|
13.2.24.23. wordwrap
Devuelve una cadena ajustada a un número máximo/mínimo de carácteres.
Sintaxis |
wordwrap(string, wrap_length, [delimiter_string]) [] marca argumentos opcionales |
Argumentos |
|
Ejemplos |
|
13.2.25. Expresiones de Usuario
Este grupo contiene las expresiones guardadas como user expressions.
13.2.26. Variables
Este grupo contiene variables dinámicas relacionadas con la aplicación, el archivo del proyecto y otras configuraciones. La disponibilidad de variables depende del contexto:
desde el diálogo de propiedades de la capa
desde el diseñador de impresión
Para usar estas variables en una expresión, deben estar precedidas por el carácter @``(p.ej, ``@row_number
).
Variable |
Descripción |
---|---|
algorithm_id |
El ID único de un algoritmo |
animation_end_time |
Fin del rango de tiempo sobre todo el tiempo de la animación (como valor de fecha y hora) |
animation_interval |
Duración del rango de tiempo sobre todo el tiempo de animación (como un valor de intervalo) |
animation_start_time |
Inicio del rango de tiempo sobre todo el tiempo de la animación (como valor de fecha y hora) |
atlas_feature |
La entidad actual del atlas (como objeto de entidad) |
atlas_featureid |
La ID de la entidad actual del atlas |
atlas_featurenumber |
El número de entidades actuales del atlas en el diseño |
atlas_filename |
El nombre de archivo del atlas actual |
atlas_geometry |
La geometría de la entidad actual del atlas |
atlas_layerid |
La ID de la capa de cobertura del atlas actual |
atlas_layername |
El nombre de la capa de cobertura del atlas actual |
atlas_pagename |
El nombre de la página del atlas actual |
atlas_totalfeatures |
El número total de entidades en el atlas |
canvas_cursor_point |
La última posición del cursos en el lienzo en coordenadas geográficas del proyecto |
cluster_color |
El color de los símbolos dentro de un grupo, o NULL si los símbolos tienen colores mezclados |
cluster_size |
La cantidad de símbolos contenidos en un grupo |
current_feature |
La entidad que se está editando actualmente en el formulario de atributo o la fila de la tabla |
current_geometry |
La geometría de la entidad que se está editando actualmente en el formulario o la fila de la tabla |
current_parent_feature |
representa la función que se está editando actualmente en el formulario principal. Solo se puede utilizar en un contexto de formulario incrustado. |
current_parent_geometry |
representa la geometría de la función que se está editando actualmente en el formulario principal. Solo se puede utilizar en un contexto de formulario incrustado. |
form_mode |
Para qué se usa el formulario, como AddFeatureMode, SingleEditMode, MultiEditMode, SearchMode, AggregateSearchMode o IdentifyMode como cadena. |
feature |
La característica actual que se está evaluando. Puede utilizarse con la función «attribute» para evaluar los valores de los atributos de la característica actual. |
frame_duration |
Duración temporal de cada cuadro de animación (como valor de intervalo) |
frame_number |
Número de fotograma actual durante la reproducción de la animación |
frame_rate |
Número de fotogramas por segundo durante la reproducción de la animación |
fullextent_maxx |
Valor x máximo de la extensión del lienzo completo (incluidas todas las capas) |
fullextent_maxy |
Valor y máximo de la extensión del lienzo completo (incluidas todas las capas) |
fullextent_minx |
Valor x mínimo de la extensión del lienzo completo (incluidas todas las capas) |
fullextent_miny |
Valor y mínimo de la extensión del lienzo completo (incluidas todas las capas) |
geometry |
La geometría del objeto espacial actual que se está evaluando |
geometry_part_count |
El número de piezas en la geometría de la entidad renderizada. |
geometry_part_num |
El número de partes de la geometría actual para la entidad que se está renderizando |
geometry_point_count |
El número de puntos en la parte de la geometría renderizada. |
geometry_point_num |
El número de puntos actual en la parte de la geometría renderizada |
geometry_ring_num |
Número de anillo de geometría actual para la entidad que se está representando (solo para entidades poligonales). El anillo exterior tiene un valor de 0. |
grid_axis |
El eje de anotación de la cuadrícula actual (p. Ej., “X” para la longitud, “y” para la latitud) |
grid_number |
El valor de anotación de cuadrícula actual |
id |
ID de la función que se está evaluando |
item_id |
El ID de usuario del elemento del diseño (no necesariamente único) |
item_uuid |
El ID único del elemento de diseño |
layer |
La capa actual |
layer_crs |
El ID de autoridad del sistema de referencia de coordenadas de la capa actual |
layer_id |
La ID de la capa actual |
layer_ids |
Las ID de todas las capas del mapa en el proyecto actual como una lista |
layer_name |
El nombre de la capa actual |
layers |
Todas las capas del mapa en el proyecto actual como una lista |
layout_dpi |
La resolución de la composición (DPI) |
layout_name |
El nombre del diseño |
layout_numpages |
El número de páginas en el diseño |
layout_page |
El número de página del elemento actual en el diseño |
layout_pageheight |
La altura de la página activa en el diseño (en mm para tamaños de papel estándar o cualquier unidad que se haya utilizado para el tamaño de papel personalizado) |
layout_pageoffsets |
Matriz de coordenadas Y de la parte superior de cada página. Permite posicionar dinámicamente elementos en páginas en un contexto donde los tamaños de página pueden cambiar |
layout_pagewidth |
El ancho de página activo en el diseño (en mm para tamaños de papel estándar, o cualquier unidad que se haya utilizado para el tamaño de papel personalizado) |
legend_column_count |
El número de columnas en la leyenda |
legend_filter_by_map |
Indica si el contenido de la leyenda es filtrada por el mapa |
legend_filter_out_atlas |
indica si el atlas es filtrado fuera de la leyenda |
legend_split_layers |
Indica si las capas pueden ser cortadas en la leyenda |
legend_title |
El título de la leyenda |
legend_wrap_string |
El carácter(es) usado(s) para el texto de la leyenda |
map_crs |
El sistema de coordenadas de Referencia del mapa actual |
map_crs_acronym |
El acrónimo del sistema de referencia de coordenadas del mapa actual |
map_crs_definition |
La definición completa del sistema de referencia de coordenadas del mapa actual |
map_crs_description |
El nombre del sistema de referencia de coordenadas del mapa actual |
map_crs_ellipsoid |
El acrónimo del elipsoide del sistema de referencia de coordenadas del mapa actual |
map_crs_proj4 |
La definición de Proj4 del sistema de referencia de coordenadas del mapa actual |
map_crs_projection |
El nombre descriptivo del método de proyección utilizado por el sistema de referencia de coordenadas del mapa (por ejemplo, “Albers Equal Area”) |
map_crs_wkt |
La definición WKT del sistema de referencia de coordenadas del mapa actual |
map_end_time |
El final del rango de tiempo del mapa temporal (como valor de fecha y hora) |
map_extent |
La geometría que representa la extensión actual del mapa. |
map_extent_center |
La entidad de puntos en el centro del mapa |
map_extent_height |
La altura actual del mapa |
map_extent_width |
El ancho actual del mapa |
map_id |
El ID del destino actual del mapa. Este será “lienzo” para las representaciones de lienzo y el ID del elemento para las representaciones del mapa de diseño |
map_interval |
La duración del rango de tiempo del mapa temporal (como un valor de intervalo) |
map_layer_ids |
La lista de IDs de capas de mapa visibles en el mapa |
map_layers |
La lista de capas de mapa visibles en el mapa. |
map_rotation |
La rotación actual del mapa |
map_scale |
La escala actual del mapa |
map_start_time |
El inicio del rango de tiempo del mapa temporal (como un valor de fecha y hora) |
map_units |
Las unidades de medida del mapa |
model_path |
Ruta completa (incluido el nombre del archivo) del modelo actual (o ruta del proyecto si el modelo está incrustado en un proyecto). |
model_folder |
Carpeta que contiene el modelo actual (o carpeta del proyecto si el modelo está incrustado en un proyecto). |
model_name |
Nombre del modelo actual |
model_group |
Grupo del modelo actual |
notification_message |
Contenido del mensaje de notificación enviado por el proveedor (disponible solo para acciones activadas por notificaciones del proveedor). |
parent |
Se refiere a la entidad actual en la capa principal, que proporciona acceso a sus atributos y geometría al filtrar una función aggregate |
project_abstract |
El resumen del proyecto, tomado de los metadatos del proyecto. |
project_area_units |
La unidad de área del proyecto actual, que se utiliza al calcular áreas de geometrías. |
project_author |
El autor del proyecto, tomado de los metadatos del proyecto. |
project_basename |
El nombre base del nombre de archivo del proyecto actual (sin ruta ni extensión) |
project_creation_date |
La fecha de creación del proyecto, tomada de los metadatos del proyecto. |
project_crs |
El sistema de referencia de coordenadas del proyecto |
project_crs_arconym |
El acrónimo del sistema de referencia de coordenadas del proyecto. |
project_crs_definition |
La definición completa del sistema de referencia de coordenadas del proyecto. |
project_crs_description |
La descripción del sistema de referencia de coordenadas del proyecto. |
project_crs_ellipsoid |
El elipsoide del sistema de referencia de coordenadas del proyecto |
project_crs_proj4 |
La representación Proj4 del sistema de referencia de coordenadas del proyecto |
project_crs_wkt |
La representación WKT (texto bien conocido) del sistema de referencia de coordenadas del proyecto |
project_distance_units |
La unidad de distancia para el proyecto actual, utilizada al calcular longitudes de geometrías y distancias. |
project_ellipsoid |
El nombre del elipsoide del proyecto actual, utilizado al calcular áreas geodésicas o longitudes de geometrías. |
project_filename |
El nombre de archivo del proyecto actual |
project_folder |
La carpeta del proyecto actual |
project_home |
La ruta a casa del proyecto actual |
project_identifier |
El identificador del proyecto, tomado de los metadatos del proyecto. |
project_keywords |
Las palabras clave del proyecto, tomadas de los metadatos del proyecto. |
project_last_saved |
Fecha / hora de la última vez que se guardó el proyecto. |
project_path |
La ruta completa (incluido el nombre del archivo) del proyecto actual |
project_title |
El título del proyecto actual |
project_units |
Las unidades del CRS del proyecto |
qgis_locale |
El idioma actual de QGIS |
qgis_os_name |
El nombre del sistema operativo actual, por ejemplo, “windows”, “linux” u “osx” |
qgis_platform |
La plataforma QGIS, por ejemplo, “escritorio” o “servidor” |
qgis_release_name |
El nombre de la versión actual de QGIS |
qgis_short_version |
La cadena corta de la versión actual de QGIS |
qgis_version |
La cadena de versión actual de QGIS |
qgis_version_no |
El número de versión actual de QGIS |
row_number |
Guarda el número de la fila actual. |
snapping_results |
Da acceso a los resultados de ajuste mientras se digitaliza una función (solo disponible en agregar función) |
scale_value |
El valor de distancia de la barra de escala actual |
selected_file_path |
Ruta de archivo seleccionada desde el selector de widget de archivo al cargar un archivo con un sistema de almacenamiento externo |
symbol_angle |
El ángulo del símbolo utilizado para representar la entidad (válido solo para símbolos de marcador) |
symbol_color |
El color del símbolo utilizado para representar la entidad. |
symbol_count |
El número de entidades representadas por el símbolo (en la leyenda del diseño) |
symbol_id |
El ID interno del símbolo (en la leyenda del diseño) |
symbol_label |
La etiqueta del símbolo (ya sea una etiqueta definida por el usuario o la etiqueta predeterminada generada automáticamente, en la leyenda del diseño) |
symbol_layer_count |
Número total de capas de símbolo en el símbolo |
symbol_layer_index |
Índice de capa de símbolo actual |
symbol_marker_column |
Número de columna para el marcador (válido solo para rellenos de patrón de puntos). |
symbol_marker_row |
Número de fila para el marcador (válido solo para rellenos de patrón de puntos). |
user_account_name |
El nombre de la cuenta del sistema operativo del usuario actual |
user_full_name |
El nombre de usuario del sistema operativo del usuario actual |
value |
El valor actual |
vector_tile_zoom |
Nivel de zoom de mosaico vectorial exacto del mapa que se está representando (derivado de la escala del mapa actual). Normalmente en el intervalo [0, 20]. A diferencia de @zoom_level, esta variable es un valor de punto flotante que se puede usar para interpolar valores entre dos niveles de zoom enteros. |
with_variable |
Permite configurar una variable para usar dentro de una expresión y evitar recalcular el mismo valor repetidamente |
zoom_level |
Nivel de zoom de mosaico vectorial del mapa que se está representando (derivado de la escala del mapa actual). Normalmente en el intervalo [0, 20]. |
Algún ejemplo:
Devuelve la coordenada X del centro de un elemento de mapa en el diseño:
x( map_get( item_variables( 'map1'), 'map_extent_center' ) )
Devuelve, para cada entidad de la capa actual, el número de entidades aeroportuarias superpuestas:
aggregate( layer:='airport', aggregate:='count', expression:="code", filter:=intersects( $geometry, geometry( @parent ) ) )
Obtener la object_id del primer punto ajustado de una línea:
with_variable( 'first_snapped_point', array_first( @snapping_results ), attribute( get_feature_by_id( map_get( @first_snapped_point, 'layer' ), map_get( @first_snapped_point, 'feature_id' ) ), 'object_id' ) )
13.2.27. Funciones recientes
Este grupo contiene funciones utilizadas recientemente. Dependiendo del contexto de su uso (selección de características, calculadora de campo, genérico), las expresiones aplicadas recientemente se agregan a la lista correspondiente (hasta diez expresiones), ordenadas de más a menos recientes. Esto facilita recuperar y volver a aplicar rápidamente expresiones utilizadas anteriormente.