Class CvsLabel

Simple label with text and / or icon

Hierarchy

Properties

action: Function = ...

The event handler for this control. Although it is permitted to set this property directly it is recommended that the setAction(...) method is used to define the event handler actions.

Methods

  • Add a child to this control using its relative position [rx, ry]. If rx and ry are not provided then it uses the values set in the child.

    Returns

    this control

    Parameters

    • c: string | CvsBaseControl

      is the actual control or its name

    • Optional rx: number
    • Optional ry: number

    Returns any

  • Set or get the corner radii used for this control

    Returns

    an array with the 4 corner radii

    Parameters

    • c: number[]

      an array of 4 corner radii

    Returns number[] | CvsBaseControl

  • Disables this control

    Returns

    this control

    Parameters

    • Optional cascade: boolean

      if true disable child controls

    Returns CvsBaseControl

  • Enables this control

    Returns

    this control

    Parameters

    • Optional cascade: boolean

      if true enable child controls

    Returns CvsBaseControl

  • Calculates the absolute position on the canvas taking into account any ancestors

    Returns

    the actual position in the canvas

    Returns __Position

  • Make this control invisible

    Returns

    this control

    Parameters

    • Optional cascade: boolean

      if true hide children

    Returns CvsBaseControl

  • Gets or sets the icon and its alignment relative to any text in the control.

    Processing constants are used to define the icon alignment.

    Returns

    this control or the current icon

    Parameters

    • i: Graphics

      the icon to use for this control

    • Optional align: number

      LEFT or RIGHT

    Returns any

  • Sets the icon alignment relative to the text.

    Processing constants are used to define the text alignment.

    Returns

    this control

    Parameters

    • align: number

      LEFT or RIGHT

    Returns CvsLabel

  • Invalidates the control's buffer forcing it to validate it on the next frame

    Returns

    this control

    Returns CvsLabel

  • Use enable() and disable() to enable and disable it.

    Returns

    true if the control is enabled else false

    Returns boolean

  • Returns

    true if this control is visible

    Since

    0.9.3

    Returns boolean

  • Returns

    the unique identier for this control

    Returns string

  • Specify the orientation to show this control

    Returns

    this control

    Parameters

    • dir: string

      'north', 'south', 'east' or 'west'

    Returns CvsBaseControl

  • Adds this control to another control which becomes its parent

    Returns

    this control

    Parameters

    • p: string | CvsBaseControl

      is the parental control or its name

    • Optional rx: number

      x position relative to parent

    • Optional ry: number

      y position relative to parent

    Returns CvsBaseControl

  • Sets or gets the color scheme used by this control.

    Returns

    this control or the control's color scheme

    Parameters

    • Optional id: string
    • Optional cascade: boolean

    Returns CvsBaseControl | __Scheme

  • This sets the event handler to be used when this control fires an event. The parameter can take three forms:

    1. Arrow function definition
    2. Anonymous function definition
    3. Named function declaration

    Returns

    this control

    Parameters

    • event_handler: Function

      the function to handle this controls event

    Returns CvsLabel

  • Make this control visible

    Returns

    this control

    Parameters

    • Optional cascade: boolean

      if true show children

    Returns CvsBaseControl

  • Shrink the control to fit contents.

    To shrink on one dimension only pass either 'w' (width) or 'h' (height) to indicate which dimmension to shrink

    Returns

    this control

    Parameters

    • Optional dim: string

      the dimension to shrink

    Returns CvsBaseControl

  • Gets or sets the current text.

    Processing constants are used to define the alignment.

    Returns

    this control or the existing text

    Parameters

    • Optional t: string | string[]

      the text to display

    • Optional align: number

      LEFT, CENTER or RIGHT

    Returns string | CvsBaseControl

  • Sets the text alignment.

    Processing constants are used to define the text alignment.

    Returns

    this control

    Parameters

    • align: number

      LEFT, CENTER or RIGHT

    Returns CvsBaseControl

  • Sets or gets the text size.

    Returns

    this control or the current text size

    Parameters

    • lts: number

      the text size to use

    Returns number | GUI | CvsLabel

  • Sets the size of the text to use in the tooltip

    Parameters

    • Optional tsize: number

      text size for this tooltip

    Returns CvsLabel

  • Create a tooltip for this control

    Returns

    this control

    Parameters

    • tiptext: string

      the text to appear in the tooltip

    • duration: number

      how long the tip remains visible (milliseconds)

    Returns CvsLabel

Generated using TypeDoc