excel.functions.plugins

Class ExcelFunctions

java.lang.Object

excel.functions.plugins.ExcelFunctions

public class ExcelFunctions
extends Object

Author:

BioVoxxel

Constructor Summary

Constructors

Constructor and Description
ExcelFunctions()

Method Summary

Modifier and Type	Method and Description
static void	addImageToWorkbookSheet(ij.ImagePlus imagePlus, File workbookFile) This function adds an image open in ImageJ / Fiji as PNG to the defined worksheet in a defined Excel workbook Note: the size of images added to Excel cannot be properly controlled via the Apache POI library.
static void	addImageToWorkbookSheet(ij.ImagePlus imagePlus, File workbookFile, int sheetIndex, int column, int row) This function adds an image open in ImageJ / Fiji as PNG to the defined worksheet in a defined Excel workbook Note: the size of images added to Excel cannot be properly controlled via the Apache POI library.
static void	addImageToWorkbookSheet(ij.ImagePlus imagePlus, File workbookFile, String sheetName, int column, int row) This function adds an image open in ImageJ / Fiji as PNG to the defined worksheet in a defined Excel workbook Note: the size of images added to Excel cannot be properly controlled via the Apache POI library.
static void	appendArrayAsExcelColumn(Number[] array, File workbookFile, int sheetIndex, int startingRow)
static void	appendArrayAsExcelColumn(Number[] array, File workbookFile, String sheetName, int startingRow)
static void	appendArrayAsExcelColumn(String[] array, File workbookFile, int sheetIndex, int startingRow)
static void	appendArrayAsExcelColumn(String[] array, File workbookFile, String sheetName, int startingRow)
static void	appendArrayAsExcelRow(Number[] array, File workbookFile, int sheetIndex, int startingColumn)
static void	appendArrayAsExcelRow(Number[] array, File workbookFile, String sheetName, int startingColumn)
static void	appendArrayAsExcelRow(String[] array, File workbookFile, int sheetIndex, int startingColumn)
static void	appendArrayAsExcelRow(String[] array, File workbookFile, String sheetName, int startingColumn)
static void	appendTableAsColumns(ij.measure.ResultsTable ijResultsTable, File workbookFile, int sheetIndex, Boolean includeColumnHeadings) Adds the specified ResultsTable as additional columns after the existing ones on the specified sheet
static void	appendTableAsColumns(ij.measure.ResultsTable ijResultsTable, File workbookFile, String sheetName, Boolean includeColumnHeadings) Adds the specified ResultsTable as additional columns after the existing ones on the specified sheet
static void	appendTableAsRows(ij.measure.ResultsTable ijResultsTable, File workbookFile, int sheetIndex, Boolean includeColumnHeadings) Adds the specified ResultsTable as additional rows below the existing ones on the specified sheet
static void	appendTableAsRows(ij.measure.ResultsTable ijResultsTable, File workbookFile, String sheetName, Boolean includeColumnHeadings) Adds the specified ResultsTable as additional rows below the existing ones on the specified sheet
static void	deleteWorkbookSheet(File workbookFile, int sheetIndex)
static void	deleteWorkbookSheet(File workbookFile, String sheetName)
static String	getAllWorkbookSheetNames(File workbookFile)
static void	importXlsxWorksheetAsTable(File workbookFile, int sheetIndex, boolean useFirstRowAsHeading)
static void	importXlsxWorksheetAsTable(File workbookFile, String sheetName, boolean useFirstRowAsHeading)
static void	saveAllOpenTablesAsWorkbookSheets(File workbookFile, Boolean includeColumnHeadings)
static void	saveAllOpenTablesAsWorkbookSheets(String filePathToXlsxWorkbookFile, Boolean includeColumnHeadings)
static void	saveTableToWorkbookSheet(ij.measure.ResultsTable ijResultsTable, File workbookFile) Table column headings will be automatically included in the exported sheet and sheets will receive the title of the exported table as name.
static void	saveTableToWorkbookSheet(ij.measure.ResultsTable ijResultsTable, File workbookFile, String sheetName, Boolean includeColumnHeadings)
static void	saveTableToWorkbookSheet(ij.measure.ResultsTable ijResultsTable, String filePathToXlsxWorkbookFile, String sheetName, Boolean includeColumnHeadings)
static void	setColumnDataFormat(File workbookFile, int sheetIndex, int columnNumber, String dataFormatString)
static void	setColumnDataFormat(File workbookFile, String sheetName, int columnNumber, String dataFormatString) Allowed data formats can be found under: BuiltinFormats

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ExcelFunctions

