API IDEE Core v1.1.0 API - Module: IDEE/utils

Module: IDEE/utils

IDEE/utils

Esta clase contiene funciones de utilidad.

Example

import utils from 'IDEE/utils';

Methods

module:IDEE/utils.addParameters(url, params){String} facade/js/util/Utils.js, line 229

Añade parámetros a una URL.

Name	Type	Description
`url`	String	URL.
`params`	String \| Object	Parámetros.

Returns:

URL con parámetros.

module:IDEE/utils.beautifyAttribute(String){String} facade/js/util/Utils.js, line 589

Esta función formatea los atributos.

Name	Type	Description
`String`	attributeName	Valor:Atributo.

Returns:

Atributo formateado.

module:IDEE/utils.beautifyAttributeName(rawAttributeName){String} facade/js/util/Utils.js, line 614

Esta función formatea el nombre de los atributos.

Name	Type	Description
`rawAttributeName`	String	Nombre del atributo.

Returns:

Texto formateado.

module:IDEE/utils.beautifyString(text){String} facade/js/util/Utils.js, line 547

Esta función formatea la cadena de texto.

Name	Type	Description
`text`	String	Texto para dar formato a la cadena.

Returns:

Texto formateado.

module:IDEE/utils.bytesToBase64(bytes, format){String} facade/js/util/Utils.js, line 1272

Esta función transforma "bytes" a Base64.

Name	Type	Description
`bytes`	Array	Matriz con "bytes".
`format`	String	Formato de salida, por defecto image/png.

Returns:

Base64.

module:IDEE/utils.classToggle(htmlElement, className) facade/js/util/Utils.js, line 1156

Esta función añade o elimina una clase a un elemento html

Name	Type	Description
`htmlElement`	HTMLElement	Elemento html para añadir/eliminar la clase
`className`	String	Clase a añadir/eliminar

module:IDEE/utils.concatUrlPaths(paths){String} facade/js/util/Utils.js, line 632

Esta función concatena una ruta.

Name	Type	Description
`paths`	Array.<String>	Array con url más rutas a concatenar.

Returns:

Ruta concatenada.

module:IDEE/utils.copyImageClipBoard(map, canva) facade/js/util/Utils.js, line 1756

Esta función copia una imagen en el portapapeles.

Name	Type	Description
`map`	IDEE.Map	Mapa del que se obtiene el canvas.
`canva`	HTMLCanvasElement	Elemento canvas.

module:IDEE/utils.decodeBase64(base64){Object} facade/js/util/Utils.js, line 1493

Esta función decodifica un objeto en base64 a un objeto JSON.

Name	Type	Description
`base64`	String	base64.

module:IDEE/utils.decodeHtml(encodedHtml){String} facade/js/util/Utils.js, line 913

Esta función decodifica el HTML y devuelve su contenido.

Name	Type	Description
`encodedHtml`	String	Texto codificado con entidades HTML.

Returns:

Texto decodificado.

module:IDEE/utils.defineFunctionFromString(objParam){function} facade/js/util/Utils.js, line 1110

Esta función genera una función a partir de una cadena de texto.

Name	Type	Description
`objParam`	String	Cadena con la función.

Returns:

Función.

module:IDEE/utils.dragElement(elmntID, buttonID) facade/js/util/Utils.js, line 1438

Esta función proporciona movimiento a un contendor HTML.

Name	Type	Description
`elmntID`	String	Identificador del elemento que se quiere mover.
`buttonID`	Object	Identificador del botón.

module:IDEE/utils.draggabillyElement(element, handleEl, containmentEl) facade/js/util/Utils.js, line 1545

Esta función proporciona movimiento a un dialog.

Name	Type	Description
`element`	String	Selector del elemento a mover.
`handleEl`	String	Selemento del elemento iniciador del movimiento.
`containmentEl`	String	Selector del elemento contenedor.

module:IDEE/utils.draggabillyPlugin(panel, handleEl) facade/js/util/Utils.js, line 1507

Esta función proporciona movimiento a un plugin.

Name	Type	Description
`panel`	IDEE.ui.Panel	Panel del "plugin".
`handleEl`	String	Elemento o selector en el que comienza la interacción del arrastre.

