Árvore de camadas

Monta a árvore com os temas existentes no mapa atual.  A árvore contém as opções de ligar e desligar temas, alteração na ordem de desenho, links para acesso a funcionalidades, etc.

Por padrão, a árvore é inserida no elemento HTML da interface do mapa cujo ID for igual a listaTemas

i3GEO.arvoreDeCamadas permite controlar quais as opções que serão mostradas na árvore e seu comportamento em diferentes situa&ccdil;õs.

Alguns itens são incluídos caso sejam localizados na interface elementos html com os seguintes ID

listaLayersBaselista os layers de fundo na interface OpenLayers
buscaRapidaformulário de busca de dados em camadas
listaPropriedadesconjunto de atalhos para ferramentas que controlam algumas características do mapa (na versão 6 do i3Geo esses atalhos constam em outros lugares, sendo desnecessário manter essa lista ativa na árvore)

Namespace

i3GEO.arvoreDeCamadas

Exemplo

Para alterar as opções da árvore, modifique as propriedades colocando um código como o seguinte no javascript utilizado na interface de mapa que estiver sendo utilizada

i3GEO.arvoreDeCamadas.INCLUILFUNDO = false;

Veja

http://localhost/i3geo/classesjs/classe_arvoredecamadas.js

Summary
Árvore de camadasMonta a árvore com os temas existentes no mapa atual.
Constants
ARVOREObjeto com a árvore criada com YAHOO.widget.TreeView Pode ser usado para receber métodos da API do YAHOO
IDHTMLArmazena o ID do elemento DOM onde a árvore foi inserida.
CAMADASINICIAISO mesmo que CAMADAS mas guarda de forma permanente as camadas que iniciaram o mapa
Variaveis
CAMADASObjeto com a lista de camadas existentes no mapa.
Propriedades
FINALIZAFunção ou nome de uma função que será executada após a árvore ter sido montada A funço permite ajustar a árvore conforme o programador desejar.
NOTEMAObjeto com os parâmetros que são utilizados na árvore de camadas para incluir os nós correspondentes a cada tema
NOTEMAICONObjeto com os parâmetros que são utilizados na árvore de camadas para incluir os nós correspondentes aos ícones de opções de cada tema
INCLUILFUNDOInclui ou não na árvore as camadas do tipo baselayer (layers de fundo).
ATIVATEMANome da função que será incluída no evento onclick do elemento checkbox adicionado no início do nome de um camada
TEMPLATELEGENDANome do template HTML que sera usado para compor a legenda de cada tema.
BARRAPROGRESSOMostra uma barra na parte superior do mapa que indica o progresso do desenho das camadas do mapa
MOSTRALISTAKMLMostra na árvore a lista de endereços de arquivos KML cadastrados no sistema de administração.
FILTROFiltro que será aplicado para restringir os tipos de camadas mostradas na árvore
VERIFICAABRANGENCIATEMASVerifica ou não se um tema da árvore está dentro da abrangência do mapa atual, marcando esses temas na árvore
EXPANDESOLEGENDAAo expandir um tema mostra apenas a legenda, sem as outras opções
PERMITEEXPANDIRTEMASPermite que as opções abaixo dos nós referentes a cada tema sejam mostradas
ARRASTARORDEMAtiva a opção de arrastar um tema para alterar a ordem de desenho das camadas
EXPANDIDAIndica se a árvore será montada de forma expandida ou não.
LEGENDAEXPANDIDAIndica se a legenda da árvore será montada de forma expandida ou não.
MOSTRATITULOIndica se o título da árvore será incluído ou não
OPCOESICONESInclui ou não os ícones de opções em cada tema (farol, zoom para o tema, etc)
OPCOESLEGENDAInclui ou não o nó para mostrar a legenda do tema.
OPCOESARVOREInclui ou não as opções de ícones mostradas na raiz da ávore
AGUARDALEGENDAAtiva a opção de aguarde para mostrar a legenda de um tema quando o usuário estaciona o mouse sobre o nome de um tema.
ICONETEMAMostra ou não o ícone do tema caso exista.
CONFIGICONESDefine as configurações dos ícones mostrados na raiz da árvore e na raiz de cada tema
Functions
criaCria a árvore com as opções de manipulação das camadas existentes no mapa
iniciaEssa função cria e inicializa a árvore de camadas utilizando o objeto default que contém os parâmetros de cada camada.
atualizaAtualiza a árvore de camadas.
ligaDesligaTemasMarca ou desmarca os checkbox da árvore de uma lista de temas
atualizaLegendaAtualiza a legenda de um tema.
aplicaTemasRefaz o mapa ligando e desligando os temas conforme consta na árvore de camadas ou ligando/desligando todos
listaLigadosDesligadosLista os temas que estão ligados e os que estão desligados tendo como fonte de busca os checkbox existentes na árvore.
capturaCheckBoxRetorna o objeto input (check box) que corresponde a uma determinada camada na árvore.
pegaTemaProcura um tema no objeto CAMADAS.
alteraPropCamadasAltera o valor de uma propriedade de um tema do objeto i3GEO.arvoreDeCamadas.CAMADAS
i3GEO.arvoreDeCamadas.dialogoAbre as telas de diálogo das opções de manipulação da árvore
Functions
filtroAbre a janela de diálogo para o usuário escolher ou alterar o filtro aplicado a árvore
excluirAbre a janela de diálogo para o usuário escolher os temas que serão excluídos da árvore

