classe_i3geo-js.html
21.6 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
<html><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>i3Geo</title><link rel="stylesheet" type="text/css" href="../../styles/main.css"><script language=JavaScript src="../../javascript/main.js"></script><script language=JavaScript src="../../javascript/prettify.js"></script></head><body class="FramedContentPage" onLoad="NDOnLoad();prettyPrint();"><script language=JavaScript><!--
if (browserType) {document.write("<div class=" + browserType + ">");if (browserVer) {document.write("<div class=" + browserVer + ">"); }}// --></script>
<!-- Generated by Natural Docs, version 1.51 -->
<!-- http://www.naturaldocs.org -->
<!-- saved from url=(0026)http://www.naturaldocs.org -->
<div id=Content><div class="CSection"><div class=CTopic id=MainTopic><h1 class=CTitle><a name="i3Geo"></a>i3Geo</h1><div class=CBody><p>A classe i3GEO possuí os métodos de criação e atualização do mapa. Todas as subclasses são baseadas em i3GEO, por exemplo, para criar uma janela flutuante sobre o mapa, utilize i3GEO.janela.cria()</p><p>Para inicializar o mapa, utilize i3GEO.inicia() e para atualizar o mapa, utilize i3GEO.atualiza(). Após terminado o processo de inicialização, pode-se executar uma função de ajuste. Essa função deve ser definida em i3GEO.finaliza, por exemplo i3GEO.finaliza = “funcaoDeAjuste()” ou i3GEO.finaliza = function(){}</p><p>Ao inicializar ou atualizar o i3Geo, é feita uma chamada em AJAX para a obtenção dos parametros necessários ao funcionamento do mapa. Esses parametros são armazenados na variável i3GEO.parametros</p><p>Nessa classe estão disponíveis variáveis internas utilizadas em várias funções, como i3GEO.temaAtivo</p><h4 class=CHeading>Namespace</h4><p>i3GEO</p><h4 class=CHeading>Veja</h4><p><a href="http://localhost/i3geo/classesjs/classe_i3geo.js" class=LURL target=_top>http://localhost/i3geo/classesjs/classe_i3geo.js</a></p><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SMain"><td class=SEntry><a href="#i3Geo" >i3Geo</a></td><td class=SDescription>A classe i3GEO possuí os métodos de criação e atualização do mapa. </td></tr><tr class="SSection"><td class=SEntry><a href="#i3GEOF" >i3GEOF</a></td><td class=SDescription>Esse objeto recebe os métodos sob demanda por meio de injeção de javascripts (script tag). </td></tr><tr class="SSection"><td class=SEntry><a href="#YAHOO.i3GEO" >YAHOO.<wbr>i3GEO</a></td><td class=SDescription>Namespace da biblioteca YUI que é reutilizável em vários trechos de código do i3Geo</td></tr><tr class="SSection"><td class=SEntry><a href="#i3GEO" >i3GEO</a></td><td class=SDescription></td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Constants" >Constants</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent2 SMarked"><td class=SEntry><a href="#tamanhodoc" >tamanhodoc</a></td><td class=SDescription>Largura e altura do navegador após a inicialização do mapa</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Propriedades" >Propriedades</a></td><td class=SDescription></td></tr><tr class="SPropriedade SIndent2 SMarked"><td class=SEntry><a href="#parametros" >parametros</a></td><td class=SDescription>Parametros obtidos do mapa atual. </td></tr><tr class="SPropriedade SIndent2"><td class=SEntry><a href="#scrollerWidth" >scrollerWidth</a></td><td class=SDescription>Largura da barra de rolagem do navegador. </td></tr><tr class="SPropriedade SIndent2 SMarked"><td class=SEntry><a href="#finaliza" >finaliza</a></td><td class=SDescription>Função que será executada após a criação e posicionamento do mapa. </td></tr><tr class="SPropriedade SIndent2"><td class=SEntry><a href="#finalizaAPI" >finalizaAPI</a></td><td class=SDescription>Função que será executada após a API utilizada (Openlayers ou Googlemaps) ter sido inicializada e o objeto com</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Variaveis" >Variaveis</a></td><td class=SDescription></td></tr><tr class="SVariavel SIndent2 SMarked"><td class=SEntry><a href="#temaAtivo" >temaAtivo</a></td><td class=SDescription>Indica o último tema que foi ativado no mapa</td></tr><tr class="SGroup SIndent1"><td class=SEntry><a href="#Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#cria" id=link1 onMouseOver="ShowTip(event, 'tt1', 'link1')" onMouseOut="HideTip('tt1')">cria</a></td><td class=SDescription>Cria e configura a visualização do mapa, definindo posicionamentos, tamanho etc</td></tr><tr class="SFunction SIndent2"><td class=SEntry><a href="#inicia" id=link2 onMouseOver="ShowTip(event, 'tt2', 'link2')" onMouseOut="HideTip('tt2')">inicia</a></td><td class=SDescription>Inicializa o mapa</td></tr><tr class="SFunction SIndent2 SMarked"><td class=SEntry><a href="#atualiza" id=link3 onMouseOver="ShowTip(event, 'tt3', 'link3')" onMouseOut="HideTip('tt3')">atualiza</a></td><td class=SDescription>Atualiza o mapa atual, altera a imagem do mapa os gadgets ativos e os parametros e verifica a integridade do mapa em uso (arquivo mapfile)</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="i3GEOF"></a>i3GEOF</h2><div class=CBody><p>Esse objeto recebe os métodos sob demanda por meio de injeção de javascripts (script tag). É utilizado pelas ferramentas existentes em i3geo/ferramentas.</p><p>Cada javascript inserido na página adiciona novos objetos, como por exemplo i3GEOF.buffer.</p></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="YAHOO.i3GEO"></a>YAHOO.<wbr>i3GEO</h2><div class=CBody><p>Namespace da biblioteca YUI que é reutilizável em vários trechos de código do i3Geo</p><h4 class=CHeading>Type</h4><p>{YAHOO.namespace}</p></div></div></div>
<div class="CSection"><div class=CTopic><h2 class=CTitle><a name="i3GEO"></a>i3GEO</h2><div class=CBody><!--START_ND_SUMMARY--><div class=Summary><div class=STitle>Summary</div><div class=SBorder><table border=0 cellspacing=0 cellpadding=0 class=STable><tr class="SGroup"><td class=SEntry><a href="#Constants" >Constants</a></td><td class=SDescription></td></tr><tr class="SConstant SIndent1 SMarked"><td class=SEntry><a href="#tamanhodoc" >tamanhodoc</a></td><td class=SDescription>Largura e altura do navegador após a inicialização do mapa</td></tr><tr class="SGroup"><td class=SEntry><a href="#Propriedades" >Propriedades</a></td><td class=SDescription></td></tr><tr class="SPropriedade SIndent1 SMarked"><td class=SEntry><a href="#parametros" >parametros</a></td><td class=SDescription>Parametros obtidos do mapa atual. </td></tr><tr class="SPropriedade SIndent1"><td class=SEntry><a href="#scrollerWidth" >scrollerWidth</a></td><td class=SDescription>Largura da barra de rolagem do navegador. </td></tr><tr class="SPropriedade SIndent1 SMarked"><td class=SEntry><a href="#finaliza" >finaliza</a></td><td class=SDescription>Função que será executada após a criação e posicionamento do mapa. </td></tr><tr class="SPropriedade SIndent1"><td class=SEntry><a href="#finalizaAPI" >finalizaAPI</a></td><td class=SDescription>Função que será executada após a API utilizada (Openlayers ou Googlemaps) ter sido inicializada e o objeto com</td></tr><tr class="SGroup"><td class=SEntry><a href="#Variaveis" >Variaveis</a></td><td class=SDescription></td></tr><tr class="SVariavel SIndent1 SMarked"><td class=SEntry><a href="#temaAtivo" >temaAtivo</a></td><td class=SDescription>Indica o último tema que foi ativado no mapa</td></tr><tr class="SGroup"><td class=SEntry><a href="#Functions" >Functions</a></td><td class=SDescription></td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#cria" id=link4 onMouseOver="ShowTip(event, 'tt1', 'link4')" onMouseOut="HideTip('tt1')">cria</a></td><td class=SDescription>Cria e configura a visualização do mapa, definindo posicionamentos, tamanho etc</td></tr><tr class="SFunction SIndent1"><td class=SEntry><a href="#inicia" id=link5 onMouseOver="ShowTip(event, 'tt2', 'link5')" onMouseOut="HideTip('tt2')">inicia</a></td><td class=SDescription>Inicializa o mapa</td></tr><tr class="SFunction SIndent1 SMarked"><td class=SEntry><a href="#atualiza" id=link6 onMouseOver="ShowTip(event, 'tt3', 'link6')" onMouseOut="HideTip('tt3')">atualiza</a></td><td class=SDescription>Atualiza o mapa atual, altera a imagem do mapa os gadgets ativos e os parametros e verifica a integridade do mapa em uso (arquivo mapfile)</td></tr></table></div></div><!--END_ND_SUMMARY--></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Constants"></a>Constants</h3></div></div>
<div class="CConstant"><div class=CTopic><h3 class=CTitle><a name="tamanhodoc"></a>tamanhodoc</h3><div class=CBody><p>Largura e altura do navegador após a inicialização do mapa</p><p>É utilizado como um parametro para verificar se o mapa foi ou não redimensionado pelo usuário de forma consistente</p><h4 class=CHeading>Type</h4><p>{array}</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Propriedades"></a>Propriedades</h3></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="parametros"></a>parametros</h3><div class=CBody><p>Parametros obtidos do mapa atual. Os parametros são fornecidos pelos programas PHP de redesenho e criação do mapa e atualizados sempre que o mapa é alterado.</p><p>Algumas dessas variáveis são definidas em ms_configura.php</p><h4 class=CHeading>Exemplos</h4><blockquote><pre class="prettyprint">alert(i3GEO.parametros.mapexten);
i3GEO.parametros.mapscale = 25000;</pre></blockquote><h4 class=CHeading>Parametros</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>mapexten {String}</td><td class=CDLDescription>extensão geográfica do mapa no formato xmin ymin xmax ymax</td></tr><tr><td class=CDLEntry>mapscale {Numeric}</td><td class=CDLDescription>denominador da escala do mapa</td></tr><tr><td class=CDLEntry>mapres {Numeric}</td><td class=CDLDescription>resolução da imagem do mapa em DPI</td></tr><tr><td class=CDLEntry>pixelsize {Numeric}</td><td class=CDLDescription>tamanho em unidades de terreno dos pixels da imagem</td></tr><tr><td class=CDLEntry>mapfile {String}</td><td class=CDLDescription>nome do mapfile atualmente em uso</td></tr><tr><td class=CDLEntry>cgi {String}</td><td class=CDLDescription>endereço do executável do mapserver no servidor acessível pela URL</td></tr><tr><td class=CDLEntry>extentTotal {String}</td><td class=CDLDescription>extensão do mapa na inicialização</td></tr><tr><td class=CDLEntry>mapimagem {String}</td><td class=CDLDescription>URL da imagem que compõe o mapa</td></tr><tr><td class=CDLEntry>geoip {sim|nao}</td><td class=CDLDescription>indica se o geoip está instalado</td></tr><tr><td class=CDLEntry>listavisual {String}</td><td class=CDLDescription>(depreciado) lista de visuais disponíveis</td></tr><tr><td class=CDLEntry>utilizacgi {sim|nao}</td><td class=CDLDescription>indica se o mapa atual está no modo CGI</td></tr><tr><td class=CDLEntry>versaoms {String}</td><td class=CDLDescription>versão do Mapserver instalado no servidor (maior)</td></tr><tr><td class=CDLEntry>versaomscompleta {String}</td><td class=CDLDescription>versão do Mapserver instalado no servidor (completa)</td></tr><tr><td class=CDLEntry>mensagens {String}</td><td class=CDLDescription>mensagens para uso no letreiro</td></tr><tr><td class=CDLEntry>w {Integer}</td><td class=CDLDescription>largura do mapa atual</td></tr><tr><td class=CDLEntry>h {Integer}</td><td class=CDLDescription>altura do mapa atual</td></tr><tr><td class=CDLEntry>locsistemas {String}</td><td class=CDLDescription>endereço do xml com a lista de sistemas adicionais</td></tr><tr><td class=CDLEntry>locidentifica {String}</td><td class=CDLDescription>endereço do xml com a lista de sistemas de identificação</td></tr><tr><td class=CDLEntry>r {sim|nao}</td><td class=CDLDescription>indica se o software R está instalado no servidor</td></tr><tr><td class=CDLEntry>locmapas {String}</td><td class=CDLDescription>endereço do xml com a lista de mapas</td></tr><tr><td class=CDLEntry>extentref {String}</td><td class=CDLDescription>extensão geográfica do mapa de referência</td></tr><tr><td class=CDLEntry>celularef {Numeric}</td><td class=CDLDescription>tamanho do pixel do mapa de referência em unidades do terreno</td></tr><tr><td class=CDLEntry>kmlurl {String}</td><td class=CDLDescription>url de um arquivo kml que será inserido no mapa. Válido apenas na interface Google Maps</td></tr><tr><td class=CDLEntry>mensagemInicia {String}</td><td class=CDLDescription>mensagem definida em ms_configura.php indicando a versão atual do i3Geo.</td></tr><tr><td class=CDLEntry>interfacePadrao {String}</td><td class=CDLDescription>interface padrão definida em ms_configura</td></tr><tr><td class=CDLEntry>embedLegenda {String}</td><td class=CDLDescription>sim|nao indica se na inicialização a legenda foi inserida no conteúdo do mapa ou não</td></tr><tr><td class=CDLEntry>celularef {Numeric}</td><td class=CDLDescription>tamanho da célula do mapa de referência</td></tr><tr><td class=CDLEntry>autenticadoopenid {sim|nao}</td><td class=CDLDescription>indica se o usuário foi autenticado em alguma rede social</td></tr><tr><td class=CDLEntry>editor {sim|nao}</td><td class=CDLDescription>indica se o usuário atual é um editor (administrador)</td></tr></table><p>cordefundo {r,g,b}</p><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>copyright {String}</td><td class=CDLDescription>texto existente no Layer copyright do mapfile de inicialização</td></tr><tr><td class=CDLEntry>statusFerramentas {array}</td><td class=CDLDescription>indicador de status de algumas ferramentas que dependem de configurações no servidor</td></tr></table></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="scrollerWidth"></a>scrollerWidth</h3><div class=CBody><p>Largura da barra de rolagem do navegador. Se for igual a “”, a largura será calculada automaticamente.</p><p>O valor “scrollerWidth” será utilizado no calculo da largura do mapa. Se vc não quer diminuir o tamanho do mapa, subtraindo a largura da barra de rolagem, defina scrollerWidth = 0</p><h4 class=CHeading>Tipo</h4><p>{numérico}</p></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="finaliza"></a>finaliza</h3><div class=CBody><p>Função que será executada após a criação e posicionamento do mapa. Pode ser uma string também, que será avaliada com “eval”.</p><h4 class=CHeading>Exemplo</h4><blockquote><pre class="prettyprint">i3GEO.finaliza = function() {
if ($i("i3GEOlogoMarca")) {
$i("i3GEOlogoMarca").style.display = "none";
}
i3GEO.mapa.insereDobraPagina("googlemaps","../imagens/dobragooglemaps.png");
};</pre></blockquote><h4 class=CHeading>Tipo</h4><p>{function}</p></div></div></div>
<div class="CPropriedade"><div class=CTopic><h3 class=CTitle><a name="finalizaAPI"></a>finalizaAPI</h3><div class=CBody><p>Função que será executada após a API utilizada (Openlayers ou Googlemaps) ter sido inicializada e o objeto com</p><ul><li>mapa ter sido criado. Pode ser uma string também, que será avaliada com “eval”.</li></ul><h4 class=CHeading>Tipo</h4><p>{function}</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Variaveis"></a>Variaveis</h3></div></div>
<div class="CVariavel"><div class=CTopic><h3 class=CTitle><a name="temaAtivo"></a>temaAtivo</h3><div class=CBody><p>Indica o último tema que foi ativado no mapa</p><p>Permite que ao se passar de uma ferramenta para outra, os menus reflitam a última escolha.</p><h4 class=CHeading>Tipo</h4><p>{string}</p></div></div></div>
<div class="CGroup"><div class=CTopic><h3 class=CTitle><a name="Functions"></a>Functions</h3></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="cria"></a>cria</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">cria : function()</td></tr></table></blockquote><p>Cria e configura a visualização do mapa, definindo posicionamentos, tamanho etc</p><p>Após as definições básicas, é executado o programa <i3GEO.Interface.cria> que irá realizar as operações conforme a interface atualmente em uso. A interface é definida em <i3GEO.Interface.ATUAL></p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="inicia"></a>inicia</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>inicia : function(</td><td class="PParameter prettyprint " nowrap>retorno</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Inicializa o mapa</p><p>Verifica se o mapa apresenta algum problema no processamento no lado do servidor e realiza as operações de tentativa de recuperação, se for o caso</p><p>No início do processo é executada a função <i3GEOmantemCompatibilidade> para realizar as operações necessárias de manutenção de compatibilidade da versão atual para as anteriores</p><p>A inicialização é baseada em <i3GEO.php.inicia> cujo retorno é utilizado para definir a variável <i3GEO.parametros></p><p>Após a inicialização é executado <i3GEO.Interface.inicia></p></div></div></div>
<div class="CFunction"><div class=CTopic><h3 class=CTitle><a name="atualiza"></a>atualiza</h3><div class=CBody><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>atualiza : function(</td><td class="PParameter prettyprint " nowrap>retorno</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote><p>Atualiza o mapa atual, altera a imagem do mapa os gadgets ativos e os parametros e verifica a integridade do mapa em uso (arquivo mapfile)</p><p>O processo executa também a função de atualização específica da interface atual em uso, veja <i3GEO.Interface.redesenha></p><p>Os seguintes gadgets são processados</p><p><i3GEO.arvoreDeCamadas.atualiza></p><p><i3GEO.arvoreDeCamadas.atualizaFarol></p><p>Os eventos definidos em <i3GEO.eventos.navegaMapa> são executados</p><h4 class=CHeading>Parametro</h4><table border=0 cellspacing=0 cellpadding=0 class=CDescriptionList><tr><td class=CDLEntry>{Objeto}</td><td class=CDLDescription>parametros do novo mapa. Se retorno não for especificado ou se for vazio, será feita uma chamada em ajax para sua obtenção. O resultado dessa chamada é armazenada em i3GEO.parametros</td></tr></table></div></div></div>
</div><!--Content-->
<!--START_ND_TOOLTIPS-->
<div class=CToolTip id="tt1"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td class="prettyprint">cria : function()</td></tr></table></blockquote>Cria e configura a visualização do mapa, definindo posicionamentos, tamanho etc</div></div><div class=CToolTip id="tt2"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>inicia : function(</td><td class="PParameter prettyprint " nowrap>retorno</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Inicializa o mapa</div></div><div class=CToolTip id="tt3"><div class=CFunction><blockquote><table border=0 cellspacing=0 cellpadding=0 class="Prototype"><tr><td><table border=0 cellspacing=0 cellpadding=0><tr><td class="PBeforeParameters prettyprint "nowrap>atualiza : function(</td><td class="PParameter prettyprint " nowrap>retorno</td><td class="PAfterParameters prettyprint "nowrap>)</td></tr></table></td></tr></table></blockquote>Atualiza o mapa atual, altera a imagem do mapa os gadgets ativos e os parametros e verifica a integridade do mapa em uso (arquivo mapfile)</div></div><!--END_ND_TOOLTIPS-->
<script language=JavaScript><!--
if (browserType) {if (browserVer) {document.write("</div>"); }document.write("</div>");}// --></script></body></html>