Class: Label

var label = this.label("myLabel", "<b>Atenção:</b><br>Siga as instruções
abaixo para completar o procedimento")
label.border = "1px"
label.width  = "100px"
label.height = "50px"
label.write()

Members

---

align :string

Alinhamento do texto no label. Por padrão, assume o valor Alignment.LEFT.
Pode receber um dos seguintes valores: Alignment.LEFT, Alignment.RIGHT, Alignment.CENTER ou Alignment.JUSTIFY.

Type:

• string

---

autoSanitize :boolean

Determina se o texto do rótulo deve ser tratado para remover tags que possam ser utilizadas com o objetivo de injetar scripts maliciosos em ataques do tipo Cross Site Scripting (XSS).

Ao desativar esta propriedade, é de crítica importância que algum tipo de validação ou sanitização seja realizada no conteúdo a ser escrito na tela.

Atenção: Tags <script> não serão executadas, independente dessa configuração estar ligada ou não.

Type:

• boolean

---

backgroundColor :string

Define a cor de fundo do label. O valor a ser informado pode ser num dos seguintes formatos: "#FFFFFF" - hexadecimal, "blue" - cor por extenso (em inglês), "rgb(100, 150, 255)" - formato RGB. Alterações feitas nesta propriedade em tempo de execução serão refletidas na interface dinamicamente.

Type:

• string

---

border :string

Largura das bordas do label. Por padrão, o label não exibe bordas.
O valor informado deve ser seguido da unidade, como "1px".

Type:

• string

---

color :string

Define a cor do texto do label. O valor a ser informado pode ser num dos seguintes formatos: "#FFFFFF" - hexadecimal, "blue" - cor por extenso (em inglês), "rgb(100, 150, 255)" - formato RGB. Por padrão é adotada a cor definida no tema do usuário.

Type:

• string

---

css :string

Classe de CSS que será adicionada ao label.

Esta propriedade não deve ser mais utilizada, priorize a propriedade cssClass.

Type:

• string

Deprecated:

• Yes

See:

• #cssClass

---

cssClass :string

Classe de CSS adicional para o label.

Type:

• string

---

fontSize :string

Deve ser informado uma string com o valor seguido da unidade, como "8pt". Esta configuração se destina a configurações avançadas de tamanho do Label e o tamanho definido nesta propriedade irá permanecer fixo independente da configuração de densidade variável selecionada pelo usuário.

Para configurar um tamanho que seja adaptável à densidade variável, dê preferência ao uso da propriedade size.

Type:

• string

See:

• #size

---

height :string

Altura do label na tela. Deve ser informada uma string com a altura seguida da unidade, por exemplo: "150px".
Caso não seja informado, o label assumirá altura variável conforme o conteúdo.
Alterações feitas nesta propriedade em tempo de execução serão refletidas na interface dinamicamente.

Type:

• string

---

layout :LayoutConfig

Opções que definem como este componente deve ser apresentando no leiaute da interação do processo.

Type:

• LayoutConfig

See:

• module:@nginstack/web-framework/lib/process/LayoutConfig~LayoutConfig

Example

grid.layout.column = 1;
grid.write();

label.layout.column = 2;
label.write()

// Apresentação:
// ------------   ----------
// |   grid   |   |  label  |
// ------------   ----------

---

name :string

Nome do label. É o identificador do objeto label. Deve ser único e é o nome que será passado para o método label() do process para se obter o objeto label desejado.

Type:

• string

---

size :string

Controla o tamanho do texto do Label. valores possíveis: "small", "default" ou "large".

Um valor vazio será considerado como o valor "default". O tamanho irá se ajustar às configurações de densidade variável do Web Framework.

Type:

• string

See:

• module:@nginstack/web-framework/lib/label/LabelSize

Example

const footNote = this.label('note');
footNote.size = 'small';
footNote.text = '* Development: the process of developing or being developed.'
footNote.write();

---

text :string

Texto a ser apresentado no label. É por esta propriedade que é possível indicar o que o objeto label irá exibir na tela. O texto atribuído pode conter tags de HTML.

Type:

• string

---

visible :boolean

Indica a visibilidade do label na interface. Por padrão, o label quando escrito estará visível.

Type:

• boolean

---

width :string

Largura do label na tela. Deve ser informada uma string com a largura seguida da unidade, por exemplo: "150px".
Caso não seja informado, o label assumirá uma largura variável conforme o conteúdo.
Alterações feitas nesta propriedade em tempo de execução serão refletidas na interface dinamicamente.

Type:

• string

Methods

---

write()

Escreve o label na interface.