Métodos e funções

geoMapBR


new geoMapBR(elemento)

Representa a classe GeoMapBR. Deve ser instanciada para permitir acesso às funções. Contém as funcionalidades para criação de mapas coropléticos brasileiros e opções de configuração.
Parameters:
Name Type Description
elemento string id do componente HTML da página Web onde será criado o mapa. OBS: este componente deve ser um elemento div e deve estar configurado com sua altura e largura em pixels.
Returns:
Objeto de classe com propriedades de criação de mapa.
Exemplo
gmb = new GeoMapBR(id_div);

Métodos


gerarMapa()

Método para gerar e aplicar configurações setadas ao mapa. Verifica variáveis de configuração de série temporal e realiza operações, se necessário, antes de executar outros métodos privados.

getAtivaClassificacaoPorFiltro()

Retorna true se está definido que o intervalo de classificação de dados acompanhará o filtro aplicado e não a massa de dados.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getAtributos()

Retorna os campos da base de dados inserida pelo usuário. Caso a base de dados não tenha sido carregada, retornará um Array vazio. Aconselha-se chamar esta função como callback de setDados();
See:
Returns:
Array contendo nome dos campos.
Type
Array.<string>

getCampoCodMunicipio()

Retorna o campo da base de dados inserida pelo usuário definida como códgio do município do registro.
Returns:
String contendo nome do campo.
Type
string

getCampoDescritor()

Retorna o campo da base de dados inserida pelo usuário definida como descrição do registro.
Returns:
String contendo nome do campo.
Type
string

getCampoID()

Retorna o campo da base de dados inserida pelo usuário definida como id do registro.
Returns:
String contendo nome do campo.
Type
string

getCampoValor()

Retorna o campo da base de dados inserida pelo usuário definida como valor do registro.
Returns:
String contendo nome do campo.
Type
string

getCasasDecimais()

Retorna a quantidade de casas decimais definida para classificação dos dados.
Returns:
Integer com a quantidade de casas decimais.
Type
integer

getCorAzul()

Retorna true se o esquema de cores setado para classificação de dados for azul.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getCorEspectral()

Retorna true se o esquema de cores setado para classificação de dados for espectral.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getCorLaranja()

Retorna true se o esquema de cores setado para classificação de dados for laranja.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getCorRoxa()

Retorna true se o esquema de cores setado para classificação de dados for roxo.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getCorVerde()

Retorna true se o esquema de cores setado para classificação de dados for verde.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getCorVermelha()

Retorna true se o esquema de cores setado para classificação de dados for vermelho.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getDados()

Retorna base de dados inserida pelo usuário.
Returns:
Array de dados.
Type
Array.<Object>

getDesenhaBordaEstado()

Retorna true se está setado desenho das bordas de estado.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getDesenhaBordaMesorregiao()

Retorna true se está setado desenho das bordas de mesorregião.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getDesenhaBordaMicrorregiao()

Retorna true se está setado desenho das bordas de microrregião.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getDesenhaBordaMunicipio()

Retorna true se está setado desenho das bordas de municípios.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getDesenhaBordaRegiao()

Retorna true se está setado desenho das bordas de região.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getFiltroEstado()

Retorna o código do estado com filtro, ou false caso não haja filtro de estado.
Returns:
Caso haja filtro de estado aplicado, retorna o código (integer) do estado, senão, false.
Type
integer | boolean

getFiltroMesorregiao()

Retorna o código da mesorregião com filtro, ou false caso não haja filtro de mesorregião.
Returns:
Caso haja filtro de mesorregião aplicado, retorna o código (integer) da mesorregião, senão, false.
Type
integer | boolean

getFiltroMicrorregiao()

Retorna o código da microrregião com filtro, ou false caso não haja filtro de microrregião.
Returns:
Caso haja filtro de microrregião aplicado, retorna o código (integer) da microrregião, senão, false.
Type
integer | boolean

getFiltroRegiao()

Retorna o código da região com filtro, ou false caso não haja filtro de região.
Returns:
Caso haja filtro de região aplicado, retorna o código (integer) da região, senão, false.
Type
integer | boolean

getListaEstados( [cod])

