OptionalcloseOptionaldisplayOptionalgutterOptionalmaxOptionalmaxOptionalminOptionalminOptionaltimeoutProtectedcleanClean the grid, closes the panel and deselect the selected features.
Deserialize an element and set the current element state to the deserialized one
The element serialization as returned by the serialize method
When the component is disconnected from the DOM all the callbacks will be unregistered
Activates the specified tab, renders the grid, and displays the grid for the specified id.
Generates a CSV file from the selected rows in the grid.
The current array of TabHeader objects.
Hide the component (display: none).
Convert the string in parameter with uHtml and return it. This allows to convert a string with html in a right html object. For example, htmlUnsafe('
') will return an html div object.Inverts the selection of all rows in the grid.
NOTE REG: We cannot just use truthy here, because javascript comparaison table is really problematic. For example: 0 == false [] == false "" == false And there are cases where we want to check null or undefined, because 0 can be a right value. More here : https://dorey.github.io/JavaScript-Equality-Table/
Re-Render the component. The method should be called when the component has already been rendered and needs to be updated.
Render the component regarding its visibility.
Renders a hidden span with the name of the component. Useful to render a placeholder for not visible component.
Selects all rows in the grid.
Deselects all rows in the grid.
Returns the serialization of the current element. This method should be overwritten by child classes
An object describing the current element serialized
Show the component (display: block).
In the templates, sometimes for accessibility reasons, we have to support the KeyDown Event In those case, we often juste want to do the same as the click event when Enter or Space is pressed Then this method can be used : it just calls the click event on the same element
OptionaleventNames: GgUserInteractionEvent | GgUserInteractionEvent[]Zooms to the extent of the selected rows in the grid.
Represents a selection grid component based on GridJs. Display itself when it should be visible and have selected features. To be visible, it has to be the defined selectionComponent.