Page tree
Skip to end of metadata
Go to start of metadata

All properties listed alphabetically can be found on the Grid Property - full list

Grid details properties

List of properties, that help to specify grid details. They apply to the complete grid.

You can enable grid features by adding the property to the configuration. 

gd.allowAddRows Enable or disable the possibility to add rows
gd.cleanupTable Delete rows from the gridtable when containing issue is deleted.
gd.columns Use this to specify what columns should be displayed on the grid
gd.decimalSeparator Use this to specify <span>the default decimal separator for any grid column of type &apos;number&apos;</span>
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 &apos;delete non modified&apos; or &apos;delete duplicates&apos;
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.enableXSSValidation <span style="color: rgb(0,0,0);">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). </span>
gd.filter Enable filtering capabilities on the grid such that a user can filter out rows based on a search term
gd.insertChangeComments Insert grid changes as comments to the issue
gd.readonly When you want to use the grid for displaying purposes only
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.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.tablename Provide the base name of the grid table
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.


Grid display properties


You can specify grid display format (height, width, ...) using these properties.

gd.caption Sets grid caption
gd.collapseDefault Use collapseDefault to indicate what the collapse status of a grid is when viewed for the first time by a user.
gd.displayCondition Specify the condition when a grid should be showed in the view edit screen
gd.extraHeight Add some extra space below the last row, to avoid that the horizontal scroll bar potentially overlaps the last row.
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. <br />gd.fitcolumns allows to change the behaviour, such that the columns are resized or not.
gd.hideFooter Hides grid footer (toolbar with pagination and all buttons in edit mode)
gd.hideHeader Hides grid header
gd.issueNavigatorLayout.header Defines the visibility of a grid&apos;s header in issue navigator
gd.maxDisplayGridHeight Maximum height of a non collapsed grid expressed in pixels
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.minDisplayGridHeight Minimum height of a non collapsed grid expressed in pixels
gd.minDisplayRowCount Minimum number of rows to display.
gd.minDisplayRowHeight Minimum height of a row expressed in pixels
gd.pagination.size Specifies the number of rows on a single grid page
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.toolbar.disable Hide particular buttons on the grid toolbar
gd.visiblerows specify how many rows a grid should contain

The parameters have an effect on each other.  The plugin tries to show as much information as possible, avoiding the need to display horizontal or vertical scroll bars.  There are many different factors that influence this layout.  The Grid layout components provide some insights.

The priorities of the parameters are as follows

  • gd.maxDisplayGridHeight has always more priority than gd.minDisplayRowCount 
    if the the row height=1 and gd.minDisplayRowCount=10 then the grid height should be at least 10, but
    if gd.maxDisplayGridHeight=5, then the height of grid will be 5.
    The gd.minDisplayRowCount rule is be overriden by the maxDisplayGridHeight rule.
  • gd.minDisplayGridHeight has always more priority than gd.maxDisplayRowCount.
    if gd.minDisplayGridHeight = 100, gd.maxDisplayRowCount=3 and gd.minDisplayRowHeight=5, then the resulting grid height is 100
  • gd.maxDisplayGridHeight has more priority than gd.minDisplayRowHeight



Grid initialization properties


You don't need to start with an empty grid. Check grid reload for more details.

You can initialize a grid either statically or dynamically with the help of these properties. 

To initialize a grid statically use the gd.query.row properties.

To initialize a grid dynamically use the gd.query and gd.query.ds properties. 

gd.ds <pre>Use this to specify a different grid storage database - for instance the JIRA database, or a database source specification.</pre>
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.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.query A query, used to initialize the grid when the issue is created, when the grid is reloaded using the <strong>reload button</strong> or when a dependent custom field is changed.<p>Note that this property is applied only on the creation of the issue.</p>
gd.query.columns Use this property to specify which columns should be initialized with the results of a query.
gd.query.ds Specify on which datasource a query needs to be run.
gd.query.keepOnRefresh specifies which rows can be removed when reloading the grid
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.reloadTrigger Allows to reload the grid on issue view or update
gd.query.row Use this property to initialize a grid with static data.

If a grid contains static and dynamic initialization properties, both will be used to set up initial data.

For example,  when the grid configuration contains properties as below, it will be initialized with all the employees aged 25 or younger, and the 2 static entries (Brad Pitt and Angelina Jolie).

