OpenBI Docs Buy

Visuals

Every visual on a report page is one HTML element whose name starts with obi-, bound to the model by name. The Visuals pane adds them for you; this page lists them all, grouped, with what each shows.

To add one, see Reports. To see or change one’s attributes, select it with HTML on: its tag is picked out in the page’s HTML.

Charts

One element, <obi-chart>, draws every chart: a measure along a column. Its type chooses how; without one it is a column chart.

Categories
column, bar, line, area, pie, donut, funnel, treemap, waterfall, lollipop, dumbbell, slope, radar, parallel, stream, circular, waffle, wordcloud
Regions
choropleth (regions coloured by a measure), cartogram (a circle per region), hexmap (a hexagon per region): Nordic and world shapes built in, or a GeoJSON of your own.
Hierarchies and flows
sankey, chord, sunburst, packing (circles in circles), dendrogram
Points
scatter (with trend lines and their bands), connected (two measures traced along a date), hexbin, heatmap, candlestick (open, high, low and close, with averages, bands and volume), forest (estimates with their intervals, such as a Cox model’s hazard ratios; written in the HTML, not in the gallery)
Distributions
histogram, density, boxplot, violin, ridgeline

Every chart takes a title, a subtitle (the takeaway) and a source; a chart can highlight one series and grey the rest, and carry notes on its data.

Tables, matrices and statements

<obi-table> Table
Rows of columns with measures, totals and data bars; it fetches more rows as you scroll.
<obi-matrix> Matrix
Rows by a column’s values, with true totals (each total is its own query) and Power BI’s drill buttons. It fits its card: its headings wrap between words, as Power BI’s matrix’s column headers do (heading-wrap="false" keeps each on one line), its columns are measured again whenever the card changes width, and columns that still don’t fit scroll sideways inside the card, never the page.
<obi-statement> Financial statement
A profit and loss or a balance sheet from a chart of accounts that adds up (a parent-child tree, or level columns), with columns such as last year, budget and variance, lines such as gross profit and margins, comments, an Excel file with formulas, printing and a typeset PDF.

Cards and text

<obi-kpi> Card
A measure, its change against another, a target and its trend.
<obi-value>
A measure inside a sentence of the page’s text, as it is now.
<obi-math>
A formula in TeX, with the model’s values in it.
<obi-ref>
“Figure 2” or “Table 1” in the text, linking to a visual with a caption, numbered as a book’s are.

Slicers and what-ifs

<obi-slicer> Slicer
A column’s values to choose from: a list, tiles, a dropdown, a range of numbers or dates, or a search box that keeps the rows containing what you type (the gallery’s Text filter).
<obi-param> What-if parameter
A slider whose value the page’s measures and queries use, as {{name}}.
<obi-filters>
The page’s selections, each one removable.

Page elements

<obi-header> Header
The page’s title, who is looking, how fresh the data is, and its filters, with an Analyze in Excel link.
<obi-nav> Page tabs
The report’s pages as tabs, keeping the selection from page to page.
<obi-canvas>
A free layout, as a Power BI page: each visual at its place, on 1,280 × 720 by default.
<obi-grid> Grid
A layout of twelve columns, for pages that flow.
<obi-button>
A button that saves a table’s or a matrix’s data as an Excel file, or as a mail draft.

Maps

<obi-map> Map
Places by latitude and longitude, and routes through them in order. Its tiles are set with File › Map tiles… (OpenStreetMap’s to start with, or none).

For regions coloured by a measure, see the chart types choropleth, cartogram and hexmap above.

Analytics

Computed live by the engine in the page’s filters. Several draw what the analytics tabs make (see Operations research, Quantitative, Networks).

<obi-network> Network
Who is connected, measured with Open Graph: communities, who matters, and the shortest path between two nodes you click. Its force layout is Fruchterman-Reingold’s; from 0.3.76 its nodes sit elsewhere than in 0.3.75, in a drawing of the same kind.
<obi-survival> Survival
Kaplan-Meier curves by group, with bands, numbers at risk, medians and the log-rank test; Cox-adjusted curves, the hazard rate, and whether each effect holds over time.
<obi-embedding> Map of rows
Rows placed by PCA or UMAP from many measures, with k-means clusters.
<obi-montecarlo> Monte Carlo
A measure by date simulated ahead with QuantLib, as a fan of percentiles.
<obi-curve> Yield curve
Zero and forward rates bootstrapped from instruments with QuantLib.
<obi-routes> Routes
Vehicles’ routes from a depot, solved live with OR-Tools, on a map.
<obi-schedule> Schedule
Jobs on machines, done soonest, solved live with OR-Tools’ CP-SAT.
<obi-gantt> Gantt
A schedule from the model’s rows: tasks from start to end, in lanes.
<obi-correlation> Correlation matrix
How measures move together (Pearson or Spearman).
<obi-decomposition> Time series decomposition
A measure over time split into season, trend and remainder (STL).
<obi-images> Image grid
Pictures from a column of web addresses, ranked by a measure.

Your own visuals

A page can define visuals of its own with OpenBI.visual("obi-…", {…}), drawn with D3 or ECharts and bound to the model by name, as the others are. An agent working in the studio can write one for you.

Last updated · OpenBI Studio 0.3.78