public ExcelFunctions()

Method Detail

saveTableToWorkbookSheet

public static void saveTableToWorkbookSheet(ij.measure.ResultsTable ijResultsTable,
                                            File workbookFile,
                                            String sheetName,
                                            Boolean includeColumnHeadings)

Parameters:

ijResultsTable - - instance of an ImageJ ResultsTable

workbookFile - - The file instance which holds the Excel workbook

sheetName - - desired name of the worksheet (if sheet name exists already, a new sheet will be created with appended numbering)

includeColumnHeadings - - set true to add table data headings or set false to skip headings when adding data to a sheet

saveTableToWorkbookSheet

public static void saveTableToWorkbookSheet(ij.measure.ResultsTable ijResultsTable,
                                            String filePathToXlsxWorkbookFile,
                                            String sheetName,
                                            Boolean includeColumnHeadings)

Parameters:

ijResultsTable - - instance of an ImageJ ResultsTable

filePathToXlsxWorkbookFile - - the String file path including the extension ".xlsx" to the Excel workbook file

sheetName - - desired name of the worksheet (if sheet name exists already, a new sheet will be created with appended numbering)

includeColumnHeadings - - set true to add table data headings or set false to skip headings when adding data to a sheet

saveTableToWorkbookSheet

public static void saveTableToWorkbookSheet(ij.measure.ResultsTable ijResultsTable,
                                            File workbookFile)

Table column headings will be automatically included in the exported sheet and sheets will receive the title of the exported table as name.

Parameters:

ijResultsTable - - instance of an ImageJ ResultsTable

workbookFile - - The file instance which holds the Excel workbook

saveAllOpenTablesAsWorkbookSheets

public static void saveAllOpenTablesAsWorkbookSheets(File workbookFile,
                                                     Boolean includeColumnHeadings)

Parameters:

workbookFile - - The file instance which holds the Excel workbook

includeColumnHeadings - - set true to add table data headings or set false to skip headings when adding data to a sheet

saveAllOpenTablesAsWorkbookSheets

public static void saveAllOpenTablesAsWorkbookSheets(String filePathToXlsxWorkbookFile,
                                                     Boolean includeColumnHeadings)

Parameters:

filePathToXlsxWorkbookFile - - the String file path including the extension ".xlsx" to the Excel workbook file

includeColumnHeadings - - set true to add table data headings or set false to skip headings when adding data to a sheet

addImageToWorkbookSheet

public static void addImageToWorkbookSheet(ij.ImagePlus imagePlus,
                                           File workbookFile)

This function adds an image open in ImageJ / Fiji as PNG to the defined worksheet in a defined Excel workbook Note: the size of images added to Excel cannot be properly controlled via the Apache POI library. Therefore, images normally appear distorted in Excel. Using the image properties in Excel and pressing "Reset" restores the correct aspect ratio.

Parameters:

imagePlus - - any ImagePlus instance open in a Window in ImageJ

workbookFile - - The file instance which holds the Excel workbook

addImageToWorkbookSheet

public static void addImageToWorkbookSheet(ij.ImagePlus imagePlus,
                                           File workbookFile,
                                           String sheetName,
                                           int column,
                                           int row)

This function adds an image open in ImageJ / Fiji as PNG to the defined worksheet in a defined Excel workbook Note: the size of images added to Excel cannot be properly controlled via the Apache POI library. Therefore, images normally appear distorted in Excel. Using the image properties in Excel and pressing "Reset" restores the correct aspect ratio.

Parameters:

imagePlus - - any ImagePlus instance open in a Window in ImageJ

workbookFile - - Instance of an Excel workbook file

sheetName - - name of the worksheet or the 0-based index of an existing sheet.

column - - 0-based column of the cell which should be the location of the upper left corner of the added image (negative values take the first empty column)

row - - 0-based row of the cell which should be the location of the upper left corner of the added image (negative values take the first empty row)

addImageToWorkbookSheet

public static void addImageToWorkbookSheet(ij.ImagePlus imagePlus,
                                           File workbookFile,
                                           int sheetIndex,
                                           int column,
                                           int row)

This function adds an image open in ImageJ / Fiji as PNG to the defined worksheet in a defined Excel workbook Note: the size of images added to Excel cannot be properly controlled via the Apache POI library. Therefore, images normally appear distorted in Excel. Using the image properties in Excel and pressing "Reset" restores the correct aspect ratio.

