Cell Object API

Difference from V10.0:

Such API is not provided in V10.0.

Added setValue() API in the dashboard, and adapted the API to the FineVis Data Visualization plugin of V 1.17.0.

Example 1: You can obtain the positions of the cell row and cell column as well as the current cell position of the obtained cell defined as cell.

cell.getPosition();//To obtain the position of the cell object defined as cell

cell.getPosition()[0];//To obtain the row position of the cell object defined as cell

cell.getPosition()[1];//To obtain the column position of the cell object defined as cell

Example 2: In the FRM report, you can obtain the position information of cell A1 in the report block report0.

_g().getWidgetByName('report0').getCell(1,1).getPosition();

Example 3: In a general report, you can obtain the position information of cell A1.

 _g().getCell(1,1).getPosition();

Example 4: In the FVS visualization dashboard, you can obtain the position information of cell A1 in the component Table1.

 duchamp.getWidgetByName("Table1").getCell(1,1).getPosition();

Example 5: In the FRM dashboard, you can set a pop-up prompt about the row and column information of cell A1 in the report block report0.

var row=_g().getWidgetByName('report0').getCell(1,1).getPosition()[0];

var col=_g().getWidgetByName('report0').getCell(1,1).getPosition()[1];

FR.Msg.alert("prompt","the row position of cell A1 is"+row+"the column position is"+col);

For details, you can download the template Obtaining the Cell Object Position.frm

FVS visualization dashboard: Obtaining the Cell Object Position.fvs

cell.getRow();

Example 2: In the FRM dashboard, you can obtain the cell object of the row where cell A1 in the report block report0 is located.

_g().getWidgetByName('report0').getCell(1,1).getRow();

Example 3: In a general report, you can obtain the cell object of the row where cell A1 is located.

_g().getCell(1, 1).getRow();

Example 4: In the FVS visualization dashboard, you can obtain the cell object of the row where cell A1 in the component Table1 is located.

duchamp.getWidgetByName("Table1").getCell(1,1).getRow();

Example 5: In the FRM report, you can modify the text color to red and the font size to 14 for the content in the row where cell A1 is located in the report block report0.

_g().getWidgetByName('report0').getCell(1, 1).getRow().setStyle({

 fontSize: 14,

 color: 'red'

});

For details, you can download the template Modifying the Row Style.frm

FVS visualization dashboard: Modifying the Row Style.fvs.

cell.getColumn();

Example 2: In the FRM report, you can obtain the cell object of the column where cell A1 in the report block report0 is located.

_g().getWidgetByName('report0').getCell(1,1).getColumn();

Example 3: In a general report, you can obtain the cell object of the column where cell A1 is located.

_g().getCell(1,1).getColumn();

Example 4: In the FVS visualization dashboard, you can obtain the cell object of the column where cell A1 in the component Table1 is located.

duchamp.getWidgetByName("Table1").getCell(1,1).getColumn();

Example 5: In the FRM report, you can modify the text color to red and the font size to 14 for the content in the column where cell A1 is located in the report block report0.

_g().getWidgetByName('report0').getCell(1,1).getColumn().setStyle({

 fontSize: 14,

 color: 'red'

});

For details, you can download the template Modifying the Column Style.frm. 

FVS visualization dashboard: Modifying the Column Style.fvs.

cell.getValue();

Example 2: In the FRM report, you can obtain the type and the value of cell A1 in the report block report0.

_g().getWidgetByName('report0').getCell(1,1).getValue();

Example 3: In a general report, you can obtain the type and the value of cell A1.

_g().getCell(1,1).getValue();

Example 4: In the FVS visualization dashboard, you can obtain the type and the value of cell A1 in the component Table1.

duchamp.getWidgetByName("Table1").getCell(1,1).getValue();

Example 5: In the FRM report, you can set a pop-up prompt about printing the type and the value of cell A1 in the report block report0.

var a=_g().getWidgetByName('report0').getCell(1,1).getValue();

FR.Msg.alert("Prompt", "The value of cell A1 is"+a);

For details, you can download the template Displaying the Cell Value by Clicking.frm.

FVS visualization dashboard: Obtaining the Cell Value.fvs.

However, when getCell is used with getValue, such as

 _g().getCell(1,1).getValue();

, the effect cannot be displayed in the data entry preview.

Example 1: In the FVS visualization dashboard, you can assign the value other regions to the component Table1 in cell A1.

duchamp.getWidgetByName("Table1").getCell(1,1).setValue("other regions");

Example 2: In the FRM report, you can assign the value other regions to cell A1 in the report block report0.

_g().getWidgetByName("report0").getCell(1,1).setValue("other regions");

For details, you can download the template Modifying the Cell Value by Clicking.fvs.

opts: Object

{

    show: boolean,

    content: {

        text: string, // text

        image: string, // image

        header: string // title

    }

    style: {

    } 

}

Note: 

The header and image parameters are not supported in general reports.

opts: pop-up option, which is an object.

1. show: whether to show a pop-up window, which is a boolean. true: to show the pop-up window. false: not to show the pop-up window.

2. content: You can select a field, or the cell value will be displayed.

text: the prompt content, which is a string.

image: URL path to the image, which is a string. The supported image formats include PNG and JPG. The image source can be a web page, as shown in the following figure.

