Skip to content
MSO CloudDocumentation

Dataset pack fields

On this page

Optional fields a dataset pack can declare to shape a page, a card or the navigation. A pack that declares none of them installs and renders exactly as before; every field below is opt-in and has no default.

Packs are data (docs/adr/0042-dashboard-packs-as-data.md, docs/adr/0059-per-org-dashboards-at-scale.md). The schemas live in apps/web/src/server/dataset-packs/pack-schema.ts (pack, page, frame, filter bar) and apps/web/src/server/widget-config-schemas.ts (card config). A pack is client-neutral: examples here use placeholder names, and no tenant name belongs in a pack committed to the repository.

Every localised text is { "vi": "...", "en": "..." }; vi is required and en falls back to vi.

Navigation#

Declared at the pack root (nav) and on a page (landing, menu). Applied on a full install; a refresh-dashboards run that adds nav is refused, so bump the pack version.

Field Meaning Example
nav.groups[] Sidebar groups, upserted by id into the org default menu; groups the pack does not name are kept. id matches org-group:[a-z0-9-]{1,64}; nesting is one level (parentGroupId) {"nav":{"groups":[{"id":"org-group:portfolio","label":{"vi":"Danh mục","en":"Portfolio"},"order":0}]}}
eyebrow, sublabel On a group: a small line above the label and a line under it {"eyebrow":{"vi":"Dòng sản phẩm"},"sublabel":{"vi":"A · B · C"}}
numbered On a group: its items are numbered 01, 02 … {"numbered":true}
footer On a group: text under it while one of its pages is open; a child group without one inherits its parent's. \n starts a new line and the first line is emphasised. Hidden in the collapsed rail and the phone drawer {"footer":{"vi":"5 kỳ báo cáo\nMới nhất: 05/10 – 18/10"}}
landing On a page, true on at most one page: install sets the brand's default landing path to it, only when the current value is empty or already a page of this pack {"pageKey":"home","landing":true}
menu.sublabelVi, menu.sublabelEn A line under the page's menu entry; the pack owns it and refreshes it on install {"menu":{"labelVi":"Trang chủ","group":"org-group:portfolio","sublabelVi":"2026"}}

Page frame#

pages[].frame (strict). Read at render time from the installed pack row, so a new pack version plus a page upgrade is enough; there is no migration.

Field Meaning Example
title, subtitle A light header band (card surface, hairline under it) at the top of the page body; the title is the page's one h1. Edit mode keeps the generic header {"frame":{"title":{"vi":"Báo cáo chiến dịch"},"subtitle":{"vi":"Đối thủ: X"}}}
breadcrumb[] Trail on the band's first line. A step with page links to a page of the same pack; add pack to link another installed pack's page {"breadcrumb":[{"text":{"vi":"Danh mục"},"page":"home"},{"text":{"vi":"Chiến dịch"}}]}
footer Closing line after the last card. {dimKey} is that page control's current option; \n breaks lines {"footer":{"vi":"Kỳ đo: {period_id}\n© 2026"}}
footerLayout: "split" A two-line footer sits on one row: first line at the start, the last at the end (stacked when narrow) {"footer":{"vi":"Samsung MX · 2026\n© 2026 YouNet Media"},"footerLayout":"split"}
tabFooters[] Replaces the footer on one tab; a tabKey that names no tab is refused {"tabFooters":[{"tabKey":"paid","text":{"vi":"Kỳ đo: {period_id}"}}]}
tabStrip Draws the page tabs as a labelled segmented control; refused on a page without tabs {"tabStrip":{"label":{"vi":"So sánh với"}}}
tabStrip.placement: "head-end" The strip sits in the hosting card's heading, right slot, with the assistant entry; the label names the tablist but is not printed {"tabStrip":{"label":{"vi":"Nguồn phản hồi"},"placement":"head-end"}}
csv: true A "Tải CSV" button writes every mounted panel card on the open tab, each table under its title {"csv":true}
csv.mode: "page_state" One flat table: the tab and every control of the page bar and open tab as leading columns, then the rows of the first card in widgetKeys that has data. name fills {dimKey} and {tab} {"csv":{"mode":"page_state","name":"overview_{period_id}_{tab}","widgetKeys":["kpi-a"]}}
csv.rowsOf Only the card rows whose key is the current pick of a page dim (a click-filter pick) {"csv":{"mode":"page_state","name":"list","widgetKeys":["list"],"rowsOf":"topic"}}
csv.rowsAlong The source rows run along a page dim (one period per row): the dim heads the first column and leaves the state columns {"csv":{"mode":"page_state","name":"trend","widgetKeys":["trend"],"rowsAlong":"period_id"}}
csv.label On csv.mode: "page_state": the button's words, vi/en. Absent = the kit's "Tải CSV" {"csv":{"mode":"page_state","name":"Duo_daily","widgetKeys":["ov-daily"],"label":{"vi":"Tải CSV theo dõi","en":"Download tracking CSV"}}}
shareLink An icon button that copies ?tab= plus the page dims to the clipboard. It never writes the address bar (§170); the opened link's params win over resetOnLoad {"shareLink":true}

