Hui v0.5.7 Hui.F.Interval View Source
Struct and functions related to interval faceting parameters.
Example
iex> x = %Hui.F.Interval{interval: "price", set: ["[0,10]", "(10,100]"]}
%Hui.F.Interval{
interval: "price",
set: ["[0,10]", "(10,100]"],
per_field: false
}
iex> y = %Hui.F{interval: x, field: ["type", "year"]}
%Hui.F{
contains: nil,
"contains.ignoreCase": nil,
"enum.cache.minDf": nil,
excludeTerms: nil,
exists: nil,
facet: true,
field: ["type", "year"],
interval: %Hui.F.Interval{
interval: "price",
set: ["[0,10]", "(10,100]"],
per_field: false
},
limit: nil,
matches: nil,
method: nil,
mincount: nil,
missing: nil,
offset: nil,
"overrequest.count": nil,
"overrequest.ratio": nil,
pivot: [],
"pivot.mincount": nil,
prefix: nil,
query: [],
range: nil,
sort: nil,
threads: nil
}
iex> y |> Hui.URL.encode_query # render struct into URL query string with `facet` prefixes
"facet=true&facet.field=type&facet.field=year&facet.interval=price&facet.interval.set=%5B0%2C10%5D&facet.interval.set=%2810%2C100%5D"
Example - per field intervals, f.[fieldname].facet.interval
iex> x = %Hui.F.Interval{interval: "price", set: ["[0,10]", "(10,100]"], per_field: true}
%Hui.F.Interval{
interval: "price",
set: ["[0,10]", "(10,100]"],
per_field: true
}
iex> y = %Hui.F{field: "type", interval: x}
%Hui.F{
contains: nil,
"contains.ignoreCase": nil,
"enum.cache.minDf": nil,
excludeTerms: nil,
exists: nil,
facet: true,
field: "type",
interval: %Hui.F.Interval{
interval: "price",
set: ["[0,10]", "(10,100]"],
per_field: true
},
limit: nil,
matches: nil,
method: nil,
mincount: nil,
missing: nil,
offset: nil,
"overrequest.count": nil,
"overrequest.ratio": nil,
pivot: [],
"pivot.mincount": nil,
prefix: nil,
query: [],
range: nil,
sort: nil,
threads: nil
}
iex> y |> Hui.URL.encode_query
"facet=true&facet.field=type&facet.interval=price&f.price.facet.interval.set=%5B0%2C10%5D&f.price.facet.interval.set=%2810%2C100%5D"
Link to this section Summary
Link to this section Types
Struct for interval faceting parameters, use in conjunction with
the main faceting t:Hui.F.t/0
struct (interval).
Hui.URL.encode_query/1
renders this struct into URL query string.