OptTableAgGrid Module

class epyk.core.html.options.OptTableAgGrid.AggFnc(options: Options, name: str, js_tree: Optional[bool] = None, page: Optional[PageModel] = None)
null()

Related Pages:

sum()

Related Pages:

class epyk.core.html.options.OptTableAgGrid.CellEditor(options: Options, name: str, js_tree: Optional[bool] = None, page: Optional[PageModel] = None)
agRichSelectCellEditor(values, **kwargs)

Related Pages:

Parameters:

values –

class epyk.core.html.options.OptTableAgGrid.CellRenderer(options: Options, name: str, js_tree: Optional[bool] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptTableAgGrid.ColOrder(options: Options, name: str, js_tree: Optional[bool] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptTableAgGrid.ColType(options: Options, name: str, js_tree: Optional[bool] = None, page: Optional[PageModel] = None)
dateColumn()

Related Pages:

medalColumn()

Related Pages:

nonEditableColumn()

Related Pages:

numberColumn()

Related Pages:

numericColumn()

Related Pages:

rightAligned()

Related Pages:

class epyk.core.html.options.OptTableAgGrid.Column(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
add_children(attrs: dict)

Integrated way to add children to the header definition.

Parameters:

attrs – The different columns properties to set.

property cellClassRules

Rules that return true will have the class applied the second time. Rules that return false will have the class removed second time.

Related Pages:

property cellRenderer

Change the cell rendering.

Usage:

c = table.get_column("city")
c.cellRenderer = ''' function(param){
return '<span><i class="far fa-comments"></i>Test '+ param.value +'</span>'} '''

Related Pages:

property cellRendererParams

On top of the parameters provided by the grid, you can also provide your own parameters. This is useful if you want to ‘configure’ your Cell Renderer. For example, you might have a Cell Renderer for formatting currency but you need to provide what currency for your cell renderer to use.

Related Pages:

property cellRenderers: CellRenderer

Related Pages:

https://www.ag-grid.com/archive/27.1.0/javascript-data-grid/component-cell-renderer/

property cellStyle

Rules that return true will have the class applied the second time. Rules that return false will have the class removed second time.

Related Pages:

property children

Related Pages:

https://www.ag-grid.com/javascript-grid-grouping-headers/

property colId

Related Pages:

https://www.ag-grid.com/javascript-grid-grouping-headers/

property columnGroupShow

values closed, open.

Related Pages:

property comparator

Custom sorting is provided at a column level by configuring a comparator on the column definition.

Related Pages:

property editor: CellEditor

Cell editing format

Related Pages:

property enableCellChangeFlash

The grid can flash cells to highlight data changes. This is a great visual indicator to users of the grid who want data changes to be noticed.

Related Pages:

property enableRowGroup

Allow every column to be grouped.

Related Pages:

property filterValueGetter

Function or expression. Gets the value for filtering purposes.

Related Pages:

property filters: ColumnFilter

Set filtering on a column using the column definition property filter. The property can have one of the following values:

Related Pages:

property flex

It’s often required that one or more columns fill the entire available space in the grid. For this scenario, it is possible to use the flex config. Some columns could be set with a regular width config, while other columns would have a flex config.

Related Pages:

property floatingFilterComponent

Related Pages:

https://www.ag-grid.com/javascript-data-grid/component-floating-filter/

property floatingFilterComponentParams

Related Pages:

https://www.ag-grid.com/javascript-data-grid/component-floating-filter/

property groupDisplayType

To display each row group using group rows set groupDisplayType = ‘groupRows’ as shown below:

Related Pages:

property groupRowsSticky

To enable sticky groups, set the groupRowsSticky property to true. This behaviour applies to all row group levels.

Related Pages:

property headerCheckboxSelection

If true or the callback returns true, a ‘select all’ checkbox will be put into the header. See Header Checkbox Selection.

Related Pages:

property headerCheckboxSelectionCurrentPageOnly

Related Pages:

https://www.ag-grid.com/javascript-data-grid/row-selection/

property headerClass

Similarly to styling cells, the grid will use the result of headerClass from the column definition to style the grid headers.

Related Pages:

property headerName

The name to render in the column header. If not specified and field is specified, the field name will be used as the header name.

Related Pages:

property headerTooltip

When we want to display a header tooltip, we set the headerTooltip config as a string, and that string will be displayed as the tooltip.

Related Pages:

property headerValueGetter

Function or expression. Gets the value for display in the header.

Related Pages:

property hide

True if the column is hidden, otherwise false.

Related Pages:

property lockPinned

If you do not want the user to be able to pin using the UI, set the property lockPinned=true. This will block the UI in the following way:

Related Pages:

property lockPosition

The column property lockPosition locks columns to the first position in the grid.

Related Pages:

property marryChildren

Sometimes you want columns of the group to always stick together. To achieve this, set the column group property marryChildren=true. The example below demonstrates the following:

property resizable

Turn column resizing on for the grid by setting resizable=true for each column. To set resizing for each column, set resizable=true on the default column definition.

Related Pages:

property rowGroupIndex

The index of the row group. If the column is not grouped, this field is null. If multiple columns are used to group, this index provides the order of the grouping.

Related Pages:

property rowSpan

By default, each cell will take up the height of one row. You can change this behaviour to allow cells to span multiple rows. This feature is similar to ‘cell merging’ in Excel or ‘row spanning’ in HTML tables.

Related Pages:

rowSpanFunc(data: Union[str, JsDataModel, float, dict, list, bool])

Set a rowSpan function. This can be a callback function or even a string pointing to a JavaScript function.

Related Pages:

Parameters:

data – JavaScript expression

property sort

Custom sorting is provided at a column level.

Related Pages:

property sortingOrder

It is possible to override this behaviour by providing your own sortingOrder on either the gridOptions or the colDef. If defined both in colDef and gridOptions, the colDef will get preference, allowing you to defined a common default, and then tailoring per column.

Related Pages:

property sorts

Cell editing format

Related Pages:

property suppressCellFlash

Related Pages:

https://www.ag-grid.com/javascript-grid-refresh/

property suppressColumnsToolPanel

Related Pages:

https://www.ag-grid.com/javascript-data-grid/tool-panel-columns/#column-tool-panel-example

property suppressMenu

Related Pages:

https://www.ag-grid.com/javascript-data-grid/component-floating-filter/

property suppressMovable

The column property suppressMovable changes whether the column can be dragged.

Related Pages:

property suppressSizeToFit

If you don’t want a particular column to be included in the auto resize, then set the column definition suppressSizeToFit=true. This is helpful if, for example, you want the first column to remain fixed width, but all other columns to fill the width of the table.

Related Pages:

property toolPanelClass

Related Pages:

https://www.ag-grid.com/javascript-data-grid/tool-panel-columns/#column-tool-panel-example

property tooltipField

//www.ag-grid.com/javascript-data-grid/component-tooltip/

Type:

https

property types: ColType

Related Pages:

https://www.ag-grid.com/javascript-data-grid/column-definitions/#default-column-definitions

property unSortIcon

Custom sorting is provided at a column level.

Related Pages:

property valueFormatter

Value formatters allow you to format values for display. This is useful when data is one type (e.g. numeric) but needs to be converted for human reading (e.g. putting in currency symbols and number formatting).

Related Pages:

property valueGetter

Related Pages:

https://www.ag-grid.com/javascript-data-grid/column-definitions/#default-column-definitions

property valueSetter

Related Pages:

https://www.ag-grid.com/javascript-data-grid/value-setters/

property wrapHeaderText

If enabled then column header names that are too long for the column width will wrap onto the next line. Default false

Related Pages:

class epyk.core.html.options.OptTableAgGrid.ColumnFilter(options: Options, name: str, js_tree: Optional[bool] = None, page: Optional[PageModel] = None)
agDateColumnFilter(**kwargs)

A Date Filter for date comparisons.

Related Pages:

agNumberColumnFilter()

A Number Filter for number comparisons.

Related Pages:

agSetColumnFilter(filter_name)

A Set Filter, influenced by how filters work in Microsoft Excel. This is an ag-Grid-Enterprise feature.

Related Pages:

agTextColumnFilter(**kwargs)

A Text Filter for string comparisons.

Related Pages:

class epyk.core.html.options.OptTableAgGrid.DefaultColDef(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property cellRenderer

Change the cell rendering.

Usage:

c = table.get_column("city")
c.cellRenderer = ''' function(param){
return '<span><i class="far fa-comments"></i>Test '+ param.value +'</span>'} '''

Related Pages:

property cellRendererParams: CellRendererParams
property cellRenderers: CellRenderer

Related Pages:

https://www.ag-grid.com/archive/27.1.0/javascript-data-grid/component-cell-renderer/

property editable

make every column editable

property field

Related Pages:

https://www.ag-grid.com/javascript-data-grid/component-floating-filter/

property filter

set a filter for every columns.

property filters

Set filtering on a column using the column definition property filter. The property can have one of the following values:

Related Pages:

property flex

It’s often required that one or more columns fill the entire available space in the grid. For this scenario, it is possible to use the flex config. Some columns could be set with a regular width config, while other columns would have a flex config.

Related Pages:

property floatingFilter

Floating Filter Components allow you to add your own floating filter types to AG Grid. You can create a Custom Floating Filter Component to work alongside one of the grid’s Provided Filters, or alongside a Custom Filter.

Related Pages:

property groupDefaultExpanded

To open all groups down to a given group level use the groupDefaultExpanded grid option as shown below:

Related Pages:

property headerName

Related Pages:

https://www.ag-grid.com/javascript-data-grid/component-floating-filter/

property resizable

Turn column resizing on for the grid by setting resizable=true for each column. To set resizing for each column, set resizable=true on the default column definition.

Related Pages:

property suppressMovable

The column property suppressMovable changes whether the column can be dragged.

Related Pages:

property treeData

Related Pages:

https://www.ag-grid.com/documentation/javascript/tree-data/

property width

set every column width.

Related Pages:

class epyk.core.html.options.OptTableAgGrid.EnumStatusPanelsPanels(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.Enums(options: Options, name: str, js_tree: Optional[bool] = None, page: Optional[PageModel] = None)
property item

Return the option object on which the key, value will be added.

property key

Returns the predefined enumeration key which will be added with this object.

class epyk.core.html.options.Options(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property builder

Add a JavaScript Builder function to the options.

This will be used to automatically map the Python component to its corresponding JavaScript builder function used by the build method.

Usage:

but = page.ui.button()
but.options.builder = "Button"
Prop value:

The JavaScript builder function name.

property config_default

The default value for the configuration in case of template.

Default value is an empty string.

Usage:

component.options.config_default = {"value": "test"}
config_html()

Return the HTML options used by the python and passed to the HTML.

Those options will not be available in the JavaScript layer and they are only defined either to build the HTML from Python or to set some HTML properties.

The returned dictionary is a copy so it can be changed or used in other processes. To change the internal component property, the options property should be used.

config_js(attrs: Optional[dict] = None)

Return the JavaScript options used by the builders functions.

Builder functions can be defined in the framework or external from the various packages.

The returned dictionary is a copy so it can be changed or used in other processes. To change the internal component property, the options property should be used.

Parameters:

attrs – Optional. The extra or overridden options

custom_config(name: str, value: Any, js_type: bool = False)

Add a custom JavaScript configuration.

Usage:

chart = page.ui.charts.apex.scatter()
chart.options.chart.zoom.custom_config("test", False)
Parameters:

  • name – The key to be added to the attributes

  • value – String or JString. The value of the defined attributes

  • js_type – Optional. Specify if the parameter is a JavaScript fragment

details()

Retrieve the defined properties details.

This function will return a dictionary with all the component attributes (required and optional) ones. It will provide the full available description of those components.

Usage:

but = page.ui.button()
pprint.pprint(but.options.details(), indent=4)
from_json(vals: dict, schema: Optional[dict] = None)

Load the option schema for a component from a json string.

TODO: add more feature to handle functions and enumeration

Parameters:

  • vals – The input schema

  • schema – The full object schema

has_attribute(cls_obj, name: Optional[str] = None)

Add an extra sub layer to the data structure.

The key in the object representation will be the function name.

Parameters:

  • cls_obj – Class. The sub data class used in the structure definition

  • name – The sub attribute name

isJsContent(property_name: str)

Check if the content of a property is defined to always be a JavaScript fragment.

Thus the framework will not convert it to a Json content.

Usage:

div = page.ui.div()
print(div.options.isJsContent("inline"))
Parameters:

property_name – The property name

property managed

Boolean flag to set if the component needs to be added to the page.

If set to False the component has to be managed manually in the page.

Usage:

but = page.ui.button()
but.options.managed = False
Prop bool:

Flag to specify if this component is automatically managed by the page

optional()

Return all options not added to the HTML component by default.

Those are options which will impact either the Python or the JavaScript builders.

To get the full definition of options the details method should be used.

Usage:

but = page.ui.button()
pprint.pprint(but.options.optional(), indent=4)
property profile

Boolean flag to set if extra logs need to be displayed.

This could help in debugging, default is the page verbose flag (default is false).

Usage:

but = page.ui.button()
but.options.verbose = True
Prop flag:

Flag to display / hide warning logs generated by the framework.

required()

Return all the mandatory / required options with the default values.

Those options are added by the framework to provide a default for the HTML components but they can be changed.

System options are also added to this category as they are always available in any HTML components.

To get the full definition of options the details method should be used.

Usage:

but = page.ui.button()
pprint.pprint(but.options.required(), indent=4)
set_attrs(vals: dict)

Set the object internal attributes.

Parameters:

vals – All the attributes to be added to the component

property style

Change some CSS attributes to the internal HTML component.

Related Pages:

Prop values:

The CSS attributes.

update_config(attrs: dict)

Update the option configuration.

Parameters:

attrs – The attributes to set

property verbose

Boolean flag to set if extra logs need to be displayed.

This could help in debugging, default is the page verbose flag (default is false).

Usage:

but = page.ui.button()
but.options.verbose = True
Prop flag:

Boolean. Flag to display / hide warning logs generated by the framework.

class epyk.core.html.options.OptTableAgGrid.TableConfig(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
property alignedGrids

To have one (the first) grid reflect column changes in another (the second), place the first grid’s options in alignedGrids property of the second grids.

Related Pages:

property allowContextMenuWithControlKey

If you always want the grid’s context menu, even when Ctrl is pressed, then set allowContextMenuWithControlKey=true.

Related Pages:

property animateRows

Row animations occur after filtering, sorting, resizing height and expanding / collapsing a row group. Each of these animations is turned OFF by default. They are all turned on using the property animateRows=true.

Related Pages:

property cacheBlockSize

Related Pages:

http://54.222.217.254/javascript-grid-server-side-model-tree-data/

property colResizeDefault

If you hold ‘shift’ while dragging the resize handle, the column will take space away from the column adjacent to it. This means the total width for all columns will be constant.

You can also change the default behaviour for resizing. Set grid property colResizeDefault=’shift’ to have shift resizing as default and normal resizing to happen when shift key is pressed.

Related Pages:

property columnTypes

Define a column type (you can define as many as you like. Expect a valid Json object.

Related Pages:

property columns: Column

Set the columnDefs with all the column properties.

Related Pages:

property data

Update the Row Data inside the grid by updating the rowData grid property or by calling the grid API setRowData().

Related Pages:

property debug

Related Pages:

https://www.ag-grid.com/javascript-data-grid/data-update-row-data/

property defaultColDef: DefaultColDef

Contains properties that all columns will inherit.

Related Pages:

property editType

Related Pages:

property enableColResize

Related Pages:

http://54.222.217.254/javascript-grid-server-side-model-tree-data/

property enablePivot

Allow every column to be pivoted

Related Pages:

property enableRangeSelection

Related Pages:

https://www.ag-grid.com/javascript-data-grid/context-menu/

property enableValue

This means you can drag the columns to the values section, but you cannot drag them to the group or pivot sections.

Related Pages:

property ensureDomOrder

Ensures the rows and columns in the DOM always appear in the same order as displayed in the grid.

Related Pages:

property enterMovesDown

Set to true to have Enter key move focus to the cell below if not editing. The default is Enter key starts editing the currently focused cell.

Related Pages:

property enterMovesDownAfterEdit

Set to true to have Enter key move focus to the cell below after Enter is pressed while editing. The default is editing will stop and focus will remain on the editing cell.

Related Pages:

property functionsReadOnly

By setting the property functionsReadOnly=true, the grid will prevent changes to group, pivot or values through the GUI. This is useful if you want to show the user the group, pivot and values panel, so they can see which columns are used, but prevent them from making changes to the selection.

Related Pages:

getRowClass(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None, func_ref: bool = False)

Callback version of property rowClass to set class(es) for each row individually. Function should return either a string (class name), array of strings (array of class names) or undefined for no class.

Related Pages:

Parameters:

  • js_funcs – The Javascript functions

  • profile – Optional. A flag to set the component performance storage

  • func_ref – Optional. Specify if js_funcs point to an external function

getServerSideGroupKey(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None, func_ref: bool = False)
Parameters:

  • js_funcs – The Javascript functions

  • profile – Optional. A flag to set the component performance storage

  • func_ref – Optional. Specify if js_funcs point to an external function

property groupAggFiltering

Related Pages:

https://www.ag-grid.com/javascript-data-grid/tree-data/

property groupDefaultExpanded

To open all groups down to a given group level use the groupDefaultExpanded grid option as shown below:

Related Pages:

property groupIncludeFooter

If you want to include a footer with each group, set the property groupIncludeFooter to true. It is also possible to include a ‘grand’ total footer for all groups using the property groupIncludeTotalFooter.

Related Pages:

property groupIncludeTotalFooter

Related Pages:

https://www.ag-grid.com/archive/26.0.0/javascript-data-grid/grouping-footers/

property groupSelectsChildren

Filler groups do not keep their selection state should the filler group be moved.

For example if you have groups A->B->C, where C is the only row provided (so the grid creates groups A and B for you), and then you change the patch to D->B->C, group B will not keep it’s selection.

Related Pages:

isGroupOpenByDefault(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None, func_ref: bool = False)
Parameters:

  • js_funcs – The Javascript functions

  • profile – Optional. A flag to set the component performance storage

  • func_ref – Optional. Specify if js_funcs point to an external function

isServerSideGroup(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None, func_ref: bool = False)
Parameters:

  • js_funcs – The Javascript functions

  • profile – Optional. A flag to set the component performance storage

  • func_ref – Optional. Specify if js_funcs point to an external function

property maxBlocksInCache

Related Pages:

http://54.222.217.254/javascript-grid-server-side-model-tree-data/

on(event_type: str, js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None, func_ref: bool = False)

Related Pages:

Parameters:

  • event_type – The event type

  • js_funcs – The Javascript functions

  • profile – Optional. A flag to set the component performance storage

  • func_ref – Optional. Specify if js_funcs point to an external function

onCellEditingStopped(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None, func_ref: bool = False)

Editing a cell has stopped.

Related Pages:

Parameters:

  • js_funcs – The Javascript functions

  • profile – Optional. A flag to set the component performance storage

  • func_ref – Optional. Specify if js_funcs point to an external function

onCellValueChanged(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None, func_ref: bool = False)

Value has changed after editing (this event will not fire if editing was cancelled, eg ESC was pressed) or if cell value has changed as a result of paste operation.

Related Pages:

Parameters:

  • js_funcs – The Javascript functions

  • profile – Optional. A flag to set the component performance storage

  • func_ref – Optional. Specify if js_funcs point to an external function

onColumnResized(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None, func_ref: bool = False)

Related Pages:

Parameters:

  • js_funcs – The Javascript functions

  • profile – Optional. A flag to set the component performance storage

  • func_ref – Optional. Specify if js_funcs point to an external function

onGridReady(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None, func_ref: bool = False)

Related Pages:

Parameters:

  • js_funcs – The Javascript functions

  • profile – Optional. A flag to set the component performance storage

  • func_ref – Optional. Specify if js_funcs point to an external function

onPaginationChanged(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None, func_ref: bool = False)

Related Pages:

Parameters:

  • js_funcs – The Javascript functions

  • profile – Optional. A flag to set the component performance storage

  • func_ref – Optional. Specify if js_funcs point to an external function

onRowClicked(js_funcs: Union[List[Union[str, JsDataModel]], str], profile: Optional[Union[bool, dict]] = None, func_ref: bool = False)

Related Pages:

Parameters:

  • js_funcs – The Javascript functions

  • profile – Optional. A flag to set the component performance storage

  • func_ref – Optional. Specify if js_funcs point to an external function

property overlayLoadingTemplate

Provide a plain HTML string to the grid properties overlayLoadingTemplate and overlayNoRowsTemplate.

Related Pages:

property overlayNoRowsTemplate

Provide a plain HTML string to the grid properties overlayLoadingTemplate and overlayNoRowsTemplate.

Related Pages:

property paginateChildRows

Set to true to have pages split children of groups when using Row Grouping or detail rows with Master Detail. See Pagination & Child Rows.

Default: false

Related Pages:

property pagination

To enable pagination in, set the grid property pagination=true. The following simple example shows this, the only difference to this and previous examples is the pagination=true property.

Related Pages:

property paginationAutoPageSize

If you set paginationAutoPageSize=true the grid will automatically show as many rows in each page as it can fit. This is demonstrated below. Note if you resize the display area of the grid, the page size automatically changes. To view this, open the example up in a new tab and resize your browser.

Related Pages:

paginationNumberFormatter()

Allows user to format the numbers in the pagination panel, i.e. ‘row count’ and ‘page number’ labels. This is for pagination panel only, to format numbers inside the grid’s cells (i.e. your data), then use valueFormatter in the column definitions.

Related Pages:

property paginationPageSize

How many rows to load per page. If paginationAutoPageSize is specified, this property is ignored. See Customising Pagination. Default: 100

Related Pages:

property pivotMode

Related Pages:

https://www.ag-grid.com/javascript-data-grid/tool-panel-columns/#column-tool-panel-example

property pivotPanelShow

Related Pages:

https://www.ag-grid.com/javascript-data-grid/tool-panel-columns/#column-tool-panel-example

property popupParent

Related Pages:

https://www.ag-grid.com/javascript-data-grid/csv-export/

property rowBuffer

Sets the number of rows rendered outside of the scrollable viewable area.

Related Pages:

property rowClass

The style properties to apply to all rows. Set to an object of key (style names) and values (style values).

Related Pages:

property rowClassRules

The following snippet shows rowClassRules applying classes to rows using expressions on an age column value:

Related Pages:

property rowDeselection

Set to true to allow rows to be deselected if you hold down Ctrl and click the row. By default, the grid disallows deselection of rows (i.e. once a row is selected, it remains selected until another row is selected in its place).

Related Pages:

property rowGroupPanelShow

Related Pages:

https://www.ag-grid.com/javascript-data-grid/tool-panel-columns/#column-tool-panel-example

property rowHeight

By default, the grid will display rows with a height of 25px. You can change this for each row individually to give each row a different height.

Related Pages:

property rowModelType

Related Pages:

http://54.222.217.254/javascript-grid-server-side-model-tree-data/

property rowMultiSelectWithClick

Set to true to allow multiple rows to be selected with clicks.

For example, if you click to select one row and then click to select another row, the first row will stay selected as well. Clicking a selected row in this mode will deselect the row. This is useful for touch devices where Ctrl and Shift clicking is not an option.

Related Pages:

property rowSelection

Type of row selection, set to either ‘single’ or ‘multiple’ to enable selection. ‘single’ will use single row selection, such that when you select a row, any previously selected row gets unselected. ‘multiple’ allows multiple rows to be selected.

Related Pages:

property rowStyle

Property to set style for all rows. Set to an object of key (style names) and values (style values).

Related Pages:

property rowTotal

Predefined way to add a row total attached to the table.

property sideBar
property singleClickEdit

To change the default so that a single-click starts editing, set the property gridOptions.singleClickEdit = true. This is useful when you want a cell to enter edit mode as soon as you click on it, similar to the experience you get when inside Excel.

Related Pages:

property sortingOrder

It is possible to override this behaviour by providing your own sortingOrder on either the gridOptions or the colDef. If defined both in colDef and gridOptions, the colDef will get preference, allowing you to define a common default, and then tailoring per column.

Related Pages:

statusBar() → TableStatusBar
property suppressAggFilteredOnly

Related Pages:

https://www.ag-grid.com/javascript-data-grid/tree-data/

property suppressAggFuncInHeader

Related Pages:

https://www.ag-grid.com/javascript-data-grid/row-selection/

property suppressClickEdit

The grid configures a cellRenderer with a button to start editing.

Related Pages:

property suppressColumnVirtualisation

Ensures all columns are rendered, i.e. appears in the DOM.

Related Pages:

property suppressDragLeaveHidesColumns

Column animations happen when you move a column. The default is for animations to be turned on.

It is recommended that you leave the column move animations on unless your target platform (browser and hardware) is to slow to manage the animations. To turn OFF column animations, set the grid property suppressColumnMoveAnimation=true.

Related Pages:

property suppressExcelExport

Related Pages:

https://www.ag-grid.com/javascript-data-grid/csv-export/

property suppressPaginationPanel

If you set suppressPaginationPanel=true, the grid will not show the standard navigation controls for pagination. This is useful is you want to provide your own navigation controls.

Related Pages:

property suppressRowClickSelection

If true, rows won’t be selected when clicked. Use, for example, when you want checkbox selection, and don’t want to also select the row when the row is clicked.

Related Pages:

property suppressRowTransform

The property suppressRowTransform=true is used to stop the grid positioning rows using CSS transform and instead the grid will use CSS top.

Related Pages:

property suppressScrollOnNewData

The example also sets property suppressScrollOnNewData=true, which tells the grid to NOT scroll to the top when the page changes.

Related Pages:

property treeData

Related Pages:

https://www.ag-grid.com/documentation/javascript/tree-data/

property valueCache

Set to true to turn on the value cache.

Default: false

Related Pages:

property valueCacheNeverExpires

Set to true to configure the value cache to not expire after data updates.

Default: false

Related Pages:

class epyk.core.html.options.OptTableAgGrid.TableStatusBar(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
class epyk.core.html.options.OptTableAgGrid.TableToolPanels(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
filters()
class epyk.core.html.options.OptTableAgGrid.TableToolPanelsFilters(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)
toolPanelParams()
class epyk.core.html.options.OptTableAgGrid.TableToolPanelsParams(component: HtmlModel, attrs: Optional[dict] = None, options: Optional[dict] = None, js_tree: Optional[dict] = None, page: Optional[PageModel] = None)