module:IDEE/utils.drawDynamicStyle(){URL} facade/js/util/Utils.js, line 1226

Esta función devuelve la leyenda dinamica establecida.

Returns:

Devuelve el valor de "dynamicLegend".

module:IDEE/utils.enableTouchScroll(elem) facade/js/util/Utils.js, line 766

Esta función permite el desplazamiento con el modo táctil.

Name	Type	Description
`elem`	HTMLElement	Elemento HTML.

module:IDEE/utils.encodeBase64(JSON){String} facade/js/util/Utils.js, line 1479

Esta función codifica un objeto JSON en base64.

Name	Type	Description
`JSON`	Object	JSON.

module:IDEE/utils.escapeJSCode(jsCode){String} facade/js/util/Utils.js, line 750

Esta función elimina el código de JavaScript.

Name	Type	Description
`jsCode`	String	Código de JavaScript.

Returns:

Valor remplazado.

module:IDEE/utils.escapeXSS(xssValue){String} facade/js/util/Utils.js, line 718

Esta función remplaza los caracteres de tipo XSS.

Name	Type	Description
`xssValue`	String	Valor XSS.

Returns:

Valor remplazado.

module:IDEE/utils.extend(targetParam, source, override){Object} facade/js/util/Utils.js, line 695

Esta función extiende los prototipos de un objeto.

Name	Type	Description
`targetParam`	Object	Objeto.
`source`	Object	Atributos para extender el objeto.
`override`	Boolean	Sobreescribir el prototipo (verdadero o falso).

Returns:

Objeto extendido.

module:IDEE/utils.extendsObj(destParam, src){Object} facade/js/util/Utils.js, line 1000

Esta función extiende un objeto.

Name	Type	Description
`destParam`	Object	Objeto para extender.
`src`	Object	Objeto atributos a extender.

Returns:

Objeto extendido.

module:IDEE/utils.fillResolutions(minResolution, maxResolution, numZoomLevels){Array.<Number>} facade/js/util/Utils.js, line 370

Esta función genera una resolución máxima y mínima.

Name	Type	Description
`minResolution`	Number	Resolución mínima.
`maxResolution`	Number	Resolución máxima.
`numZoomLevels`	Number	Número de niveles de zoom.

Returns:

Resolución.

module:IDEE/utils.filterList(inputId, listId) facade/js/util/Utils.js, line 2050

Esta función filtra una lista html en base al valor del input.

Name	Type	Description
`inputId`	String	ID del input que contiene el filtro.
`listId`	String	ID de la lista que se va a filtrar.

module:IDEE/utils.findUrls(text){Array.<String>} facade/js/util/Utils.js, line 1781

Esta función detecta los enlaces en un texto.

Name	Type	Description
`text`	String	Texto donde se detectará los enlaces.

Returns:

Matriz de enlaces.

module:IDEE/utils.generateColorScale(colors, numberClasses){Array.<string>} facade/js/util/Utils.js, line 1359

Esta función obtiene un array de escala de colores en formato hexadecimal.

Name	Type	Description
`colors`	Array.<String>	Colores.
`numberClasses`	Number	Número de colores.

Returns:

Escala de colores en formato hexadecimal.

module:IDEE/utils.generateIntervals(array, breaks){Array} facade/js/util/Utils.js, line 1030

Esta función devuelve una matriz con valores intermedios entre el principio y el final de dicha matriz.

Name	Type	Description
`array`	Array	Matriz.
`breaks`	Number	Numero de elementos.

Returns:

Intervalo.

module:IDEE/utils.generateRandom(prefix, sufix){String} facade/js/util/Utils.js, line 266

Genera un valor aleatorio.

Name	Type	Description
`prefix`	String	Prefijo.
`sufix`	String	Sufijo.

Returns:

Valor aleatorio.

module:IDEE/utils.generateResolutionsFromExtent(extentParam, size, zoomLevels){Array.<Number>} facade/js/util/Utils.js, line 450

Esta función genera la resolución máxima y mínima para una extensión.

