# ``prisma`.`qgis`.`layout_manager`.`LayoutManager``

class documentation

`class LayoutManager:`

View In Hierarchy

Classe responsável por fazer a manipulação do Layout de impressão. Contém métodos para fazer o controle das feições carregadas para impressão, manipular textos e também algumas operações com dados que serão plotados ou utilizados para gerar relatórios PDF.

Method | `__init__` | Método construtor da classe.
Method | `add​_template​_to​_project` | Adiciona o template do layout ao projeto atual. @keyword template_dir: Variável armazena o local do layout.
Method | `calculation​_db` | Função compara a feição de input passada como parâmetro com bases de dados oriundas de bancos de dados. Para cada área de comparação comparada com a feição de input, chama a função handle_layers, responsável por gerar as camadas no QGIS.
Method | `calculation​_required` | Undocumented
Method | `calculation​_shp` | Função compara a feição de input passada como parâmetro com bases de dados shapefiles selecionados. Para cada área de comparação comparada com a feição de input, chama a função handle_layers, responsável por gerar as camadas no QGIS.
Method | `explode​_input` | Undocumented
Method | `export​_pdf` | Função responsável carregar o layout de impressão e por gerar os arquivos PDF.
Method | `fill​_observation` | Undocumented
Method | `get​_feature​_symbol` | Estilização dinâmica para diferentes tipos de geometrias (Áreas de comparação).
Method | `get​_input​_standard​_symbol` | Estilização dinâmica para diferentes tipos de geometrias (Área de input sem o buffer de aproximação).
Method | `get​_input​_symbol` | Estilização dinâmica para diferentes tipos de geometrias (Área de input).
Method | `get​_required​_layers` | Extrai as camadas obrigatórias das bases de dados shp e db e do dicionário de configuração.
Method | `handle​_layers` | Carrega camadas já processadas no QGis para que posteriormente possam ser gerados os relatórios no formato PDF. Após gerar todas camadas necessárias, está função aciona outra função (export_pdf), que é responsável por gerar o layout PDF a partir das feições carregadas nesta função.
Method | `handle​_text` | Faz a manipulação de alguns dados textuais presentes no layout de impressão.
Method | `load​_required​_layers` | Undocumented
Method | `pdf​_generator` | Função onde se inicia a geração de PDF. A função chama funções de calculo de sobreposição de forma individual para cada feição de input. Ainda nesta função é extraida a zona UTM das feições de input e controle da barra de progresso.
Method | `remove​_layers` | Undocumented
Instance Variable | `atlas` | Variável que armazena o atlas do layout para geração de plantas PDF.
Instance Variable | `epsg​_shp​_dir` | Diretório do shapefile para gerar dinamicamente os EPSG's (Comtém as Zonas UTM).
Instance Variable | `index​_input` | Undocumented
Instance Variable | `layers` | Utilizada para salvar a camada de input, já processada e projetada no QGIS.
Instance Variable | `layout` | Variável que armazena o layout para geração de plantas PDF.
Instance Variable | `operation​_config` | Dicionário que armazena configurações de operação, como por exemplo: dado de input, bases de dados selecionadas para comparação, busca por ponto, shapefile, etc...
Instance Variable | `overlay​_analysis` | Variável utilizada para importar a classe presente em prisma/analysis/overlay_analysis.py.
Instance Variable | `progress​_bar` | Variável de controle da barra de progresso do processamento para geração de plantas PDF.
Instance Variable | `required​_layers​_loaded` | Undocumented
Instance Variable | `root` | Undocumented
Instance Variable | `utils` | Variável conténdo classe presentem em prisma/utils/utils.py

def __init__(self, operation_config, progress_bar):
Método construtor da classe.

Parameters
operation​_config | Dicionário que armazena configurações de operação, como por exemplo: dado de input, bases de dados selecionadas para comparação, busca por ponto, shapefile, etc...
progress​_bar | Variável de controle da barra de progresso do processamento para geração de relatórios PDF.

def add_template_to_project(self, template_dir):
Adiciona o template do layout ao projeto atual.

Parameters
template​_dir | Variável armazena o local do layout.

def calculation_db(self, input, gdf_line_input, gdf_point_input, input_standard, gdf_selected_db, gdf_required):
Função compara a feição de input passada como parâmetro com bases de dados oriundas de bancos de dados. Para cada área de comparação comparada com a feição de input, chama a função handle_layers, responsável por gerar as camadas no QGIS.

Parameters
input | Feição ou shapefile de input, caso possua zona de proximidade inserida pelo usuário, a mesma será armazenado nesta variável.
gdf​_line​_input | Undocumented
gdf​_point​_input | Undocumented
input​_standard | Feição ou shapefile de input padrão isto é, sem zona de proximidade (caso necessário).
gdf​_selected​_db | Bases de dados de banco(s) de dado selecionados para comparação com a área de input.
gdf​_required | Undocumented

def calculation_required(self, input, gdf_required):

Undocumented

def calculation_shp(self, input, gdf_line_input, gdf_point_input, input_standard, gdf_selected_shp, gdf_required):
Função compara a feição de input passada como parâmetro com bases de dados shapefiles selecionados. Para cada área de comparação comparada com a feição de input, chama a função handle_layers, responsável por gerar as camadas no QGIS.

