API IDEE Core v1.1.0 API - Class: Section

Class: Section

IDEE/layer/Section~Section

import Section from 'IDEE/layer/Section';

Esta clase representa una sección de capas de cualquier tipo dentro de un mapa. Si la sección ya está añadida al mapa, las capas añadidas a la sección se añadirán automáticamente al mapa, y las capas eliminadas de la sección se eliminarán automáticamente del mapa. Los elementos dentro de la sección son considerados como hijos de la sección.

new Section(userParameters)

facade/js/layer/Section.js, line 34

Constructor principal de la clase. Crea una nueva instancia de la clase Section con parametros especificados por el usuario.

Name Type Description

Name	Type	Description
`userParameters`	string \| Mx.parameters.Layer	Parámetros especificados por el usuario. idSection: Identificador de la sección. title: Título de la sección. collapsed: Verdadero o falso para mostrar la sección colapsada o expandida en el árbol de contenidos, si lo hay. order: Posición de la sección. zIndex: Z-index de la sección para el orden de visualización. children: Array de capas hijas de esta sección.

userParameters

string | Mx.parameters.Layer

Parámetros especificados por el usuario.

idSection: Identificador de la sección.
title: Título de la sección.
collapsed: Verdadero o falso para mostrar la sección colapsada o expandida en el árbol de contenidos, si lo hay.
order: Posición de la sección.
zIndex: Z-index de la sección para el orden de visualización.
children: Array de capas hijas de esta sección.

Properties:

Name	Type	Description
`idSection`	string	Identificador de la sección.
`title`	string	Título de la sección.
`collapsed`	boolean	Verdadero o falso para mostrar la sección colapsada o expandida en el árbol de contenidos, si lo hay.
`order`	number	Posición de la sección.
`parent`	IDEE.layer.Section	Sección padre de esta sección, si la hay.
`children`	Array.<(IDEE.layer.Section\|IDEE.Layer)>	Capas hijas de esta sección.
`impl`	IDEE.impl.layer.Section	Implementación de la capa.
`zIndex`	number	Z-index de la sección para el orden de visualización.

Extends

IDEE.Object

Members

collapsed{boolean}

Section collapsed: Verdadero o falso para mostrar la sección colapsada o expandida en el TOC.

idSection{string}

Section idSection: Identificador de la sección.

order{number}

Section order: Posición de la sección.

parent{IDEE.layer.Section}

Sección padre de esta sección, si la hay.

title{string}

Section title: Título de la sección.

Methods

module:IDEE/layer/Section~Section.findGroupById(groupId, sections) facade/js/layer/Section.js, line 376

Este método busca una sección por su id, recursivamente si hay secciones anidadas.

Name	Type	Description
`groupId`	number	Identificador de la sección a buscar.
`sections`	Array.<IDEE.layer.Section>	Conjunto de secciones donde buscar.

addChild(layer, index) facade/js/layer/Section.js, line 228

Este método añade capas hijas a la sección.

Name	Type	Description
`layer`	IDEE.Layer \| IDEE.layer.Section	Capa o sección a añadir.
`index`	number	Posición a añadir la capa.

addChildren(children) facade/js/layer/Section.js, line 312

Este método añade un conjunto de capas hijas a la sección.

Name	Type	Description
`children`	Array.<(IDEE.Layer\|IDEE.layer.Section)>	Capas o secciones a añadir.

addTo(map) facade/js/layer/Section.js, line 163

Este método añade la capa al mapa.

Name	Type	Description
`map`	IDEE.Map	Mapa al que se añade la sección.

deleteChild(child) facade/js/layer/Section.js, line 267

Este método elimina una capa hija de la sección.

Name	Type	Description
`child`	IDEE.Layer \| IDEE.layer.Section	Capa o sección a eliminar.

deleteChildren(children) facade/js/layer/Section.js, line 286

Este método elimina un conjunto de capas hijas de la sección.

Name	Type	Description
`children`	Array.<(IDEE.Layer\|IDEE.layer.Section)>	Capas o secciones a eliminar.

destroy() facade/js/layer/Section.js, line 363

Este método destruye la sección y todas sus capas hijas.

getAllLayers(){Array.<IDEE.Layer>} facade/js/layer/Section.js, line 344

Este método devuelve todas las capas hijas de la sección que son instancia de Layer, ya sean directas o indirectas (de secciones internas).

Returns:

Capas que son instancia de Layer de la sección.

getChildren(){Array.<(IDEE.Layer|IDEE.layer.Section)>} facade/js/layer/Section.js, line 331

Este método devuelve todas las capas hijas de la sección.

Returns:

Capas de la sección.

getZIndex(){number} facade/js/layer/Section.js, line 215

Este método obtiene el z-index de la sección. Este z-index se corresponde con el más bajo de sus capas.

Returns:

Devuelve el z-index de la sección.

setVisible(visibility) facade/js/layer/Section.js, line 181

Este método sobreescribe la visibilidad de la sección y de todas sus capas.

Name	Type	Description
`visibility`	boolean	Define si la sección es visible o no.

setZIndex(zIndex) facade/js/layer/Section.js, line 195

Este método establece el z-index de la sección y de todas sus capas hijas. El z-index se aplica a la primera capa de la sección, luego se incrementa en uno y se aplica a la siguiente capa, y así sucesivamente.

Name	Type	Description
`zIndex`	number	Nuevo z-index.

ungroup(child) facade/js/layer/Section.js, line 298

Este método saca una capa de la sección.

Name	Type	Description
`child`	IDEE.Layer \| IDEE.layer.Section	Capa o sección a sacar.