Retorna Array com código e nome dos estados. Permite inserir código de região para filtro.
Parameters:
Name Type Argument Description
cod integer <optional>
código da região.
Returns:
Array de Objetos, contendo código (Integer) e nome do estado (String). Se informado cod e não for encontrado dados, retorna null.
Type
Array.<{integer, string}>

getListaMesorregioes( [cod])

Retorna Array com código e nome das mesorregiões. Permite inserir código de região ou estado para filtro.
Parameters:
Name Type Argument Description
cod integer <optional>
código da região ou estado.
Returns:
Array de Objetos, contendo código (Integer) e nome da mesorregião (String). Se informado cod e não for encontrado dados, retorna null.
Type
Array.<{integer, string}>

getListaMicrorregioes( [cod])

Retorna Array com código e nome das microrregiões. Permite inserir código de região, estado ou mesorregião para filtro.
Parameters:
Name Type Argument Description
cod integer <optional>
código da região, estado ou mesorregião.
Returns:
Array de Objetos, contendo código (Integer) e nome da microrregião (String). Se informado cod e não for encontrado dados, retorna null.
Type
Array.<{integer, string}>

getListaMunicipios( [cod])

Retorna Array com código e nome dos municípios. Permite inserir código de região, estado, mesorregião ou microrregião para filtro.
Parameters:
Name Type Argument Description
cod integer <optional>
código da região, estado, mesorregião ou microrregião.
Returns:
Array de Objetos, contendo código (Integer) e nome do município (String). Se informado cod e não for encontrado dados, retorna null.
Type
Array.<{integer, string}>

getListaRegioes()

Retorna Array com código e nome das regiões.
Returns:
Array de Objetos, contendo código (Integer) e nome da região (String).
Type
Array.<{integer, string}>

getMetodoDesvioPadrao()

Retorna true se o método setado é do tipo desvio padrão.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getMetodoIntervalosIguais()

Retorna true se o método setado é do tipo intervalos iguais.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getMetodoIntervalosManuais()

Retorna cadeia de carateres com intervalo se o método setado é do tipo intervalos manuais.
Returns:
String com intervalo caso verdadeiro, senão, false.
Type
string | boolean

getMetodoQuantil()

Retorna true se o método setado é do tipo quantis.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getMetodoQuebrasNaturais()

Retorna true se o método setado é do tipo quebras naturais (jenks).
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getOperacaoContagem()

Retorna true se a operação setada é do tipo contagem.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getOperacaoMedia()

Retorna true se a operação setada é do tipo média.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getOperacaoSoma()

Retorna true se a operação setada é do tipo soma.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getQtdClasses()

Retorna a quantidade de classes definida para classificação dos dados.
Returns:
Integer com a quantidade de classes.
Type
integer

getSemFiltro()

Retorna true se nenhum filtro está aplicado.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getSerieTemporalAtivar()

Retorna true se está ativa a série temporal.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getSerieTemporalLoop()

Retorna true se está ativo o loop para série temporal.
Returns:
Boolean true caso verdadeiro, senão, false.
Type
boolean

getSerieTemporalTempo()

Retorna tempo em segundos setado para série temporal.
Returns:
Integer contendo tempo em segundos
Type
integer

getTituloMapa()

Retorna título do mapa
Returns:
String com título.
Type
string

setAtivaClassificacaoPorFiltro(b)

Setar se intervalo de classificação acompanhará a massa de dados ou apenas os dados referentes ao filtro aplicado.
Parameters:
Name Type Description
b boolean true para limitar dados ao filtro aplicado, senão, false.

setCampoCodMunicipio(s)

Setar campo da base de dados do usuário referente ao código do municipio do registro.
Parameters:
Name Type Description
s string texto com nome do campo.

setCampoDescritor(s)

Setar campo da base de dados do usuário referente a descrição do registro.
Parameters:
Name Type Description
s string texto com nome do campo.

setCampoID(s)

Setar campo da base de dados do usuário referente ao id do registro.
Parameters:
Name Type Description
s string texto com nome do campo.

setCampoValor(s)

Setar campo da base de dados do usuário referente ao valor do registro.
Parameters:
Name Type Description
s string texto com nome do campo.

setCasasDecimais(n)

Setar número de casas decimais para classificação dos dados.
Parameters:
Name Type Description
n integer número de casas decimais.

