Skip to content

Commit

Permalink
Merge pull request #79 from pdeffebach/patch-1
Browse files Browse the repository at this point in the history
Update docstring so list displays properly
  • Loading branch information
pfitzseb authored Jun 2, 2021
2 parents 6a49528 + 8976367 commit 965f404
Showing 1 changed file with 13 additions and 12 deletions.
25 changes: 13 additions & 12 deletions src/TableView.jl
Original file line number Diff line number Diff line change
Expand Up @@ -53,18 +53,19 @@ showtable(table::AbstractMatrix; kwargs...) = showtable(Tables.table(table); kwa
Return a `WebIO.Scope` that displays the provided `table`.
Optional arguments:
- `options`: Directly passed to agGrid's `Grid` constructor. Refer to the
[documentation](https://www.ag-grid.com/documentation/) for more info.
- `options_mutator!`: Runs on the `options` dictionary populated by TableView and allows for
customizing the grid (at your own risk -- you can break the package by
supplying invalid options).
- `dark`: Switch to a dark theme.
- `title`: Displayed above the table if non-empty;
- `height`/`width`: CSS attributes specifying the output height and with.
- `cell_changed`: Either `nothing` or a function that takes a single argument with the fields
`"new"`, `"old"`, `"row"`, and `"col"`. This function is called whenever the
user edits a table field. Note that all values will be strings, so you need to
do the necessary conversions yourself.
- `options`: Directly passed to agGrid's `Grid` constructor. Refer to the
[documentation](https://www.ag-grid.com/documentation/) for more info.
- `options_mutator!`: Runs on the `options` dictionary populated by TableView and allows for
customizing the grid (at your own risk -- you can break the package by
supplying invalid options).
- `dark`: Switch to a dark theme.
- `title`: Displayed above the table if non-empty;
- `height`/`width`: CSS attributes specifying the output height and with.
- `cell_changed`: Either `nothing` or a function that takes a single argument with the fields
`"new"`, `"old"`, `"row"`, and `"col"`. This function is called whenever the
user edits a table field. Note that all values will be strings, so you need to
do the necessary conversions yourself.
"""
function showtable(table;
options::Dict{Symbol, Any} = Dict{Symbol, Any}(),
Expand Down

0 comments on commit 965f404

Please sign in to comment.