Properties overview

This page provides a quick overview of the properties, that you can use to create a grid.

Key	Usage

Key	Usage
grid details	Enable grid features by adding the property to the configuration. gd.sample.size — Generate a number of rows with randomly generated content for each of the columns such that a grid can be tested. gd.delete.allowed — Allow or disallow users to delete individual rows on a grid gd.delete.confirmation — When enabled, the grid will ask for confirmation before deleting a set of rows using the 'delete non modified' or 'delete duplicates' gd.readonly — When you want to use the grid for displaying purposes only gd.enableXSSValidation — This property is in the first place meant to protect against XSS attacks. Use this property to block submission of html based data into a grid cell (string or textarea). gd.emptyRows — Use this to initialize the grid with a number of empty rows. Property is applied when you create a new issue. Columns are initialized with their default value gd.allowAddRows — Enable or disable the possibility to add rows gd.tablename — Provide the base name of the grid table gd.insertChangeComments — Insert grid changes as comments to the issue gd.selector — Enables selection capabilities on the grid such that a user can select one row. Cell value that resides in the selected row and selector column is accessible in other grid queries using {customfield:XXXXX} notation gd.decimalSeparator — Use this to specify the default decimal separator for any grid column of type 'number' gd.cleanupTable — Delete rows from the gridtable when containing issue is deleted. gd.tracking — When enabled, adds 4 tracking columns to the grid table to know who and when a grid row has been added and/or updated. gd.filter — Enable filtering capabilities on the grid such that a user can filter out rows based on a search term gd.columns — Use this to specify what columns should be displayed on the grid
grid display	You can specify grid display format (height, width, ...) using these properties. gd.maxDisplayRowCount — maximum number of rows to display gd.maxDisplayRowHeight — Allows to limit the height of a row - for instance when it contains large chunks of text. gd.caption — Sets grid caption gd.issueNavigatorLayout.header — Defines the visibility of a grid's header in issue navigator gd.fitcolumns — The columns in the grid are by default resized such that the complete grid does fit into the area provided by JIRA. The aim is to avoid an horizontal scroll bar. When the grid has a lot of columns this results in an unreadable configuration. gd.visiblerows — specify how many rows a grid should contain gd.minDisplayGridHeight — Minimum height of a non collapsed grid expressed in pixels gd.minDisplayRowHeight — Minimum height of a row expressed in pixels gd.pagination.size — Specifies the number of rows on a single grid page gd.minDisplayRowCount — Minimum number of rows to display. gd.collapseDefault — Use collapseDefault to indicate what the collapse status of a grid is when viewed for the first time by a user. gd.hideFooter — Hides grid footer (toolbar with pagination and all buttons in edit mode) gd.rownumbers — If this option is set to true a new column at the left of the grid is created containing the sequence number of the row in the grid. gd.extraHeight — Add some extra space below the last row, to avoid that the horizontal scroll bar potentially overlaps the last row. gd.maxDisplayGridHeight — Maximum height of a non collapsed grid expressed in pixels gd.hideHeader — Hides grid header gd.displayCondition — Specify the condition when a grid should be showed in the view edit screen gd.toolbar.disable — Hide particular buttons on the grid toolbar Grid layout components
grid initialization	Initialize grid with data statically or dynamically using these properties gd.query.row — Use this property to initialize a grid with static data. gd.ds — Use this to specify a different grid storage database - for instance the JIRA database, or a database source specification. gd.query.keepOnRefresh — specifies which rows can be removed when reloading the grid gd.query — A query, used to initialize the grid when the issue is created, when the grid is reloaded using the reload button or when a dependent custom field is changed. gd.initFromParent — When gd.initFromParent is true, and a sub-task of the issue is created, all rows which are linked to the parent issue, will be duplicated to the created sub-task gd.initFromClone — When gd.initFromClone is true, and an issue is cloned, all rows which are linked to the original issue, will be duplicated to the new (cloned) issue gd.query.columns — Use this property to specify which columns should be initialized with the results of a query. gd.query.reloadTrigger — Allows to reload the grid on issue view or update gd.query.reloadOnCustomFieldChange — Allows to disable automatic reloading of the grid on Create Issue and Edit Issue screens triggered by on custom field change gd.query.ds — Specify on which datasource a query needs to be run.
database details	Connect grid to the database using Data source admin. ds.xyz.connection.type = mysql — Use this to create a database source which connects to a mysql type of database. ds.xyz.connection.type = postgres — Use this to create a database source which connects to a postgres database. ds.xyz.connection.type = sqlserver — Use this to create a database source which connects to a MS Sql Server type of database. ds.xyz.connection.type = oracle — Use this to create a database source which connects to an oracle database. datasource.names — define the datasources in use in this grid. Further specified in [database detail ds.xyz.connection.type = sybase — Use this to create a database source which connects to an sybase database. Database reserved words
column types	Set columns for the grid using these properties: col.xyz.type — Specify what type of values can be stored in a column, defines the behaviour of the plugin. col.xyz.type = checkbox — Show checkbox options when editing a cell. col.xyz.type = integer — Use this when the column should store plain integer number fields such as 1234, -789, ... col.xyz.type = sequence — Give each row in the grid a unique id. col.xyz.type = string — The column is used to enter a single line of text. col.xyz.type = number — Use this when the column should store number fields with a decimal (such as 1.5, -212.34 ...) col.xyz.type = datetime — Enter a date time field col.xyz.type = textarea — This type allows the user to enter multiple lines of text col.xyz.type = radio — To present a radio button group to the user col.xyz.type = date — Formats the column as a date. When editing a cell, brings up a calendar popup. col.xyz.type = userlist — This column type provides a dropdown listing JIRA users. This type has additional properties allowing to filter the users col.xyz.type = list — Create a dropdown list which is either initialized using a static list or using a query.
column details	Specify column details using these properties col.xyz.summary — Adds an additonal row with a summary of the column. This summary can be either 'sum', 'avg', 'count', 'min', 'max' or just a label such as 'total:' col.xyz.nameX — Used to specify the label of a static list entry col.xyz.align — Horizontal align the content of a column left, middle or center col.xyz.hidden — Hide a column from displaying on the grid col.xyz.formatDate — Format the date when a column is a date type col.xyz.required — Specify if a column can be empty or not col.xyz.formula — Use the formula property to calculate the content of a column. String, math and conditional expressions are supported col.xyz.sortable — Specify if a column is sortable or not col.xyz.formatUser — Set the format of options of the userlist column col.xyz.query — Specify a source to initialize a list col.xyz.hidemode — The col.xyz.hidemode allows to specify in which grid mode a field must be hidden. col.xyz.defaultValue — Specify a default value for a column when adding one or more rows col.xyz.name=<tracking field> — When you want to display in a grid the values of a tracking field. col.xyz.defaultDate — initialize a date column with a date calculated from now. col.xyz.initialValue — Set the first value of a sequence col.xyz.cols — Specify the number of characters on a single line when editing a cell of a textarea column col.xyz.valueX — Specify a value for a specific entry in a list col.xyz.rows — Specify the number of lines of the textarea when editing a cell of a textarea column col.xyz.name — When the name of the attribute in the grid table (in the database) should be different from the column identifier col.xyz.allow.roles — Used in the context of a userlist column type - allows to limit the listed users to specific groups col.xyz.checked — When the checkbox is checked - show this value col.xyz.autocomplete — When you want a type-ahead drop down list allowing to filter on specific values in the list. col.xyz.list.size — In case of a static list, specify the number of list entries col.xyz.allow.groups — Used in the context of a userlist column type - allows to limit the listed users to specific groups col.xyz.firstDayOfTheWeek — Specifies first day of the week in the datepicker for date and datetime columns col.xyz.defaultSort — Use this property to specify a default sorting when viewing a grid col.xyz.formatnumber.decimalSeparator — Use this property to change the decimal separator when using the property col.xyz.formatnumber col.xyz.uniqueSequence — This property defines if the sequence is unique (is restarted) for each Jira issue or not. col.xyz.minValue — Specify a minimum value for a number or integer column. Will show an alert if the number is lower than the minValue col.xyz.width — Specify the width of the column in pixels col.xyz.plain.width — Specify the width of the column in pixels for raw grid representation (Issue Search, Printable export) col.xyz.maxLength — Limits the number of characters which can be entered in a text or textarea columns col.xyz.parseurl — By default, the grid addon will process any character sequence of the form 'a:b' in columns of type textarea and string and turn these into a clickable url. col.xyz.query.ds — When a list is initialized with a query, use this property to specify which database should be used. col.xyz.maxValue — Specify a maximum value for a number or integer column. Will show an alert if the number is higher than the maxValue col.xyz.editable — Use this to indicate if a column should be readonly or not col.xyz.unchecked — When the checkbox is unchecked - show this value col.xyz.allow.disabled — The col.xyz.type = userlist allows to list all users in a dropdown. The normal behaviour is to list only the active users. This property allows to modify to include the disabled users. col.xyz.renderer — Specify how the content of a string or textarea should be rendered. Two options - text or wiki col.xyz.formatnumber.groupingSeparator — Use this property to change the grouping separator when using the col.xyz.formatnumber property col.xyz.sequencePrefix — Use this label to prefix the sequence number when viewing the rows in a grid col.xyz.formatnumber — Use this property to format a number according to a particular pattern. col.xyz — Define the column header of a single column col.xyz.query - customfield — When you want to reuse options provided in a custom field col.xyz.tooltip — Add a short explanation of what is expected to be filled in a column
MLCF details	Specify general Multi Level Cascade field details using these properties mc.ds — Use mc.ds to select the database where the Multi Cascade field should be maintained mc.view — Use this to define if the multi cascade select lists (levels) will be displayed, in edit mode, horizontal or vertical mc.query — Use this to define Simple Config, to specify the query of the Multi Cascade's with one level (select list) mc.levels — Use this to specify what levels should Multi Cascade Field contain
MLCF level's details	Specify details for the levels of your Multi Level Cascade custom field level.xyz.query.ds — Specify on which datasource a query for the given level needs to be run. level.xyz.viewColumn — Specify the name of the column which value will be displayed while editing and for saved dropdown options level.xyz.label — Use this to specify the display title of the Multi Cascade's level (select list) level.xyz.query — Use this to specify the query of the Multi Cascade's level (select list) level.xyz.width — Use this to specify the width of the Multi Cascade's level (select list) level.xyz.storeColumn — Specify the name of the column which value will be saved as a value of the selected dropdown option
issue values	Issue values can be reused in queries to build grids in a dynamic way