Visual library

The visual library is where your organisation's custom visuals are published and kept. Publish a visual once, insert it into any report, and control which version each report uses. To build a visual, see Custom visuals and the visual library.

Add a tile to the library

You need the Publish Organization Visuals permission.

  1. Open the tile menu on a custom visual in a report and choose Add to visual library.
  2. Fill in the form. Name is the name the library shows, up to 200 characters. Description says what the visual shows and when to use it, up to 2,000 characters. Family is one of Chart, Table, KPI, Map, Text, Navigation or Other.
  3. For a visual that reads fields, leave Store the first 50 rows as sample data on. Sample rows drive the gallery thumbnail and preview, and every library reader sees them.
  4. Choose Add to library. The visual is saved as a draft at version 1, and the tile is pinned to it.

The form refuses incomplete input with Name is required, Name is too long (200 characters max) or Description is too long (2000 characters max). A disabled Add to library button carries its reason, such as Enter a name for the visual, Sample rows are still loading or Fix the blocking checks first.

Publish a version

A draft is visible to its owner and to people who hold Publish Organization Visuals. Everyone else sees the visual only after you publish it.

  1. Open DataPrism > Visuals and select the visual. The header reads Current v<n> once the visual has a published version, or Not published yet.
  2. In Versions, choose Publish on the version that should become the library head.
  3. Choose what happens to the reports that already use the visual, then confirm with Publish or Publish and replace.
OptionWhat it does
Replace in all dependant reports (N)Rewrites the pinned tiles as one labelled, restorable report version per report. Detached copies are never touched.
New version, dependants stay pinnedReports keep the version they pinned and show an Update available chip.

Replace is preselected when the version is compatible with every pinned tile. When a version changes the data roles or options, replace is unavailable: Replace is unavailable: this version changes the data roles or options, so dependant tiles would lose their bindings. Publish it as a new version instead.

Warning

With Replace in all dependant reports selected, every listed report changes as soon as you publish. Check the choice first.

Publishing is also refused while the code uses literal colours. The checks a visual passes are described in Sandbox, network and the allowlist.

Insert a visual into a report

  1. Open the report in edit mode, open Visualizations and choose Library in the Custom group. The picker reads Insert from the visual library.
  2. Search by name, description or author; switch between Organization and This report (N); and sort by Recently updated or Name A to Z.
  3. Select a visual and choose its version under Version to insert. The detail lists the roles it Expects in the Data well.
  4. Choose Insert v<n> onto page, then bind the fields the visual reads in the Data well.

The picker lists published visuals only. One that cannot be inserted stays listed, dimmed and last; hover it for the reason. When there is nothing to show, it offers Open the visual library, Browse the organization or Clear search.

A visual can reference uploaded files. When the report does not hold them, the picker warns Assets missing from this report; the visual shows them as missing until they are uploaded to the report's assets.

Update a tile that is on an older version

Manage a published visual

Open DataPrism > Visuals to browse the gallery: one card per visual, with previews drawn from sample data, and controls to filter by status (Published, Draft, Deprecated) or family. Select a visual to open its detail; an open visual has its own link you can share.

Switch a visual off and back on

Chips you will see

ChipMeaning
Update availableA newer published version exists. Select it to review and update the tile.
DeprecatedThe visual is deprecated. Reports that use it keep working.
Disabled by an administratorThe visual is switched off; its tiles show a placeholder instead.
Detached copyThe tile stopped following the library and keeps the version it had.
Library visual (no access)You cannot read the visual's library record, so its name is hidden.

Questions, answered

Can I choose an older version to insert?

Yes. Under Version to insert you choose any published version, and the button takes that exact version, so it reads Insert v<n> onto page. The tile stays pinned to that version until someone chooses Update.

What do "Compatible" and "Breaking" mean on a version?

A version is compatible when it keeps the same data roles and options as the version before it. A breaking version changes them: it can still be published, but it cannot replace pinned tiles, so each report moves to it only when someone reviews the update.

What happens to a detached tile?

It keeps working on the version it has and stops following the library. It shows the Detached copy chip, replacing never touches it, and the Used in list counts it separately.

Why is a visual dimmed in the library picker?

It cannot be inserted: it is Disabled by an administrator or has No published version yet. It stays listed and last; hover it to see the reason.

Do I need sample rows to publish a visual?

Yes, for a visual that reads fields: without a sample it is blocked with A data-bound visual needs sample rows for its gallery thumbnail and preview. The add form stores the first 50 rows of the tile by default, and a sample can hold up to 1,000 rows or 256 KiB. A data-free visual, such as a header or a logo, publishes without sample rows.

How do I see which reports use a visual?

Open the visual in the library. Used in counts the reports and tiles, for example Used in 3 reports (5 tiles, 1 detached), and each report has an Open link.

Can I make an older version the current one again?

Yes. Open the visual, choose Publish on that version in Versions, and decide what happens to the reports that use the visual; it becomes the library head again.

Who can add a visual to the library?

You need Publish Organization Visuals. Writing or editing the code needs Author DataPrism Custom Visuals, and switching a visual off everywhere needs Disable DataPrism Custom Visuals. See Who can do what in DataPrism.