Name	Type	Description
`extentParam`	Number	Extensión.
`size`	Number	Tamaño.
`zoomLevels`	Number	Niveles de zoom.

Returns:

Resolución.

module:IDEE/utils.generateResolutionsFromScales(maxScale, minScale, zoomLevels, units){Array.<Number>} facade/js/util/Utils.js, line 432

Esta función genera la resolución máxima y mínima para una escala.

Name	Type	Description
`maxScale`	Number	Escala máxima.
`minScale`	Number	Escala mínima.
`zoomLevels`	Number	Niveles de zoom.
`units`	String	Unidades.

Returns:

Resolución.

module:IDEE/utils.getEnvolvedExtent(extents){Array.<Number>} facade/js/util/Utils.js, line 1240

Esta función calcula la extensión envolvente de los alcances proporcionados por el usuario.

Name	Type	Description
`extents`	Array.<Array.<Number>>	Array de arrays de extensiones.

Returns:

Alcance.

module:IDEE/utils.getFeaturesExtent(features, projectionCode){Array.<ol.Extent>} facade/js/util/Utils.js, line 24

Este método obtiene las extensiones de los objetos geográficos especificados

Name	Type	Description
`features`	Array.<ol.Feature>	Objetos geográficos.
`projectionCode`	String	Código de proyección

Returns:

Extensiones de los objetos geográficos.

module:IDEE/utils.getImageMap(map, type, canva, isPromise){String} facade/js/util/Utils.js, line 1738

Esta función devuelve una captura de pantalla del mapa.

Name	Type	Description
`map`	IDEE.Map	Mapa del que se obtiene el canvas.
`type`	String	Formato de la imagen resultante.
`canva`	HTMLCanvasElement	Elemento canvas.
`isPromise`	Boolean	Si tiene que devolver una promesa (MapLibre).

Returns:

Imagen en base64 o Promesa con la imagen en base64.

module:IDEE/utils.getImageSize(url){Promise} facade/js/util/Utils.js, line 1063

Esta función devuelve una imagen para comparar su tamaño.

Name	Type	Description
`url`	String	URL de la imagen.

Returns:

Promesa con el HTML de la imagen.

module:IDEE/utils.getOpacityFromRgba(rgbaColor){Number} facade/js/util/Utils.js, line 827

Esta función devuelve la opacidad de un color rbga.

Name	Type	Description
`rgbaColor`	String	Color RGBA.

Returns:

Opacidad.

module:IDEE/utils.getParameterValue(paramName, url){String} facade/js/util/Utils.js, line 200

Devuelve los parámetros de una URL.

Name	Type	Description
`paramName`	String	Nombre del parámetro.
`url`	String	URL.

Returns:

Valor del parametro de la URL.

module:IDEE/utils.getResolutionFromScale(scale, unitsParam){Number} facade/js/util/Utils.js, line 405

Esta función calcula la resolución de una escala.

Name	Type	Description
`scale`	Number	Escala.
`unitsParam`	String	Unidades.

Returns:

La resolución para la escala especificada.

module:IDEE/utils.getRgba(color, opacity){String} facade/js/util/Utils.js, line 967

Esta función devuelve el color RGBA.

Name	Type	Description
`color`	String	Color.
`opacity`	Number	Opacidad.

Returns:

Color RGBA.

module:IDEE/utils.getScaleFromResolution(resolution, unitsParam, decimals){Number} facade/js/util/Utils.js, line 484

Esta función calcula la escala partiendo de una resolución.

Name	Type	Description
`resolution`	Number	Resolución.
`unitsParam`	String	Unidades.
`decimals`	Number	Numero de decimales a redondear.

Returns:

La escala para la resolución especificada.

module:IDEE/utils.getSystem(){String} facade/js/util/Utils.js, line 1894

Este método determina el sistema operativo móvil.

Returns:

El sistema operativo móvil detectado ('iOS', 'Android', 'Windows Phone', or 'unknown').

module:IDEE/utils.getTextFromHtml(html){String} facade/js/util/Utils.js, line 928

Esta función devuelve el contenido de un texto extraído del HTML.

Name	Type	Description
`html`	HTMLElement \| String	Cadena o elemento con etiquetas HTML.

