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() Constructor to use the static Excel functions

Method Summary

Modifier and Type	Method and Description
static void	addImageToWorkbookSheet(ij.ImagePlus imagePlus, String filePath, Object sheetNameOrIndex, 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, String filePath, Object sheetNameOrIndex, int startingRow, String columnDataFormat)
static void	appendArrayAsExcelColumn(String[] array, String filePath, Object sheetNameOrIndex, int startingRow, String columnDataFormat)
static void	appendArrayAsExcelRow(Number[] array, String filePath, Object sheetNameOrIndex, int startingColumn)
static void	appendArrayAsExcelRow(String[] array, String filePath, Object sheetNameOrIndex, int startingColumn)
ExcelUtils	getExcelUtils()
static void	saveAllOpenTablesToWorkbook(File file, Boolean appendData, Boolean skipHeadingsWhenAppending)
static void	saveAllOpenTablesToWorkbook(String filePath, Boolean appendData, Boolean skipHeadingsWhenAppending)
static void	saveTableToWorkbookSheet(ij.measure.ResultsTable ijResultsTable, File file, Object sheetNameOrIndex, Boolean appendData, Boolean skipHeadingsWhenAppending)
static void	saveTableToWorkbookSheet(ij.measure.ResultsTable ijResultsTable, String filePath, Object sheetNameOrIndex, Boolean appendData, Boolean skipHeadingsWhenAppending)
static void	saveTableToWorkbookSheet(String ijTableName, File file, Object sheetNameOrIndex, Boolean appendData, Boolean skipHeadingsWhenAppending)
static void	saveTableToWorkbookSheet(String ijTableName, String filePath, Object sheetNameOrIndex, Boolean appendData, Boolean skipHeadingsWhenAppending)
static void	setColumnDataFormat(String filePath, Object sheetNameOrIndex, Integer 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()

Constructor to use the static Excel functions

Method Detail

getExcelUtils

public ExcelUtils getExcelUtils()

saveTableToWorkbookSheet

public static void saveTableToWorkbookSheet(ij.measure.ResultsTable ijResultsTable,
                                            File file,
                                            Object sheetNameOrIndex,
                                            Boolean appendData,
                                            Boolean skipHeadingsWhenAppending)

Parameters:

ijResultsTable - - instance of an ImageJ ResultsTable

file - - The file instance which holds the Excel workbook

sheetNameOrIndex - - name of the worksheet or the 0-based index of an existing sheet (the String keywords "FIRST" or "LAST" retrieve the corresponding sheets)

appendData - - set false to create a new worksheet for the current table or true to append data below existing ones on an already existing worksheet

skipHeadingsWhenAppending - - set false to add table data headings or set true to skip headings when appending data to seamlessly fuse data to prior ones

saveTableToWorkbookSheet

public static void saveTableToWorkbookSheet(ij.measure.ResultsTable ijResultsTable,
                                            String filePath,
                                            Object sheetNameOrIndex,
                                            Boolean appendData,
                                            Boolean skipHeadingsWhenAppending)

Parameters:

ijResultsTable - - instance of an ImageJ ResultsTable

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

sheetNameOrIndex - - name of the worksheet or the 0-based index of an existing sheet (the String keywords "FIRST" or "LAST" retrieve the corresponding sheets)

appendData - - set false to create a new worksheet for the current table or true to append data below existing ones on an already existing worksheet

skipHeadingsWhenAppending - - set false to add table data headings or set true to skip headings when appending data to seamlessly fuse data to prior ones

saveTableToWorkbookSheet

public static void saveTableToWorkbookSheet(String ijTableName,
                                            File file,
                                            Object sheetNameOrIndex,
                                            Boolean appendData,
                                            Boolean skipHeadingsWhenAppending)

Parameters:

ijTableName - - String name of the ImageJ results table

file - - The file instance which holds the Excel workbook

sheetNameOrIndex - - name of the worksheet or the 0-based index of an existing sheet (the String keywords "FIRST" or "LAST" retrieve the corresponding sheets)

appendData - - set false to create a new worksheet for the current table or true to append data below existing ones on an already existing worksheet

skipHeadingsWhenAppending - - set false to add table data headings or set true to skip headings when appending data to seamlessly fuse data to prior ones

saveTableToWorkbookSheet

public static void saveTableToWorkbookSheet(String ijTableName,
                                            String filePath,
                                            Object sheetNameOrIndex,
                                            Boolean appendData,
                                            Boolean skipHeadingsWhenAppending)

Parameters:

ijTableName - - String name of the ImageJ results table

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

sheetNameOrIndex - - name of the worksheet or the 0-based index of an existing sheet (the String keywords "FIRST" or "LAST" retrieve the corresponding sheets)

appendData - - set false to create a new worksheet for the current table or true to append data below existing ones on an already existing worksheet

skipHeadingsWhenAppending - - set false to add table data headings or set true to skip headings when appending data to seamlessly fuse data to prior ones

saveAllOpenTablesToWorkbook

public static void saveAllOpenTablesToWorkbook(File file,
                                               Boolean appendData,
                                               Boolean skipHeadingsWhenAppending)

Parameters:

file - - The file instance which holds the Excel workbook

appendData - - set false to create a new worksheet for the current table or true to append data below existing ones on an already existing worksheet

skipHeadingsWhenAppending - - set false to add table data headings or set true to skip headings when appending data to seamlessly fuse data to prior ones

saveAllOpenTablesToWorkbook

public static void saveAllOpenTablesToWorkbook(String filePath,
                                               Boolean appendData,
                                               Boolean skipHeadingsWhenAppending)

Parameters:

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

appendData - - set false to create a new worksheet for the current table or true to append data below existing ones on an already existing worksheet

skipHeadingsWhenAppending - - set false to add table data headings or set true to skip headings when appending data to seamlessly fuse data to prior ones

addImageToWorkbookSheet

public static void addImageToWorkbookSheet(ij.ImagePlus imagePlus,
                                           String filePath,
                                           Object sheetNameOrIndex,
                                           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

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

sheetNameOrIndex - - name of the worksheet or the 0-based index of an existing sheet (the String keywords "FIRST" or "LAST" retrieve the corresponding sheets)

column - - 0-based column of the cell which should be the location of the upper left corner of the added image

row - - 0-based row of the cell which should be the location of the upper left corner of the added image

appendArrayAsExcelRow

public static void appendArrayAsExcelRow(Number[] array,
                                         String filePath,
                                         Object sheetNameOrIndex,
                                         int startingColumn)

Parameters:

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

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

sheetNameOrIndex - - name of the worksheet or the 0-based index of an existing sheet (the String keywords "FIRST" or "LAST" retrieve the corresponding sheets)

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,
                                         String filePath,
                                         Object sheetNameOrIndex,
                                         int startingColumn)

Parameters:

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

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

sheetNameOrIndex - - name of the worksheet or the 0-based index of an existing sheet (the String keywords "FIRST" or "LAST" retrieve the corresponding sheets)

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,
                                            String filePath,
                                            Object sheetNameOrIndex,
                                            int startingRow,
                                            String columnDataFormat)

