FVS Page Interface

11.0

V1.0.0

The lowest version requirement.

11.0.22

V2.5.0

Adds interface getAllPages.

Template pagination

URL suffix parameter page=x, x starts from 0.

page=0 represents the first page.

Change the URL suffix parameter to page_number=x, where x starts from 1.

page_number=1 represents the first page.

Table pagination

The pagination index starts from 1, representing the first page.

Unchanged.

Tab sheet

The tab sheet index starts from 0, representing the first page.

The tab index starts from 1, representing the first page.

/

/

object

Current component object

Example 1: Get the actual value of the current widget component.

this.getValue();

Example 2: Set the current widget to be invisible.

this.setVisible(false);

Example 3: Clear the value of the current widget.

this.reset();

/

It is supported on mobile terminals.

name: string

Component name, string

object

Component object

Example: Get the title component.

duchamp.getWidgetByName("Title1_Page1");

/

It is supported on mobile terminals.

{para:"para"}

parameter name: parameter value

/

/

Example 1: Trigger the Component1 refresh.

duchamp.getWidgetByName("Component1").reset();

Example 2: Trigger the Column Chart component refresh and transfer the parameter New York to the column chart.

duchamp.getWidgetByName("Column Chart").refresh({Region:"New York"});

Note:

When you transfer multiple parameters to the same component, use the following syntax:

duchamp.getWidgetByName("Component").refresh({a:"parameter value",b:"parameter value"});

Click the title component to trigger a refresh of the Column Chart component and transfer the parameter of New York as Region to the column chart.

You can download the template: refresh.fvs.

It is supported on mobile terminals.

/

/

/

/

Trigger all click events of Component1.

duchamp.getWidgetByName("Component1").reset();

/

It is supported on mobile terminals.

/

/

/

/

Example: Add a click JavaScript event to the title component to trigger the full-screen mode on the page.

duchamp.requestFullscreen();

/

It is not supported on mobile terminals.

/

/

/

/

Example: Add a click JavaScript event to the title component to exit the full-screen mode.

duchamp.exitFullscreen();

/

It is not supported on mobile terminals.

/

/

/

/

Refresh the page every two seconds.

setInterval(() => {    duchamp.reload();  }, 2 * 1000);

Plugins before V1.7.2 can only implement this function through the JavaScript code under Template > Event After Page Load.

Starting from V1.7.2, you can use the Template Timed Refresh function to implement this function.

It is supported on mobile terminals.

always/hover/never

Three states of the switch button (always by default).

always: always display

hover: display when you hover the cursor

never: never display

/

/

You can add the following code to Event After Page Load of the template.

Example 1: Set the switch button always to display.

duchamp.setPageButtonDisplayPolicy("always");

Example 2: Set the switch button to invisible and display when the cursor hovers over it.

duchamp.setPageButtonDisplayPolicy("hover");

Example 3: Set the switch button never to display.

duchamp.setPageButtonDisplayPolicy("never");

/

It is not supported on mobile terminals.

{para:"para"}

parameter name: parameter value

/

/

There is no need to get multiple parameter widgets and assign values to them separately. Using this interface can achieve global parameter linkage, which affects all pages.

Example: Click the title component and transfer New York as the parameter value to all components in the template that use the Region parameter.

duchamp.linkageGlobal({Region:"New York"})

Note:

The syntax for transferring multiple parameters is shown below:

duchamp.linkageGlobal({a:"parameter value",b:"parameter value"});

You can download the template: linkageGlobal.fvs.

It is supported on mobile terminals.

/

/

/

/

When the multi-page template is set to automatically switch pages, pause the switch.

duchamp.pauseRollPlay();

You can download the template: pauseRollPlay_continueRollPlay.fvs.

It is not supported on mobile terminals.

/

/

/

/

When the multi-page template is set to automatically switch pages and the automatic page switch is paused, resume the automatic page switching.

duchamp.continueRollPlay();

You can download the template: pauseRollPlay_continueRollPlay.fvs.

It is not supported on mobile terminals.

value:page_number|name

Get a page through the page index or page name.

page_number: page index (a positive integer starting from 1)

name: page name (string)

{
  setVisible: (visible: boolean) => void,
  goto: (options?: { [key: string]: string }) => void,
  getName: () => string,
  getIndex: () => number,
  isVisible: () => boolean,
}