Parameters
input | Feição ou shapefile de input, caso possua zona de proximidade inserida pelo usuário, a mesma será armazenado nesta variável.
gdf​_line​_input | Undocumented
gdf​_point​_input | Undocumented
input​_standard | Feição ou shapefile de input padrão isto é, sem zona de proximidade (caso necessário).
gdf​_selected​_shp | Shapefiles selecionados para comparação com a área de input.
gdf​_required | Undocumented

def explode_input(self, gdf_input):

Undocumented

def export_pdf(self, feature_input_gdp, index_1, index_2):
Função responsável carregar o layout de impressão e por gerar os arquivos PDF.

Parameters
feature​_input​_gdp | Feição de input comparada
index​_1 | Variável utilizada para pegar dados armazenados no arquivo Json, exemplo: pegar informções como estilização ou nome da camada.
index​_2 | Variável utilizada para pegar dados armazenados no arquivo Json, exemplo: pegar informções como estilização ou nome da camada.

def fill_observation(self, feature_input_gdp, layer_name):

Undocumented

def get_feature_symbol(self, geometry_type, style):
Estilização dinâmica para diferentes tipos de geometrias (Áreas de comparação).

Parameters
geometry​_type | Tipo de geometria da área de comparação.
style | Variável armazena o estilo que será usado para a projeção de uma determinada camada. Este estilo é obtido através do arquivo JSON de configuração.
Returns
Retorna o objeto contendo a estilização de uma determinada camada.

def get_input_standard_symbol(self, geometry_type):
Estilização dinâmica para diferentes tipos de geometrias (Área de input sem o buffer de aproximação).

Parameters
geometry​_type | Tipo de geometria da área de input sem o buffer de aproximação.
Returns
Retorna o objeto contendo a estilização de uma determinada camada.

def get_input_symbol(self, geometry_type):
Estilização dinâmica para diferentes tipos de geometrias (Área de input).

Parameters
geometry​_type | Tipo de geometria da área de input (com ou se buffer de área de aproximação).
Returns
Retorna o objeto contendo a estilização de uma determinada camada.

def get_required_layers(self, gdf_selected_shp, gdf_selected_db):
Extrai as camadas obrigatórias das bases de dados shp e db e do dicionário de configuração.
def handle_layers(self, feature_input_gdp, gdf_line_input, gdf_point_input, input_standard, feature_area, feature_intersection, gdf_required, index_1, index_2):
Carrega camadas já processadas no QGis para que posteriormente possam ser gerados os relatórios no formato PDF. Após gerar todas camadas necessárias, está função aciona outra função (export_pdf), que é responsável por gerar o layout PDF a partir das feições carregadas nesta função.

Parameters
feature​_input​_gdp | Feição que está sendo processada e será carregada para o QGis.
gdf​_line​_input | Undocumented
gdf​_point​_input | Undocumented
input​_standard | Feição padrão isto é, sem zona de proximidade (caso necessário), que está sendo processada e será carregada para o QGis.
feature​_area | Camada de comparação que está sendo processada.
feature​_intersection | Camada de interseção (caso exista) e será carregada para o QGis.
gdf​_required | Undocumented
index​_1 | Variável utilizada para pegar dados armazenados no arquivo Json, exemplo: pegar informções como estilização ou nome da camada.
index​_2 | Variável utilizada para pegar dados armazenados no arquivo Json, exemplo: pegar informções como estilização ou nome da camada.

def handle_text(self, feature_input_gdp, index_1, index_2):
Faz a manipulação de alguns dados textuais presentes no layout de impressão.

Parameters
feature​_input​_gdp | Undocumented
index​_1 | Variável utilizada para pegar dados armazenados no arquivo Json, exemplo: pegar informções como estilização ou nome da camada.
index​_2 | Variável utilizada para pegar dados armazenados no arquivo Json, exemplo: pegar informções como estilização ou nome da camada.

def load_required_layers(self, gdf_required, crs):

Undocumented

def pdf_generator(self):
Função onde se inicia a geração de PDF. A função chama funções de calculo de sobreposição de forma individual para cada feição de input. Ainda nesta função é extraida a zona UTM das feições de input e controle da barra de progresso.
def remove_layers(self):

Undocumented

atlas =
Variável que armazena o atlas do layout para geração de plantas PDF.
epsg_shp_dir =
Diretório do shapefile para gerar dinamicamente os EPSG's (Comtém as Zonas UTM).
index_input =

Undocumented

layers =
Utilizada para salvar a camada de input, já processada e projetada no QGIS.
layout =
Variável que armazena o layout para geração de plantas PDF.
operation_config =
Dicionário que armazena configurações de operação, como por exemplo: dado de input, bases de dados selecionadas para comparação, busca por ponto, shapefile, etc...
overlay_analysis =
Variável utilizada para importar a classe presente em prisma/analysis/overlay_analysis.py.
progress_bar =
Variável de controle da barra de progresso do processamento para geração de plantas PDF.
required_layers_loaded: `bool` =

Undocumented

root =

Undocumented

utils =
Variável conténdo classe presentem em prisma/utils/utils.py