Componentes
Listado de los componentes que se exponen a través del API:
search
Este componente permite la búsqueda de instrumentos financieros que el usuario defina mediante filtros (por ejemplo, todos los Fondos de Inversión distribuidos en España). La búsqueda se realiza por ISIN o por nombre y el componente devuelve una lista de instrumentos coincidentes. El usuario podrá seleccionar el instrumento que más le interese.
Parámetros de entrada
-
filter
: (object) Permite filtrar el universo sobre el que se va a hacer la búsqueda. Si no se pasa filtro la búsqueda se hace sobre toda la base de datos. Documentación. -
query
: (string) Cadena de texto que se quiere buscar. Puede ser el nombre o el ISIN de los fondos. Si se pasa vacío no devuelve nada. No puede exceder los 127 caracteres. -
maxResults
: (number) Número máximo de resultados que se quieren mostrar. El valor por defecto es 20 y no puede ser superior a 50.
Información de salida
La información que se expone es la del fondo seleccionado por el usuario de la lista de resultados.
symbolId
: (number) Identificador del fondo seleccionado.name
: (string) Nombre del fondo seleccionado.isin
: (string) ISIN del fondo seleccionado.
universe
Visualización en 3D de fondos de inversión.
Parámetros de entrada
versión inicial
-
filter*
: (object) Permite filtrar el universo. Documentación. position
: (object) Objeto de tipo{ horizontal: Number }
.
Permite ubicar el universo en la pantalla. Originalmente el universo está posicionado en el centro del contenedor, y esta propiedad permite mover el universo horizontalmente. Por ejemplo: si se quiere posicionar un 50% a la derecha el parámetro debería ser:position: { horizontal: 50 }
palette
: Define la paleta de colores que va a utilizar el universo. Se puede definir de 2 maneras:length
: (number) Dice al componente que genere una paleta automática con esta longitud.[values]
: (array) Colección de colores en formato#HEX
. Si esta propiedad tiene valores no se tiene en cuenta la propiedadlength
-
categoryType
: (string) Tipo de categorías. Puede ser "ets" o "rentamarkets". Por defecto es "ets".
versión v0
-
filter*
: (object) Permite filtrar el universo. Documentación. -
config
: (object) Configuración para la visualización del universo. Objeto del tipo:-
position
: (object) Objeto de tipo{ horizontal: Number }
.
Permite ubicar el universo en la pantalla. Originalmente el universo está posicionado en el centro del contenedor, y esta propiedad permite mover el universo horizontalmente. Por ejemplo: si se quiere posicionar un 50% a la derecha el parámetro debería ser:position: { horizontal: 50 }
-
palette
: (number | array) Define la paleta de colores que va a utilizar el universo. Se puede definir de 2 maneras:- (number) Como un valor, que dice al componente que genere una paleta automática con esta longitud.
- (array) Como una lista de colores en formato
#HEX
.
-
particle
: (object) Define la configuración de las partículas.size
: (number) Tamaño de la partícula. Tiene que ser entre 10 y 40, y por defecto es 20.color
: (string) Color de la partícula en format#HEX
. Por defecto es #fff.
-
background
: (string | object) Define el background del universo. Se puede definir de 2 maneras:- (string) Como un color en
#HEX
que define el color sólido del background. -
(object) Como un objeto que define el gradiente del background. Este es el valor por defecto. Está compuesto de 2 colores:
primaryColor
: (string) Color en formato#HEX
. Por defecto es #0a4763.secondaryColor
: (string) Color en format#HEX
. Por defecto es #28072d.
- (string) Como un color en
-
-
categoryType
: (string) Tipo de categorías. Puede ser "ets" o "rentamarkets". Por defecto es "ets".
portfolio-table
Muestra una tabla con información de las posiciones de una cartera dada. La información que se muestra es personalizable.
Parámetros de entrada
-
assetsAmounts*
: (array of objects) Lista de posiciones. Documentación. -
fields
: (array of strings) Define los campos que se quieren mostrar y el orden en el que aparecen. Campos disponibles:color
: Color que representa a la posición. Se utiliza para ver la ubicación de la posición en el universo.name
: Nombre de la posición.isin
: ISIN de la posición.category
: Categoría de la posición.currency
: Divisa de la posición.weight
: Peso de la posición en la cartera.ocr
: Coste de la posición.return3Y
: Rentabilidad a 3 años de la posición.volatility3Y
: Volatilidad a 3 años de la posición.amount
: Cantidad invertida en la posición en euros.assets
: Patrimonio de la posición.
color
,name
,isin
,category
,currency
,weight
yamount
. editable
: (bool) Define si se pueden eliminar posiciones de la tabla. Por defecto es falso.-
validations
: (object) Define las validaciones que debe devolver el componente. Ahora mismo sólo hay una validación disponible:sameFund
: (bool) Habilita la validación que comprueba si hay clases del mismo fondo.
Información de salida
-
assetsAmounts
: (array of objects) Lista de posiciones con su identificador, cantidad invertida e ISIN.symbolId
: Identificador de la posición.amount
: Cantidad invertida en la posición en euros.isin
: ISIN de la posición.
-
validationMessages
: (object) Devuelve un objeto con las validaciones que ha habilitado el usuario. Por cada validación se envía una lista con mensajes de error de aquellas posiciones que no cumplen la validación. Si la lista está vacía es que la validación es correcta.sameFund
: (list of strings) Lista de mensajes de las posiciones que tienen el mismo fondo.
reco-draft-assessment
Componente para generar un diagnóstico nuevo.
Parámetros de entrada
-
assetsAmounts*
: (array of objects) Lista de posiciones. Documentación. -
filter
: (object) Permite filtrar el universo para hacer el diagnóstico y seleccionar los mejores. Si no se pasa nada se hacer sobre toda la base de datos. Documentación. -
fees*
: (object) Parametriza los fees de los symbolos seleccionados que se van a mostrar en el diagnóstico. Documentación. -
proposedFees*
: (object) Parametriza los fees de los symbolos propuesto que se van a mostrar en el diagnóstico. Documentación.
slider
Componente para seleccionar valores en formato slider
Parámetros de entrada
-
[steps]*
: (array of objects) Lista de valores seleccionables. Cada objeto es de tipo:value
: (number) Valor que se devuelve si se selecciona.text
: (string) Texto que se muestra para ese valor.
selectedValue
: (number) Valor seleccionado. Por defecto selecciona el primer elemento.selectedIndex
: (number) Índice seleccionado. Por defecto selecciona el primer elemento. En caso de pasarselectedValue
yselectedIndex
tiene preferenciaselectedIndex
.showLabels
: (bool) Define si se muestran o no las etiquetas en los valores.
Información de salida
value
: (number) Valor seleccionado.
power-bars
v0
Muestra en un gráfico de araña los valores que va tomando la configuración de la cartera. Estos valores son:
- Rentabilidad
- Coste
- Diversificación
- Riesgo
Parámetros de entrada
Se le pueden pasar unos parámetros con los valores ya predefinidos
-
values
: (object) Objeto del tipo:profitability
: (number) Valor de la rentabilidad. Valor entre 0 y 1. Por defecto vale 0.cost
: (number) Valor del coste. Valor entre 0 y 1. Por defecto vale 0.risk
: (number) Valor del riesgo. Valor entre 0 y 1. Por defecto vale 0.diversification
: (number) Valor de la diversificación. Valor entre 0 y 1. Por defecto vale 0.
v1
Muestra en un gráfico de araña los valores que va tomando la configuración de la cartera. Estos valores son:
- Rentabilidad
- Popularidad
- Gestión del riesgo
- Ahorro en costes
- Diversificación
- ESG
Parámetros de entrada
-
config*
: (object) Configuración de la estrategia. Tiene que ser una configuración válida para la estrategia que se quiera. Es la misma configuración que se envía a la propuesta. -
proposalId*
: (number) Identificador de la propuesta para obtener sus powerbars.
risk-selector
Permite seleccionar el riesgo con un gráfico gauge.
Parámetros de entrada
steps
: (number) Número de pasos que se pueden seleccionar. Por defecto es 7. Como mínimo deben ser 2 y como máximo 20.value
: (number) Valor seleccionado. Por defecto es 1, es decir, el valor mínimo seleccionable.
Información de salida
value
: (number) Valor seleccionado por el usuario. Valor entre 1 y el número de steps.normalizedValue
: (number) Valor seleccionado por el usuario normalizado entre 0 y 1.
categories
Componente para seleccionar categorías de ETS agrupadas. El usuario provee cada conjunto de categorías ETS con un nombre personalizado. Estos conjuntos se agrupan. También pasa como parámetro la descripción asociada a cada conjunto.
Parámetros de entrada
[groups]*
: (array of objects) Lista de grupos de categorías. Son las agrupaciones. Cada grupo es un objeto de tipo:name*
: (string) Nombre de la pestaña.-
[categories]*
: (array of objects) Lista con las categorías. Cada categorías es un objeto de tipo:name*
: (string) Nombre del conjunto.-
[ids]*
: (array of numbers) Lista con los identificadores de las categorías ETS que agrupa. Lista de las categorías disponibles. selected
: (bool) Si está seleccionado o no por defecto. Por defecto es falso.favourite
: (bool) Si es favorita o no por defecto. Por defecto es falso.locked
: (bool) Si está bloqueada o no para su selección. Por defecto es falso.-
tooltip
: (object) Información para el tooltip. Si no se pasa no se pinta el tooltip. Este objeto es de tipo:description
: (string) Texto con la información descriptiva.-
data*
: (object) Valores con la información que se muestra en formato tabular. Este objeto es de tipo:return*
: (number) Rentabilidad del conjunto de las categorías. Valor en tanto por uno.volatility*
: (number) Volatilidad del conjunto de las categorías. Valor en tanto por uno.mdd*
: (number) Máximo Drawdown del conjunto de las categorías. Valor en tanto por uno.
-
categoryType
: (string) Tipo de categorías. Puede ser "ets" o "rentamarkets". Por defecto es "ets".
Información de salida
[groups]
: (array of objects) Devuelve el mismo objeto que ha pasado el usuario por parámetro modificado.
preferences
Permite modificar las preferencias en la selección de activos de la cartera del usuario. Los 4 parámetros a tener en cuenta son:
- Rentabilidad
- Riesgo
- Popularidad
- Coste
- ESG
Parámetros de entrada
profitability
: (number) Representa cuánto le importa la rentabilidad al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.risk
: (number) Representa cuánto le importa el riesgo al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.-
popularity
: (number) Representa cuánto le importa la popularidad al usuario, es decir, cuanto patrimonio tiene. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1. cost
: (number) Representa cuánto le importa el coste al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.esg
: (number) Representa cuánto le importa la sostenibilidad al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.
Información de salida
La información que se expone son los valores de las preferencias.
profitability
: (number) Valor actual de la rentabilidad.risk
: (number) Valor actual del riesgo.popularity
: (number) Valor actual de la popularidad.cost
: (number) Valor actual del coste.esg
: (number) Valor actual del ESG.
reco-draft-proposal
Componente que genera una propuesta nueva dada una configuración de estrategia.
Parámetros de entrada
v0
-
configuration*
: (object) Configuración de la estrategia. Tiene que ser una configuración válida para la estrategia que se quiera.Configuración para
mt16_efama
:configurationType
: (string) Nombre del tipo de configuración.universeType
: (string) Tipo de universo.operativeType
: (string) Tipo de operativa.adaptationLevel
: (number) Nivel de adaptación de la cartera. De 0 a 5.riskLevel
: (number) Nivel de riesgo de la cartera. De 1 a 7.categories
: (array of numbers) Lista de los identificadores de las categorías ETS seleccionadas.favourites
: (array of numbers) Lista de los identificadores de las categorías ETS favoritas.-
preferences
: (object) Las preferencias seleccionadas por el usuario. Objeto de tipo:return
: (number) Número de 0 a 1 que representa cuánto le importa la rentabilidad al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.risk
: (number) Número de 0 a 1 que representa cuánto le importa el riesgo al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.-
popularity
: (number) Número de 0 a 1 que representa cuánto le importa la popularidad al usuario, es decir, cuanto patrimonio tiene. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1. fees
: (number) Número de 0 a 1 que representa cuánto le importa el coste al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.
Configuración para
mt16_rm
:configurationType
: (string) Nombre del tipo de configuración.universeType
: (string) Tipo de universo.operativeType
: (string) Tipo de operativa.adaptationLevel
: (number) Nivel de adaptación de la cartera. De 0 a 5.riskLevel
: (number) Nivel de riesgo de la cartera. De 1 a 7.-
categories
: (array of objects) Lista de objetos con todas las categorías según el estado seleccionado:tag
: Identificador de la categoría. Por ejemplo: "EQUITY_CONSUMER".status
: Estado de la categoría. Puede ser:favourite
,enabled
ódisabled
.
-
preferences
: (object) Las preferencias seleccionadas por el usuario. Objeto de tipo:return
: (number) Número de 0 a 1 que representa cuánto le importa la rentabilidad al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.risk
: (number) Número de 0 a 1 que representa cuánto le importa el riesgo al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.-
popularity
: (number) Número de 0 a 1 que representa cuánto le importa la popularidad al usuario, es decir, cuanto patrimonio tiene. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1. fees
: (number) Número de 0 a 1 que representa cuánto le importa el coste al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.
-
assetsAmounts*
: (array of objects) Lista de posiciones. Documentación. -
fees*
: (object) Parametriza los fees que se van a mostrar en la propuesta. Documentación. -
powerBars
: (object) Valores de los powerbars de la cartera. Objeto de tipo:profitability
: (number) Valor de la rentabilidad. Valor entre 0 y 1. Por defecto vale 0.cost
: (number) Valor del coste. Valor entre 0 y 1. Por defecto vale 0.risk
: (number) Valor del riesgo. Valor entre 0 y 1. Por defecto vale 0.diversification
: (number) Valor de la diversificación. Valor entre 0 y 1. Por defecto vale 0.esg
: (number) Valor de la sostenibilidad. Valor entre 0 y 1. Por defecto vale 0.
-
benchmarkIds
: (array of numbers or strings) Identificadores de los índices. Si el identificador es de tipo number es el id del índice en la base de datos de ETS, si es un string es el ticker del cliente. Si no se pasa ningún benchmarkId no se muestra en el gráfico de evolución. -
associatedPortfolioId
: (number or string) Identificadores del índice. Si el identificador es de tipo number es el id del índice en la base de datos de ETS, si es un string es el ticker del cliente.
v1
-
configuration*
: (object) Configuración de la estrategia. Tiene que ser una configuración válida para la estrategia que se quiera.Configuración para
mt16_efama
:configurationType
: (string) Nombre del tipo de configuración.universeType
: (string) Tipo de universo.operativeType
: (string) Tipo de operativa.adaptationLevel
: (number) Nivel de adaptación de la cartera. De 0 a 5.riskLevel
: (number) Nivel de riesgo de la cartera. De 1 a 7.categories
: (array of numbers) Lista de los identificadores de las categorías ETS seleccionadas.favourites
: (array of numbers) Lista de los identificadores de las categorías ETS favoritas.-
preferences
: (object) Las preferencias seleccionadas por el usuario. Objeto de tipo:return
: (number) Número de 0 a 1 que representa cuánto le importa la rentabilidad al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.risk
: (number) Número de 0 a 1 que representa cuánto le importa el riesgo al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.-
popularity
: (number) Número de 0 a 1 que representa cuánto le importa la popularidad al usuario, es decir, cuanto patrimonio tiene. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1. fees
: (number) Número de 0 a 1 que representa cuánto le importa el coste al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.esg
: (number) Número de 0 a 1 que representa cuánto le importa la sostenibilidad al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.
Configuración para
mt16_rm
:configurationType
: (string) Nombre del tipo de configuración.universeType
: (string) Tipo de universo.operativeType
: (string) Tipo de operativa.adaptationLevel
: (number) Nivel de adaptación de la cartera. De 0 a 5.riskLevel
: (number) Nivel de riesgo de la cartera. De 1 a 7.-
categories
: (array of objects) Lista de objetos con todas las categorías según el estado seleccionado:tag
: Identificador de la categoría. Por ejemplo: "EQUITY_CONSUMER".status
: Estado de la categoría. Puede ser:favourite
,enabled
ódisabled
.
-
preferences
: (object) Las preferencias seleccionadas por el usuario. Objeto de tipo:return
: (number) Número de 0 a 1 que representa cuánto le importa la rentabilidad al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.risk
: (number) Número de 0 a 1 que representa cuánto le importa el riesgo al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.-
popularity
: (number) Número de 0 a 1 que representa cuánto le importa la popularidad al usuario, es decir, cuanto patrimonio tiene. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1. fees
: (number) Número de 0 a 1 que representa cuánto le importa el coste al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.esg
: (number) Número de 0 a 1 que representa cuánto le importa la sostenibilidad al usuario. Por defecto vale 0, es decir, nada. Valores permitidos: 0, 0.25, 0.5, 0.75, 1.
-
assetsAmounts*
: (array of objects) Lista de posiciones. Documentación. -
fees*
: (object) Parametriza los fees que se van a mostrar en la propuesta. Documentación. -
benchmarkIds
: (array of numbers or strings) Identificadores de los índices. Si el identificador es de tipo number es el id del índice en la base de datos de ETS, si es un string es el ticker del cliente. Si no se pasa ningún benchmarkId no se muestra en el gráfico de evolución. -
associatedPortfolioId
: (number or string) Identificadores del índice. Si el identificador es de tipo number es el id del índice en la base de datos de ETS, si es un string es el ticker del cliente.
proposal-weight-comparative
Muestra un gráfico de barras que compara el weight para cada posición utilizada en una propuesta.
Parámetros de entrada
El componente se puede inicializar de dos formas:
proposalId*
: (number) Identificador de la propuesta para sacar los weights de cada posición.categoryType*
: (string) Tipo de categorías. Puede ser "ets" o "rentamarkets". Por defecto es "ets".
Pasando un proposalId
O pasando una configuración para crear una propuesta. Se utilizarán los mismos parametros como en el componente proposal
.
Opcional:
column-comparative
Muestra un gráfico de columnas que compara una lista de valores.
Parámetros de entrada
names*
: (Array) Lista de nombres.Tiene que tener el mismo numero de valores que las valores.values*
: (Array) Lista de valores.Tiene que tener el mismo numero de valores que los nombres.type
: (string) Tipo de valores para formatear en el grafico.-
Variantes aceptadas:
number
percentage
scatter-chart
Muestra un grafico de puntos posicionados en X axis + Y axis.
Parámetros de entrada
-
xAxis
: (object) Las preferencias seleccionadas por el usuario. Objeto de tipo:type
: (string) Tipo de valores para formatear en el grafico.-
Variantes aceptadas:
number
percentage
data
: (array of numbers) Lista de valores para mostrar en el eje horizontal. Tiene que tener el mismo numero de valores que el otro ejename
: (string) Nombre para mostrar como el titulo en xAxis
-
yAxis
: (object) Las preferencias seleccionadas por el usuario. Objeto de tipo:type
: (string) Tipo de valores para formatear en el grafico.-
Variantes aceptadas:
number
percentage
data
: (array of numbers) Lista de valores para mostrar en el eje vertical. Tiene que tener el mismo numero de valores que el otro ejename
: (string) Nombre para mostrar como el titulo en yAxis.
selectedIndex
: (number) Identificador del punto seleccionado para destacarlo. Por defecto no se selecciona ningun punto.
selectedIndex
se llama la función update()
pasando el nuevo index.