Parameters:

imagePlus - - any ImagePlus instance open in a Window in ImageJ

workbookFile - - Instance of an Excel workbook file

sheetIndex - - 0-based index of an existing sheet.

column - - 0-based column of the cell which should be the location of the upper left corner of the added image (negative values take the first empty column)

row - - 0-based row of the cell which should be the location of the upper left corner of the added image (negative values take the first empty row)

appendArrayAsExcelRow

public static void appendArrayAsExcelRow(Number[] array,
                                         File workbookFile,
                                         String sheetName,
                                         int startingColumn)

Parameters:

array - - Number[] array which should be added to the specified Row

workbookFile - - Instance of an Excel workbook file

sheetName - - name String of the worksheet (if not existing it will be created)

startingColumn - - 0-based starting column from which onwards the array data are added to the cells of the first empty row in the sheet

appendArrayAsExcelRow

public static void appendArrayAsExcelRow(Number[] array,
                                         File workbookFile,
                                         int sheetIndex,
                                         int startingColumn)

Parameters:

array - - Number[] array which should be added to the specified Row

workbookFile - - Instance of an Excel workbook file

sheetIndex - - 0-based integer index of an existing sheet

startingColumn - - 0-based starting column from which onwards the array data are added to the cells of the first empty row in the sheet

appendArrayAsExcelRow

public static void appendArrayAsExcelRow(String[] array,
                                         File workbookFile,
                                         String sheetName,
                                         int startingColumn)

Parameters:

array - - String[] array which should be added to the specified Row

workbookFile - - Instance of an Excel workbook file

sheetName - - name String of the worksheet (if not existing it will be created)

startingColumn - - 0-based starting column from which onwards the array data are added to the cells of the first empty row in the sheet

appendArrayAsExcelRow

public static void appendArrayAsExcelRow(String[] array,
                                         File workbookFile,
                                         int sheetIndex,
                                         int startingColumn)

Parameters:

array - - String[] array which should be added to the specified Row

workbookFile - - Instance of an Excel workbook file

sheetIndex - - 0-based integer index of an existing sheet

startingColumn - - 0-based starting column from which onwards the array data are added to the cells of the first empty row in the sheet

appendArrayAsExcelColumn

public static void appendArrayAsExcelColumn(Number[] array,
                                            File workbookFile,
                                            String sheetName,
                                            int startingRow)

Parameters:

array - - Numbers[] array which should be added to the specified Row

workbookFile - - Instance of an Excel workbook file

sheetName - - name String of the worksheet (if not existing it will be created)

startingRow - - 0-based row at which the first entry of the provided array is added to the cells of the first empty column in the sheet

appendArrayAsExcelColumn

public static void appendArrayAsExcelColumn(Number[] array,
                                            File workbookFile,
                                            int sheetIndex,
                                            int startingRow)

Parameters:

array - - Numbers[] array which should be added to the specified Row

workbookFile - - Instance of an Excel workbook file

sheetIndex - - 0-based integer index of an existing sheet

startingRow - - 0-based row at which the first entry of the provided array is added to the cells of the first empty column in the sheet

appendArrayAsExcelColumn

public static void appendArrayAsExcelColumn(String[] array,
                                            File workbookFile,
                                            String sheetName,
                                            int startingRow)

Parameters:

array - - String[] array which should be added to the specified Row

workbookFile - - Instance of an Excel workbook file

sheetName - - name String of the worksheet (if not existing it will be created)

startingRow - - 0-based row at which the first entry of the provided array is added to the cells of the first empty column in the sheet

appendArrayAsExcelColumn

public static void appendArrayAsExcelColumn(String[] array,
                                            File workbookFile,
                                            int sheetIndex,
                                            int startingRow)

Parameters:

array - - String[] array which should be added to the specified Row

workbookFile - - Instance of an Excel workbook file

sheetIndex - - 0-based integer index of an existing sheet

startingRow - - 0-based row at which the first entry of the provided array is added to the cells of the first empty column in the sheet

setColumnDataFormat

public static void setColumnDataFormat(File workbookFile,
                                       String sheetName,
                                       int columnNumber,
                                       String dataFormatString)

Allowed data formats can be found under: BuiltinFormats

Parameters:

workbookFile - - Instance of an Excel workbook file

sheetName - - name String of the worksheet

columnNumber - - the 0-based column number to which the format change should be applied