Parameters:

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

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

sheetNameOrIndex - - name of the worksheet or the 0-based index of an existing sheet (the String keywords "FIRST" or "LAST" retrieve the corresponding sheets)

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

columnDataFormat - - optional data format for that column (options can be found under BuiltinFormats). This can be an empty String "" to use the setting "General", the default in Excel.

appendArrayAsExcelColumn

public static void appendArrayAsExcelColumn(String[] array,
                                            String filePath,
                                            Object sheetNameOrIndex,
                                            int startingRow,
                                            String columnDataFormat)

Parameters:

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

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

sheetNameOrIndex - - name of the worksheet or the 0-based index of an existing sheet (the String keywords "FIRST" or "LAST" retrieve the corresponding sheets)

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

columnDataFormat - - optional data format for that column (options can be found under BuiltinFormats). This can be an empty String "" to use the setting "General", the default in Excel.

setColumnDataFormat

public static void setColumnDataFormat(String filePath,
                                       Object sheetNameOrIndex,
                                       Integer columnNumber,
                                       String dataFormatString)

Allowed data formats can be found under: BuiltinFormats

Parameters:

filePath - - file path to an .xlsx worksheet file

sheetNameOrIndex - - name of the worksheet or the 0-based index of an existing sheet (the String keywords "FIRST" or "LAST" retrieve the corresponding sheets)

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

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