setCorAzul()

Setar esquema de cores de classificação dos dados como azul.

setCorEspectral()

Setar esquema de cores de classificação dos dados como espectral.

setCorLaranja()

Setar esquema de cores de classificação dos dados como laranja.

setCorRoxa()

Setar esquema de cores de classificação dos dados como roxo.

setCorVerde()

Setar esquema de cores de classificação dos dados como verde.

setCorVermelha()

Setar esquema de cores de classificação dos dados como vermelho.

<async> setDados(arquivo, callback)

Setar base de dados inserida pelo usuário. Permite leitura de arquivo .csv separados por ponto e vírgula (;), vírgula (,), barra vertical (|) ou tabulação (\t).
Parameters:
Name Type Description
arquivo file arquivo oriundo de um input.file.
callback method função de retorno após concluída a leitura do arquivo.
Exemplo
gmb.setDados(document.getElementById("input").files, function () {

});

setDesenhaBordaEstado(b)

Setar se será desenhada bordas de estados
Parameters:
Name Type Description
b boolean true para desenhar bordas, senão, false.

setDesenhaBordaMesorregiao(b)

Setar se será desenhada bordas de mesorregiões
Parameters:
Name Type Description
b boolean true para desenhar bordas, senão, false.

setDesenhaBordaMicrorregiao(b)

Setar se será desenhada bordas de microrregiões
Parameters:
Name Type Description
b boolean true para desenhar bordas, senão, false.

setDesenhaBordaMunicipio(b)

Setar se será desenhada bordas de municípios
Parameters:
Name Type Description
b boolean true para desenhar bordas, senão, false.

setDesenhaBordaRegiao(b)

Setar se será desenhada bordas de regiões
Parameters:
Name Type Description
b boolean true para desenhar bordas, senão, false.

setFiltroEstado(cod)

Setar filtro de estado.
Parameters:
Name Type Description
cod integer código do estado.

setFiltroMesorregiao(cod)

Setar filtro de mesorregião.
Parameters:
Name Type Description
cod integer código da mesorregião.

setFiltroMicrorregiao(cod)

Setar filtro de microrregião.
Parameters:
Name Type Description
cod integer código da microrregião.

setFiltroRegiao(cod)

Setar filtro de região.
Parameters:
Name Type Description
cod integer código da região.

setInverterCores(b)

Setar se esquema de cores de classificação será do mais claro ao mais escuro ou do mais escuro ao mais claro (invertido).
Parameters:
Name Type Description
b boolean true para inverter cores (do mais escuro para o mais claro), senão, false.

setMetodoDesvioPadrao()

Setar método de classificação dos dados como desvio padrão.

setMetodoIntervalosIguais()

Setar método de classificação dos dados como intervalos iguais.

setMetodoIntervalosManuais(s)

Setar método de classificação dos dados como intervalos manuais.
Parameters:
Name Type Description
s string valores separados por ponto e vírgula (;). OBS: necessário inserir pelo menos 4 (quatro) valores.
Exemplo
let intervalo = "1;2;3;4";
gmb.setMetodoIntervalosManuais(intervalo);

setMetodoQuantil()

Setar método de classificação dos dados como quantis.

setMetodoQuebrasNaturais()

Setar método de classificação dos dados como quebras naturais (jenks).

setOperacaoContagem()

Setar operação de dados como contagem.

setOperacaoMedia()

Setar operação de dados como média.

setOperacaoSoma()

Setar operação de dados como soma.

setQtdClasses(n)

Setar quantidade de classes para classificação dos dados.
Parameters:
Name Type Description
n integer número de classes.

setSemFiltro()

Remover quaisquer filtros sobre o mapa.

setSerieTemporalAtivar(b)

Ativar série temporal de dados.
Parameters:
Name Type Description
b boolean true para ativar séritemporal, senão, false.

setSerieTemporalLoop(n)

Ativar loop em série temporal.
Parameters:
Name Type Description
n boolean true para ativar loop, senão, false.

setSerieTemporalTempo(n)

Setar tempo de transição entre os campos da série temporal.
Parameters:
Name Type Description
n integer tempo em segundos.

setTituloMapa(s)

Inserir título ao mapa.
Parameters:
Name Type Description
s string texto com título.