Marquee API

  • Last update:April 09, 2025
  • Version

    VersionFunctional Change
    11.0

    Difference from 10.0:

    Supported this API in 10.0, as well as 10.0.19 and later versions.

    11.0.9Allowed you to configure the marquee (a special effect)  without using any JS code in FVS V1.14.0. Optimized the startMarquee API parameter in FVS for alignment with configuration items.

     startMarquee

    General Report/FRM Report

    iconNote:
     1. The marquee effect set through the following API cannot be refreshed by the FRM Dashboard Block Refresh plugin.
    API startMarquee(opt)   To enable the marquee effect. 
      Parameter

    opt: {

    offsetnumber,

    intervalnumber,

    stopOnHoverboolean,

    tostring

    } 

    Scrolling effect attribute in the JSON format.

    offset: scrolling distance (5px by default), in px.

    interval: time interval (0.1s by default), in s.

    stopOnHover: whether to pause the scrolling when you hover your cursor over a report block, which is set to true by default.

    true: pause

    false: no pause

    to: scrolling direction, which can be set to left or top (default value).

    'top': to scroll up

    'left': to scroll left

      Returned Value  void
      Example Example 1: You can achieve the default marquee effect (scrolling by 5px every 0.1s and pausing when you hover your cursor over an obtained report block defined as report).

    report.startMarquee();

    Example 2: In a general report, you can achieve the default marquee effect. 

    _g().startMarquee();

    Example 3: In an FRM report, you can add the default marquee effect for the report block named report0

    _g().getWidgetByName('report0').startMarquee();

    iconNote: 
    When adding the code in an After Initialization event, you are advised to add a delay function to postpone the execution. Otherwise, an error may occur due to incomplete creation of the report block object. The example is as follows:

    setTimeout(function(){

         _g().getWidgetByName('report0').startMarquee();

    }, 500);

    Example 4: You can set a general report to scroll left by 2px every 0.3s and not to be paused when you hover your cursor over the report.

    _g().startMarquee({        

     offset: 2,        

     interval: 0.3,        

     stopOnHover: false,

     to:'left'   

    });

    Example 5: You can set the report block named report0 in an FRM report to scroll left by 2px every 0.3s and not to be paused when you hover your cursor over the report block. 

    setTimeout(function() {

     _g().getWidgetByName('report0').startMarquee({

      offset: 2,

      interval: 0.3,

      stopOnHover: false,

      to:'left'

     })

    }, 500);

     Application 

    Example 

    You can achieve the default marquee effect for a report block (namely, stopped from scrolling when you hover your cursor over the report block).

    For details, you can download the template Enabling the Marquee Effect.frm.

    09.gif

    Mobile TerminalThe marquee effects of general reports/FRM reports cannot be previewedon the DataAnalyst app.

    The marquee effects of general reports can be previewed on H5 terminals, but cannot be previewed during data entry.

    The marquee effects of FRM reports can be previewed on H5 terminals.

    FVS Visualization Dashboard

    APIstartMarquee(opt) To enable the marquee effect.
      Parameter 

    opt: {

    modestring,

    speednumber,

    tostring,

    staynumber,

    stopOnHover:boolean,

    joinable:boolean, 

    } 

    Scrolling effect attribute in the JSON format.

    mode: scrolling content, (displayed in full screen by default).

    'item': scrolling by item

    'page': full screen scrolling 

    speed: scrolling speed (50 px/s by default), in px/s.

    to: scrolling direction, which can be set to left or top (efault value).

    'top': to scroll up

    'left': to scroll left

    stay: scrolling interval (0s by default), in s. 

    stoopOnHover: whether to pause the scrolling when you hover your cursor over a dashboard, which is set to true by default.

    true: pause

    false: no pause

    joinable: whether to scroll a dashboad in a head-to-tail way, which is set to false by default.

    true: head-to-tail scrolling

    false: scrolling from the beginning

    Returned Valuevoid
     Example Example: In an FVS visualization dashboard, you can add the default marquee effect to a table component.

    setTimeout(() => {

            duchamp.getWidgetByName("Table component").startMarquee()     

    }, 500);

      Application 

    Example 


     Mobile Terminal This API is supported on mobile terminals.

    stopMarquee

    API stopMarquee() To disable the marquee effect.
     Parameter --

    Returned 

    Value

    void
    ExampleExample 1: You can disable the marquee effect set by startMarquee() for the obtained report block defined as report. 

    report.stopMarquee();

    Example 2: In a general report, you can disable the marquee effect set by startMarquee().

    _g().stopMarquee();

    Example 3: In an FRM report, you can disable the marquee effect of the report block named report0.

    _g().getWidgetByName('report0').stopMarquee();

    Example 4: In an FVS visualization dashboard, you can disable the marquee effect of a table component.

    duchamp.getWidgetByName("table").stopMarquee();

     Application Example You can click the Disable button to disable the marquee effect in a report block.

    For details, you can download the template Disabling the Marquee Effect.frm.

    10.gif

    Mobile 

    Terminal 

    The marquee effects of general reports cannot be previewed on the DataAnalyst app or H5 terminals.

    The marquee effects of FVS visualization dashboards can be previewed on the DataAnalyst app and H5 terminals.

    The marquee effects of FRM reports can be previewed on H5 terminals, but cannot be previewed on the DataAnalyst app.

     

    Attachment List


    Theme: Secondary Development
    • Helpful
    • Not helpful
    • Only read

    滑鼠選中內容,快速回饋問題

    滑鼠選中存在疑惑的內容,即可快速回饋問題,我們將會跟進處理。

    不再提示

    10s後關閉

    Get
    Help
    Online Support
    Professional technical support is provided to quickly help you solve problems.
    Online support is available from 9:00-12:00 and 13:30-17:30 on weekdays.
    Page Feedback
    You can provide suggestions and feedback for the current web page.
    Pre-Sales Consultation
    Business Consultation
    Business: international@fanruan.com
    Support: support@fanruan.com
    Page Feedback
    *Problem Type
    Cannot be empty
    Problem Description
    0/1000
    Cannot be empty

    Submitted successfully

    Network busy