gd.columns = firstname, lastname
gd.query = select firstname, lastname from employees where age < 26
gd.query.ds= employeedb
gd.query.row1 = Brad, Pitt
gd.query.row2 = Angelina, Jolie

Column details properties


You can define one or more properties for each grid column, specified in gd.columns.

xyz  is a placeholder for the actual column id

PropertyUsage Define the column header of a single column Horizontal align the content of a column left, middle or center The = 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. Used in the context of a userlist column type - allows to limit the listed users to specific groups Used in the context of a userlist column type - allows to limit the listed users to specific groups When you want a type-ahead drop down list allowing to filter on specific values in the list. When the checkbox is checked - show this value  Specify the number of characters on a single line when editing a cell of a textarea column  initialize a date column with a date calculated from now. Use this property to specify a default sorting when viewing a grid Specify a default value for a column when adding one or more rows Use this to indicate if a column should be readonly or not <span style="color: rgb(0,0,0);">Specifies first day of the week in the datepicker for date and datetime columns</span> Format the date when a column is a date type Use this property to format a number according to a particular pattern. Use this property to change the decimal separator when using the property Use this property to change the grouping separator when using the property Set the format of options of the userlist column Use the formula property to calculate the content of a column. String, math and conditional expressions are supported Hide a column from displaying on the grid The allows to specify in which grid mode a field must be hidden. Set the first value of a sequence In case of a static list, specify the number of list entries Limits the number of characters which can be entered in a text or textarea columns Specify a maximum value for a number or integer column. Will show an alert if the number is higher than the maxValue Specify a mininum value for a number or integer column. Will show an alert if the number is lower than the minValue When the name of the attribute in the grid table (in the database) should be different from the column identifier<tracking field> When you want to display in a grid the values of a tracking field. <br />(A tracking field keeps track when and by whom a row in the grid table has been created / updated) Used to specify the label of a static list entry By default, the grid addon will process any character sequence of the form &apos;a:b&apos; in columns of type textarea and string and turn these into a clickable url.<br />This property allows to disable this behaviour Specify the width of the column in pixels for raw grid representation (Issue Search, Printable export) Specify a source to initialize a list - customfield When you want to reuse options provided in a custom field When a list is initialized with a query, use this property to specify which database should be used. Specify how the content of a string or textarea should be rendered. Two options - text or wiki Specify if a column can be empty or not Specify the number of lines of the textarea when editing a cell of a textarea column Use this label to prefix the sequence number when viewing the rows in a grid Specify if a column is sortable or not Adds an additonal row with a summary of the column. This summary can be either &apos;sum&apos;, &apos;avg&apos;, &apos;count&apos;, &apos;min&apos;, &apos;max&apos; or just a label such as &apos;total:&apos; Add a short explaination what is expected to be filled in a column When the checkbox is unchecked - show this value  This property defines if the sequence is unique (is restarted) for each Jira issue or not. Specify a value for a specific entry in a list Specify the width of the column in pixels

Column types properties


You can set the grid column type using these properties. Here is the list of available types and their specific behavior.

PropertyUsage Specify what type of values can be stored in a column, defines the behaviour of the plugin. = checkbox  Show checkbox options when editing a cell. = date Formats the column as a date. When editing a cell, brings up a calendar popup. = datetime Enter a date time field = integer Use this when the column should store plain integer number fields such as 1234, -789, ... = list Create a dropdown list which is either initialized using a static list or using a query. = number Use this when the column should store number fields with a decimal (such as 1.5, -212.34 ...) = radio  To present a radio button group to the user = sequence Give each row in the grid a unique id. = string The column is used to enter a single line of text. = textarea This type allows the user to enter multiple lines of text = userlist This column type provides a dropdown listing JIRA users. This type has additional properties allowing to filter the users

Datasource details properties


These properties are meant to setup a configuration specific connection to a database.
Alternatively (and recommended approach) is to use the Datasource Specifications  

datasource.names define the datasources in use in this grid. Further specified in [database detail = mysql Use this to create a database source which connects to a mysql type of database. = oracle Use this to create a database source which connects to an oracle database. = postgres Use this to create a database source which connects to a postgres database. = sqlserver Use this to create a database source which connects to a MS Sql Server type of database. = sybase Use this to create a database source which connects to an sybase database.

Table of contents

  • No labels