dataFormatString - - the actual format string as found in the BuiltinFormats

setColumnDataFormat

public static void setColumnDataFormat(File workbookFile,
                                       int sheetIndex,
                                       int columnNumber,
                                       String dataFormatString)

Parameters:

workbookFile - - Instance of an Excel workbook file

sheetIndex - - 0-based index of an existing sheet

columnNumber - - the 0-based column number to which the format change should be applied

dataFormatString - - the actual format string as found in the BuiltinFormats

importXlsxWorksheetAsTable

public static void importXlsxWorksheetAsTable(File workbookFile,
                                              String sheetName,
                                              boolean useFirstRowAsHeading)

Parameters:

workbookFile - - Instance of an Excel workbook file

sheetName - - name String of the worksheet

useFirstRowAsHeading - - takes first sheet row as heading of the IJ table

importXlsxWorksheetAsTable

public static void importXlsxWorksheetAsTable(File workbookFile,
                                              int sheetIndex,
                                              boolean useFirstRowAsHeading)

Parameters:

workbookFile - - Instance of an Excel workbook file

sheetIndex - - 0-based index of an existing sheet

useFirstRowAsHeading - - takes first sheet row as heading of the IJ table

getAllWorkbookSheetNames

public static String getAllWorkbookSheetNames(File workbookFile)

Parameters:

workbookFile - - Instance of an Excel workbook file

Returns:

concatenated String (comma separated) of all existing worksheet names

appendTableAsColumns

public static void appendTableAsColumns(ij.measure.ResultsTable ijResultsTable,
                                        File workbookFile,
                                        String sheetName,
                                        Boolean includeColumnHeadings)

Adds the specified ResultsTable as additional columns after the existing ones on the specified sheet

Parameters:

ijResultsTable - - instance of an ImageJ ResultsTable

workbookFile - - The file instance which holds the Excel workbook

sheetName - - desired name of the worksheet (if sheet name exists already, a new sheet will be created with appended numbering)

includeColumnHeadings - - set true to add table data headings or set false to skip headings when adding data to a sheet

appendTableAsColumns

public static void appendTableAsColumns(ij.measure.ResultsTable ijResultsTable,
                                        File workbookFile,
                                        int sheetIndex,
                                        Boolean includeColumnHeadings)

Adds the specified ResultsTable as additional columns after the existing ones on the specified sheet

Parameters:

ijResultsTable - - instance of an ImageJ ResultsTable

workbookFile - - The file instance which holds the Excel workbook

sheetIndex - - Integer index of desired worksheet (if name exists already, a new sheet will be created with appended numbering)

includeColumnHeadings - - set true to add table data headings or set false to skip headings when adding data to a sheet

appendTableAsRows

public static void appendTableAsRows(ij.measure.ResultsTable ijResultsTable,
                                     File workbookFile,
                                     String sheetName,
                                     Boolean includeColumnHeadings)

Adds the specified ResultsTable as additional rows below the existing ones on the specified sheet

Parameters:

ijResultsTable - - instance of an ImageJ ResultsTable

workbookFile - - The file instance which holds the Excel workbook

sheetName - - desired name of the worksheet (if sheet name exists already, a new sheet will be created with appended numbering)

includeColumnHeadings - - set true to add table data headings or set false to skip headings when adding data to a sheet

appendTableAsRows

public static void appendTableAsRows(ij.measure.ResultsTable ijResultsTable,
                                     File workbookFile,
                                     int sheetIndex,
                                     Boolean includeColumnHeadings)

Adds the specified ResultsTable as additional rows below the existing ones on the specified sheet

Parameters:

ijResultsTable - - instance of an ImageJ ResultsTable

workbookFile - - The file instance which holds the Excel workbook

sheetIndex - - Integer index of desired worksheet (if name exists already, a new sheet will be created with appended numbering)

includeColumnHeadings - - set true to add table data headings or set false to skip headings when adding data to a sheet

deleteWorkbookSheet

public static void deleteWorkbookSheet(File workbookFile,
                                       String sheetName)

Parameters:

workbookFile - - The file instance which holds the Excel workbook

sheetName - - desired name of an existing worksheet which should be deleted (does nothing if sheet is not existing)

deleteWorkbookSheet

public static void deleteWorkbookSheet(File workbookFile,
                                       int sheetIndex)

Parameters:

workbookFile - - The file instance which holds the Excel workbook

sheetIndex - - 0-based index of an existing sheet which should be deleted (does nothing if sheet is not existing)