Alternatively, you can place the image in the report project directory %FR_HOME%\webapps\webroot and access it via URL, as shown in the following figure.

header: the title.

3. style: You can select a field, or the default style will be displayed. For details about supported styles, see Style Attribute.

cell.showToolTip({

 show: true, // Whether to show the pop-up window

 content: { // To select a field or display the text

  text: "Regional Sales Data", // The text

  header: "Prompt" // The title

 },

 style: { // To select the field supported by CSS specifications or display the default style

  color: "#DC143C"

// Follow the CSS specifications

 }

});

Example 2: In the FRM report, you can set a prompt box whose title is Prompt and the content is Regional Sales Data in red for the report block report0.

_g().getWidgetByName('report0').getCell(1,1).showToolTip({

 show: true, // Whether to show the pop-up window

 content: { // To select a field or display the content cell.getValue();

  text: "Regional Sales Data", // The text

  header: "Prompt" // The title

 },

 style: { // To select the field supported by CSS specifications or display the default style

  color: "#DC143C"

// Follow the CSS specifications

 }

});

Example 3: In a general report, you can set a prompt box whose title is Prompt and the content is Regional Sales Data in red for cell A1.

_g().getCell(1,1).showToolTip({

 show: true, // Whether to show the pop-up window

 content: { // To select a field or display the content cell.getValue();

  text: "Regional Sales Data", // The text

  header: "Prompt" // The title

 },

 style: { // To select the field supported by CSS specifications or display the default style

  color: "#DC143C"

// Follow the CSS specifications

 }

});

Example 4: In the FVS visualization dashboard, you can set a prompt box whose title is Prompt and the content is the cell value for cell A1 in the component Table1.

duchamp.getWidgetByName("Table1").getCell(1,1).showToolTip({

 show: true, // Whether to show the pop-up window

 content: { // To select a filed or display the text

  header: "Prompt" // The title

 }

});

Example 5: In the FRM report, you can set a prompt box whose title is Prompt and the content is the cell value for the report block report0.

_g().getWidgetByName('report0').getCell(1,1).showToolTip({

 show: true, // Whether to show the pop-up window

 content: { // To select a field or display the text

  header: "Prompt" // The title

 }

});

For details, you can download the template Text Tooltip in Cells with Hovering Cursor.frm.

FVS visualization dashboard: Text Tooltip in Cells with Hovering Cursor.fvs.

opts: Object 

{

    fontFamily: String

    fontSize: number

    fontWeight: String

    color: String

  ........ 

}

opts: cell style attributes such as border and font color.

For details about supported attributes, see Style Attribute.

cell.setStyle({

 fontSize: 14,

 color: 'red'

});

Example 2: In a general report, you can set the font color to red and font size to 14 for cell A1.

_g().getCell(1,1).getValue();

 fontSize: 14,

 color: 'red'

});

Example 4: In the FVS visualization dashboard, you can set the font color to red and font size to 20 for cell A1 in the component Table1.

duchamp.getWidgetByName("Table1").getCell(1,1).setStyle({

 fontSize: 20,

 color: 'red'

});

Example 5: In the FRM report, you can set the font color to red and font size to 14 for cell A1 in the report block report0.

_g().getWidgetByName('report0').getCell(1,1).setStyle({

 fontSize: 14,

 color: 'red'

});

For details, you can download the template Modifying Cell Style after Obtaining the Cell.frm.

FVS visualization dashboard: Modifying Cell Style after Obtaining the Cell.fvs.

Row and column indexes in JSON format

col: column index, starting from 0

row: row index, starting from 0

FR.cellStr2ColumnRow("A1");

Example 2: In a general report or FRM report, you can use this API to print the row number of cell A1.

var a=FR.cellStr2ColumnRow("A1").row+1;

FR.Msg.alert("Prompt", "The row number of cell A1 is"+a);

Example 3: In an FVS template, you can print the row and column number of a cell.

var a=duchamp.cellStr2ColumnRow("A3").col+1;

var b=duchamp.cellStr2ColumnRow("A3").row+1;

//alert(a);

duchamp.Msg.alert({

    title: "Prompt",

    message:  "The column number of cell A3 is"+a,

});

duchamp.Msg.alert({

    title: "Prompt",

    message:  "The row number of cell A3 is"+b,

});

In the FVS template, you can click the button to print the row and column numbers of cell A3.

For details, you can download the template Printing the Row and Column Numbers of A Cell.fvs.

Row and column indexes in JSON format

col: column index, starting from 0

row: row index, starting from 0

FR.columnRow2CellStr({col:1, row:3});

Example 2: In a general report or FRM report, you can print the cell number of the cell with row index 3 and column index 1.

var a=FR.columnRow2CellStr({col:1, row:3})

FR.Msg.alert("Prompt", "The cell number of the cell with row index 3 and column index 1 is "+a);

Example 3: In an FVS template, you can print the cell number of the cell with row index 3 and column index 1.

var a=duchamp.columnRow2CellStr({col:1, row:3})

duchamp.Msg.alert({

    title: "Prompt",

    message: "The cell number of the cell with row index 3 and column index 1 is"+a,

});

In the FVS template, you can print the cell number of the cell with row index 3 and column index 1.

For details, you can download the template Obtaining the Cell Number Based on the Row and Column Number.fvs.