YouTrack Standalone 2017.2 Help

BundleProjectCustomField

Extends: ProjectCustomField

Represents a custom field in a project that stores an predefined set of values.

Properties

Name

Type

Description

Read-only

becomesRemoved

Boolean

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

checkbox marked

isNew

Boolean

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

checkbox marked

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

values

Set.<Field>

The set of values that is available for the custom field.

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.

Returns:

Type

Description

boolean

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

 

becomesInvisibleInIssue

becomesInvisibleInIssue(issue)

Checks if the changes that are applied in the current transaction remove the condition to show the custom field.

Parameters:

Name

Type

Description

issue

Issue

The issue for which the condition for showing the field is checked.

Returns:

Type

Description

Boolean

When `true`, the condition for showing the field is removed in the current transaction.

 

becomesVisibleInIssue

becomesVisibleInIssue(issue)

Checks if the changes that are applied in the current transaction satisfy the condition to show the custom field.

Parameters:

Name

Type

Description

issue

Issue

The issue for which the condition for showing the field is checked.

Returns:

Type

Description

Boolean

When `true`, the condition for showing the field is met in the current transaction.

 

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.

Returns:

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.

Returns:

Type

Description

boolean

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

 

createValue

createValue(name)

Adds a value to the set of values for the custom field. If a value with the specified name already exists in the set, an exception is thrown.

Parameters:

Name

Type

Description

name

String

The name of the value that you want to add to the set.

Returns:

Type

Description

Field

The value that was added to the set.

 

findValueByName

findValueByName(name)

Returns a value with the specified name in the set of values for a custom field.

Parameters:

Name

Type

Description

name

String

The name of the field value to search for.

Returns:

Type

Description

Field

The value with the specified name in the set of values for the custom field.

 

findValueByOrdinal

findValueByOrdinal(ordinal)

Returns a value that is assigned a specified position in the set of values for a custom field.

Parameters:

Name

Type

Description

ordinal

Number

The position of the field value to search by.

Returns:

Type

Description

Field

The value that is assigned the specified position in the set of values for the custom field.

 

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.

Returns:

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.

Returns:

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.

Returns:

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.

Returns:

Type

Description

boolean

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

 

isVisibleInIssue

isVisibleInIssue(issue)

Checks if a field is visible in the issue.

Parameters:

Name

Type

Description

issue

Issue

The issue for which the condition for showing the field is checked.

Returns:

Type

Description

Boolean

When `true`, the condition for showing the custom field in the issue has been met. It can also mean that the field is not shown on a conditional basis and is always visible.

 

oldValue

oldValue(fieldName)

Returns the previous value of a single-value field before an update was applied. If the field is not changedin the transaction, returns null.

Parameters:

Name

Type

Description

fieldName

string

The name of the field.

Returns:

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