Grid Display Parameters
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