Documentation

Namespace: SuperGrid_Options

SuperGrid_Options

Options for the SuperGrid widget

Members

accessibility :boolean

Defines if accessibility mode should be enabled. Note: This options will automatically several options if enabled
Type:
  • boolean
Default Value:
  • True

colReorder :boolean

Defines if column reordering should be enabled. If enabled this will allow the user to reorder columns by dragging the columns header to a new place.
Type:
  • boolean
Default Value:
  • False

colResize :boolean

Enables Columns to be resizable or fixed.
Type:
  • boolean
Default Value:
  • False

fixedHeader :Object

Allows SuperGrid to compute it's own height based on the parent container's height. The parent container must have a height or weird things will happen. The body's height will be calculated by taking the container height and subtracting the (relatively fixed) height of the header and footer. Optionally you can provide an arbitrary amount of height to remove from grid body in addition to the standard math. This can be useful to allow you to scale the grid to changes in the screen size.
Type:
  • Object
Properties:
Name Type Description
fixedHeader object The fixedHeader option object.
Properties
Name Type Description
enabled boolean Turns on/off auto height calculation.
removeHeight number A number in pixels to remove from the body in addition to the header and footer height.
Default Value:
  • False

pageSize :Number

Defines how many rows should be on a page. Must be at least 1 page, if the page size is larger than the number of rows of data then only 1 page will be shown.
Type:
  • Number
Default Value:
  • 25

paginate :boolean

Defines if pagination should be enabled. If enabled this will provide a basic paging footer Note: This options will be automatically disabled if accessibility is enabled.
Type:
  • boolean
Default Value:
  • True