streamlit-aggrid API Reference
Full documentation for streamlit-aggrid (Standard Library / Native)
streamlit-aggrid.AgGrid
Python Library Documentation: function AgGrid in module st_aggrid.AgGrid
AgGrid(data: Union[pandas.core.frame.DataFrame, str] = None, gridOptions: Dict = None, height: int = 400, update_mode: Union[st_aggrid.shared.GridUpdateMode, Literal['MANUAL', 'MODEL_CHANGED', 'VALUE_CHANGED', 'SELECTION_CHANGED', 'GRID_CHANGED']] = <GridUpdateMode.NO_UPDATE: 1>, data_return_mode: Union[st_aggrid.shared.DataReturnMode, Literal['AS_INPUT', 'FILTERED', 'FILTERED_AND_SORTED', 'MINIMAL', 'CUSTOM']] = <DataReturnMode.FILTERED_AND_SORTED: 'FILTERED_AND_SORTED'>, allow_unsafe_jscode: bool = False, enable_enterprise_modules: Union[bool, Literal['enterpriseOnly', 'enterprise+AgCharts']] = False, license_key: str = None, conversion_errors: str = 'coerce', columns_state=None, theme: Union[str, st_aggrid.shared.StAggridTheme, Literal['streamlit', 'light', 'dark', 'blue', 'fresh', 'material']] = 'streamlit', custom_css=None, key: Any = None, update_on=['cellValueChanged', 'selectionChanged', 'filterChanged', 'sortChanged'], callback=None, show_toolbar: bool = False, show_search: bool = True, show_download_button: bool = True, custom_jscode_for_grid_return: st_aggrid.shared.JsCode = None, should_grid_return: st_aggrid.shared.JsCode = None, use_json_serialization: Union[bool, Literal['auto']] = 'auto', server_sync_strategy: Literal['client_wins', 'server_wins'] = 'client_wins', **default_column_parameters) -> st_aggrid.AgGridReturn.AgGridReturn
Renders a DataFrame using AgGrid.
Parameters
----------
data : pd.DataFrame | pl.DataFrame | str | Path, optional
The data to be displayed on the grid. Accepts:
- Pandas or Polars DataFrames
- Json string data in records format (list like [{column -> value}, … , {column -> value}])
- Path to a json file with records
Defaults to None.
gridOptions : dict, optional
Dictionary of AG Grid options. Full documentation at https://www.ag-grid.com/javascript-data-grid/grid-options/
If None, default grid options will be infered with GridOptionsBuilder.from_dataframe().
Defaults to None.
key : Any, optional
Streamlit widget key for maintaining state across reruns.
It is highly recommended setting it for each grid.
Defaults to None.
height : int, optional
Grid height in pixels. If None, Auto Height is enabled.
See: https://www.ag-grid.com/react-data-grid/grid-size/#dom-layout
Defaults to 400.
update_mode : GridUpdateMode, optional
DEPRECATED. Use update_on parameter instead.
Defines how the grid sends results back to Streamlit.
Defaults to GridUpdateMode.NO_UPDATE.
data_return_mode : DataReturnMode, optional
How data is retrieved from the grid:
- AS_INPUT: Returns data as originally provided, includes edits
- FILTERED: Returns filtered data in original order
- FILTERED_AND_SORTED: Returns filtered and sorted data
- CUSTOM: Returns CustomResponse with user-defined data structure (requires custom_jscode_for_grid_return set)
Defaults to DataReturnMode.FILTERED_AND_SORTED.
allow_unsafe_jscode : bool, optional
Allows JavaScript code injection in gridOptions. Required when using JsCode.
Defaults to False.
enable_enterprise_modules : bool | Literal['enterpriseOnly', 'enterprise+AgCharts'], optional
Enables AG Grid Enterprise features (requires license):
- True or 'enterpriseOnly': Enterprise modules only
- 'enterprise+AgCharts': Enterprise + AgCharts modules
- False: Community features only
Defaults to False.
license_key : str, optional
License key for AG Grid Enterprise features.
Defaults to None.
conversion_errors : str, optional
How to handle type conversion errors:
- 'raise': Raises exception on conversion failure
- 'coerce': Sets invalid values to NaT/NaN
- 'ignore': Returns input unchanged on failure
Defaults to 'coerce'.
columns_state : dict, optional
Initial column state (visibility, order, width, etc.).
Format follows https://www.ag-grid.com/javascript-data-grid/column-state/#reference-state-applyColumnState
Defaults to None.
theme : str | StAggridTheme, optional
Grid theme:
- 'streamlit': Matches Streamlit's default styling
- 'light': AG Grid balham-light theme
- 'dark': AG Grid balham-dark theme
- 'blue': AG Grid blue theme
- 'fresh': AG Grid fresh theme
- 'material': AG Grid material theme
Defaults to 'streamlit'.
custom_css : dict, optional
Custom CSS rules injected into the component iframe.
Defaults to None.
update_on : list[str | tuple[str, int]], optional
AG Grid events that trigger data return to Streamlit.
Events: https://www.ag-grid.com/javascript-data-grid/grid-events/
Use tuple (event_name, debounce_ms) for debounced events.
Example: ['cellValueChanged', ('columnResized', 500)]
Defaults to ['cellValueChanged', 'selectionChanged', 'filterChanged', 'sortChanged'].
callback : callable, optional
Function called when grid data changes. Receives AgGridReturn object.
Requires key parameter to be set.
Defaults to None.
show_toolbar : bool, optional
Show toolbar above the grid.
Defaults to False.
show_search : bool, optional
Show search bar in toolbar.
Defaults to True.
show_download_button : bool, optional
Show CSV download button in toolbar.
Defaults to True.
custom_jscode_for_grid_return : JsCode, optional
JavaScript function for custom data collection when using DataReturnMode.CUSTOM.
Receives: {streamlitRerunEventTriggerName, eventData}
Required when data_return_mode is DataReturnMode.CUSTOM.
Example:
JsCode('''
function({streamlitRerunEventTriggerName, eventData}) {
let api = eventData.api;
return {
columnNames: api.getAllDisplayedColumns().map(c => c.colDef.headerName),
rowCount: api.getDisplayedRowCount(),
selectedCount: api.getSelectedRows().length
};
}
''')
Defaults to None.
should_grid_return : JsCode, optional
JavaScript function that determines whether the grid should return data to Streamlit.
This function is called before each potential data return and can be used to
conditionally prevent updates based on grid state or event data.
The function receives: {streamlitRerunEventTriggerName, eventData}
Should return: boolean (true to proceed with data return, false to skip)
Example:
should_return = JsCode('''
function should_return({streamlitRerunEventTriggerName, eventData}){
//returns only if column Move has finished
if (streamlitRerunEventTriggerName == 'columnMoved'){
return eventData.finished;
}
return true;
}
''')
Defaults to None.
use_json_serialization : bool | Literal['auto'], optional
Controls JSON serialization behavior for complex data types:
- 'auto' (default): Automatically detect PyArrow conversion errors and fallback
to JSON serialization. User-friendly option that handles complex data seamlessly.
- True: Always use JSON serialization for non-primitive data types (lists, dicts, sets).
Converts complex objects to JSON strings before rendering.
- False: Never use JSON serialization. Will raise PyArrow conversion errors
for non-hashable or mixed-type data.
Use 'auto' for best user experience, True for consistent JSON behavior,
or False for strict type checking.
Defaults to 'auto'.
server_sync_strategy : Literal['client_wins', 'server_wins'], optional
Controls data synchronization behavior between server and client:
- 'client_wins' (default): After first edit, grid ignores server data updates
and maintains local edits. Standard behavior for interactive editing.
- 'server_wins': Server data always overwrites the grid, including edited cells.
Useful when server data should be the single source of truth.
When using 'server_wins', consider intercepting grid results with session_state
to preserve user edits before re-rendering.
Defaults to 'client_wins'.
**default_column_parameters
Additional parameters passed to gridOptions.defaultColDef.
Returns
-------
AgGridReturn | CustomResponse
The return type depends on the data_return_mode:
- AS_INPUT, FILTERED, FILTERED_AND_SORTED: Returns AgGridReturn object with full grid data
- MINIMAL: Returns MinimalResponse object with lightweight access to raw data
- CUSTOM: Returns CustomResponse object with user-defined data structure
AgGridReturn provides properties like:
- .data: DataFrame with grid data
- .selected_data: DataFrame with selected rows
- .grid_state: Grid state information
- .columns_state: Column configuration state
CustomResponse provides safe access methods:
- .raw_data: Access to the raw returned data
- .get(key, default): Safe key access with default value
- Standard dictionary access with helpful error messages
streamlit-aggrid.AgGridReturn
Python Library Documentation: class AgGridReturn in module st_aggrid.AgGridReturn
class AgGridReturn(collections.abc.Mapping, typing.Generic)
| AgGridReturn(originalData, grid_response={}, data_return_mode=<DataReturnMode.AS_INPUT: 'AS_INPUT'>, conversion_errors='coerce', frame_dtypes=None) -> None
|
| Container for AgGrid component response data.
|
| Provides easy access to grid data, selected rows, grid state, and other
| information returned by the AgGrid component.
|
| Method resolution order:
| AgGridReturn
| collections.abc.Mapping
| collections.abc.Collection
| collections.abc.Sized
| collections.abc.Iterable
| collections.abc.Container
| typing.Generic
| builtins.object
|
| Methods defined here:
|
| __getitem__(self, key)
| Get item using dict-like access.
|
| __init__(self, originalData, grid_response={}, data_return_mode=<DataReturnMode.AS_INPUT: 'AS_INPUT'>, conversion_errors='coerce', frame_dtypes=None) -> None
| Initialize self. See help(type(self)) for accurate signature.
|
| __iter__(self)
| Iterate over public attributes.
|
| __len__(self)
| Return number of public attributes.
|
| keys(self)
| Return all available keys (attributes + grid_response keys).
|
| values(self)
| Return all values for public attributes.
|
| ----------------------------------------------------------------------
| Readonly properties defined here:
|
| columns_state
| Gets the state of the columns. Typically used when saving column state.
|
| data
| Data from the grid. If rows are grouped, return only the leaf rows.
|
| dataGroups
| Returns grouped rows as a dictionary where keys are tuples of
| groupby strings and values are pandas.DataFrame.
|
| event_data
| Returns information about the event that triggered AgGrid response.
|
| grid_options
| GridOptions as applied on the grid.
|
| grid_response
| Raw response from component.
|
| grid_state
| Gets the grid state. Tipically used on initialState option. (https://ag-grid.com/javascript-data-grid//grid-options/#reference-miscellaneous-initialState)
|
| rows_id_after_filter
| The filtered row indexes
|
| rows_id_after_sort_and_filter
| The row indexes after sort and filter is applied
|
| selected_data
| Selected data from the grid.
|
| selected_dataGroups
| Returns selected rows as a dictionary where keys are tuples of
| grouped column names and values are pandas.DataFrame.
|
| selected_rows
| Returns selected rows as a DataFrame.
| If there are grouped rows, returns a dict of {key: pd.DataFrame}.
|
| selected_rows_id
| Ids of selected rows
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| __abstractmethods__ = frozenset()
|
| __orig_bases__ = (typing.Mapping,)
|
| __parameters__ = ()
|
| ----------------------------------------------------------------------
| Methods inherited from collections.abc.Mapping:
|
| __contains__(self, key)
|
| __eq__(self, other)
| Return self==value.
|
| get(self, key, default=None)
| D.get(k[,d]) -> D[k] if k in D, else d. d defaults to None.
|
| items(self)
| D.items() -> a set-like object providing a view on D's items
|
| ----------------------------------------------------------------------
| Data and other attributes inherited from collections.abc.Mapping:
|
| __hash__ = None
|
| __reversed__ = None
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Collection:
|
| __subclasshook__(C)
| Abstract classes can override this to customize issubclass().
|
| This is invoked early on by abc.ABCMeta.__subclasscheck__().
| It should return True, False or NotImplemented. If it returns
| NotImplemented, the normal algorithm is used. Otherwise, it
| overrides the normal algorithm (and the outcome is cached).
|
| ----------------------------------------------------------------------
| Class methods inherited from collections.abc.Iterable:
|
| __class_getitem__ = GenericAlias(...)
| Represent a PEP 585 generic type
|
| E.g. for t = list[int], t.__origin__ is list and t.__args__ is (int,).
|
| ----------------------------------------------------------------------
| Class methods inherited from typing.Generic:
|
| __init_subclass__(...)
| Function to initialize subclasses.
streamlit-aggrid.AgGridTheme
Python Library Documentation: class AgGridTheme in module st_aggrid.shared class AgGridTheme(BaseEnum) | AgGridTheme(*values) | | # add deprecation note | | Method resolution order: | AgGridTheme | BaseEnum | enum.Enum | builtins.object | | Data and other attributes defined here: | | ALPINE = <AgGridTheme.ALPINE: 'alpine'> | | BALHAM = <AgGridTheme.BALHAM: 'balham'> | | MATERIAL = <AgGridTheme.MATERIAL: 'material'> | | STREAMLIT = <AgGridTheme.STREAMLIT: 'streamlit'> | | ---------------------------------------------------------------------- | Data descriptors inherited from enum.Enum: | | name | The name of the Enum member. | | value | The value of the Enum member. | | ---------------------------------------------------------------------- | Static methods inherited from MetaEnum: | | __contains__(item) | Return True if `value` is in `cls`. | | `value` is in `cls` if: | 1) `value` is a member of `cls`, or | 2) `value` is the value of one of the `cls`'s members. | | ---------------------------------------------------------------------- | Static methods inherited from enum.EnumType: | | __getitem__(name) | Return the member matching `name`. | | __iter__() | Return members in definition order. | | __len__() | Return the number of members (no aliases) | | ---------------------------------------------------------------------- | Readonly properties inherited from enum.EnumType: | | __members__ | Returns a mapping of member name->value. | | This mapping lists all enum members, including aliases. Note that this | is a read-only view of the internal mapping.
streamlit-aggrid.ColumnsAutoSizeMode
Python Library Documentation: class ColumnsAutoSizeMode in module st_aggrid.shared class ColumnsAutoSizeMode(enum.IntEnum) | ColumnsAutoSizeMode(*values) | | Method resolution order: | ColumnsAutoSizeMode | enum.IntEnum | builtins.int | enum.ReprEnum | enum.Enum | builtins.object | | Methods defined here: | | __format__(self, format_spec, /) from builtins.int | Convert to a string according to format_spec. | | __new__(cls, value) from enum.Enum | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes defined here: | | FIT_ALL_COLUMNS_TO_VIEW = <ColumnsAutoSizeMode.FIT_ALL_COLUMNS_TO_VIEW... | | FIT_CONTENTS = <ColumnsAutoSizeMode.FIT_CONTENTS: 2> | | NO_AUTOSIZE = <ColumnsAutoSizeMode.NO_AUTOSIZE: 0> | | ---------------------------------------------------------------------- | Methods inherited from enum.IntEnum: | | __repr__(self) from enum.Enum | Return repr(self). | | __str__ = __repr__(self, /) from builtins.int | Return repr(self). | | ---------------------------------------------------------------------- | Methods inherited from builtins.int: | | __abs__(self, /) | abs(self) | | __add__(self, value, /) | Return self+value. | | __and__(self, value, /) | Return self&value. | | __bool__(self, /) | True if self else False | | __ceil__(...) | Ceiling of an Integral returns itself. | | __divmod__(self, value, /) | Return divmod(self, value). | | __eq__(self, value, /) | Return self==value. | | __float__(self, /) | float(self) | | __floor__(...) | Flooring an Integral returns itself. | | __floordiv__(self, value, /) | Return self//value. | | __ge__(self, value, /) | Return self>=value. | | __getattribute__(self, name, /) | Return getattr(self, name). | | __getnewargs__(self, /) | | __gt__(self, value, /) | Return self>value. | | __hash__(self, /) | Return hash(self). | | __index__(self, /) | Return self converted to an integer, if self is suitable for use as an index into a list. | | __int__(self, /) | int(self) | | __invert__(self, /) | ~self | | __le__(self, value, /) | Return self<=value. | | __lshift__(self, value, /) | Return self<<value. | | __lt__(self, value, /) | Return self<value. | | __mod__(self, value, /) | Return self%value. | | __mul__(self, value, /) | Return self*value. | | __ne__(self, value, /) | Return self!=value. | | __neg__(self, /) | -self | | __or__(self, value, /) | Return self|value. | | __pos__(self, /) | +self | | __pow__(self, value, mod=None, /) | Return pow(self, value, mod). | | __radd__(self, value, /) | Return value+self. | | __rand__(self, value, /) | Return value&self. | | __rdivmod__(self, value, /) | Return divmod(value, self). | | __rfloordiv__(self, value, /) | Return value//self. | | __rlshift__(self, value, /) | Return value<<self. | | __rmod__(self, value, /) | Return value%self. | | __rmul__(self, value, /) | Return value*self. | | __ror__(self, value, /) | Return value|self. | | __round__(...) | Rounding an Integral returns itself. | | Rounding with an ndigits argument also returns an integer. | | __rpow__(self, value, mod=None, /) | Return pow(value, self, mod). | | __rrshift__(self, value, /) | Return value>>self. | | __rshift__(self, value, /) | Return self>>value. | | __rsub__(self, value, /) | Return value-self. | | __rtruediv__(self, value, /) | Return value/self. | | __rxor__(self, value, /) | Return value^self. | | __sizeof__(self, /) | Returns size in memory, in bytes. | | __sub__(self, value, /) | Return self-value. | | __truediv__(self, value, /) | Return self/value. | | __trunc__(...) | Truncating an Integral returns itself. | | __xor__(self, value, /) | Return self^value. | | as_integer_ratio(self, /) | Return a pair of integers, whose ratio is equal to the original int. | | The ratio is in lowest terms and has a positive denominator. | | >>> (10).as_integer_ratio() | (10, 1) | >>> (-10).as_integer_ratio() | (-10, 1) | >>> (0).as_integer_ratio() | (0, 1) | | bit_count(self, /) | Number of ones in the binary representation of the absolute value of self. | | Also known as the population count. | | >>> bin(13) | '0b1101' | >>> (13).bit_count() | 3 | | bit_length(self, /) | Number of bits necessary to represent self in binary. | | >>> bin(37) | '0b100101' | >>> (37).bit_length() | 6 | | conjugate(...) | Returns self, the complex conjugate of any int. | | is_integer(self, /) | Returns True. Exists for duck type compatibility with float.is_integer. | | to_bytes(self, /, length=1, byteorder='big', *, signed=False) | Return an array of bytes representing an integer. | | length | Length of bytes object to use. An OverflowError is raised if the | integer is not representable with the given number of bytes. Default | is length 1. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Determines whether two's complement is used to represent the integer. | If signed is False and a negative integer is given, an OverflowError | is raised. | | ---------------------------------------------------------------------- | Class methods inherited from builtins.int: | | from_bytes(bytes, byteorder='big', *, signed=False) | Return the integer represented by the given array of bytes. | | bytes | Holds the array of bytes to convert. The argument must either | support the buffer protocol or be an iterable object producing bytes. | Bytes and bytearray are examples of built-in objects that support the | buffer protocol. | byteorder | The byte order used to represent the integer. If byteorder is 'big', | the most significant byte is at the beginning of the byte array. If | byteorder is 'little', the most significant byte is at the end of the | byte array. To request the native byte order of the host system, use | `sys.byteorder' as the byte order value. Default is to use 'big'. | signed | Indicates whether two's complement is used to represent the integer. | | ---------------------------------------------------------------------- | Data descriptors inherited from builtins.int: | | denominator | the denominator of a rational number in lowest terms | | imag | the imaginary part of a complex number | | numerator | the numerator of a rational number in lowest terms | | real | the real part of a complex number | | ---------------------------------------------------------------------- | Methods inherited from enum.Enum: | | __dir__(self) | Returns public methods and other interesting attributes. | | __init__(self, *args, **kwds) | Initialize self. See help(type(self)) for accurate signature. | | __reduce_ex__(self, proto) | Helper for pickle. | | ---------------------------------------------------------------------- | Data descriptors inherited from enum.Enum: | | name | The name of the Enum member. | | value | The value of the Enum member. | | ---------------------------------------------------------------------- | Static methods inherited from enum.EnumType: | | __contains__(value) | Return True if `value` is in `cls`. | | `value` is in `cls` if: | 1) `value` is a member of `cls`, or | 2) `value` is the value of one of the `cls`'s members. | | __getitem__(name) | Return the member matching `name`. | | __iter__() | Return members in definition order. | | __len__() | Return the number of members (no aliases) | | ---------------------------------------------------------------------- | Readonly properties inherited from enum.EnumType: | | __members__ | Returns a mapping of member name->value. | | This mapping lists all enum members, including aliases. Note that this | is a read-only view of the internal mapping.
streamlit-aggrid.DataReturnMode
Python Library Documentation: class DataReturnMode in module st_aggrid.shared
class DataReturnMode(builtins.str, enum.Enum)
| DataReturnMode(*values)
|
| Method resolution order:
| DataReturnMode
| builtins.str
| enum.Enum
| builtins.object
|
| Methods defined here:
|
| __format__(self, format_spec) from enum.Enum
| Default object formatter.
|
| Return str(self) if format_spec is empty. Raise TypeError otherwise.
|
| __new__(cls, value) from enum.Enum
| Create and return a new object. See help(type) for accurate signature.
|
| __repr__(self) from enum.Enum
| Return repr(self).
|
| __str__(self) from enum.Enum
| Return str(self).
|
| ----------------------------------------------------------------------
| Data and other attributes defined here:
|
| AS_INPUT = <DataReturnMode.AS_INPUT: 'AS_INPUT'>
|
| CUSTOM = <DataReturnMode.CUSTOM: 'CUSTOM'>
|
| FILTERED = <DataReturnMode.FILTERED: 'FILTERED'>
|
| FILTERED_AND_SORTED = <DataReturnMode.FILTERED_AND_SORTED: 'FILTERED_A...
|
| MINIMAL = <DataReturnMode.MINIMAL: 'MINIMAL'>
|
| ----------------------------------------------------------------------
| Methods inherited from builtins.str:
|
| __add__(self, value, /)
| Return self+value.
|
| __contains__(self, key, /)
| Return bool(key in self).
|
| __eq__(self, value, /)
| Return self==value.
|
| __ge__(self, value, /)
| Return self>=value.
|
| __getitem__(self, key, /)
| Return self[key].
|
| __getnewargs__(...)
|
| __gt__(self, value, /)
| Return self>value.
|
| __hash__(self, /)
| Return hash(self).
|
| __iter__(self, /)
| Implement iter(self).
|
| __le__(self, value, /)
| Return self<=value.
|
| __len__(self, /)
| Return len(self).
|
| __lt__(self, value, /)
| Return self<value.
|
| __mod__(self, value, /)
| Return self%value.
|
| __mul__(self, value, /)
| Return self*value.
|
| __ne__(self, value, /)
| Return self!=value.
|
| __rmod__(self, value, /)
| Return value%self.
|
| __rmul__(self, value, /)
| Return value*self.
|
| __sizeof__(self, /)
| Return the size of the string in memory, in bytes.
|
| capitalize(self, /)
| Return a capitalized version of the string.
|
| More specifically, make the first character have upper case and the rest lower
| case.
|
| casefold(self, /)
| Return a version of the string suitable for caseless comparisons.
|
| center(self, width, fillchar=' ', /)
| Return a centered string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| count(...)
| S.count(sub[, start[, end]]) -> int
|
| Return the number of non-overlapping occurrences of substring sub in
| string S[start:end]. Optional arguments start and end are
| interpreted as in slice notation.
|
| encode(self, /, encoding='utf-8', errors='strict')
| Encode the string using the codec registered for encoding.
|
| encoding
| The encoding in which to encode the string.
| errors
| The error handling scheme to use for encoding errors.
| The default is 'strict' meaning that encoding errors raise a
| UnicodeEncodeError. Other possible values are 'ignore', 'replace' and
| 'xmlcharrefreplace' as well as any other name registered with
| codecs.register_error that can handle UnicodeEncodeErrors.
|
| endswith(...)
| S.endswith(suffix[, start[, end]]) -> bool
|
| Return True if S ends with the specified suffix, False otherwise.
| With optional start, test S beginning at that position.
| With optional end, stop comparing S at that position.
| suffix can also be a tuple of strings to try.
|
| expandtabs(self, /, tabsize=8)
| Return a copy where all tab characters are expanded using spaces.
|
| If tabsize is not given, a tab size of 8 characters is assumed.
|
| find(...)
| S.find(sub[, start[, end]]) -> int
|
| Return the lowest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| format(...)
| S.format(*args, **kwargs) -> str
|
| Return a formatted version of S, using substitutions from args and kwargs.
| The substitutions are identified by braces ('{' and '}').
|
| format_map(...)
| S.format_map(mapping) -> str
|
| Return a formatted version of S, using substitutions from mapping.
| The substitutions are identified by braces ('{' and '}').
|
| index(...)
| S.index(sub[, start[, end]]) -> int
|
| Return the lowest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the substring is not found.
|
| isalnum(self, /)
| Return True if the string is an alpha-numeric string, False otherwise.
|
| A string is alpha-numeric if all characters in the string are alpha-numeric and
| there is at least one character in the string.
|
| isalpha(self, /)
| Return True if the string is an alphabetic string, False otherwise.
|
| A string is alphabetic if all characters in the string are alphabetic and there
| is at least one character in the string.
|
| isascii(self, /)
| Return True if all characters in the string are ASCII, False otherwise.
|
| ASCII characters have code points in the range U+0000-U+007F.
| Empty string is ASCII too.
|
| isdecimal(self, /)
| Return True if the string is a decimal string, False otherwise.
|
| A string is a decimal string if all characters in the string are decimal and
| there is at least one character in the string.
|
| isdigit(self, /)
| Return True if the string is a digit string, False otherwise.
|
| A string is a digit string if all characters in the string are digits and there
| is at least one character in the string.
|
| isidentifier(self, /)
| Return True if the string is a valid Python identifier, False otherwise.
|
| Call keyword.iskeyword(s) to test whether string s is a reserved identifier,
| such as "def" or "class".
|
| islower(self, /)
| Return True if the string is a lowercase string, False otherwise.
|
| A string is lowercase if all cased characters in the string are lowercase and
| there is at least one cased character in the string.
|
| isnumeric(self, /)
| Return True if the string is a numeric string, False otherwise.
|
| A string is numeric if all characters in the string are numeric and there is at
| least one character in the string.
|
| isprintable(self, /)
| Return True if the string is printable, False otherwise.
|
| A string is printable if all of its characters are considered printable in
| repr() or if it is empty.
|
| isspace(self, /)
| Return True if the string is a whitespace string, False otherwise.
|
| A string is whitespace if all characters in the string are whitespace and there
| is at least one character in the string.
|
| istitle(self, /)
| Return True if the string is a title-cased string, False otherwise.
|
| In a title-cased string, upper- and title-case characters may only
| follow uncased characters and lowercase characters only cased ones.
|
| isupper(self, /)
| Return True if the string is an uppercase string, False otherwise.
|
| A string is uppercase if all cased characters in the string are uppercase and
| there is at least one cased character in the string.
|
| join(self, iterable, /)
| Concatenate any number of strings.
|
| The string whose method is called is inserted in between each given string.
| The result is returned as a new string.
|
| Example: '.'.join(['ab', 'pq', 'rs']) -> 'ab.pq.rs'
|
| ljust(self, width, fillchar=' ', /)
| Return a left-justified string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| lower(self, /)
| Return a copy of the string converted to lowercase.
|
| lstrip(self, chars=None, /)
| Return a copy of the string with leading whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| partition(self, sep, /)
| Partition the string into three parts using the given separator.
|
| This will search for the separator in the string. If the separator is found,
| returns a 3-tuple containing the part before the separator, the separator
| itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing the original string
| and two empty strings.
|
| removeprefix(self, prefix, /)
| Return a str with the given prefix string removed if present.
|
| If the string starts with the prefix string, return string[len(prefix):].
| Otherwise, return a copy of the original string.
|
| removesuffix(self, suffix, /)
| Return a str with the given suffix string removed if present.
|
| If the string ends with the suffix string and that suffix is not empty,
| return string[:-len(suffix)]. Otherwise, return a copy of the original
| string.
|
| replace(self, old, new, count=-1, /)
| Return a copy with all occurrences of substring old replaced by new.
|
| count
| Maximum number of occurrences to replace.
| -1 (the default value) means replace all occurrences.
|
| If the optional argument count is given, only the first count occurrences are
| replaced.
|
| rfind(...)
| S.rfind(sub[, start[, end]]) -> int
|
| Return the highest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Return -1 on failure.
|
| rindex(...)
| S.rindex(sub[, start[, end]]) -> int
|
| Return the highest index in S where substring sub is found,
| such that sub is contained within S[start:end]. Optional
| arguments start and end are interpreted as in slice notation.
|
| Raises ValueError when the substring is not found.
|
| rjust(self, width, fillchar=' ', /)
| Return a right-justified string of length width.
|
| Padding is done using the specified fill character (default is a space).
|
| rpartition(self, sep, /)
| Partition the string into three parts using the given separator.
|
| This will search for the separator in the string, starting at the end. If
| the separator is found, returns a 3-tuple containing the part before the
| separator, the separator itself, and the part after it.
|
| If the separator is not found, returns a 3-tuple containing two empty strings
| and the original string.
|
| rsplit(self, /, sep=None, maxsplit=-1)
| Return a list of the substrings in the string, using sep as the separator string.
|
| sep
| The separator used to split the string.
|
| When set to None (the default value), will split on any whitespace
| character (including \n \r \t \f and spaces) and will discard
| empty strings from the result.
| maxsplit
| Maximum number of splits.
| -1 (the default value) means no limit.
|
| Splitting starts at the end of the string and works to the front.
|
| rstrip(self, chars=None, /)
| Return a copy of the string with trailing whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| split(self, /, sep=None, maxsplit=-1)
| Return a list of the substrings in the string, using sep as the separator string.
|
| sep
| The separator used to split the string.
|
| When set to None (the default value), will split on any whitespace
| character (including \n \r \t \f and spaces) and will discard
| empty strings from the result.
| maxsplit
| Maximum number of splits.
| -1 (the default value) means no limit.
|
| Splitting starts at the front of the string and works to the end.
|
| Note, str.split() is mainly useful for data that has been intentionally
| delimited. With natural text that includes punctuation, consider using
| the regular expression module.
|
| splitlines(self, /, keepends=False)
| Return a list of the lines in the string, breaking at line boundaries.
|
| Line breaks are not included in the resulting list unless keepends is given and
| true.
|
| startswith(...)
| S.startswith(prefix[, start[, end]]) -> bool
|
| Return True if S starts with the specified prefix, False otherwise.
| With optional start, test S beginning at that position.
| With optional end, stop comparing S at that position.
| prefix can also be a tuple of strings to try.
|
| strip(self, chars=None, /)
| Return a copy of the string with leading and trailing whitespace removed.
|
| If chars is given and not None, remove characters in chars instead.
|
| swapcase(self, /)
| Convert uppercase characters to lowercase and lowercase characters to uppercase.
|
| title(self, /)
| Return a version of the string where each word is titlecased.
|
| More specifically, words start with uppercased characters and all remaining
| cased characters have lower case.
|
| translate(self, table, /)
| Replace each character in the string using the given translation table.
|
| table
| Translation table, which must be a mapping of Unicode ordinals to
| Unicode ordinals, strings, or None.
|
| The table must implement lookup/indexing via __getitem__, for instance a
| dictionary or list. If this operation raises LookupError, the character is
| left untouched. Characters mapped to None are deleted.
|
| upper(self, /)
| Return a copy of the string converted to uppercase.
|
| zfill(self, width, /)
| Pad a numeric string with zeros on the left, to fill a field of the given width.
|
| The string is never truncated.
|
| ----------------------------------------------------------------------
| Static methods inherited from builtins.str:
|
| maketrans(...)
| Return a translation table usable for str.translate().
|
| If there is only one argument, it must be a dictionary mapping Unicode
| ordinals (integers) or characters to Unicode ordinals, strings or None.
| Character keys will be then converted to ordinals.
| If there are two arguments, they must be strings of equal length, and
| in the resulting dictionary, each character in x will be mapped to the
| character at the same position in y. If there is a third argument, it
| must be a string, whose characters will be mapped to None in the result.
|
| ----------------------------------------------------------------------
| Methods inherited from enum.Enum:
|
| __dir__(self)
| Returns public methods and other interesting attributes.
|
| __init__(self, *args, **kwds)
| Initialize self. See help(type(self)) for accurate signature.
|
| __reduce_ex__(self, proto)
| Helper for pickle.
|
| ----------------------------------------------------------------------
| Data descriptors inherited from enum.Enum:
|
| name
| The name of the Enum member.
|
| value
| The value of the Enum member.
|
| ----------------------------------------------------------------------
| Readonly properties inherited from enum.EnumType:
|
| __members__
| Returns a mapping of member name->value.
|
| This mapping lists all enum members, including aliases. Note that this
| is a read-only view of the internal mapping.
streamlit-aggrid.ExcelExportMode
Python Library Documentation: class ExcelExportMode in module st_aggrid.shared class ExcelExportMode(BaseEnum) | ExcelExportMode(*values) | | Method resolution order: | ExcelExportMode | BaseEnum | enum.Enum | builtins.object | | Data and other attributes defined here: | | FILE_BLOB_IN_GRID_RESPONSE = <ExcelExportMode.FILE_BLOB_IN_GRID_RESPON... | | MANUAL = <ExcelExportMode.MANUAL: 'MANUAL'> | | MULTIPLE_SHEETS = <ExcelExportMode.MULTIPLE_SHEETS: 'MULTIPLE_SHEETS'> | | NONE = <ExcelExportMode.NONE: 'NONE'> | | SHEET_BLOB_IN_GRID_RESPONSE = <ExcelExportMode.SHEET_BLOB_IN_GRID_RESP... | | TRIGGER_DOWNLOAD = <ExcelExportMode.TRIGGER_DOWNLOAD: 'TRIGGER_DOWNLOA... | | ---------------------------------------------------------------------- | Data descriptors inherited from enum.Enum: | | name | The name of the Enum member. | | value | The value of the Enum member. | | ---------------------------------------------------------------------- | Static methods inherited from MetaEnum: | | __contains__(item) | Return True if `value` is in `cls`. | | `value` is in `cls` if: | 1) `value` is a member of `cls`, or | 2) `value` is the value of one of the `cls`'s members. | | ---------------------------------------------------------------------- | Static methods inherited from enum.EnumType: | | __getitem__(name) | Return the member matching `name`. | | __iter__() | Return members in definition order. | | __len__() | Return the number of members (no aliases) | | ---------------------------------------------------------------------- | Readonly properties inherited from enum.EnumType: | | __members__ | Returns a mapping of member name->value. | | This mapping lists all enum members, including aliases. Note that this | is a read-only view of the internal mapping.
streamlit-aggrid.GridOptionsBuilder
Python Library Documentation: class GridOptionsBuilder in module st_aggrid.grid_options_builder class GridOptionsBuilder(builtins.object) | Builder for gridOptions dictionary | | Methods defined here: | | __init__(self) | Initialize self. See help(type(self)) for accurate signature. | | build(self) | Builds the gridOptions dictionary | | Returns: | dict: Returns a dicionary containing the configured grid options | | configure_auto_height(self, autoHeight=True) | Makes grid autoheight | | Args: | autoHeight (bool, optional): enable or disable autoheight. Defaults to True. | | configure_column(self, field, header_name=None, **other_column_properties) | Configures an individual column | check https://www.ag-grid.com/javascript-grid-column-properties/ for more information. | | Args: | field (String): field name, usually equals the column header. | header_name (String, optional): [description]. Defaults to None. | | configure_columns(self, column_names=[], **props) | Batch configures columns. Key-pair values from props dict will be merged | to colDefs which field property is in column_names list. | | Args: | column_names (list, optional): | columns field properties. If any of colDefs matches **props dict is merged. | Defaults to []. | | configure_default_column(self, **other_default_column_properties) | Configure default column. | | Args: | min_column_width (int, optional): | Minimum column width. Defaults to 100. | | resizable (bool, optional): | All columns will be resizable. Defaults to True. | | filterable (bool, optional): | All columns will be filterable. Defaults to True. | | sortable (bool, optional): | All columns will be sortable. Defaults to True. | | sorteable (bool, optional): | Backwards compatibility alias for sortable. Overrides sortable if not None. | | groupable (bool, optional): | All columns will be groupable based on row values. Defaults to True. | | editable (bool, optional): | All columns will be editable. Defaults to True. | | groupable (bool, optional): | All columns will be groupable. Defaults to True. | | **other_default_column_properties: | Key value pairs that will be merged to defaultColDef dict. | Chech ag-grid documentation. | | configure_first_column_as_index(self, suppressMenu: bool = True, headerText: str = '', resizable=False, sortable=True) | Configures the first column definition to look as an index column. | | Args: | suppressMenu (bool, optional): Suppresses the header menu for the index col. Defaults to True. | headerText (str, optional): Header for the index column. Defaults to empty string. | resizable (bool, optional): Make index column resizable. Defaults to False. | sortable (bool, optional): Make index column sortable. Defaults to True. | | configure_grid_options(self, **props) | Merges props to gridOptions | | Args: | props (dict): props dicts will be merged to gridOptions root. | | configure_pagination(self, enabled=True, paginationAutoPageSize=True, paginationPageSize=10) | Configure grid's pagination features | | Args: | enabled (bool, optional): | Self explanatory. Defaults to True. | | paginationAutoPageSize (bool, optional): | Calculates optimal pagination size based on grid Height. Defaults to True. | | paginationPageSize (int, optional): | Forces page to have this number of rows per page. Defaults to 10. | | configure_selection(self, selection_mode: str = 'single', use_checkbox: bool = False, header_checkbox: bool = False, header_checkbox_filtered_only: bool = True, pre_select_all_rows: bool = False, pre_selected_rows: list = None, rowMultiSelectWithClick: bool = False, suppressRowDeselection: bool = False, suppressRowClickSelection: bool = False, groupSelectsChildren: bool = True, groupSelectsFiltered: bool = True) | Configure grid selection features | | Args: | selection_mode (str, optional): | Either 'single', 'multiple' or 'disabled'. Defaults to 'single'. | | use_checkbox (bool, optional): | Set to true to have checkbox next to each row. | | header_checkbox (bool, optional): | Set to true to have a checkbox in the header to select all rows. | | header_checkbox_filtered_only (bool, optional): | If header_checkbox is set to True, once the header checkbox is clicked, returned rows depend on this parameter. | If this is set to True, only filtered (shown) rows will be selected and returned. | If this is set to False, the whole dataframe (all rows regardless of the applited filter) will be selected and returned. | | pre_selected_rows (list, optional): | Use list of dataframe row iloc index to set corresponding rows as selected state on load. Defaults to None. | | rowMultiSelectWithClick (bool, optional): | If False user must hold shift to multiselect. Defaults to True if selection_mode is 'multiple'. | | suppressRowDeselection (bool, optional): | Set to true to prevent rows from being deselected if you hold down Ctrl and click the row | (i.e. once a row is selected, it remains selected until another row is selected in its place). | By default the grid allows deselection of rows. | Defaults to False. | | suppressRowClickSelection (bool, optional): | Supress row selection by clicking. Usefull for checkbox selection for instance | Defaults to False. | | groupSelectsChildren (bool, optional): | When rows are grouped selecting a group select all children. | Defaults to True. | | groupSelectsFiltered (bool, optional): | When a group is selected filtered rows are also selected. | Defaults to True. | | configure_side_bar(self, filters_panel=True, columns_panel=True, defaultToolPanel='') | configures the side panel of ag-grid. | Side panels are enterprise features, please check www.ag-grid.com | | Args: | filters_panel (bool, optional): | Enable filters side panel. Defaults to True. | | columns_panel (bool, optional): | Enable columns side panel. Defaults to True. | | defaultToolPanel (str, optional): The default tool panel that should open when grid renders. | Either "filters" or "columns". | If value is blank, panel will start closed (default) | | ---------------------------------------------------------------------- | Static methods defined here: | | from_dataframe(dataframe, **default_column_parameters) | Creates an instance and initilizes it from a dataframe. | ColumnDefs are created based on dataframe columns and data types. | | Args: | dataframe (pd.DataFrame): a pandas DataFrame. | | Returns: | GridOptionsBuilder: The instance initialized from the dataframe definition. | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
streamlit-aggrid.GridUpdateMode
Python Library Documentation: class GridUpdateMode in module st_aggrid.shared class GridUpdateMode(enum.Flag) | GridUpdateMode(*values) | | Method resolution order: | GridUpdateMode | enum.Flag | enum.Enum | builtins.object | | Data and other attributes defined here: | | COLUMN_MOVED = <GridUpdateMode.COLUMN_MOVED: 128> | | COLUMN_PINNED = <GridUpdateMode.COLUMN_PINNED: 256> | | COLUMN_RESIZED = <GridUpdateMode.COLUMN_RESIZED: 64> | | COLUMN_VISIBLE = <GridUpdateMode.COLUMN_VISIBLE: 512> | | FILTERING_CHANGED = <GridUpdateMode.FILTERING_CHANGED: 16> | | MANUAL = <GridUpdateMode.MANUAL: 2> | | NO_UPDATE = <GridUpdateMode.NO_UPDATE: 1> | | SELECTION_CHANGED = <GridUpdateMode.SELECTION_CHANGED: 8> | | SORTING_CHANGED = <GridUpdateMode.SORTING_CHANGED: 32> | | VALUE_CHANGED = <GridUpdateMode.VALUE_CHANGED: 4> | | ---------------------------------------------------------------------- | Methods inherited from enum.Flag: | | __contains__(self, other) | Returns True if self has at least the same flags set as other. | | __iter__(self) | Returns flags in definition order. | | __len__(self) | Return the number of members (no aliases) | | ---------------------------------------------------------------------- | Data descriptors inherited from enum.Enum: | | name | The name of the Enum member. | | value | The value of the Enum member. | | ---------------------------------------------------------------------- | Static methods inherited from enum.EnumType: | | __getitem__(name) | Return the member matching `name`. | | ---------------------------------------------------------------------- | Readonly properties inherited from enum.EnumType: | | __members__ | Returns a mapping of member name->value. | | This mapping lists all enum members, including aliases. Note that this | is a read-only view of the internal mapping.
streamlit-aggrid.JsCode
Python Library Documentation: class JsCode in module st_aggrid.shared class JsCode(builtins.object) | JsCode(js_code: str) | | # stole from https://github.com/andfanilo/streamlit-echarts/blob/master/streamlit_echarts/frontend/src/utils.js Thanks andfanilo | | Methods defined here: | | __init__(self, js_code: str) | Wrapper around a js function to be injected on gridOptions. | code is not checked at all. | set allow_unsafe_jscode=True on AgGrid call to use it. | Code is rebuilt on client using new Function Syntax (https://javascript.info/new-function) | | Args: | js_code (str): javascript function code as str | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object
streamlit-aggrid.StAggridTheme
Python Library Documentation: class StAggridTheme in module st_aggrid.shared class StAggridTheme(builtins.dict) | StAggridTheme(base: Optional[Literal['alpine', 'balham', 'quartz']] = None) | | # suclassing a dict because it is JSON serializable. | | Method resolution order: | StAggridTheme | builtins.dict | builtins.object | | Methods defined here: | | __init__(self, base: Optional[Literal['alpine', 'balham', 'quartz']] = None) | Initialize self. See help(type(self)) for accurate signature. | | base(self, base: Literal['alpine', 'balham', 'quartz']) | | withParams(self, **params: Mapping[str, str | int]) | | withParts(self, *parts: List[str]) | | ---------------------------------------------------------------------- | Data descriptors defined here: | | __dict__ | dictionary for instance variables | | __weakref__ | list of weak references to the object | | ---------------------------------------------------------------------- | Methods inherited from builtins.dict: | | __contains__(self, key, /) | True if the dictionary has the specified key, else False. | | __delitem__(self, key, /) | Delete self[key]. | | __eq__(self, value, /) | Return self==value. | | __ge__(self, value, /) | Return self>=value. | | __getattribute__(self, name, /) | Return getattr(self, name). | | __getitem__(self, key, /) | Return self[key]. | | __gt__(self, value, /) | Return self>value. | | __ior__(self, value, /) | Return self|=value. | | __iter__(self, /) | Implement iter(self). | | __le__(self, value, /) | Return self<=value. | | __len__(self, /) | Return len(self). | | __lt__(self, value, /) | Return self<value. | | __ne__(self, value, /) | Return self!=value. | | __or__(self, value, /) | Return self|value. | | __repr__(self, /) | Return repr(self). | | __reversed__(self, /) | Return a reverse iterator over the dict keys. | | __ror__(self, value, /) | Return value|self. | | __setitem__(self, key, value, /) | Set self[key] to value. | | __sizeof__(...) | D.__sizeof__() -> size of D in memory, in bytes | | clear(...) | D.clear() -> None. Remove all items from D. | | copy(...) | D.copy() -> a shallow copy of D | | get(self, key, default=None, /) | Return the value for key if key is in the dictionary, else default. | | items(...) | D.items() -> a set-like object providing a view on D's items | | keys(...) | D.keys() -> a set-like object providing a view on D's keys | | pop(...) | D.pop(k[,d]) -> v, remove specified key and return the corresponding value. | | If the key is not found, return the default if given; otherwise, | raise a KeyError. | | popitem(self, /) | Remove and return a (key, value) pair as a 2-tuple. | | Pairs are returned in LIFO (last-in, first-out) order. | Raises KeyError if the dict is empty. | | setdefault(self, key, default=None, /) | Insert key with a value of default if key is not in the dictionary. | | Return the value for key if key is in the dictionary, else default. | | update(...) | D.update([E, ]**F) -> None. Update D from dict/iterable E and F. | If E is present and has a .keys() method, then does: for k in E: D[k] = E[k] | If E is present and lacks a .keys() method, then does: for k, v in E: D[k] = v | In either case, this is followed by: for k in F: D[k] = F[k] | | values(...) | D.values() -> an object providing a view on D's values | | ---------------------------------------------------------------------- | Class methods inherited from builtins.dict: | | __class_getitem__(...) | See PEP 585 | | fromkeys(iterable, value=None, /) | Create a new dictionary with keys from iterable and values set to value. | | ---------------------------------------------------------------------- | Static methods inherited from builtins.dict: | | __new__(*args, **kwargs) class method of builtins.dict | Create and return a new object. See help(type) for accurate signature. | | ---------------------------------------------------------------------- | Data and other attributes inherited from builtins.dict: | | __hash__ = None
streamlit-aggrid.aggrid_utils
Python Library Documentation: module st_aggrid.aggrid_utils in st_aggrid
NAME
st_aggrid.aggrid_utils
FUNCTIONS
parse_update_mode(update_mode: st_aggrid.shared.GridUpdateMode, update_on=None)
DATA
Mapping = typing.Mapping
A generic version of collections.abc.Mapping.
Tuple = typing.Tuple
Deprecated alias to builtins.tuple.
Tuple[X, Y] is the cross-product type of X and Y.
Example: Tuple[T1, T2] is a tuple of two elements corresponding
to type variables T1 and T2. Tuple[int, float, str] is a tuple
of an int, a float and a string.
To specify a variable-length tuple of homogeneous type, use Tuple[T, ...].
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\st_aggrid\aggrid_utils.py
streamlit-aggrid.grid_options_builder
Python Library Documentation: module st_aggrid.grid_options_builder in st_aggrid
NAME
st_aggrid.grid_options_builder
CLASSES
builtins.object
GridOptionsBuilder
class GridOptionsBuilder(builtins.object)
| Builder for gridOptions dictionary
|
| Methods defined here:
|
| __init__(self)
| Initialize self. See help(type(self)) for accurate signature.
|
| build(self)
| Builds the gridOptions dictionary
|
| Returns:
| dict: Returns a dicionary containing the configured grid options
|
| configure_auto_height(self, autoHeight=True)
| Makes grid autoheight
|
| Args:
| autoHeight (bool, optional): enable or disable autoheight. Defaults to True.
|
| configure_column(self, field, header_name=None, **other_column_properties)
| Configures an individual column
| check https://www.ag-grid.com/javascript-grid-column-properties/ for more information.
|
| Args:
| field (String): field name, usually equals the column header.
| header_name (String, optional): [description]. Defaults to None.
|
| configure_columns(self, column_names=[], **props)
| Batch configures columns. Key-pair values from props dict will be merged
| to colDefs which field property is in column_names list.
|
| Args:
| column_names (list, optional):
| columns field properties. If any of colDefs matches **props dict is merged.
| Defaults to [].
|
| configure_default_column(self, **other_default_column_properties)
| Configure default column.
|
| Args:
| min_column_width (int, optional):
| Minimum column width. Defaults to 100.
|
| resizable (bool, optional):
| All columns will be resizable. Defaults to True.
|
| filterable (bool, optional):
| All columns will be filterable. Defaults to True.
|
| sortable (bool, optional):
| All columns will be sortable. Defaults to True.
|
| sorteable (bool, optional):
| Backwards compatibility alias for sortable. Overrides sortable if not None.
|
| groupable (bool, optional):
| All columns will be groupable based on row values. Defaults to True.
|
| editable (bool, optional):
| All columns will be editable. Defaults to True.
|
| groupable (bool, optional):
| All columns will be groupable. Defaults to True.
|
| **other_default_column_properties:
| Key value pairs that will be merged to defaultColDef dict.
| Chech ag-grid documentation.
|
| configure_first_column_as_index(self, suppressMenu: bool = True, headerText: str = '', resizable=False, sortable=True)
| Configures the first column definition to look as an index column.
|
| Args:
| suppressMenu (bool, optional): Suppresses the header menu for the index col. Defaults to True.
| headerText (str, optional): Header for the index column. Defaults to empty string.
| resizable (bool, optional): Make index column resizable. Defaults to False.
| sortable (bool, optional): Make index column sortable. Defaults to True.
|
| configure_grid_options(self, **props)
| Merges props to gridOptions
|
| Args:
| props (dict): props dicts will be merged to gridOptions root.
|
| configure_pagination(self, enabled=True, paginationAutoPageSize=True, paginationPageSize=10)
| Configure grid's pagination features
|
| Args:
| enabled (bool, optional):
| Self explanatory. Defaults to True.
|
| paginationAutoPageSize (bool, optional):
| Calculates optimal pagination size based on grid Height. Defaults to True.
|
| paginationPageSize (int, optional):
| Forces page to have this number of rows per page. Defaults to 10.
|
| configure_selection(self, selection_mode: str = 'single', use_checkbox: bool = False, header_checkbox: bool = False, header_checkbox_filtered_only: bool = True, pre_select_all_rows: bool = False, pre_selected_rows: list = None, rowMultiSelectWithClick: bool = False, suppressRowDeselection: bool = False, suppressRowClickSelection: bool = False, groupSelectsChildren: bool = True, groupSelectsFiltered: bool = True)
| Configure grid selection features
|
| Args:
| selection_mode (str, optional):
| Either 'single', 'multiple' or 'disabled'. Defaults to 'single'.
|
| use_checkbox (bool, optional):
| Set to true to have checkbox next to each row.
|
| header_checkbox (bool, optional):
| Set to true to have a checkbox in the header to select all rows.
|
| header_checkbox_filtered_only (bool, optional):
| If header_checkbox is set to True, once the header checkbox is clicked, returned rows depend on this parameter.
| If this is set to True, only filtered (shown) rows will be selected and returned.
| If this is set to False, the whole dataframe (all rows regardless of the applited filter) will be selected and returned.
|
| pre_selected_rows (list, optional):
| Use list of dataframe row iloc index to set corresponding rows as selected state on load. Defaults to None.
|
| rowMultiSelectWithClick (bool, optional):
| If False user must hold shift to multiselect. Defaults to True if selection_mode is 'multiple'.
|
| suppressRowDeselection (bool, optional):
| Set to true to prevent rows from being deselected if you hold down Ctrl and click the row
| (i.e. once a row is selected, it remains selected until another row is selected in its place).
| By default the grid allows deselection of rows.
| Defaults to False.
|
| suppressRowClickSelection (bool, optional):
| Supress row selection by clicking. Usefull for checkbox selection for instance
| Defaults to False.
|
| groupSelectsChildren (bool, optional):
| When rows are grouped selecting a group select all children.
| Defaults to True.
|
| groupSelectsFiltered (bool, optional):
| When a group is selected filtered rows are also selected.
| Defaults to True.
|
| configure_side_bar(self, filters_panel=True, columns_panel=True, defaultToolPanel='')
| configures the side panel of ag-grid.
| Side panels are enterprise features, please check www.ag-grid.com
|
| Args:
| filters_panel (bool, optional):
| Enable filters side panel. Defaults to True.
|
| columns_panel (bool, optional):
| Enable columns side panel. Defaults to True.
|
| defaultToolPanel (str, optional): The default tool panel that should open when grid renders.
| Either "filters" or "columns".
| If value is blank, panel will start closed (default)
|
| ----------------------------------------------------------------------
| Static methods defined here:
|
| from_dataframe(dataframe, **default_column_parameters)
| Creates an instance and initilizes it from a dataframe.
| ColumnDefs are created based on dataframe columns and data types.
|
| Args:
| dataframe (pd.DataFrame): a pandas DataFrame.
|
| Returns:
| GridOptionsBuilder: The instance initialized from the dataframe definition.
|
| ----------------------------------------------------------------------
| Data descriptors defined here:
|
| __dict__
| dictionary for instance variables
|
| __weakref__
| list of weak references to the object
FILE
c:\users\youse\appdata\local\programs\python\python312\lib\site-packages\st_aggrid\grid_options_builder.py
streamlit-aggrid.walk_gridOptions
Python Library Documentation: function walk_gridOptions in module st_aggrid.shared
walk_gridOptions(go, func)
Recursively walk grid options applying func at each leaf node
Args:
go (dict): gridOptions dictionary
func (callable): a function to apply at leaf nodes