Returns:

Texto contenido por las etiquetas HTML.

module:IDEE/utils.getWMSGetCapabilitiesUrl(serverUrl, version, ticket){String} facade/js/util/Utils.js, line 296

Devuelve los metadatos de una URL, capa WMS.

Name	Type	Description
`serverUrl`	String	URL.
`version`	String	Versión.
`ticket`	String	Ticket.

Returns:

Devuelve los metadatos.

module:IDEE/utils.getWMTSCapabilities(url){Promise.<Object>} facade/js/util/Utils.js, line 1919

Este método recupera la información descriptiva del servicio WMTS.

Name	Type	Description
`url`	String	URL del servicio WMTS (debe incluir el parámetro service=WMTS y request=GetCapabilities).

Returns:

Promesa que se resuelve con un objeto que contiene las capacidades del servicio WMTS.

module:IDEE/utils.getWMTSGetCapabilitiesUrl(serverUrl, version){String} facade/js/util/Utils.js, line 326

Devuelve los metadatos de una URL, capa WMTS.

Name	Type	Description
`serverUrl`	String	URL.
`version`	String	Versión.

Returns:

Devuelve los metadatos.

module:IDEE/utils.htmlToString(html){String} facade/js/util/Utils.js, line 527

Esta función transforma código HTML a cadena de texto.

Name	Type	Description
`html`	HTMLElement	Contenido HTML.

Returns:

Cadena de texto.

module:IDEE/utils.includes(array, searchElement, fromIndex){Boolean} facade/js/util/Utils.js, line 659

Esta función comprueba que en un matriz contenga un determinado elemento.

Name	Type	Description
`array`	Array	Matriz.
`searchElement`	*	Elemento que se quiere buscar.
`fromIndex`	Number	Indice a partir del que se quiere buscar.

Returns:

Elemento encontrado.

module:IDEE/utils.inverseColor(color){String} facade/js/util/Utils.js, line 948

Esta función obtiene el inverso de un color. El inverso de un color es la diferencia entre el valor hexadecimal de blanco (0xFFFFFF) y el valor hexadecimal del color.

Name	Type	Description
`color`	String	Color.

Returns:

Color inverso en formato hexadecimal.

module:IDEE/utils.isArray(obj){Boolean} facade/js/util/Utils.js, line 73

Devuelve verdadero si es valor que se le pasa por parámetros es "Array".

Name	Type	Description
`obj`	*	Valor que se quiere comprobar.

Returns:

Verdadero si es "Array".

module:IDEE/utils.isBoolean(obj){Boolean} facade/js/util/Utils.js, line 48

Devuelve verdadero si es valor que se le pasa por parámetros es "boolean".

Name	Type	Description
`obj`	*	Valor que se quiere comprobar.

Returns:

Verdadero si es "boolean".

module:IDEE/utils.isDynamic(obj, namesToSkip){Boolean} facade/js/util/Utils.js, line 1188

Esta función devuelve verdadero si algún valor de objeto es función o "{{*}}".

Name	Type	Description
`obj`	Object	Objeto con los valores.
`namesToSkip`	Array.<String>	Nombres de atributos omitir.

Returns:

Verdadero si algún valor de objeto es función o "{{*}}".

module:IDEE/utils.isFunction(obj){Boolean} facade/js/util/Utils.js, line 109

Devuelve verdadero si es valor que se le pasa por parámetros es una función.

Name	Type	Description
`obj`	*	Valor que se quiere comprobar.

Returns:

Verdadero si es una función.

module:IDEE/utils.isGeometryType(type){Boolean} facade/js/util/Utils.js, line 900

Esta función devuelve verdadero si existe el tipo de geometría.

Name	Type	Description
`type`	String	Tipo de geometría.

Returns:

Verdadero si existe.

module:IDEE/utils.isNull(obj){Boolean} facade/js/util/Utils.js, line 60

Devuelve verdadero si es valor que se le pasa por parámetros es nulo.

Name	Type	Description
`obj`	*	Valor que se quiere comprobar.

Returns:

Verdadero si es nulo.

