jsdoc componentearbol

componenteArbol

Componente concreto Lista jerárquica (árbol).

Extiende: componente

Métodos

inicializar()

Inicializa la instancia tras ser creada o restaurada.
Devuelve: componenteArbol

crear()

Crea el elemento del DOM para esta instancia.
Devuelve: componenteArbol

listo()

Evento Listo.

propiedadModificada(propiedad,valor,tamano,valorAnterior)

Actualiza el componente.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
propiedad
valor
tamano
valorAnterior

Devuelve: componenteArbol

actualizarIterativo()

Actualiza el componente.
Devuelve: componenteArbol

removerMensajeSinDatos()

Elimina el mensaje de bloque sin datos, si existe.
Devuelve: componenteArbol

mostrarMensajeSinDatos()

Genera el mensaje de bloque sin datos.
Devuelve: componenteArbol

generarItem(destino,objeto,indice,recursivo)

Genera y agrega un nuevo item correspondiente a un elemento del origen de datos del componente iterativo.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
destino	Node	Elemento de destino. Por defecto, this.contenedorItems o this.elemento.
objeto	*	Objeto o elemento del origen de datos.
indice	number	Indice del elemento en el listado u origen de datos.
recursivo	Object	Parámetros del recorrido recursivo del listado, si corresponde.

Devuelve: Node

generarItems([indice,listado,destino,recursivo])

Genera los items del árbol.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
indice	number	Ignorado.	Si
listado	object[]	Listado a utilizar. Por defecto, utilizará el origen de datos.	Si
destino	Node	Elemento de destino. Por defecto, utilizará el elemento del componente.	Si
recursivo	Object	Parámetros para recorrer listado en forma recursiva. Puede presentar propiedades adicionales, las cuales serán pasadas tal cual a la descendencia.	Si

Propiedades de recursivo

Propiedad	Tipo	Descripción	Opcional	Predeterminado
nivel	int	Nivel actual.	Si
propiedad	string	Propiedad de cada elemento de listado que contiene la descendencia.	Si
nivel	int	Nivel actual.	Si
ruta	int[]	Ruta actual, como listado de índices.	Si

Devuelve: componenteArbol

obtenerItemsExpandidos()

Devuelve un listado de las rutas de los items expandidos.
Devuelve: string[]

expandirItems(rutas)

Expande los ítems especificados dadas sus rutas.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
rutas	string[]

Devuelve: componenteArbol

expandir([ruta])

Expande o abre un nivel dada su ruta.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
ruta	string	Ruta como array o índices separados por punto, comenzando desde 0 (por ejemplo 0.1.0). Si se omite, se expandirá el árbol completo. Para expandir todo el primer nivel (pero no los sub-niveles), especificar -1.	Si

Devuelve: componenteArbol

contraer([ruta])

Contrae o cierra un nivel dada su ruta.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
ruta	string	Ruta como array o índices separados por punto, comenzando desde 0 (por ejemplo 0.1.0). Si se omite, se expandirá el árbol completo. Para contraer todo el primer nivel (pero mantener el estado de los sub-niveles), especificar -1.	Si

Devuelve: componenteArbol

alternar([ruta])

Alterna el estado de un nivel dada su ruta.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
ruta	string	Ruta como índices separados por punto, comenzando desde 0 (por ejemplo 0.1.0). Si se omite, se expandirá/contraerá el árbol completo. Para alternar todo el primer nivel (pero mantener el estado de los sub-niveles), especificar -1.	Si

Devuelve: componenteArbol

expandido([ruta])

Determina si un nivel se encuentra expandido o no.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
ruta	string	Ruta como índices separados por punto, comenzando desde 0 (por ejemplo 0.1.0).	Si

Devuelve: boolean

extraerValor()

Genera y devuelve el valor de retorno según las propiedades devuelve, filtrarPropiedades y filtrarItems.
Devuelve: *

obtenerObjetoDatos([indice])

Devuelve un elemento del origen de datos correspondiente a un índice o, en el caso de listados a nidados, una ruta.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
indice	number|string|number[]	Índice, o ruta como array o índices separados por punto, comenzando desde 0 (por ejemplo 0.1.0).	Si

Devuelve: Object|null

obtenerItem([ruta])

Devuelve el elemento (<li>) correspondiente a un nivel.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
ruta	string	Ruta como array o índices separados por punto, comenzando desde 0 (por ejemplo 0.1.0).	Si

Devuelve: Node

obtenerRuta(elemento)

Dado un elemento del árbol, devuelve su ruta.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
elemento	Element|Node	Elemento <li>.

Devuelve: string|null

click(evento)

Evento Click. Por defecto, expande/contrae el nivel.

Parámetro	Tipo	Descripción	Opcional	Predeterminado
evento	MouseEvent	Parámetros del evento.

Devuelve: boolean