Constants

ARVORE

Objeto com a árvore criada com YAHOO.widget.TreeView Pode ser usado para receber métodos da API do YAHOO

Tipo

{YAHOO.widget.TreeView}

IDHTML

Armazena o ID do elemento DOM onde a árvore foi inserida.

Tipo

{string}

Default

”listaTemas”

CAMADASINICIAIS

O mesmo que CAMADAS mas guarda de forma permanente as camadas que iniciaram o mapa

Tipo

{objeto}

Variaveis

CAMADAS

Objeto com a lista de camadas existentes no mapa.  É definido na inicialização ou no redesenho do mapa.

Este objeto é construído nas operações em PHP de inicialização ou redesenho do mapa e lista todos os layers existentes no mapfile temporário em uso.

classesphp/classe_mapas.php

parametrosTemas

Tipo

{objeto}

Propriedades

FINALIZA

Função ou nome de uma função que será executada após a árvore ter sido montada A funço permite ajustar a árvore conforme o programador desejar.  É executada apenas na criação da árvore

Tipo

{string}

Default

””

NOTEMA

Objeto com os parâmetros que são utilizados na árvore de camadas para incluir os nós correspondentes a cada tema

Esse objeto segue as definições da API da biblioteca YUI2

http://yui.github.io/yui2/docs/yui_2.9.0_full/docs/YAHOO.widget.Node.html

NOTEMAICON

Objeto com os parâmetros que são utilizados na árvore de camadas para incluir os nós correspondentes aos ícones de opções de cada tema

Esse objeto segue as definições da API da biblioteca YUI2

http://yui.github.io/yui2/docs/yui_2.9.0_full/docs/YAHOO.widget.Node.html

INCLUILFUNDO

Inclui ou não na árvore as camadas do tipo baselayer (layers de fundo).  Afeta apenas os mapas baseados no OpenLayers.  Será considerado como false caso exista no mapa outro local marcado para receber a lista de layers de fundo, ou seja, será sempre false caso o i3Geo localize algum elemento HTML com id "listaLayersBase"

Tipo

{boolean}

Default

true

ATIVATEMA

Nome da função que será incluída no evento onclick do elemento checkbox adicionado no início do nome de um camada

Tipo

{string}

Default

””

TEMPLATELEGENDA

Nome do template HTML que sera usado para compor a legenda de cada tema.  O HTML deve ser armazenado em i3geo/aplicmap.  Templates de legenda seguem a sintaxe definida pelo software Mapserver

Tipo

{string}

Default

legenda5.htm

BARRAPROGRESSO

Mostra uma barra na parte superior do mapa que indica o progresso do desenho das camadas do mapa

Funciona apenas na interface Openlayers

Tipo

{boolean}

Default

true

MOSTRALISTAKML

Mostra na árvore a lista de endereços de arquivos KML cadastrados no sistema de administração.  Quando presente no mapa, o usuário pode escolher um KML de uma lista pré-definida para ser adicionado

Tipo

{boolean}

Default

false

FILTRO

Filtro que será aplicado para restringir os tipos de camadas mostradas na árvore

Tipo

{ligados|desligados|selecionados|download|wms|raster|toponimia}

Default

””

VERIFICAABRANGENCIATEMAS

Verifica ou não se um tema da árvore está dentro da abrangência do mapa atual, marcando esses temas na árvore

A verificação só é feita se o tema possuir a extensão geográfica registrada (veja o sistema de administração)

Tipo

{boolean}

