- Páginas
- …
- TOTVS Linha Protheus
- Documento de Referência
- Protheus 12
- Manufatura - Protheus 12
- Planejamento e Controle da Produção - Protheus 12
- Planejamento e Controle da Produção (SIGAPCP)
- Consultas - SIGAPCP
- Gestão à Vista - SIGAPCP
- Gestão à Vista - Monitores Exclusivos - PCPMCUSTOM
- Gestão à Vista - Monitores Exclusivos - Documentação Técnica
- 2. Métodos Auxiliares
PCPMonitorGauge
- Criado por Renan Roeder, última alteração em 26 out, 2023
Classe utilitária para criar o objeto json com os atributos do componente de gauge (velocímetro) no método de BuscaDados do monitor exclusivo.
Para maior esclarecimento, é possível consultar o exemplo de uso na seção do método BuscaDados.
Segue a relação dos métodos que podem ser implementados:
Sintaxe
PCPMonitorGauge():New()
Descrição
Construtor da classe.
Sintaxe
PCPMonitorGauge():Destroy()
Descrição
Limpa o objeto de gauge da memória.
Sintaxe
PCPMonitorGauge():GetJsonObject()
Descrição
Retorna o objeto json com os atributos do velocímetro.
Sintaxe
PCPMonitorGauge():SetAppend(cAppend)
Descrição
Especifica uma string que será visualizada à direita da leitura do velocímetro.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
cAppend | Caracter | String que será visualizada | X |
Sintaxe
PCPMonitorGauge():SetAppendStyle(cProperty,cValue)
Descrição
Atribui estilo à string que será visualizada à direita da leitura do velocímetro.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
cProperty | Caracter | Nome da propriedade CSS | X | |
cValue | Caracter | Valor da propriedade | X |
Sintaxe
PCPMonitorGauge():SetLabel(cLabel)
Descrição
Especifica o texto que será visualizado abaixo da leitura do velocímetro.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
cLabel | Caracter | Legenda do velocímetro | X |
Sintaxe
PCPMonitorGauge():SetLabelStyle(cProperty,cValue)
Descrição
Atribui estilo ao texto que será visualizado abaixo da leitura do velocímetro.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
cProperty | Caracter | Nome da propriedade CSS | X | |
cValue | Caracter | Valor da propriedade | X |
Sintaxe
PCPMonitorGauge():SetMargin(nMargin)
Descrição
Especifica uma margem opcional ao velocímetro.
Se não for atribuída uma margem através do método SetMargin, o valor padrão será 15.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
nMargin | Numérico | Valor da margem em pixels | X |
Sintaxe
PCPMonitorGauge():SetMarker(cLabel,cColor,nSize,cType)
Descrição
Especifica um marcador com um valor que será atribuído ao velocímetro.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão | Valores Possíveis |
cLabel | Caracter | Legenda | X | ||
cColor | Caracter | Cor | rgba(0,0,0,1) | ||
nSize | Numérico | Tamanho | 6 | ||
cType | Caracter | Tipo | line | "line","triangle" |
Sintaxe
PCPMonitorGauge():SetMaxValue(nValue)
Descrição
Especifica o valor máximo para a escala do velocímetro.
Se não for atribuído um valor máximo através do método SetMaxValue, o valor padrão será 100.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
nValue | Numérico | Valor máximo atribuído ao velocímetro | X |
Sintaxe
PCPMonitorGauge():SetMinValue(nValue)
Descrição
Especifica o valor mínimo para a escala do velocímetro.
Se não for atribuído um valor mínimo através do método SetMinValue, o valor padrão será 0.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
nValue | Numérico | Valor mínimo atribuído ao velocímetro | X |
Sintaxe
PCPMonitorGauge():SetPrepend(cPrepend)
Descrição
Especifica uma string que será visualizada à esquerda da leitura do velocímetro.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
cPrepend | Caracter | String que será visualizada | X |
Sintaxe
PCPMonitorGauge():SetPrependStyle(cProperty,cValue)
Descrição
Atribui estilo à string que será visualizada à esquerda da leitura do velocímetro.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
cProperty | Caracter | Nome da propriedade CSS | X | |
cValue | Caracter | Valor da propriedade | X |
Sintaxe
PCPMonitorGauge():SetThick(nThick)
Descrição
Especifica a espessura da barra do velocímetro.
Se não for atribuída uma espessura à barra do velocímetro através do método SetThick, o valor padrão será 20.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
nThick | Numérico | Espessura da barra | X |
Sintaxe
PCPMonitorGauge():SetThreshold(cValue,cColor,nBGOpacity)
Descrição
Especifica o valor limite onde a cor do velocímetro muda.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
cValue | Caracter | Valor limite da cor | X | |
cColor | Caracter | Cor do limitador | X | |
nBGOpacity | Numérico | Opacidade da Cor | 0.2 |
Sintaxe
PCPMonitorGauge():SetType(cType)
Descrição
Especifica o tipo do velocímetro.
Se um tipo não for atribuído ao velocímetro através do método SetType, o valor padrão será "arch".
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão | Valores Possíveis |
cType | Caracter | Tipo do velocímetro | X | "semi","arch","full" |
Sintaxe
PCPMonitorGauge():SetValue(nValue)
Descrição
Especifica o valor corrente do velocímetro.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
nValue | Numérico | Valor corrente | X |
Sintaxe
PCPMonitorGauge():SetValueStyle(cProperty,cValue)
Descrição
Atribui estilo ao valor corrente do velocímetro.
Parâmetros
Nome | Tipo | Descrição | Obrigatório | Valor Padrão |
cProperty | Caracter | Nome da propriedade CSS | X | |
cValue | Caracter | Valor da propriedade | X |
- Sem rótulos