{

visible: visibility

options: the page object to go to

name: the page name

number: the page index (a positive integer starting from 1)

}

Example 1: In the FVS template, get Page1.

duchamp.getPage("Page1");

Example 2: In the FVS template, the Table1 component has pagination enabled. Get Page1 of the Table1 component.

duchamp.getWidgetByName("Table1").getPage(1);

Example 3: In the FVS template, get the first sheet of the Tab1 component.

duchamp.getWidgetByName("Tab1").getPage(1);

/

It is supported on mobile terminals.

/

/

{
  setVisible: (visible: boolean) => void,
  goto: (options?: { [key: string]: string }) => void,
  getName: () => string,
  getIndex: () => number,
  isVisible: () => boolean,
}

{

visible: visibility

options: the page object to go to

name: the page name

number: the page index (a positive integer starting from 1)

}

Example 1: In the FVS template, get the previous page of the current page.

duchamp.getPreviousPage();

Example 2: In the FVS template, the Table1 component has pagination enabled. Get the previous page of the Table1 component.

duchamp.getWidgetByName("Table1").getPreviousPage();

Example One: In the FVS template, get the previous page of the Tab1 component.

duchamp.getWidgetByName("Tab1").getPreviousPage();

/

It is supported on mobile terminals.

/

/

{
  setVisible: (visible: boolean) => void,
  goto: (options?: { [key: string]: string }) => void,
  getName: () => string,
  getIndex: () => number,
  isVisible: () => boolean,
}

{

visible: visibility

options: the page object to go to

name: the page name

number: the page index (a positive integer starting from 1)

}

Example 1: In the FVS template, get the next page of the current page.

duchamp.getNextPage();

Example 2: In the FVS template, the Table1 component has pagination enabled. Get the next page of the Table1 component.

duchamp.getWidgetByName("Table1").getNextPage();

Example One: In the FVS template, get the next page of the Tab1 component.

duchamp.getWidgetByName("Tab1").getNextPage();

/

It is supported on mobile terminals.

/

/

{
  setVisible: (visible: boolean) => void,
  goto: (options?: { [key: string]: string }) => void,
  getName: () => string,
  getIndex: () => number,
  isVisible: () => boolean,
}

{

visible: visibility

options: the page object to go to

name: the page name

number: the page index (a positive integer starting from 1)

}

Example 1: In the FVS template, get the first page of the template.

duchamp.getFirstPage();

Example 2: In the FVS template, the Table1 component has pagination enabled. Get the first page of the Table1 component.

duchamp.getWidgetByName("Table1").getFirstPage();

Example 3: In the FVS template, get the first sheet of the Tab1 component.

duchamp.getWidgetByName("Tab1").getFirstPage();

/

It is supported on mobile terminals.

/

/

{
  setVisible: (visible: boolean) => void,
  goto: (options?: { [key: string]: string }) => void,
  getName: () => string,
  getIndex: () => number,
  isVisible: () => boolean,
}

{

visible: visibility

options: the page object to go to

name: the page name

number: the page index (a positive integer starting from 1)

}

Example 1: In the FVS template, get the last page of the template.

duchamp.getLastPage();

Example 2: In the FVS template, the Table1 component has pagination enabled. Get the last page of the Table1 component.

duchamp.getWidgetByName("Table1").getLastPage();

Example 3: In the FVS template, get the last sheet of the Tab1 component.

duchamp.getWidgetByName("Tab1").getLastPage();

/

It is supported on mobile terminals.

/

/

{
  setVisible: (visible: boolean) => void,
  goto: (options?: { [key: string]: string }) => void,
  getName: () => string,
  getIndex: () => number,
  isVisible: () => boolean,
}

{

visible: visibility

options: the page object to go to

name: the page name

number: the page index (a positive integer starting from 1)

}

Example 1: In the FVS template, get the page being currently displayed in the template.

duchamp.getCurrentPage();

Example 2: In the FVS template, the Table1 component has pagination enabled. Get the current page of the Table1 component.

duchamp.getWidgetByName("Table1").getCurrentPage();

Example 3: In the FVS template, get the current sheet of the Tab1 component.

duchamp.getWidgetByName("Tab1").getCurrentPage();

/

It is supported on mobile terminals.

/

/

page[x]

Page array, x starts from 0, 0 represents the first page

Note:

The page index here starts from 1, unlike the page index.

Example 1: In the FVS template, get the total number of pages in the template and display it in a pop-up.

