YouTrack Standalone 2017.3 Help

SimpleProjectCustomField

Base class for custom fields that store simple values like strings and numbers.

Extends ProjectCustomField.

Properties

Name

Type

Description

Read-only

localizedName

String

The localized name of the field.

checkbox marked

name

String

The name of the field.

checkbox marked

nullValueText

String

The text that is displayed for this field when it is empty.

checkbox marked

Methods


becomes

becomes(fieldName, expected)

Checks whether a field is set to an expected value in the current transaction.

Parameters

Name

Type

Description

fieldName

string

The name of the field to check.

expected

string

The expected value.

Return Value

Type

Description

boolean

If the field is set to the expected value, returns `true`.

 

canBeReadBy

canBeReadBy(fieldName, user)

Checks whether a user has permission to read the field.

Parameters

Name

Type

Description

fieldName

string

The name of the field.

user

User

The user for whom the permission to read the field is checked.

Return Value

Type

Description

boolean

If the user can read the field, returns `true`.

 

canBeWrittenBy

canBeWrittenBy(fieldName, user)

Checks whether a user has permission to update the field.

Parameters

Name

Type

Description

fieldName

string

The name of the field.

user

User

The user for whom the permission to update the field is checked.

Return Value

Type

Description

boolean

If the user can update the field, returns `true`.

 

getBackgroundColor

getBackgroundColor(issue)

Returns the background color that is used for this field value in the specified issue. Can return `null`, `"white"`, or a hex color presentation.

Parameters

Name

Type

Description

issue

Issue

The issue for which the background color is returned.

Return Value

Type

Description

String

The background color that is used for this field value in the specified issue.

 

getForegroundColor

getForegroundColor(issue)

Returns the foreground color that is used for this field value in the specified issue. Can return `null`, `"white"`, or a hex color presentation.

Parameters

Name

Type

Description

issue

Issue

The issue for which the foreground color is returned.

Return Value

Type

Description

String

The foreground color that is used for this field value in the specified issue.

 

getValuePresentation

getValuePresentation(issue)

Returns the string presentation of the value that is stored in this field in the specified issue.

Parameters

Name

Type

Description

issue

Issue

The issue for which the value presentation is returned.

Return Value

Type

Description

String

The string presentation of the value.

 

isChanged

isChanged(fieldName)

Checks whether the value of a field is changed in the current transaction.

Parameters

Name

Type

Description

fieldName

string

The name of the field to check.

Return Value

Type

Description

boolean

If the value of the field is changed in the current transaction, returns `true`.

 

oldValue

oldValue(fieldName)

Returns the previous value of a single-value field before an update was applied. If the field is not changed in the transaction, this value is equal to the current value of the field.

Parameters

Name

Type

Description

fieldName

string

The name of the field.

Return Value

Type

Description

Object

previous If the field is changed in the current transaction, the previous value of the field. Otherwise, the current value of the field.

 

required

required(fieldName, message)

Asserts that a value is set for a field. If a value for the required field is not set, the specified message is displayed in the user interface.

Parameters

Name

Type

Description

fieldName

string

The name of the field to check.

message

string

The message that is displayed to the user that describes the field requirement.

 

Last modified: 7 March 2019