Group of dashboards (ADR 0063)

A page whose top-level tabs are the dashboards of one group. Every key is opt-in; the frame schema is strict, so these keys need the code that reads them deployed before a pack declares them.

Field Meaning Example
filterScope: "nested" The page row, a tab's own bar and a card's local filter intersect: values conjoin per dimension, date ranges intersect, and a pair with nothing in common shows "no data" on every card instead of the unfiltered corpus. A tab's own picks are kept per tab and never reach a sibling tab. Needs tabs; tab-level bars must declare filterBarExtras {"filterScope":"nested"}
globalFilter The page filter row: a tab_filter_bar widget config, drawn under the title above the tab strip on every tab, ending with "Đặt lại" (clears the page row, every tab's bar and every card's local filter). Its date pair is the page's only time control: no "Kỳ" select, no period pin, and an unnarrowed card reads its whole corpus. Needs filterScope: "nested" {"globalFilter":{"dataSource":"audience","audienceKind":"tab_filter_bar","datasetKey":"audience_dim_leaderboard","contentDatasetKey":"corpus_rows","dimKey":null,"denominator":"mentions","coverageBasis":"received_corpus","suppressTitle":true,"ignoreFacet":true,"filterControls":[{"dim":"group","type":"checkboxes","label":"Group","labelStyle":"count"}],"filterBarExtras":{"contentScope":{"options":["all","organic","shared","comments"]}}}}
method A link-style button at the end of the page filter row opening a dialog of titled blocks. label absent = "Nguồn & cách tính". body is plain text: a blank line starts a paragraph, lines starting - form a list {"method":{"blocks":[{"title":{"vi":"Nguồn"},"body":{"vi":"Dữ liệu thảo luận đã qua QC.\n\n- Post\n- Comment"}}]}}
sectionNav[] A section-jump strip under the tab strip of one tab: each item scrolls to a card of that tab and the card in view is marked. Scrolls sideways when narrow. A tabKey or widgetKey the page does not declare is refused {"sectionNav":[{"tabKey":"overview","items":[{"label":{"vi":"Xu hướng"},"widgetKey":"ov-volume"},{"label":{"vi":"Mức đóng góp"},"widgetKey":"ov-sov"}]}]}

On a tab_filter_bar widget config (a tab bar or frame.globalFilter), filterBarExtras.timePosition (0-8) places the date range after that many of the bar's main controls; absent or 0 = first. filterBarExtras.contentScope.label (48 characters, labelEn optional) renames the content-scope control; absent = "Phạm vi nội dung". Example: {"filterBarExtras":{"timePosition":1,"contentScope":{"label":"Loại nội dung","labelEn":"Content type"}}}. On a page with frame.globalFilter the date control reads "Khoảng ngày" and offers no preset rail.

A pick of more than half a picker's values is stored in the address as the values left out (tfDimX, tt.<tab>.dimx), so a near-full selection stays short and exact.

On a tab_filter_bar control (filterControls[], dimension member), labelStyle: "count" makes the closed multi-pick read "Group (8)", the number of values ticked (all values when nothing is narrowed). The picker keeps its "Chọn tất cả" / "Bỏ chọn tất cả" actions.

On a page, redirectFrom: [{"page": "<old pageKey>", "tab": "<tabKey>"}] names pages of an earlier pack version that a tab of the declaring page replaces. The upgrade already deletes a page the pack no longer declares, with its shares and its menu pin; the old address (<packKey>-<pageKey>, -N suffix included) then opens the named tab instead of a 404. A source page must not be a page of the current version.

Assistant#

pages[].assistant.

Field Meaning Example
source "org": the org chat replaces the deck chat on a page with audience cards, when the chat is offered (plugin, AI key, role). Absent or "deck": the deck chat wins {"assistant":{"label":{"vi":"Trợ lý AI"},"source":"org"}}
questions[] Free-text starter chips, 1-200 characters each; questions plus questionIds hold at most 6, free text first. Shown only with source: "org" {"assistant":{"source":"org","questions":[{"vi":"Chủ đề nào được nhắc nhiều nhất?","en":"Which topic is mentioned most?"}]}}