var a = duchamp.getAllPages().length;
duchamp
.Msg.alert({
      title: "Prompt" ,
message:"The total number of the current template page: "+ a})

Example 2: In the FVS template, the Table1 component has pagination enabled. Get the name of the second page of the Table1 component.

duchamp.getWidgetByName("Table1").getAllPages()[1].getName();

Example 3: In the FVS template, get the index of the first sheet of the Tab1 component.

duchamp.getWidgetByName("Tab1").getAllPages()[0].getIndex();

You can download the template: getAllPages.fvs.

It is supported on mobile terminals.

visible: boolean

Whether the page is displayed, boolean type

true: visible

false: invisible

/

/

Example 1: In the FVS template, hide the Page1 template.

duchamp.getPage("Page1").setVisible(false);

Example 2: In the FVS template, the Table1 component has pagination enabled and hides Page1.

duchamp.getWidgetByName("Table1").getPage(1).setVisible(false);

Example 3: In the FVS template, hide Sheet1 of the Tab1 component.

uchamp.getWidgetByName("Tab1").getPage(1).setVisible(false);

You can download the template: setVisible.fvs.

It is supported on mobile terminals.

/

/

visible: boolean

Whether the page is displayed, boolean type

true: visible

false: invisible

Example 1: In the FVS template, get Page2, and return its visibility state with a pop-up.

var a = duchamp.getPage(Page2).isVisible();
duchamp
.Msg.alert({
      title: "Prompt" ,

message:"Page2 is visible: "+ a})

Example 2: In the FVS template, the Table1 component has pagination enabled. Get Page2 of the table and return its visibility state.

duchamp.getWidgetByName('Table1').getPage(2).isVisible();

Example 3: In the FVS template, get the visibility state of Sheet2 of the Tab1 component.

duchamp.getWidgetByName('Tab1').getPage(2).isVisible();

You can download the template: isVisible.fvs.

It is supported on mobile terminals.

{para:"para"}

parameter name: parameter value

/

/

Example 1: In the FVS template, go to the next page.

duchamp.getNextPage().goto();

Example 2: In the FVS template, the Table1 component has pagination enabled. Go to the next page.

duchamp.getWidgetByName('Table1').getNextPage().goto();

Example 3: In the FVS template, go to the next sheet of the Tab1 component.

duchamp.getWidgetByName('Tab1').getNextPage().goto();

Example 4: In the FVS template, go to the next page and transfer parameters.

duchamp.getNextPage().goto({a:"parameter a"});

The syntax for transferring multiple parameters is shown below:

duchamp.getNextPage().goto({a:"parameter a",b:"parameter b"});

You can download the template: goto.fvs.

It is supported on mobile terminals.

/

/

name: string

Page name, string

Example 1: In the FVS template, get the current page name and display it in a pop-up.

var name = duchamp.getCurrentPage().getName();
duchamp
.Msg.alert({
      title: "Prompt" ,
      
message:"The name of the current template page is: "+ name})

Example 2: In the FVS template, get the current page name of the Tab1 component and display it in a pop-up.

var name = duchamp.getWidgetByName('Tab1').getCurrentPage().getName();
duchamp
.Msg.alert({
      title: "Prompt" ,
      
message:"The name of the current tab sheet is: "+ name})

Note:

The page of the table component does not have a name. If you use the above JS, the return value will be undefined.

You can download the template: getName.fvs.

It is supported on mobile terminals.

/

/

number

The page index: (a positive integer starting from 1)

Example 1: In the FVS template, get the current page index and display it in a pop-up.

var number = duchamp.getCurrentPage().getIndex();
duchamp
.Msg.alert(
{ title: "Prompt", message: "The current page name is " +
number
 })

Example 2: In the FVS template, get the current page index of the Table1 component and display it in a pop-up.

var number = duchamp.getWidgetByName('Table1').getCurrentPage().getIndex();
duchamp
.Msg.alert({
      title: "Prompt" ,
      
message:"The index of the current page is: "+ number})

Example 2: In the FVS template, get the current page index of the Tab1 component and display it in a pop-up.

var number = duchamp.getWidgetByName('Tab1').getCurrentPage().getIndex();
duchamp
.Msg.alert({
      title: "Prompt" ,
      
message:"The index of the current sheet is: "+ number})

You can download the template: getIndex.fvs.

It is supported on mobile terminals.