YouTrack Standalone 2018.2 Help

Field

Represents a value that is stored in a custom field. The custom fields themselves are represented by the Fields class.

Extends BaseEntity.

Properties

Name

Type

Description

Read-only

static dateTimeType

String

Date and time field type. Used when defining rule requirements.

checkbox marked

static dateType

String

Date field type. Used when defining rule requirements.

checkbox marked

static floatType

String

Float field type. Used when defining rule requirements.

checkbox marked

static integerType

String

Integer field type. Used when defining rule requirements.

checkbox marked

static periodType

String

Period field type. Used when defining rule requirements.

checkbox marked

static stringType

String

String field type. Used when defining rule requirements.

checkbox marked

static textType

String

Text field type. Used when defining rule requirements.

checkbox marked

backgroundColor

String

The background color of the value in the custom field as it is displayed in YouTrack.

checkbox marked

becomesRemoved

Boolean

When `true`, the entity is removed in the current transaction. Otherwise, `false`.

Available since 2017.4.37915

checkbox marked

colorIndex

Number

The index value of the color that is assigned to the value in the custom field.

checkbox marked

description

String

The description of the value as visible in the administrative UI for custom fields.

checkbox marked

foregroundColor

String

The foreground color of the value in the custom field as it is displayed in YouTrack.

checkbox marked

isNew

Boolean

When `true`, the entity is created in the current transaction. Otherwise, `false`.

Available since 2018.2.42351

checkbox marked

name

String

The name of the value, which is also stored as the value in the custom field.

checkbox marked

ordinal

Number

The position of the value in the set of values for the custom field.

checkbox marked

presentation

String

String representation of the value.

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`.

 

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, returns null.

Parameters

Name

Type

Description

fieldName

string

The name of the field.

Return Value

Type

Description

Object

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

 

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