Docs

Visualisation

Learn how to add rich novem visuals to your documents

{{ vis                            # section type
  ref: /u/novem_demo/p/state_pop  # vis to embed
  width: 100%                     # width
  align: center                   # alignment
  include title: true             # include title
  include caption: true           # include caption
}}

Visualisation sections let you embed live novem plots and grids directly in your document. The embedded visuals update automatically when the underlying data changes.

Document vis sections work identically to mail vis sections — the same options, the same reference formats. The closing {{ /vis }} tag is optional in documents.

A novem visual is included by creating a {{ vis }} section in the content file. The section follows the novem markdown section syntax.

There are three ways to reference a visualisation:

  • Shortname — the shortname of the vis, e.g. qNGgN
  • Local path — the api path, e.g. /p/state_pop or /g/dashboard
  • Global path — full user path, e.g. /u/novem_demo/p/state_pop

Both plots (/p/) and grids (/g/) are supported.

Options are supplied as yaml within the double brackets. All options are identical to mail vis options.

keyword: ref
options: shortname | local path | global path


keyword: align
options: left | right | center
default: center


keyword: width
options: 1-100%
default: 100%


keyword: include title
options: true | false
default: true


keyword: include caption
options: true | false
default: true

keyword: include link
options: true | false
default: false


keyword: override title / override caption
options: "New string"


{{ vis
  ref: /u/novem_demo/p/nei_rgn_perf
  width: 100%
  include title: false
  include caption: true
}}


{{ vis ref: /u/novem_demo/p/nei_rgn_tb, width: 80%, align: left }}


{{ page
orient: landscape
cols: 2
}}

{{ vis
  ref: /u/novem_demo/p/nei_rgn_perf
  width: 100%
}}

{{ vis
  ref: /u/novem_demo/p/nei_rgn_hier
  width: 100%
}}
Next
Variables