• Documentation
    • Search documentation
    karat

    +

    K

    API Reference ↗
    AnalyticsNotepadWidgetsObject media preview

    Object media preview

    The Object media preview widget allows you to embed and preview images, audio, video, or document files from a supported media source.

    Supported media sources

    Media references

    Select a media reference typed object property to preview the underlying media.

    Image media references are resizable. Use the drag handle in the bottom-right corner to adjust the image size. Resizing is not supported for other media types.

    Resize media reference image.

    You can configure the print settings for document media references that are applied on Export to PDF.

    • Print widget on new page if space is limited (enabled by default): Automatically moves the widget to a new page during export if there isn’t enough space on the current page.
    • Auto-expand widget height on print: Ensures the widget expands to display the entire document, making all content visible in the exported file. Auto-expand is limited to a maximum of 15 embedded pages.

    Print settings are not supported for other media types.

    Media strings

    Media string options support media referenced in string object properties in the following formats:

    • From a media set: https://{my-foundry-url}/mio/api/media-set/{media set rid}/items/{media item rid}.
    • From a dataset: https://{my-foundry-url}/foundry-data-proxy/api/web/dataproxy/datasets/{dataset rid}/transactions/{transaction rid}/{filename} or https://{my-foundry-url}/foundry-data-proxy/api/web/dataproxy/datasets/{dataset rid}/views/{branch name}/{filename}.
    • External media URL: Ensure access has been configured in your enrollment’s Content Security Policy settings.

    Attachments

    Select an attachment typed property to render a preview of the attachment media. For details on configuring an attachment property, see Upload attachments.

    Widget properties

    • Object selection: The object whose property you want to display.
    • Property to display: The property containing or pointing to a supported media source.

    Template configuration

    • Object selection: The object whose property you want to display.