To learn more about using JavaScript in LeanFT, see Setting up and working with the JavaScript SDK.
For JavaScript code samples, see Code Samples - JavaScript.

Label

SAPGUI. Label

new Label(propsopt) → {Label}

Parameters:
Name Type Attributes Description
props Object <optional>
Initializes a Label test object using the supplied property bag.
Returns:
the description object that was initialized.
Type
Label

Methods

absoluteLocation(locationopt) → {Point|Description}

The object's coordinates relative to the screen in pixels. 0,0 is the top-left corner of the primary monitor.
Parameters:
Name Type Attributes Description
location Point <optional>
When provided, this method acts as a setter and sets the absoluteLocation value.
Returns:
If no parameter is provided, the method acts as a getter and returns the absoluteLocation value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

iconName(iconNameopt) → {string|Description}

The name of the icon used in the label.
Parameters:
Name Type Attributes Description
iconName string <optional>
When provided, this method acts as a setter and sets the iconName value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored iconName value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

id(idopt) → {string|Description}

The element's unique identifier in text format.
Parameters:
Name Type Attributes Description
id string <optional>
When provided, this method acts as a setter and sets the id value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored id value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

isHighlighted(isHighlightedopt) → {bool|Description}

Indicates whether the label is highlighted.
Parameters:
Name Type Attributes Description
isHighlighted bool <optional>
When provided, this method acts as a setter and sets the isHighlighted value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isHighlighted value; otherwise it returns 'this' for use with the builder pattern.
Type
bool | Description

isNumerical(isNumericalopt) → {bool|Description}

Indicates whether the label is a numeric field.
Parameters:
Name Type Attributes Description
isNumerical bool <optional>
When provided, this method acts as a setter and sets the isNumerical value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored isNumerical value; otherwise it returns 'this' for use with the builder pattern.
Type
bool | Description

location(locationopt) → {Point|Description}

The object's coordinates relative to the parent's location in pixels.
Parameters:
Name Type Attributes Description
location Point <optional>
When provided, this method acts as a setter and sets the location value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored location value; otherwise it returns 'this' for use with the builder pattern.
Type
Point | Description

maxLength(maxLengthopt) → {Number|Description}

The maximum number of characters that can be displayed in the label.
Parameters:
Name Type Attributes Description
maxLength Number <optional>
When provided, this method acts as a setter and sets the maxLength value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored maxLength value; otherwise it returns 'this' for use with the builder pattern.
Type
Number | Description

name(nameopt) → {string|Description}

The name of the element.
Parameters:
Name Type Attributes Description
name string <optional>
When provided, this method acts as a setter and sets the name value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored name value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

relativeId(relativeIdopt) → {string|Description}

The labels's unique identifier relative to the parent window ID in text format.
Parameters:
Name Type Attributes Description
relativeId string <optional>
When provided, this method acts as a setter and sets the relativeId value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored relativeId value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

size(sizeopt) → {Size|Description}

The object's size in pixels.
Parameters:
Name Type Attributes Description
size Size <optional>
When provided, this method acts as a setter and sets the size value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored size value; otherwise it returns 'this' for use with the builder pattern.
Type
Size | Description

text(textopt) → {string|Description}

Either the text string or the icon name of the label.
Parameters:
Name Type Attributes Description
text string <optional>
When provided, this method acts as a setter and sets the text value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored text value; otherwise it returns 'this' for use with the builder pattern.
Type
string | Description

type(typeopt) → {SAPGUI.ComponentType|Description}

The numeric identification of the GUI component type.
Parameters:
Name Type Attributes Description
type SAPGUI.ComponentType <optional>
When provided, this method acts as a setter and sets the type value.
Returns:
If no parameter is provided, the method acts as a getter and returns the current stored type value; otherwise it returns 'this' for use with the builder pattern.
Type
SAPGUI.ComponentType | Description