Interface LabControl

A user interface control.

interface LabControl {
    disconnect(): void;
    getElement(): HTMLElement;
    getParameter(): null | Parameter;
    setEnabled(enabled): void;
    toStringShort(): string;
}

Hierarchy (view full)

Implemented by

Methods

disconnect getElement getParameter setEnabled toStringShort

Methods

disconnect

  • disconnect(): void

  • Remove connections to other objects to facilitate garbage collection. For example, stops listening for user interface events.

    Returns void

getElement

  • getElement(): HTMLElement

  • Returns the top level Element of this control. For example, this might be a label Element that encloses an input Element.

    Returns HTMLElement

    the top level Element of this control

getParameter

setEnabled

  • setEnabled(enabled): void

  • Enables or disables the control.

    Parameters

    • enabled: boolean

      whether to enable the control

    Returns void

toStringShort

  • toStringShort(): string

  • Returns a minimal string representation of this object, usually giving just identity information like the class name and name of the object.

    For an object whose main purpose is to represent another Printable object, it is recommended to include the result of calling toStringShort on that other object. For example, calling toStringShort() on a DisplayShape might return something like this:

    DisplayShape{polygon:Polygon{'chain3'}}

    Returns string

    a minimal string representation of this object.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc