# Gantt Represents a Gantt chart. Extends [BaseEntity](v1-BaseEntity.html). Available since 2022.1 ## Properties | Name | Type | Description | | --- | --- | --- | | becomesRemoved | Boolean | Read-only.  When `true`, the entity is removed in the current transaction. Otherwise, `false`. This property can become `true` only in on-change rules when the rule is triggered on the removal of an issue or an article. In the rule code, the `runOn` rule property must contain the `removal` parameter set to `true`. Available since 2017.4.37915 ```JAVASCRIPT runOn: {removal: true} ``` | | extensionProperties | Object | The object containing extension properties for this entity and their values. Extension properties are custom properties that might be added to core YouTrack entities by an app. For details about extension properties, see [Extension Properties](apps-extension-properties.html). Available since 2024.3 ```JAVASCRIPT const entities = require('@jetbrains/youtrack-scripting-api/entities'); exports.rule = entities.Issue.action({ command: 'test', action: function (ctx) { const printValues = () => { return 'stringProp:' + ctx.issue.extensionProperties.stringProp + ';' + 'integerProp:' + ctx.issue.extensionProperties.integerProp + ';' + 'booleanProp:' + ctx.issue.extensionProperties.booleanProp + ';' + 'issueProp:' + ctx.issue.extensionProperties.issueProp?.id + ';' + 'issuesProp:' + ctx.issue.extensionProperties.issuesProp?.first()?.id + ';' } ctx.issue.addComment(printValues()); } }); ``` | | isNew | Boolean | Read-only.  When `true`, the entity is created in the current transaction. Otherwise, `false`. Available since 2018.2.42351 | | issues | [Set](v1-Set.html).<[Issue](v1-Issue.html)> | Read-only.  The set of issues that have been added to the Gantt chart. | | name | String | Read-only.  The name of the Gantt chart. | | owner | [User](v1-User.html) | Read-only.  The user who created the Gantt chart. | | projects | [Set](v1-Set.html).<[Project](v1-Project.html)> | Read-only.  The projects that this Gantt chart works with. | | startTimestamp | Number | Read-only.  The start date for the issues on the Gantt chart. | ## Methods ### findByExtensionProperties ```JAVASCRIPT static findByExtensionProperties(extensionPropertiesQuery) ``` Searches for Gantt entities with extension properties that match the specified query. Available since 2024.3.43260 Parameters : | Name | Type | Description | : | --- | --- | --- | : | extensionPropertiesQuery | Object | The extension properties query, defined as a set of key-value pairs representing properties and their corresponding values. | Return Value : | Type | Description | : | --- | --- | : | [Set](v1-Set.html).<[Gantt]()> | The set of Gantt entities that contain the specified extension properties. | Example : ```JAVASCRIPT : { : property1: "value1", : property2: "value2" : } : ``` ### findChartByName ```JAVASCRIPT static findChartByName(name) ``` Finds the most relevant chart with the specified name that is visible to the current user. Parameters : | Name | Type | Description | : | --- | --- | --- | : | name | String | The name of the chart to search for. | Return Value : | Type | Description | : | --- | --- | : | [Gantt]() | The most relevant chart found by name. | ### addIssue ```JAVASCRIPT addIssue(issue) ``` Adds the specified issue to the Gantt chart. Parameters : | Name | Type | Description | : | --- | --- | --- | : | issue | [Issue](v1-Issue.html) | The issue to add to the Gantt chart. | ### becomes ```JAVASCRIPT 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 ```JAVASCRIPT 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](v1-User.html) | 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 ```JAVASCRIPT 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](v1-User.html) | 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`. | ### containsIssue ```JAVASCRIPT containsIssue(issue) ``` Checks whether the issue belongs to the Gantt chart. Parameters : | Name | Type | Description | : | --- | --- | --- | : | issue | [Issue](v1-Issue.html) | The issue for which the condition is checked. | Return Value : | Type | Description | : | --- | --- | : | Boolean | If the issue belongs to the Gantt chart, returns `true`. | ### is ```JAVASCRIPT is(fieldName, expected) ``` Checks whether a field is equal to an expected value. Available since 2019.2.55603 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 equal to the expected value, returns `true`. | ### isChanged ```JAVASCRIPT 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 ```JAVASCRIPT 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`. | ### removeIssue ```JAVASCRIPT removeIssue(issue) ``` Removes the specified issue from the Gantt chart. If the issue was not present on the chart, nothing happens. Parameters : | Name | Type | Description | : | --- | --- | --- | : | issue | [Issue](v1-Issue.html) | The issue to remove from the Gantt chart. | ### required ```JAVASCRIPT 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. | ### was ```JAVASCRIPT was(fieldName, expected) ``` Checks whether a field was equal to an expected value prior to the current transaction. Available since 2019.2.55603 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 was equal to the expected value, returns `true`. | ## See also [BaseEntity](v1-BaseEntity.html) [Extension Properties](apps-extension-properties.html) [Set](v1-Set.html) [Issue](v1-Issue.html) [User](v1-User.html) [Project](v1-Project.html)