Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/bhftbootcamp/agtables.jl
AgTables is an easy-to-use wrapper for the AG Grid library, designed for quick visualization and easy sharing of tabular data
https://github.com/bhftbootcamp/agtables.jl
aggrid tableview
Last synced: about 1 month ago
JSON representation
AgTables is an easy-to-use wrapper for the AG Grid library, designed for quick visualization and easy sharing of tabular data
- Host: GitHub
- URL: https://github.com/bhftbootcamp/agtables.jl
- Owner: bhftbootcamp
- License: mit
- Created: 2024-06-03T18:56:57.000Z (7 months ago)
- Default Branch: master
- Last Pushed: 2024-09-07T19:35:41.000Z (4 months ago)
- Last Synced: 2024-09-07T20:42:52.411Z (4 months ago)
- Topics: aggrid, tableview
- Language: JavaScript
- Homepage:
- Size: 6.46 MB
- Stars: 5
- Watchers: 0
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# AgTables.jl
[](https://bhftbootcamp.github.io/AgTables.jl/stable/)
[](https://bhftbootcamp.github.io/AgTables.jl/dev/)
[](https://github.com/bhftbootcamp/AgTables.jl/actions/workflows/Coverage.yml?query=branch%3Amaster)
[](https://codecov.io/gh/bhftbootcamp/AgTables.jl)
[](https://github.com/bhftbootcamp/Green)
AgTables is an easy-to-use wrapper for the [AG Grid](https://www.ag-grid.com/) library, designed for quick visualization and easy sharing of tabular data.
## Installation
If you haven't installed our [local registry](https://github.com/bhftbootcamp/Green) yet, do that first:
```
] registry add https://github.com/bhftbootcamp/Green.git
```
To install AgTables, simply use the Julia package manager:
```julia
] add AgTables
```
## Usage
In the most basic scenario, the user just needs to parse the data and put it in a table:
```julia
using AgTables
julia> order_data = ag_order_sample_data()
100-element Vector{AgTables.Order}:
AgTables.Order("LTCUSDT", DateTime("2024-05-29T13:40:00"), "ORD00001", ...)
AgTables.Order("ETHUSDT", DateTime("2024-05-29T12:30:00"), "ORD00002", ...)
AgTables.Order("XRPUSDT", DateTime("2024-05-29T13:00:00"), "ORD00003", ...)
julia> order_table = ag_table(order_data)
AgTables.AGTable(Sheet1)
julia> ag_show(order_table)
true
```
To go further, the user can composite panels from tables and configure different parameters for each column of the table:
```julia
using AgTables
ag_show(
ag_panel(
ag_table(
ag_stock_sample_data(),
AgNumberColumnDef(;
field_name = "price",
str_format = "%s USD",
visible = true,
),
AgNumberColumnDef(;
field_name = "h24",
header_name = "24h%",
formatter = AGFormatter(;
style = AG_PERCENT,
maximum_fraction_digits = 2,
),
threshold = AGThreshold(
0;
color_up = "#22ab94",
color_down = "#f23645",
),
filter = true,
),
AgNumberColumnDef(;
field_name = "volume",
formatter = AGFormatter(;
short = true,
),
),
AgNumberColumnDef(;
field_name = "mkt",
header_name = "market сap",
formatter = AGFormatter(;
style = AG_CURRENCY,
currency = AgTables.USD,
separator = true,
),
),
AgStringColumnDef(;
field_name = "sector",
filter = true,
);
column_filter = true,
name = "Stocks",
),
ag_table(
ag_order_sample_data(),
AgStringColumnDef(;
field_name = "symbol",
filter = true,
),
AgStringColumnDef(;
field_name = "orderSide",
color_map = Dict(
"BUY" => "green",
"SELL" => "red",
),
filter = true,
),
name = "Orders",
),
),
)
```
## Using AG Grid Enterprise
Set `AG_GRID_LICENSE_KEY` at runtime to enable AG Grid's enterprise features:
```julia
ENV["AG_GRID_LICENSE_KEY"] = "YOUR_LICENSE_KEY_HERE"
```
## Contributing
Contributions to AgTables are welcome! If you encounter a bug, have a feature request, or would like to contribute code, please open an issue or a pull request on GitHub.