Default

false

EXPANDESOLEGENDA

Ao expandir um tema mostra apenas a legenda, sem as outras opções

Tipo

{boolean}

Default

false

PERMITEEXPANDIRTEMAS

Permite que as opções abaixo dos nós referentes a cada tema sejam mostradas

Tipo

{boolean}

Default

true

ARRASTARORDEM

Ativa a opção de arrastar um tema para alterar a ordem de desenho das camadas

Tipo

{boolean}

Default

true

EXPANDIDA

Indica se a árvore será montada de forma expandida ou não.  Se true, os nós do primeiro nível serão abertos na inicialização da árvore.

Tipo

{boolean}

Default

false

LEGENDAEXPANDIDA

Indica se a legenda da árvore será montada de forma expandida ou não.

Tipo

{boolean}

Default

false

MOSTRATITULO

Indica se o título da árvore será incluído ou não

Tipo

{boolean}

Default

false

OPCOESICONES

Inclui ou não os ícones de opções em cada tema (farol, zoom para o tema, etc)

Tipo

{boolean}

Default

true

OPCOESLEGENDA

Inclui ou não o nó para mostrar a legenda do tema.

Tipo

{boolean}

Default

true

OPCOESARVORE

Inclui ou não as opções de ícones mostradas na raiz da ávore

Tipo

{boolean}

Default

true

AGUARDALEGENDA

Ativa a opção de aguarde para mostrar a legenda de um tema quando o usuário estaciona o mouse sobre o nome de um tema.

Tipo

{boolean}

Default

false

ICONETEMA

Mostra ou não o ícone do tema caso exista.