module:IDEE/utils.isNullOrEmpty(obj){Boolean} facade/js/util/Utils.js, line 85

Devuelve verdadero si es valor que se le pasa por parámetros es nulo o esta vacío.

Name	Type	Description
`obj`	*	Valor que se quiere comprobar.

Returns:

Verdadero si es nulo o vacío.

module:IDEE/utils.isNumber(number){Boolean} facade/js/util/Utils.js, line 157

Devuelve verdadero si es valor que se le pasa por parámetros es un numero.

Name	Type	Description
`number`	number	Valor que se quiere comprobar.

Returns:

Verdadero si es un numero.

module:IDEE/utils.isObject(obj){Boolean} facade/js/util/Utils.js, line 121

Devuelve verdadero si es valor que se le pasa por parámetros es un objeto.

Name	Type	Description
`obj`	*	Valor que se quiere comprobar.

Returns:

Verdadero si es un objeto.

module:IDEE/utils.isPositiveNumber(number){Boolean} facade/js/util/Utils.js, line 169

Devuelve verdadero si es valor que se le pasa por parámetros es un numero positivo.

Name	Type	Description
`number`	number	Valor que se quiere comprobar.

Returns:

Verdadero si es un numero positivo.

module:IDEE/utils.isString(obj){Boolean} facade/js/util/Utils.js, line 133

Devuelve verdadero si es valor que se le pasa por parámetros es una cadena.

Name	Type	Description
`obj`	*	Valor que se quiere comprobar.

Returns:

Verdadero si es una cadena.

module:IDEE/utils.isUndefined(obj){Boolean} facade/js/util/Utils.js, line 36

Devuelve verdadero si es valor que se le pasa por parámetros es indefinido.

Name	Type	Description
`obj`	*	Valor que se quiere comprobar.

Returns:

Verdadero si es indefinido.

module:IDEE/utils.isUrl(obj){Boolean} facade/js/util/Utils.js, line 145

Devuelve verdadero si es valor que se le pasa por parámetros es una URL.

Name	Type	Description
`obj`	*	Valor que se quiere comprobar.

Returns:

Verdadero si es una URL.

module:IDEE/utils.modifySVG(url, options){String} facade/js/util/Utils.js, line 1372

Esta función modifica el archivo SVG de colores.

Name	Type	Description
`url`	String	URL.
`options`	Object	Opciones.

Returns:

SVG base64.

module:IDEE/utils.normalize(stringToNormalize, upperCase){String} facade/js/util/Utils.js, line 181

Devuelve un texto normalizado (sin espacios y en mayúsculas o minúsculas).

Name	Type	Description
`stringToNormalize`	String	Valor que se quiere normalizar.
`upperCase`	Boolean	Verdadero mayúsculas, falso minúsculas.

Returns:

Texto normalizado.

module:IDEE/utils.ObjectToArrayExtent(bbox, epsg){Array} facade/js/util/Utils.js, line 1873

Esta función ordena el bbox dependiendo del sistema de referencia.

Name	Type	Description
`bbox`	Object	Bbox.
`epsg`	String	EPSG del bbox.

Returns:

Bbox.

module:IDEE/utils.parseCRSWKTtoJSON(wkt){Object} facade/js/util/Utils.js, line 1954

Este método convierte una cadena WKT (Well-Known Text) de un sistema de referencia de coordenadas (CRS) en un objeto JSON estructurado, interpretando correctamente jerarquías, claves repetidas y valores anidados.

Si una clave aparece varias veces (como MEMBER), se agrupa en un array.
Si un valor no tiene clave explícita, se asigna a "name".
Si hay dos valores simples, se convierten en un objeto { clave: valor }.
Si hay un solo valor, se devuelve directamente.

Name	Type	Description
`wkt`	String	Cadena WKT que representa un sistema de referencia de coordenadas.

Returns:

Objeto JSON estructurado equivalente al WKT.

module:IDEE/utils.removeHTML(element) facade/js/util/Utils.js, line 1139

Esta función elimina el elemento html de un elemento padre.

Name	Type	Description
`element`	HTMLElement	Elemento html a eliminar

module:IDEE/utils.replaceNode(newNode, oldNode) facade/js/util/Utils.js, line 1172

