Given its functionality, not all properties available for a table grid editor are supported. Don't hesitate to raise a request (here) to add support for properties we might have missed.
Grid 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.
- 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'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
- Grid layout components
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 100gd.maxDisplayGridHeight has more priority than gd.minDisplayRowHeight
Column 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
- col.xyz — Define the column header of a single column
- col.xyz.align — Horizontal align the content of a column left, middle or center
- 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.allow.groups — Used in the context of a userlist column type - allows to limit the listed users to specific groups
- col.xyz.allow.roles — Used in the context of a userlist column type - allows to limit the listed users to specific groups
- col.xyz.autocomplete — When you want a type-ahead drop down list allowing to filter on specific values in the list.
- col.xyz.checked — When the checkbox is checked - show this value
- col.xyz.cols — Specify the number of characters on a single line when editing a cell of a textarea column
- col.xyz.defaultDate — initialize a date column with a date calculated from now.
- col.xyz.defaultSort — Use this property to specify a default sorting when viewing a grid
- col.xyz.defaultValue — Specify a default value for a column when adding one or more rows
- col.xyz.editable — Use this to indicate if a column should be readonly or not
- col.xyz.firstDayOfTheWeek — Specifies first day of the week in the datepicker for date and datetime columns
- col.xyz.formatDate — Format the date when a column is a date type
- col.xyz.formatnumber — Use this property to format a number according to a particular pattern.
- col.xyz.formatnumber.decimalSeparator — Use this property to change the decimal separator when using the property col.xyz.formatnumber
- col.xyz.formatnumber.groupingSeparator — Use this property to change the grouping separator when using the col.xyz.formatnumber property
- col.xyz.formatUser — Set the format of options of the userlist column
- col.xyz.formula — Use the formula property to calculate the content of a column. String, math and conditional expressions are supported
- col.xyz.hidden — Hide a column from displaying on the grid
- col.xyz.hidemode — The col.xyz.hidemode allows to specify in which grid mode a field must be hidden.
- col.xyz.initialValue — Set the first value of a sequence
- col.xyz.list.size — In case of a static list, specify the number of list entries
- col.xyz.maxLength — Limits the number of characters which can be entered in a text or textarea columns
- 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.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.name — When the name of the attribute in the grid table (in the database) should be different from the column identifier
- col.xyz.name=<tracking field> — When you want to display in a grid the values of a tracking field.
- col.xyz.nameX — Used to specify the label of a static list entry
- 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.plain.width — Specify the width of the column in pixels for raw grid representation (Issue Search, Printable export)
- col.xyz.query — Specify a source to initialize a list
- col.xyz.query.ds — When a list is initialized with a query, use this property to specify which database should be used.
- col.xyz.query - customfield — When you want to reuse options provided in a custom field
- col.xyz.renderer — Specify how the content of a string or textarea should be rendered. Two options - text or wiki
- col.xyz.required — Specify if a column can be empty or not
- col.xyz.rows — Specify the number of lines of the textarea when editing a cell of a textarea column
- col.xyz.sequencePrefix — Use this label to prefix the sequence number when viewing the rows in a grid
- col.xyz.sortable — Specify if a column is sortable or not
- 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.tooltip — Add a short explanation of what is expected to be filled in a column
- col.xyz.unchecked — When the checkbox is unchecked - show this value
- col.xyz.uniqueSequence — This property defines if the sequence is unique (is restarted) for each Jira issue or not.
- col.xyz.valueX — Specify a value for a specific entry in a list
- col.xyz.width — Specify the width of the column in pixels