-
Notifications
You must be signed in to change notification settings - Fork 15
/
Tables.jl
494 lines (386 loc) · 13.7 KB
/
Tables.jl
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
module Tables
import Tables as TablesInterface
using Genie, Stipple, StippleUI, StippleUI.API
import Genie.Renderer.Html: HTMLString, normal_element, table, template, register_normal_element
export Column, DataTablePagination, DataTableOptions, DataTable, DataTableSelection, DataTableWithSelection, rowselection, selectrows!
register_normal_element("q__table", context = @__MODULE__)
const ID = "__id"
const DataTableSelection = Vector{Dict{String, Any}}
struct2dict(s::T) where T = Dict{Symbol, Any}(zip(fieldnames(T), getfield.(Ref(s), fieldnames(T))))
#===#
Base.@kwdef mutable struct Column
name::String
required::Bool = false
label::String = name
align::Symbol = :left
field::String = name
sortable::Bool = true
end
"""
Column(name::String, args...)
----------
# Examples
----------
```julia-repl
julia> Column("x2", align = :right)
```
----------
# Arguments
----------
* `required::Bool` - if we use `visiblecolumns`, this col will always be visible
* `label::String` - label for header
* `align::Symbol` - alignment for cell
* `field::String` - row Object property to determine value for this column ex. `name`
* `sortable::Bool` - tell `table` you want this column sortable
"""
function Column(name::String; args...)
Column(name = name; args...)
end
function Column(names::Vector{String}) :: Vector{Column}
Column[Column(name) for name in names]
end
function Base.Symbol(v::Vector{Column}) :: Vector{Symbol}
[Symbol(c.name) for c in v]
end
"""
DataTablePagination(sort_by::Symbol, descending::Bool, page::Int, rows_per_page::Int)
----------
# Examples
----------
```julia-repl
julia> DataTablePagination(rows_per_page=50)
```
"""
Base.@kwdef mutable struct DataTablePagination
sort_by::Symbol = :desc
descending::Bool = false
page::Int = 1
rows_per_page::Int = 10
rows_number::Union{Int,Nothing} = nothing
_filter::AbstractString = "" # keep track of filter value for improving performance
end
"""
DataTableOptions(addid::Bool, idcolumn::String, columns::Union{Vector{Column},Nothing}, columnspecs::Dict{Union{String, Regex}, Dict{Symbol, Any}})
----------
# Examples
----------
```julia-repl
julia> DataTableOptions(columns = [Column("x1"), Column("x2", align = :right)])
```
### Columnspecs
Usage for formating columns
```julia-repl
julia> import Stipple.opts
julia> df = DataFrame(a = sin.(-π:π/10:π), b = cos.(-π:π/10:π), c = string.(rand(21)))
julia> dt = DataTable(df)
julia> dt.opts.columnspecs[r"^(a|b)\$"] = opts(format = jsfunction(raw"(val, row) => `\${100*val.toFixed(3)}%`"))
julia> model.table[] = dt
```
"""
Base.@kwdef mutable struct DataTableOptions
addid::Bool = false
idcolumn::String = "ID"
columns::Union{Vector{Column},Nothing} = nothing
columnspecs::Dict{Union{String, Regex}, Dict{Symbol, Any}} = Dict()
end
mutable struct DataTable{T}
data::T
opts::DataTableOptions
end
"""
DataTable(data::T, opts::DataTableOptions)
----------
# Examples
----------
```julia-repl
julia> df = DataFrame(a = sin.(-π:π/10:π), b = cos.(-π:π/10:π), c = string.(rand(21)))
julia> dt = DataTable(df)
or
julia> using TypedTables
julia> t = Table(a = [1, 2, 3], b = [2.0, 4.0, 6.0])
julia> dt = DataTable(t)
or
julia> using Tables
julia> Tables.table([1 2 3; 3 4 5], header = ["a", "b", "c"])
julia> dt = DataTable(t1)
```
"""
function DataTable(data::T) where {T}
DataTable{T}(data, DataTableOptions())
end
function DataTable{T}() where {T}
DataTable{T}(T(), DataTableOptions())
end
#===#
function label_clean(input)
uppercasefirst(replace(string(input), '_'=>' '))
end
function active_columns(t::T)::Vector{Column} where {T<:DataTable}
t.opts.columns !== nothing ?
t.opts.columns :
[Column(string(name), sortable = true, label = label_clean(name)) for name in TablesInterface.columnnames(t.data)]
end
"""
columns(t::T)::Vector{Column} where {T<:DataTable}
```julia-repl
julia> columns = [Column("x1"), Column("x2", align = :right)]
```
"""
function columns(t::T)::Vector{<:Union{Column, Dict}} where {T<:DataTable}
columns = active_columns(t) |> copy
if t.opts.addid
pushfirst!(columns, Column(t.opts.idcolumn, true, t.opts.idcolumn, :right, t.opts.idcolumn, true))
end
if isempty(t.opts.columnspecs)
columns
else
coldicts = Dict{Symbol, Any}[]
for col in columns
coldict = struct2dict(col)
for (k, v) in t.opts.columnspecs
occursin(k isa String ? Regex("^$k\$") : k, col.name) && merge!(coldict, v)
end
push!(coldicts, coldict)
end
coldicts
end
end
function rows(t::T)::Vector{Dict{String,Any}} where {T<:DataTable}
rows = []
for (count, row) in enumerate(TablesInterface.rows(t.data))
r = Dict()
if t.opts.addid
r[t.opts.idcolumn] = count
end
r[ID] = count
for column in active_columns(t)
r[column.name] = row[Symbol(column.name)]
end
push!(rows, r)
end
rows
end
function data(t::T; datakey = "data", columnskey = "columns")::Dict{String,Any} where {T<:DataTable}
Dict(
columnskey => columns(t),
datakey => rows(t)
)
end
"""
table(fieldname::Symbol, args...; kwargs...)
----------
# Examples
----------
### Model
```julia-repl
julia> @vars TableModel begin
data::R{DataTable} = DataTable(DataFrame(rand(100000,2), ["x1", "x2"]), DataTableOptions(columns = [Column("x1"), Column("x2", align = :right)]))
data_pagination::DataTablePagination = DataTablePagination(rows_per_page=50)
end
```
### View
```julia-repl
julia> table(:data; pagination=:data_pagination, style="height: 350px;", title="Random numbers")
```
"""
function table( fieldname::Symbol,
args...;
rowkey::String = ID,
datakey::String = "$fieldname.data",
columnskey::String = "$fieldname.columns",
filter::Union{Symbol,String,Nothing} = nothing,
kwargs...) :: ParsedHTMLString
if filter !== nothing
filter_input = """
<template v-slot:top-right>
<q-input dense debounce="300" v-model="$filter" placeholder="Search">
<template v-slot:append>
<q-icon name="search" />
</template>
</q-input>
</template>
"""
args = tuple(pushfirst!([args...], filter_input)...)
end
q__table(args...;
kw([
Symbol(":data") => "$datakey",
Symbol(":columns") => "$columnskey",
Symbol("row-key") => rowkey,
:fieldname => fieldname,
kwargs...
])...
)
end
#===#
function Stipple.render(t::T) where {T<:DataTable}
data(t)
end
function Stipple.render(dtp::DataTablePagination)
response = Dict(:sortBy => dtp.sort_by, :descending => dtp.descending, :page => dtp.page, :rowsPerPage => dtp.rows_per_page)
dtp.rows_number !== nothing && setindex!(response, dtp.rows_number, :rowsNumber)
response
end
#===#
function Stipple.watch(vue_app_name::String, fieldtype::R{T}, fieldname::Symbol, channel::String, model::M)::String where {M<:ReactiveModel,T<:DataTable}
string(vue_app_name, raw".\$watch('", fieldname, "', function(newVal, oldVal){
});\n\n")
end
#===#
function Base.parse(::Type{DataTablePagination}, d::Dict{String,Any})
dtp = DataTablePagination()
dtp.sort_by = get!(d, "sortBy", "desc") |> Symbol
dtp.page = get!(d, "page", 1)
dtp.descending = get!(d, "descending", false)
dtp.rows_per_page = get!(d, "rowsPerPage", 10)
dtp
end
function DataTableOptions(d::AbstractDict)
DataTableOptions(d["addid"], d["idcolumn"], d["columns"], d["columnspecs"])
end
function DataTableOptions(data::T) where T
dto = DataTableOptions()
dto.columns = [Column(string(name), sortable = true, label = label_clean(name)) for name in TablesInterface.columnnames(data)]
dto
end
mutable struct DataTableWithSelection
var""::R{DataTable}
_pagination::R{DataTablePagination}
_selection::R{DataTableSelection}
end
function DataTableWithSelection(data::T) where {T}
dt = DataTable{T}(data, DataTableOptions())
DataTableWithSelection(dt, DataTablePagination(), DataTableSelection())
end
Base.getindex(dt::DataTable, args...) = DataTable(dt.data[args...], dt.opts)
Base.getindex(dt::DataTable, row::Int, col) = DataTable(dt.data[[row], col], dt.opts)
Base.getindex(dt::DataTable, row, col::Int) = DataTable(dt.data[row, col::Int], dt.opts)
Base.getindex(dt::DataTable, row::Int, col::Int) = DataTable(dt.data[[row], [col]], dt.opts)
"""
rowselection(dt::DataTable, rows, cols = Colon(), idcolumn = dt.opts.addid ? dt.opts.idcolumn : "__id")
Build a table selection based on row numbers.
Standard behavior of Quasar is to include all columns in the selection.
For large tables it might be sufficient to include only the index, when no other use of the selection value is made.
This is achieved by setting `cols` to `nothing`
```
rowselection(dt, 3)
rowselection(dt, 2:5)
rowselection(dt, [2, 4, 7])
rowselection(dt, :, nothing)
```
"""
function rowselection(dt::DataTable, rows, cols = Colon(), idcolumn = dt.opts.addid ? dt.opts.idcolumn : "__id")
if isnothing(cols)
[Dict{String, Any}(union([idcolumn, "__id"]) .=> row) for row in (rows == Colon() ? (1:nrow(dt.data)) : rows)]
else
dd = Stipple.render(dt[rows, cols])["data"]
setindex!.(dd, rows, "__id")
dt.opts.addid && setindex!.(dd, rows, dt.opts.idcolumn)
dd |> Vector{Dict{String, Any}}
end
end
"""
rowselection(dt::DataTable, idcolumn::Union{String, Symbol}, values, cols = Colon())
Build a table selection based on an index and a value / list of values.
```
rowselection(dt, "a", [1, 3])
rowselection(dt, "a", 2:9)
```
"""
function rowselection(dt::DataTable, idcolumn::Union{String, Symbol}, values, cols = Colon())
vals = values isa AbstractString ? [values] : [values...]
rows = findall(x -> x ∈ vals, dt.data[:, idcolumn])
rowselection(dt, rows, cols)
end
"""
rowselection(dt::DataTable, idcolumn::Union{String, Symbol}, f::Function, cols = Colon())
Build a table selection based on a function.
```
rowselection(dt, "a", iseven)
rowselection(dt, "a", x -> x > 3)
```
"""
function rowselection(dt::DataTable, idcolumn::Union{String, Symbol}, f::Function, cols = Colon())
rows = findall(f, dt.data[:, idcolumn])
rowselection(dt, rows, cols)
end
"""
rowselection(dt::DataTable, idcolumn::Union{String, Symbol}, regex::Regex, cols = Colon())
Build a table selection based on a Regex.
```julia
rowselection(t, "b", r"hello|World")
```
"""
function rowselection(dt::DataTable, idcolumn::Union{String, Symbol}, regex::Regex, cols = Colon())
rows = findall(x -> occursin(regex, x), dt.data[:, idcolumn])
rowselection(dt, rows, cols)
end
"""
selectrows!(model::ReactiveModel, tablefield::Symbol, selectionfield::Symbol = Symbol(tablefield, "_selection"), args...)
selectrows!(dt::R{<:DataTable}, dt_selection::R, args...)
Select table rows of a model based on selection criteria. More information on selection syntax can be found in `rowselection`
```julia
@vars TableDemo begin
@mixin table::TableWithPaginationSelection
end
model = init(TableDemo)
model.table[] = DataTable(DataFrame(a = [1, 2, 4, 6, 8, 10], b = ["Hello", "world", ",", "hello", "sun", "!"]))
selectrows!(model, :table, [1, 2, 6]) # assumes the existence of a field `:table_selection`
selectrows!(model.table, model.table_selection, "b", r"hello|World"i)
selectrows!(model, :table, :table_selection, "a", iseven)
```
"""
function selectrows!(dt::R{<:DataTable}, dt_selection::R, args...)
dt_selection[] = rowselection(Stipple.Observables.to_value(dt), args...)
end
function selectrows!(model::ReactiveModel, tablefield::Symbol, selectionfield::Symbol, args...)
getfield(model, selectionfield)[] =
rowselection(Stipple.Observables.to_value(getfield(model, tablefield)), args...)
end
selectrows!(model::ReactiveModel, tablefield::Symbol, args...) = selectrows!(model, tablefield, Symbol(tablefield, "_selection"), args...)
#=== event handlers ===#
export process_request
function process_request(data, datatable::DataTable, pagination::DataTablePagination, filter::AbstractString = "")
event = params(:payload, nothing)
if event !== nothing && isa(get(event, "event", false), AbstractDict) && isa(get(event["event"], "name", false), AbstractString) && event["event"]["name"] == "request"
event = event["event"]["event"]["pagination"]
else
event = Dict()
event["sortBy"] = pagination.sort_by
event["descending"] = pagination.descending
event["page"] = pagination.page
event["rowsPerPage"] = pagination.rows_per_page
end
event["rowsPerPage"] == 0 && (event["rowsPerPage"] = TablesInterface.rowcount(data)) # when Quasar sends 0, that means all rows
if filter !== pagination._filter || filter !== ""
pagination._filter = filter
collector = []
counter = 0
for row in eachrow(data)
counter += 1
if sum(occursin.(filter, string.(Array(row)))) > 0
push!(collector, counter)
end
end
if ! isempty(collector)
fd = data[collector, :]
pagination.rows_number = length(collector)
else
fd = data[!, :]
end
else
fd = data[!, :]
end
if event["sortBy"] === nothing
event["sortBy"] = "desc"
sort!(fd)
elseif event["sortBy"] in names(fd)
sort!(fd, event["sortBy"], rev = event["descending"])
end
start_row = (event["page"] - 1) * event["rowsPerPage"] + 1
end_row = event["page"] * event["rowsPerPage"]
datatable = typeof(datatable)(fd[(start_row <= pagination.rows_number ? start_row : pagination.rows_number) : (end_row <= pagination.rows_number ? end_row : pagination.rows_number), :], datatable.opts)
pagination = typeof(pagination)(rows_per_page = event["rowsPerPage"], rows_number = pagination.rows_number, page = event["page"], sort_by = event["sortBy"], descending = event["descending"], _filter = pagination._filter)
return (data = fd, datatable = datatable, pagination = pagination)
end
end