pages[].assistant.label also names the deck AI tab when source is "deck" (it wins over the corpus document's aiAssistant.label). Example: {"assistant":{"label":{"vi":"AI Assistant","en":"AI Assistant"},"source":"deck"}}.

On a tab, pages[].tabs[].assistant.questions[] (1-6 entries of {"vi", "en"?}, 1-200 characters each) are that tab's starter chips in the deck chat's "Hỏi AI" drawer, masked like the deck's other labels. A tab that declares none shows the deck's suggestions; the AI Assistant tab always shows the deck's suggestions. Example: {"tabKey":"topics","assistant":{"questions":[{"vi":"Chủ đề nào được nhắc nhiều nhất?","en":"Which topic is mentioned most?"}]}}.

Filter bar and controls#

filterBar on a page, and its controls[].

Field Meaning Example
presentation: "stepper" A period control drawn as previous, option popover, next and a latest button. Needs required, no multi. Options may carry from / to (YYYY-MM-DD, both or neither) so the popover groups by month {"dimKey":"period_id","required":true,"presentation":"stepper","options":[{"valueKeys":["r1"],"labelVi":"07–13/09","from":"2026-09-07","to":"2026-09-13"}]}
options[].tagVi, options[].tagEn A short tag (24 characters) a frame line quotes as {dimKey.tag} while that option is picked (an empty tag prints nothing); unresolved, the line is not printed {"options":[{"valueKeys":["r5"],"labelVi":"05/10 – 18/10/2026","tagVi":"D+89"}]}
presentation: "segmented" A radiogroup instead of a select. Needs required, no multi {"dimKey":"scope","required":true,"presentation":"segmented","options":[{"valueKeys":["a"],"labelVi":"Gồm"},{"valueKeys":["b"],"labelVi":"Loại"}]}
visibleWhen The control is drawn only while a page dim holds one of the values. When false its leg is dropped from the read projection and its declared default applies {"dimKey":"activity","visibleWhen":{"dim":"channel","values":["social"]}}
placement "card" = the control leaves the top row and is drawn by the page card that sets panelView.hostsPageControls; with no such card on the page it stays in the top row {"dimKey":"activity","placement":"card","visibleWhen":{"dim":"channel","values":["social"]}}
defaultApplies The declared default is sent as the leg while nothing is picked, so the select and every card read one value. Needs required and defaultValueKeys; not a param {"dimKey":"period_id","required":true,"defaultValueKeys":["r5"],"defaultApplies":true}
childDimKeys Picking a value clears the legs of these dims {"dimKey":"period_id","childDimKeys":["topic"]}
filterBar.resetOnLoad Each leg resets once per document load (reload or first visit in the tab), not on every in-app page change; legs in the arriving URL still win. On a page with a time window it also clears the org-wide window other surfaces share {"filterBar":{"time":false,"resetOnLoad":true}}

Layout#

On a pack tab (pages[].tabs[].layout) or a flat page (pages[].layout), never on the tabbed page itself.

Field Meaning Example
layout.kind: "aside_left" One card becomes a left column of span 3 or 4 grid columns; the beside cards after it, in reading order, fill the right column and the rest pack full width below. Refused: an unknown widgetKey, a tile kind, a column last in reading order, beside above the remaining card count {"layout":{"kind":"aside_left","widgetKey":"tree","span":3,"beside":4}}
layout.align: "top" The column and the card beside it each keep their own height, top-aligned; the rows below start under the taller one. Absent, a column beside ONE card ends on that card's line {"layout":{"kind":"aside_left","widgetKey":"topics","span":4,"beside":1,"align":"top"}}
layout.besideFlow: "columns" The cards beside the column keep their content height, and each grid column stacks its own cards right under each other (a short card is not stretched to the one across from it). The rows below start under the tallest column. Absent, a row beside the column reflows to its tallest card {"layout":{"kind":"aside_left","widgetKey":"topics","span":3,"beside":4,"besideFlow":"columns"}}
aside column width Not a field: in read mode a column never draws narrower than 200px. Its grid tracks hold that floor, so it binds only on a grid under 840px (span 3); a wider grid, a span-4 column and the editor keep equal tracks {"layout":{"kind":"aside_left","widgetKey":"tree","span":3}}

Card presentation (panelView)#

On panel_matrix, chart_aligned_pivot, ring_compare, price_index_card and campaign_grid cards unless a row says otherwise. The full panelView shape is in the dataset panel read model (docs/adr/0055-dataset-panel-read-model.md).

Field Meaning Example
look Table and list presentations by kind: diverging, paired_heat, ranked_list, drivers, verbatims, tree_flat, topic_buttons (panel_matrix) and sentiment_donut (ring_compare). Each accepts aside, the right-hand unit words {"look":{"kind":"ranked_list","rank":"rank","text":"title","chipSeparator":"|"}}
look.rowStyle: "plain" On topic_buttons: borderless rows, the picked one filled, both counts ("p / n") kept. Absent = bordered buttons {"look":{"kind":"topic_buttons","positive":"pos","negative":"neg","rowStyle":"plain"}}
look.moreStyle: "box" On ranked_list with rowsCollapsed: the reveal is a bordered full-width disclosure row with a caret. Absent = a text link {"look":{"kind":"ranked_list","rowsCollapsed":5,"moreStyle":"box"}}
look.kind: "topic_sides" One topic's sides (1 or 2): each sides[] names tone, heading, the drivers text column and an optional verbatims text column; a row joins the side whose tone its text carries. Drivers print as paragraphs (emptyText when none), the first verbatim is boxed with quoteLead · <row sublabel>, the rest open behind "View N more" {"look":{"kind":"topic_sides","sides":[{"tone":"positive","heading":{"vi":"Được khen"},"drivers":"drv","verbatims":"vb"}]}}
pivotForm Chart form of an aligned pivot by kind: ranked_bars, split_bars, pool_share_bars, period_columns, cohort_columns, combo. Drawn only on a card with no click, except combo {"pivotForm":{"kind":"ranked_bars","share":true}}
pivotForm.layout: "ranked", pivotForm.countText On pool_share_bars: each pool is a block headed by its name and N (countText places it, {n} buzz), one bar per series, largest first, with its share {"pivotForm":{"kind":"pool_share_bars","countSeries":"n","layout":"ranked","countText":{"vi":"{n} buzz"}}}
bandLayout "strip": one line per row, figures inked by column polarity. "tiles": one card per top-level column (label, figure, compare, notes, change) {"bandLayout":"tiles","cardChrome":"none","titleHidden":true,"tileFit":"content"}
tileNotes[], tileContext A muted note under a tile's figure by column key; a suffix on every change line's context {"tileNotes":[{"key":"outcomes","vi":"Bài gốc"}],"tileContext":{"vi":"7 ngày trọn"}}
tileCompares: "end" Tiles: the compare line and tileNotes sit under the change line ("▲ +152.9% · vs Oct 16-22", then "Baseline: 18,255"). Absent = above it {"bandLayout":"tiles","tileCompares":"end"}
notePlacement: "top", noteLead The panel note sits above the body (an instruction rather than a footnote); noteLead: true sets its first sentence in the accent ink {"note":{"vi":"Bấm một ngày để xem bài đăng. ..."},"notePlacement":"top","noteLead":true}
tileGrid "balanced": one line when every tile fits, else balanced rows that fill the width (3+2, then 2+2+1) {"tileGrid":"balanced"}
tileUnreported, tileChangeUnavailable "hide": a tile with a blank figure is not drawn and the rest close up; tiles print no "change unavailable" line {"tileUnreported":"hide","tileChangeUnavailable":"hide"}
compareToggle The named change columns (each subOf a figure column) stay off until a card-header switch turns them on; the switch shows only when every row's change resolves {"compareToggle":{"columns":["chg"]}}
collapsed The card opens closed behind one disclosure line; the body mounts and fetches only when opened. Pair with titleHidden {"titleHidden":true,"collapsed":{"summary":{"vi":"Ghi chú đo lường"}}}
collapsed.surface: "card" The closed card is drawn on the glossary's card with the same 48px title row, so every collapsed row on a page has one height and one surface. Needs cardChrome: "none" (refused otherwise) {"titleHidden":true,"cardChrome":"none","collapsed":{"summary":{"vi":"Xem chỉ số khác"},"surface":"card"}}
collapsed.summary tokens The disclosure line fills page tokens ({label:<dimKey>}, {dimKey}); an unfilled token drops out with its separator {"collapsed":{"summary":{"vi":"Xem {label:attribute} qua các kỳ"}}}
cardGroup Widgets that share cardGroup.id draw inside ONE bordered card (read mode; the editor ignores it). Shape { id, title?: {vi,en?}, subtitle?: {vi,en?}, collapsible?: true }; only the first widget needs the header fields, later ones repeat id. collapsible adds a toggle (open by default). Also accepted on audience cards and static blocks. A group is skipped when another card sits inside its rectangle.
emptyCell A blank figure prints this word alone; the reason stays in the tooltip {"emptyCell":{"vi":"—"}}
cellNote A muted line under the named columns' cells while a page dim holds one of the values {"cellNote":{"columns":["share"],"when":{"dim":"node","values":["other"]},"vi":"Phạm vi khác"}}
visibleWhen The card is not drawn, and not fetched, unless a page dim holds one of the values {"visibleWhen":{"dim":"node","values":["total"]}}
hideWhenEmpty An answered card with nothing to draw is not drawn and its tile closes up: a matrix without rows, a chart without points or values, a chart or ring whose scope has no x point or category. A refusal or an error keeps its line {"hideWhenEmpty":true}
cardTitle, cardSubtitle Card heading and a muted line under it. Tokens: {period_id}, {label:<dimKey>} and the frame tokens. cardSubtitle alone prints under the widget's own title {"cardTitle":{"vi":"{label:node} · mỗi ngày"}}
cardTitleStyle: "heading" cardTitle prints as the card's own heading (sentence case) with cardSubtitle at the end of its row {"cardTitle":{"vi":"{label:attribute}"},"cardTitleStyle":"heading"}
cardSubtitleStyle: "badge" With cardSubtitlePlacement: "header": the subtitle reads as a warning-toned pill (a scope caveat) {"cardSubtitle":{"vi":"Gồm minigame"},"cardSubtitlePlacement":"header","cardSubtitleStyle":"badge"}
section.scopeVi, section.scopeEn A scope strip with a dot under the section title; same tokens as cardTitle. section.style: "intro" draws eyebrow, headline, lead and corner badge {"section":{"titleVi":"Tổng quan","scopeVi":"{period_id}"}}
section.scopeLead: "pill" With scopeStyle: "band": the strip's first · segment reads as a filled pill ("Tracking snapshot"), the dot goes {"section":{"scopeVi":"Ảnh chụp theo dõi · 23-29/10/2026","scopeStyle":"band","scopeLead":"pill"}}
section.subtitlePlacement: "after_scope" The section subtitle prints under the scope strip as a small caveat. Absent = under the title {"section":{"subtitleVi":"Không phải kết quả thử nghiệm.","subtitlePlacement":"after_scope"}}
section.style: "sub" A sub-heading under the page's opening block: an h3 in the section ink at the intro headline size (20px), as written (no upper case), the subtitle as a lead under it. Eyebrow and badge are not drawn. Use it for a second heading on a page that already has an intro {"section":{"titleVi":"{label:channel}","subtitleVi":"…","style":"sub"}}
column.bar: "share_pair", sharePairRoles A two-tone 100% bar plus a bold percent on a share cell; sharePairRoles names the theme seriesRoles.value keys for the two halves {"sharePairRoles":{"value":"brand-a","rest":"brand-b"}}
click.alwaysOne On click.kind: "filter", a second click keeps the pick instead of clearing it {"click":{"kind":"filter","dim":"attr","alwaysOne":true}}
click.clears On a filter click: page dims (up to 6) whose pick is cleared whenever the click changes the selection, even where their control stays visible {"click":{"kind":"filter","dim":"channel","alwaysOne":true,"clears":["activity"]}}
click.pointSummary On click.kind: "detail" of a chart: the dialog states the day's figures (each series, then its role badge), opened from the chart or from a narrative section's detail link to that chart {"click":{"kind":"detail","dim":"$sub","datasetKey":"threads","binding":{...},"pointSummary":true}}
headerAction A link to another pack page in the card header's right slot, labelled by cta (required). A card with a hidden title draws it right-aligned above the body. Same target, carry, pin, anchor, back as navigate {"headerAction":{"kind":"navigate","target":{"page":"feedback"},"carry":[],"cta":{"vi":"Khám phá phản hồi","en":"Explore feedback"}}}
hostedControlsPlacement With hostsTabControls: "section" = the hosted controls (and a frame tab strip) under the card's heading; "below" = after the body; "card" = the section place drawn as one bordered controls card, each label above its control. Absent = the card's control row {"hostsTabControls":true,"hostedControlsPlacement":"card"}
hostsPageControls The card draws the page controls marked placement: "card" in its section heading's right slot (needs section); same page state and visibleWhen as the top row {"hostsPageControls":true,"section":{"titleVi":"Social Outreach"}}
csvOnly, csvLayout Keys kept off the card but written to its CSV; "rows_per_x" writes one row per x point {"csvOnly":["per_day"],"csvLayout":"rows_per_x"}
defaults.<dim>.scope: "dataset" A cells default picks among the values of the whole dataset, not the card's pinned scope {"defaults":{"node":{"pick":"first","among":["total"],"scope":"dataset"}}}
Field Meaning Example
------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ ---------------------------------------------------------------------------------------------------------------------------------------
section.titleVi, widget title Page tokens {period_id}, {label:<dimKey>} fill a section title and suffix, and a panel card's own title in read mode. Unresolved: no section heading; a card title drops the token and its separator {"section":{"titleVi":"{label:channel}"}}; card title {label:channel} · Buzz mỗi ngày
section.scopeStyle: "band" The scope strip as a tinted band (surface.accent ground, section-ink dot). Per card, so no other card or org changes. Needs section.scopeVi (refused otherwise) {"section":{"titleVi":"Kênh","scopeVi":"{period_id}","scopeStyle":"band"}}
section.scopePlacement: "after_controls" The scope strip sits under the card's hosted controls (the controls card first, then the scope). Needs section.scopeVi and hostsTabControls (refused otherwise); takes effect with hostedControlsPlacement "section" or "card" {"hostsTabControls":true,"hostedControlsPlacement":"card","section":{"titleVi":"Tổng quan","scopeVi":"{period_id}","scopePlacement":"after_controls"}}
section.stats On a style: "intro" section: up to four figure + label pairs at the heading's right edge, the figure in the section ink (value up to 12 chars, labelVi up to 40, optional labelEn). Typed by the pack, never computed; a stat on any other style is dropped. Absent, the heading is as before {"section":{"titleVi":"Tổng quan","style":"intro","stats":[{"value":"4","labelVi":"phân khúc","labelEn":"segments"},{"value":"9","labelVi":"dòng sản phẩm"}]}}
section.statsLayout: "inline" Each intro stat reads figure then label on one line. Absent = the label under the figure {"section":{"style":"intro","stats":[{"value":"4","labelVi":"phân khúc"}],"statsLayout":"inline"}}
bulletStyle: "lead" A bullets frame prints each row as a lead paragraph: no list marker, body size, section ink. Absent = the bulleted list {"bulletStyle":"lead","rowTemplates":[{"row":"recap","vi":"..."}]}
cardSubtitlePlacement: "header" cardSubtitle in the card header's right slot, wrapping under the title when narrow; a hidden-title card keeps its line. Needs cardSubtitle (refused otherwise) {"cardSubtitle":{"vi":"Loại minigame"},"cardSubtitlePlacement":"header"}
Field Meaning Example
-------------------------------------------------------------------------------------------------- ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ ---------------------------------------------------------------------------------------------------------------------------------------
section.index under deckCardTitleCase: "as_written" Not a pack field: when the org's skin heads cards as written, a numbered section heads in sentence case at 20px in the section ink, and its subtitle takes its own line under the title. Other skins keep the upper-case label {"section":{"index":1,"titleVi":"Người dùng thảo luận điều gì"}}

Blocks and audience cards#

Field Meaning Example
static_block card Widget type with dataSource: "static". block is portfolio_segment, glossary, note or links; button targets are stored as navigate and resolved on the server {"widgetType":"static_block","config":{"dataSource":"static","block":"note","title":{"vi":"Ghi chú"},"body":{"vi":"..."},"collapsible":true}}
surface: "card" On a note block: drawn on the glossary's card, folded under the same 48px title row (or, with collapsible: false, the title row over the body). Absent = bare text {"block":"note","title":{"vi":"Về dữ liệu"},"body":{"vi":"..."},"surface":"card"}
leadEmphasis, topRule On a note block: the body's words before its first colon print bold; topRule draws a hairline above {"block":"note","collapsible":false,"leadEmphasis":true,"topRule":true}
label On a links block: a bold lead at the left of the jump buttons, {vi, en} text up to 60 characters. Absent = buttons only {"block":"links","label":{"vi":"Chuyển tới chiều"},"items":[...]}
surface: "card" On a links block: the row sits on a bordered card. Absent = bare buttons {"block":"links","surface":"card","items":[...]}
actionWidth On a portfolio_segment block: "full" = a line's buttons share its width equally and each takes the whole line once they wrap (a phone). "fit" or absent = buttons as wide as their labels, right-aligned {"block":"portfolio_segment","actionWidth":"full"}
actions[].tone A button's fill: "strong" (default, body ink), "accent", "ink" (section ink) or "outline" (section-ink border and label, no fill), so two buttons on one line can differ {"key":"explore","label":{"vi":"Mở"},"tone":"outline","navigate":{"target":{"page":"explore"}}}
toneRole, actions[].toneRole A theme value role (--series-value-<role>, from the org theme's seriesRoles.value) that fills a primary segment header or a button instead of its tone {"block":"portfolio_segment","tone":"primary","toneRole":"segment-flagship"}
narrativeLayout A narrative_block body laid out as cards, one per ### heading (level: 4 for ####); columns 1-4, numbered, surface, per-section anchor, quoteValue, navigate. csv: true adds the cards to the page CSV {"narrativeLayout":{"columns":2,"numbered":true,"sections":[{"heading":"Màn hình","anchor":"display"}]}}
narrativeLayout.contextFold A card's lead folds under a label at the card's foot, closed on load {"narrativeLayout":{"contextFold":{"label":"Bối cảnh"}}}
narrativeLayout.columnHeading The #### column headings inside a card print at a heading step (bold, primary ink) instead of the small grey label. accent: "zone" inks column n with the skin's zone ink n (--deck-zone-ink-n, the section ink where the skin declares none). Absent, the small label {"narrativeLayout":{"columnHeading":{"accent":"zone"}}}
narrativeLayout.countLine.style: "figure" The {count} figure prints large (heading step, tabular) and the rest of text follows as its label. Absent, one muted sentence {"narrativeLayout":{"countLine":{"datasetKey":"d","dimKey":"topic","text":"{count} lượt nhắc","style":"figure"}}}
narrativeLayout.actions: "buttons" A card's actions are buttons at the right of its foot: "Xem lượt nhắc" and quotes filled in the section ink, a navigate link outlined. Absent = accent text links on the left {"narrativeLayout":{"columns":2,"actions":"buttons"}}
narrativeLayout.chrome: "cards" Each card is a page card of its own; the widget draws no box around them {"narrativeLayout":{"columns":1,"chrome":"cards"}}
narrativeLayout.columnSurface: "panel" Each #### column sits in its own filled panel {"narrativeLayout":{"columns":1,"columnSurface":"panel"}}
narrativeLayout.badge A chip at the end of each card heading {"narrativeLayout":{"columns":1,"badge":{"label":"Tóm tắt cả tuần","labelEn":"Whole-week comparison summary"}}}
narrativeLayout.leadPlacement: "foot" A card's lead text prints under its columns, before the actions {"narrativeLayout":{"columns":1,"leadPlacement":"foot"}}
narrativeLayout.contextLine A card lead whose first line is wholly *…* prints that line as a chip under the card heading, out of the lead {"narrativeLayout":{"columns":2,"contextLine":true}}
narrativeLayout.figureEnd A card lead ending in a **N** · caption line prints N large at the card's end with the caption under it {"narrativeLayout":{"columns":2,"figureEnd":true}}
narrativeLayout.quoteClamp Card quotes clamp to six lines with an ellipsis; the whole quote stays in the verbatims drawer {"narrativeLayout":{"columns":1,"quoteClamp":true}}
narrativeLayout.numberPlacement: "above" With numbered: the card number sits on its own line over the title. Absent = inline before it {"narrativeLayout":{"columns":3,"numbered":true,"numberPlacement":"above"}}
narrativeLayout.quotesLabel The quotes action's words, vi/en ({count} optional). Absent = "Xem trích dẫn (n)" {"narrativeLayout":{"columns":3,"quotesLabel":{"label":"Xem trích dẫn","labelEn":"View verbatim"}}}
narrativeLayout.actionsAlign: "start" With actions: "buttons", the buttons align left; buttons lead with the navigate link {"narrativeLayout":{"columns":1,"actions":"buttons","actionsAlign":"start"}}
editorControls "edit_mode": the configure and editorial bar shows only in dashboard edit mode, never in read mode {"editorControls":"edit_mode"}
quoteCards Every records drawer the card opens lists quote cards (platform, sentiment, date, source, text, https link) with search, a sentiment filter and CSV {"quoteCards":{"translationColumn":"context","csvName":"selected_verbatims"}}
click.cards A click.kind: "detail" dialog lists selected posts as cards; each key names a column of the detail binding {"click":{"kind":"detail","cards":{"date":"published","summary":"text","impact":"impact"}}}
navigate.anchor, navigate.back anchor scrolls the target section into view (URL hash, filters nothing); back: true shows a back link on the opened page {"kind":"navigate","target":{"page":"compare"},"anchor":"display","back":true}
measureCard.shape "stacked_sentiment_bars" on audience_matrix_table: total, share and a negative, positive, neutral bar per row {"measureCard":{"shape":"stacked_sentiment_bars"}}
measureCard.rowExpand Rows expand to counts and the first curated quote; a row with nothing to open has no caret {"measureCard":{"rowExpand":{"quotes":{"datasetKey":"d","dimKey":"quote_attr"},"counts":true}}}
measureCard.rowExpand.definition: true On an audience_matrix_table row axis that is a catalog dimension: an opened row prints that value's catalog definition (definition_vi, brand-masked like labels) above the quote; a value with no definition adds nothing. Absent, the rows draw as before {"measureCard":{"rowExpand":{"definition":true,"quotes":{"datasetKey":"d","dimKey":"quote_attr"}}}}
measureCard.rowLimitOptions: [n, ...] With rowLimit (which must be one of them, the default): the card header gets a compact "Hiển thị Top n" select; the pick is read again by the server through the same rowLimit cut (donut tail, 2-D grid rows), is kept in the card's v URL param, and a share or PDF render draws rowLimit. 2 to 6 distinct values. Absent, the cut is fixed {"measureCard":{"rowLimit":5,"rowLimitOptions":[3,5,10]}}
localFilter.definition: true Under the card toolbar, print the catalog definition (definition_vi, brand-masked) of the single value picked on the first localFilter dimension; nothing for no pick or several. Absent, no line {"localFilter":{"dims":["master"],"definition":true}}
measureCard.rowCounts: "always" With rowExpand: every row prints its counts line ("n tiêu cực · n tích cực · n trung tính") under its bar, open or not; counts then open no row. Refused without rowExpand or together with rowExpand.counts {"measureCard":{"rowExpand":{"quotes":{"datasetKey":"d","dimKey":"quote_attr"}},"rowCounts":"always"}}
measureCard.rowExpandLayout: "list" With rowExpand: bordered rows, the counts coloured by sentiment and ordered positive, negative, neutral, then the total, "share of N" (N is the card's own scoped mention count), "k selected verbatims" (the row's curated quotes) and a +/- expander; no bar. Refused without rowExpand. Absent, the rows draw as before {"measureCard":{"rowExpand":{"quotes":{"datasetKey":"d","dimKey":"quote_attr"}},"rowExpandLayout":"list"}}
measureCard.legend: "sentiment" With shape: "stacked_sentiment_bars" or rowExpand: the segment colours named once above the rows, in the declared column labels (so Vietnamese or English follows the labels you wrote). Refused on any other card. Absent, no legend {"measureCard":{"shape":"stacked_sentiment_bars","legend":"sentiment"}}
measureCard.rowLayout: "ranked" With shape: "stacked_sentiment_bars": each row reads name, then the bar with its counts labelled by sentiment, then the total with "N% of sample" {"measureCard":{"shape":"stacked_sentiment_bars","rowLayout":"ranked"}}
localFilter.strip: "hidden" An audience card whose filter another card drives (a topic list's rowAction) draws no filter pills and no reset on itself {"localFilter":{"dims":["pillar"],"strip":"hidden"}}
measureCard.shareScope: "before_card_filter" Share columns divide by the scope before the card's own local filter, so an attribute inside a picked topic reads as a share of the whole sample. Absent, the base is the filtered scope {"measureCard":{"shareScope":"before_card_filter"}}
measureCard.reportedRows The client's reported figures per row, one value per column in column order (null keeps the corpus figure; a count, or a share in bp); rows then order by the stated value. For rows the client's report states and the delivered corpus cannot fully reproduce. Kept compact because the card config travels with each read {"measureCard":{"reportedRows":[{"valueKey":"p6","values":[3789,4980]}]}}
measureCard.rowValues, hideZeroRows List the declared row members in order; drop zero-count rows after padding {"measureCard":{"rowValues":["set_a","set_b"],"hideZeroRows":true}}
measureCard.csv A "Tải CSV" button exporting the rows as drawn; name stems the file {"measureCard":{"csv":{"name":"matrix"}}}
recordRank On an evidence_table card: instead of the table, the first limit records (1-50) of the page scope ranked by one engagement measure (interactions, reactions, display_comments, display_shares, views), with rank, excerpt, group or source, day, the figure and a link to the original post. Follows the filter bar, the period and ?facet= like a measure card; a row opens the source popup over the same scope. label names the figure (default: the measure's name). Refused on any other kind. Absent, the table draws as before {"audienceKind":"evidence_table","datasetKey":"audience_mentions_evidence","recordRank":{"measure":"display_comments","limit":10,"label":"..."}}