index :: ui

ui.label

simple label widget

available since version: 0.5

---

information

Label object with spaces, text-align, font customization and word-wrap

arguments:

• TEXT label text
  type: list
  

methods:

• append appends to @text end
  

• clear clear label text and clear @text property
  

• pos set UI element position
  parameters:

  • X top left x-coord
    type: float
    required: True
    

  • Y top right y-coord
    type: float
    required: True
    

• prepend insert into beginning of @text
  

properties:

• @align Get/set text align
  type: symbol
  enum: left, center, right
  default: left
  

• @background_color Get/set element background color (list of red, green, blue values in 0-1 range)
  type: list
  default: 1 1 1 1
  

• @fontname Get/set fontname
  type: symbol
  enum: Courier, DejaVu, Helvetica, Monaco, Times
  default: Helvetica
  

• @fontsize Get/set fontsize
  type: int
  range: 4..100
  default: 32
  

• @fontslant Get/set font slant
  type: symbol
  enum: roman, italic
  default: roman
  

• @fontweight Get/set font weight
  type: symbol
  enum: normal, bold
  default: normal
  

• @margin_bottom Get/set text bottom margin
  type: int
  default: 5
  

• @margin_left Get/set text left margin
  type: int
  default: 5
  

• @margin_right Get/set text right margin
  type: int
  default: 5
  

• @margin_top Get/set text top margin
  type: int
  default: 5
  

• @pinned Get/set pin mode. if 1 - put element to the lowest level
  type: bool
  default: 1
  

• @receive Get/set receive source
  type: symbol
  default: (null)
  

• @size Get/set element size (width, height pair)
  type: list
  default: 300 47
  

• @text Get/set label text
  type: list
  default: Label
  

• @text_color Get/set text color (list of red, green, blue values in 0-1 range)
  type: list
  default: 0 0 0 1
  

inlets:

• [hidden inlet] set the label text to the given float without changing @text property
  type: control

keywords:

ui label

Authors: Serge Poltavsky

License: GPL3 or later