Successfully!

Error!

FVS Template Export

  • Last update:  2024-03-25
  • Overview

    If you have installed the FineVis Data Visualization plugin, you can learn functions related to the FVS template with this document.

    Version

    Report Server Version
    Plugin VersionFunctional Change

    11.0.16

    2.0.0

    The JavaScript export interface exportTemplate has been added.

    Application Scenario

    You can export your FVS visual dashboard as a PDF, image, or PPT. You can export the dashboard by adding a parameter suffix to the URL or setting a JavaScript event.

    For details about the JavaScript export interface, you can refer to exportTemplate.

    Function Description

    Export Method

    Method 1: Export the template by adding the parameter suffix &op=export&format=xxx to the URL. Besides, you can concatenate the merge or delay parameters with the suffix for additional functions.

    Method 2: Set a JavaScript click event in the template, and export it through the exportTemplate({format,merge,delay}) interface.

    Export Parameters

    Format Parameter

    You can set the format of the exported file with the format parameter, which is not case-sensitive.

    Parameter
    ExampleExport File Format

    pdf

    &op=export&format=pdf

    PDF

    image

    &op=export&format=image

    PNG

    ppt

    &op=export&format=ppt

    PPTX

    Merge Parameter

    If the format parameter is pdf or image, you can concatenate the URL with the merge parameter, which is suitable for multi-page.

    Parameter
    ExampleExport Form

    No merge parameter concatenated.

    &op=export&format=pdf

    A single file exported through multiple pages concatenated.

    true

    &op=export&format=pdf&merge=true

    false

    &op=export&format=pdf&merge=false

    A zip file exported through multiple files that are formed by multiple pages respectively.

    If the format parameter is ppt, the merge parameter does not take effect. In this case, the merge parameter can only be exported to a separate PPTX file.

    delay Parameter

    Regarding the delay parameter, you can set the number of delay seconds before exporting. The parameter is often used for templates that may take a long time to load.

    If you do not concatenate the parameter, the delay second is 0 by default. If you concatenate the parameter with &delay=5, the template will be exported after a delay of 5 seconds.

    Export Rules

    1. The export content is all the content displayed on the template page. If there is any dynamically changing content, the static effect will be saved according to the export time.

    2. If there are multiple pages in the template, the template will be exported in the order starting from the page where the template is previewed to the last page.

    3. The name of the exported file is the template name or the page name by default, and you cannot customize the name.

    4. During the export process, the template preview page will display the "Exporting x/y pages" prompt, and you cannot perform any operation except closing the browser. If you close the browser when the template is being exported, the export will fail.

    Notes

    · You cannot export the template on mobile terminals.

    · You cannot export the Unity components.

    · If the component border backgrounds utilize NinePatch, their settings will automatically be adjusted to Common > Stretch.

    · You cannot export component shadows, reflections, and ground glass effects. Besides, you cannot export the effect of the title text shadow.

    · You cannot export cross-domain videos and images.

    · You cannot export the GIS layer of the point map, the point drill-down map, and the flow map.

    · You cannot export the image fill style of a chart that is filled with images.

    · Some exported content may differ from the original one slightly.

    The URL Export Example

    Opening a Template

    Open a FVS template, as shown in the following figure.

    URL Export

    Click Preview in the upper right corner of the design interface, and a prompt "Save the template in the directory of the current running environment." will be displayed for the first preview. Save the template and preview it.

    Add the suffix &op=export&format=pdf after the URL and press Enter, the effect is shown in the following figure.

    The effect of the downloaded template is shown in the following figure.

    An Example of JavaScript Click Event Export

    Adding a Click Event

    Take the template in section "Open a Template" as an example, add a titlte component to the template and rename the title to Click Here to Export.

    Add a JavaScript click event to the title component, and enter the following code.

    duchamp.exportTemplate({format: "pdf",merge: true});

    The steps are shown in the following figure.

    iconNote:
    If the template contains multiple pages and the event is set on the second page, when you click Click Here to Export, the template will be exported from the second page to the last page without the first page.

    Effect Display

    Click Preview and then click the title component. The effect is shown in the following figure.

    Template Download

    You can download the template: Parking Lot Intelligent Monitoring Dashboard.fvs.


    Attachment List


    Theme: Report Application
    Already the First
    Already the Last
    • Helpful
    • Not helpful
    • Only read

    Doc Feedback