Pin notebook cell
fastero_pin_notebook_cellMake a dashboard widget from a notebook cell's result, as the cell's Pin to Dashboard button does: a SQL cell's rows, or the table a Python cell shows last (a pandas DataFrame on its last line, or one passed to display()). The widget shows the rows of the notebook's latest run, so a notebook on a schedule (fastero_schedule_notebook) keeps it current, and dashboards, their shared links and emails, and pages show it like any widget. Run the notebook first (fastero_run_notebook) so the cell has a result. cellIndex counts from 0 over all the notebook's cells, markdown ones too, in the order fastero_read_notebook gives them. A chart needs assignments naming the columns it plots; table is the default. With dashboardId it is placed on that dashboard too. Returns the widget with its _id and url.
Input Schema
| Name | Required | Description | Default |
|---|---|---|---|
| name | Yes | The widget’s title, shown above it. | |
| vegaLite | No | A Vega-Lite v6 description, only for a chart chartType can't say: several panels, several kinds of mark on one chart, bands, shaded periods, labelled lines, a log or reversed axis, a colour per row, floating bars, side-by-side boxplots. A plain bar, line or pie stays chartType: it is shorter, follows the dashboard's Day/Week/Month switch, and a person can edit it by hand, which nobody can do to this. Rebuild an existing chart this way only when asked for something its type can't do; its old version stays in its history. The rows are the query's, so give no data. Give no config, background, padding, autosize or top-level title: the app decides the look, and the widget's name is the title (title.subtitle stays). About 800 wide in all, in numbers: width 720, height 320. Leave text colours to the theme. Not available: params, selections, url, href, the image and geoshape marks, and nested data. A fixed level line takes y: { datum: 80 }, and x: null under a shared x, or it draws one line per x. Formulas may call only simple functions (format, round, toDate, year and the like). Anything else, and any number people will quote, belongs in the query, so it reads the same in every view. sort: null keeps the query's order. To read well: say the finding in the name or subtitle, with its number, or, on a chart that refreshes, in a text mark worked out from the rows, since typed words go stale; a mid grey plus one accent colour, mid-tones that read on a light and a dark card, more only where they mean something; a target or limit on the chart as a labelled mark; values on the marks or an axis, not both; label only the points the finding rests on; bars start at zero. On a chart that refreshes, keep words and legends off the plot, where a later bar can land on them: a legend with orient "top", a text mark with y: -6 and baseline "bottom". Example: { "width": 720, "height": 320, "encoding": { "x": { "field": "month", "type": "temporal" } }, "layer": [ { "mark": { "type": "bar", "color": "#94a3b8" }, "encoding": { "y": { "field": "orders", "type": "quantitative" } } }, { "mark": { "type": "line", "color": "#3b82f6" }, "encoding": { "y": { "field": "avg_3m", "type": "quantitative" } } }, { "mark": { "type": "rule", "strokeDash": [4, 4] }, "encoding": { "x": null, "y": { "datum": 500 } } } ] } | |
| cellIndex | Yes | The cell, counting from 0 over all the notebook's cells, markdown ones too. | |
| chartType | No | table (the default), number, or a chart with its assignments: bar, horizontal_bar, stacked_bar, line, time_series, pie, scatter, waterfall, combo, heatmap, treemap, bubble. line or time_series for a measure over time; bar to compare categories (horizontal_bar for long labels, stacked_bar for the parts of each); pie or treemap for shares of one whole (a pie shows the 7 largest slices and groups the rest as Other); waterfall for steps that add up to a total; combo for two measures on different scales; scatter to relate two measures, bubble for three; heatmap for one measure across two categories. | |
| projectId | Yes | The project’s id, from fastero_list_projects. | |
| changeNote | No | For a Vega-Lite chart: what this change does and why, in a few words. People read it in Chart history. | |
| notebookId | Yes | A notebook’s id, from fastero_list_notebooks. | |
| assignments | No | Which result columns a chart plots, by chart type: bar, horizontal_bar, stacked_bar {category, value_slot_1, value_slot_2...}; line {xAxis, yAxis, optional value_slot_2, value_slot_3...} (a line each); time_series {date, yAxis1, optional yAxis2}; pie {category, value}; scatter {xAxis, yAxis}; waterfall {category, value}; combo {category, bar_value, line_value}; heatmap {xAxis, yAxis, value}; treemap {name, value}; bubble {xAxis, yAxis, size, optional category}; map {latitude, longitude, optional size, category, label}. Values are column names from the query result. Write the query to return one row per point (aggregate in SQL). | |
| dashboardId | No | A dashboard’s id, from fastero_list_dashboards. |