Esta función reemplaza un nodo HTML por otro

Name	Type	Description
`newNode`	Node	Nuevo nodo HTML
`oldNode`	Node	Antiguo nodo HTML

module:IDEE/utils.reproject(coordinates, sourceProj, destProj){Array.<number>} facade/js/util/Utils.js, line 1934

Este método reproyecta unas coordenadas de un sistema de referencia a otro.

Name	Type	Description
`coordinates`	Array.<number>	Coordenadas a reproyectar.
`sourceProj`	String	EPSG del sistema de referencia de origen.
`destProj`	String	EPSG del sistema de referencia de destino.

Returns:

Coordenadas reproyectadas.

module:IDEE/utils.returnPositionHtmlElement(className, map){Array.<Number>} facade/js/util/Utils.js, line 1570

Esta función devuelve las coordenadas de un elemento HTML que se encuentra en el mapa (ol-overlay-container).

Name	Type	Description
`className`	String	Clase del elemento HTML.
`map`	Map	Elemento mapa donde buscar el elemento.

Returns:

Posición del elemento HTML.

module:IDEE/utils.rgbaToHex(rgbaColor){String} facade/js/util/Utils.js, line 808

Esta función transforma el color RGBA a hexadecimal.

Name	Type	Description
`rgbaColor`	String	Color RGBA.

Returns:

Color Hexadecimal.

module:IDEE/utils.rgbToHex(rgbColor){String} facade/js/util/Utils.js, line 789

Esta función transforma el color RGB a hexadecimal.

Name	Type	Description
`rgbColor`	String	Color RGB.

Returns:

Color Hexadecimal.

module:IDEE/utils.sameUrl(url1, url2){Boolean} facade/js/util/Utils.js, line 848

Esta función comprueba que dos URL son iguales.

Name	Type	Description
`url1`	String	URL.
`url2`	String	URL.

Returns:

Verdadero si son iguales.

module:IDEE/utils.setDynamicLegend(legend) facade/js/util/Utils.js, line 1215

Esta función establece la leyenda dinámica constante.

Name	Type	Description
`legend`	String	URL.

module:IDEE/utils.setEquals(array, array2){Boolean} facade/js/util/Utils.js, line 982

Esta función devuelve si dos arrays son iguales independientemente del orden de los elementos.

Name	Type	Description
`array`	Array	Primer array a comparar.
`array2`	Array	Segundo array a comparar.

Returns:

Resultado de la comparación.

module:IDEE/utils.stringifyFunctions(objParam){String} facade/js/util/Utils.js, line 1079

Esta función convierte funciones en cadenas de texto.

Name	Type	Description
`objParam`	function	Función.

Returns:

Devuelve la función como cadena de texto.

module:IDEE/utils.stringToHtml(htmlTxt){HTMLElement} facade/js/util/Utils.js, line 507

Esta función transforma una cadena de texto a código HTML.

Name	Type	Description
`htmlTxt`	String	Cadena.

Returns:

Elemento HTML.

module:IDEE/utils.styleComparator(style, style2){Number} facade/js/util/Utils.js, line 1051

Esta función devuelve la diferencia en la propiedad order de los estilos.

Name	Type	Description
`style`	IDEE.Style	Estilo.
`style2`	IDEE.Style	Estilo.

Returns:

Diferencia, 0 si tienen el mismo.

module:IDEE/utils.transfomContent(text, pSizes){String} facade/js/util/Utils.js, line 1818

Esta función transforma los enlaces a etiquetas HTML.

Name	Type	Description
`text`	String	Texto para realizar la transformación.
`pSizes`	Object	Objeto con los tamaños definidos para cada tipo de contenido.

Returns:

Resultado de la transformación

getImageMapReplacementWithJoin(map, type){String} facade/js/util/Utils.js, line 1645

Esta función devuelve una captura de pantalla del mapa en una promesa.

Name	Type	Default	Description
`map`	IDEE.Map		Mapa del que se obtiene el canvas.
`type`	String	image/jpeg	Formato de la imagen resultante.

Returns:

Imagen en base64 o Promesa con esta.