Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 4 Current »

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.


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



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.xyzDefine the column header of a single column
  • col.xyz.alignHorizontal align the content of a column left, middle or center
  • col.xyz.allow.disabledThe 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.groupsUsed in the context of a userlist column type - allows to limit the listed users to specific groups
  • col.xyz.allow.rolesUsed in the context of a userlist column type - allows to limit the listed users to specific groups
  • col.xyz.autocompleteWhen you want a type-ahead drop down list allowing to filter on specific values in the list.
  • col.xyz.checkedWhen 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.defaultSortUse this property to specify a default sorting when viewing a grid
  • col.xyz.defaultValueSpecify a default value for a column when adding one or more rows
  • col.xyz.editableUse this to indicate if a column should be readonly or not
  • col.xyz.firstDayOfTheWeekSpecifies first day of the week in the datepicker for date and datetime columns
  • col.xyz.formatDateFormat the date when a column is a date type
  • col.xyz.formatnumberUse this property to format a number according to a particular pattern.
  • col.xyz.formatnumber.decimalSeparatorUse this property to change the decimal separator when using the property col.xyz.formatnumber
  • col.xyz.formatnumber.groupingSeparatorUse this property to change the grouping separator when using the col.xyz.formatnumber property
  • col.xyz.formatUserSet the format of options of the userlist column
  • col.xyz.formulaUse the formula property to calculate the content of a column. String, math and conditional expressions are supported
  • col.xyz.hiddenHide a column from displaying on the grid
  • col.xyz.hidemodeThe col.xyz.hidemode allows to specify in which grid mode a field must be hidden.
  • col.xyz.initialValueSet the first value of a sequence
  • col.xyz.list.sizeIn case of a static list, specify the number of list entries
  • col.xyz.maxLengthLimits the number of characters which can be entered in a text or textarea columns
  • col.xyz.maxValueSpecify a maximum value for a number or integer column. Will show an alert if the number is higher than the maxValue
  • col.xyz.minValueSpecify a minimum value for a number or integer column. Will show an alert if the number is lower than the minValue
  • col.xyz.nameWhen 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.nameXUsed to specify the label of a static list entry
  • col.xyz.parseurlBy 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.widthSpecify the width of the column in pixels for raw grid representation (Issue Search, Printable export)
  • col.xyz.querySpecify a source to initialize a list
  • col.xyz.query.dsWhen a list is initialized with a query, use this property to specify which database should be used.
  • col.xyz.query - customfieldWhen you want to reuse options provided in a custom field
  • col.xyz.rendererSpecify how the content of a string or textarea should be rendered. Two options - text or wiki
  • col.xyz.requiredSpecify if a column can be empty or not
  • col.xyz.rowsSpecify the number of lines of the textarea when editing a cell of a textarea column
  • col.xyz.sequencePrefixUse this label to prefix the sequence number when viewing the rows in a grid
  • col.xyz.sortableSpecify if a column is sortable or not
  • col.xyz.summaryAdds 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.tooltipAdd a short explanation of what is expected to be filled in a column
  • col.xyz.uncheckedWhen 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.valueXSpecify a value for a specific entry in a list
  • col.xyz.widthSpecify the width of the column in pixels
  • No labels