O ícone é definido no METADATA ICONETEMA no mapfile correspondente ao tema (veja o sistema de administração

Tipo

{boolean}

Default

true

CONFIGICONES

Define as configurações dos ícones mostrados na raiz da árvore e na raiz de cada tema

Cada ícone possuí um nome e propriedades, descritas a seguir, e que sao usadas no formato

i3GEO.arvoreDeCamadas.CONFIGICONES.refresh (onde refresh é o nome do ícone)

Ícones disponíveis

refreshMostra ou não a opção que permite atualizar a ´rvore
opacidadeMostra ou não a opção que permite alterar a transparência das camadas existentes no mapa
ferramentasMostra ou não a opção que permite abrir os atalhos para as ferramentas que atuam sobre o mapa
imprimirMostra ou não a opção que permite abrir a ferramenta de impressão
animacaoMostra ou não a opção que permite gerar uma animação do mapa, ligando e desligando camadas

olhoaberto

olhofechado

Propriedades de cada ícone

tipoarvore|tema
iconecaminho para a imagem relativo a localização do i3Geo
classenome da classe CSS que define o estilo do ícone
funcaostring com a função inserida em onclick
titlestring inserida em title
dicaajuda sobre como usar a ferramenta
idid que será inserido no ícone
statustrue|false será ou não incluĩdo na árvore
flagtrue|false indicador temporário se o ícone deve ou não ser inserido (o flag muda durante a montagem dos icones dos temas)

Functions

cria

cria : function(onde,
temas,
g_sid,
g_locaplic,
funcaoTema)

Cria a árvore com as opções de manipulação das camadas existentes no mapa

Parametros

{string}(opcional) ID do elemento DOM onde a árvore será inserida.  Se for definido como “” o id será buscado da variável IDHTML.
{objeto}(opcional) Objeto com as camadas e propriedades.  Se não for definido ou for vazio, será utilizado i3GEO.arvoreDeCamadas.CAMADAS
{string}(opcional) Código da seção PHP criada ao abrir o i3Geo
{string}(opcional) Endereço da aplicação
{string}(opcional) Nome da função que será incluida no evento disparado quando o usuário clicar no checkbox de um tema

inicia

inicia : function(id)

Essa função cria e inicializa a árvore de camadas utilizando o objeto default que contém os parâmetros de cada camada.  Faz o encadeamento das funções i3GEO.arvoreDeCamadas.cria e atualiza

i3GEO.arvoreDeCamadas.FINALIZA também é executado se existir

Parametros

stringid do elemento HTML onde a árvore será inserida

atualiza

atualiza : function(temas,
forca)

Atualiza a árvore de camadas.

Antes de executar a atualização, essa função verifica se é necessário fazê-lo.  O objeto CAMADAS é comparado com o parametro “temas” para verificar se existem diferenças que justifiquem a atualização.

Parametros

{objeto}Objeto com a lista de camadas e propriedades (veja CAMADAS).  Se não existir, a árvore é redesenhada
{boolean}força a atualização da árvore, sem verificar automaticamente se a atualização deve ou não ser feita

ligaDesligaTemas

ligaDesligaTemas : function(lista,
status)

Marca ou desmarca os checkbox da árvore de uma lista de temas

Parametros

{string}lista, separada por vírgulas, dos códigos dos temas
{boolean}marca ou desmarca

atualizaLegenda

atualizaLegenda : function(idtema)

Atualiza a legenda de um tema.

A legenda precisa ser atualizada em algumas circunstâncias, como quando é feitoumzoom no mapa.

Parametro

{String}ID (name) do tema

aplicaTemas

aplicaTemas : function(tipo)

Refaz o mapa ligando e desligando os temas conforme consta na árvore de camadas ou ligando/desligando todos

Parametro

{normal|ligartodos|desligartodos}tipo de operação A opção ‘normal’ irá desligar/ligar o que estiver marcado

listaLigadosDesligados

listaLigadosDesligados : function(tipo)

Lista os temas que estão ligados e os que estão desligados tendo como fonte de busca os checkbox existentes na árvore.

Esse método é mais demorado pois varre a árvore toda.  Porém, obtém o status verdadeiro do tema.

Parametro

{String}mantem|marca|desmarca marca, desmarca ou mantém o checkbox após identificar seu status atual

Return

{Array}array de arrays com os códigos dos temas [0]=ligados [1]=desligados [2]=todos na ordem encontrada

capturaCheckBox

capturaCheckBox : function(tema)

Retorna o objeto input (check box) que corresponde a uma determinada camada na árvore.

Parametro

{String}código do tema ao qual o elemento se refere

Return

{Objeto DOM}objeto do tipo checkbox

pegaTema

pegaTema : function(valor,
camadas,
parametro)

Procura um tema no objeto CAMADAS.

Parametro

{String} valor do parametro

{Objeto}objeto com a lista de temas (escape com “” para usar o default)
{string}parametro que sera procurado

Return

{objeto}

alteraPropCamadas

alteraPropCamadas : function(propriedade,
valor,
camada)

Altera o valor de uma propriedade de um tema do objeto i3GEO.arvoreDeCamadas.CAMADAS

Parameters

{string}propriedade que será modificada
{string}novo valor
{string}código da camada

i3GEO.arvoreDeCamadas.dialogo

Abre as telas de diálogo das opções de manipulação da árvore

Summary
Functions
filtroAbre a janela de diálogo para o usuário escolher ou alterar o filtro aplicado a árvore
excluirAbre a janela de diálogo para o usuário escolher os temas que serão excluídos da árvore

Functions

filtro

filtro : function()

Abre a janela de diálogo para o usuário escolher ou alterar o filtro aplicado a árvore

excluir

excluir : function()

Abre a janela de diálogo para o usuário escolher os temas que serão excluídos da árvore

cria : function(onde,
temas,
g_sid,
g_locaplic,
funcaoTema)
Cria a árvore com as opções de manipulação das camadas existentes no mapa
inicia : function(id)
Essa função cria e inicializa a árvore de camadas utilizando o objeto default que contém os parâmetros de cada camada.
atualiza : function(temas,
forca)
Atualiza a árvore de camadas.
ligaDesligaTemas : function(lista,
status)
Marca ou desmarca os checkbox da árvore de uma lista de temas
atualizaLegenda : function(idtema)
Atualiza a legenda de um tema.
aplicaTemas : function(tipo)
Refaz o mapa ligando e desligando os temas conforme consta na árvore de camadas ou ligando/desligando todos
listaLigadosDesligados : function(tipo)
Lista os temas que estão ligados e os que estão desligados tendo como fonte de busca os checkbox existentes na árvore.
capturaCheckBox : function(tema)
Retorna o objeto input (check box) que corresponde a uma determinada camada na árvore.
pegaTema : function(valor,
camadas,
parametro)
Procura um tema no objeto CAMADAS.
alteraPropCamadas : function(propriedade,
valor,
camada)
Altera o valor de uma propriedade de um tema do objeto i3GEO.arvoreDeCamadas.CAMADAS
filtro : function()
Abre a janela de diálogo para o usuário escolher ou alterar o filtro aplicado a árvore
excluir : function()
Abre a janela de diálogo para o usuário escolher os temas que serão excluídos da árvore