|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |
Object | +--MLA
Defined in MarkLogicExcelAddin.js
Nested Class Summary | |
<static class> |
MLA.Cell |
Constructor Summary | |
MLA()
The MLA namespace is used for global attribution. |
Method Summary | |
<static> void
|
addAutoFilter(coord1, coord2, sheetName, criteria1, operator, criteria2)
Adds AutoFilter to specified range in active worksheet. |
<static> void
|
addChartObjectMouseDownEvents(sheetName)
Adds chartObjectMouseDown events for each chart on sheet specified by sheetName. |
<static> String
|
addCustomXMLPart(customPartXml)
Adds custom part to active Open XML package. |
<static> void
|
addMacro(source, componenType)
Adds macro to active workbook. |
<static> void
|
addNamedRange(coord1,coord2,rngName, sheetName)
Names a range in the worksheet specified by sheetName. |
<static> String
|
addWorkbook(worksheetname)
Adds workbook of type Excel.XlWBATemplate.xlWBATWorksheet. |
<static> String
|
addWorksheet(sheetName)
Adds worksheet to active workbook. |
<static> String
|
base64EncodeImage(chartPath)
Returns image found at chartPath as base64 encoded string |
<static> void
|
clearNamedRange(rangeName)
Clears all cells in the range identified by name. |
<static> void
|
clearRange(coord1,coord2)
Clears all cells in the range identified by coordinates provide in A1 notation. |
<static> void
|
clearWorksheet(sheetName)
Clears the contents of the active worksheet in the active workbook. |
<static> String
|
convertA1ToR1C1(coord)
Converts an A1 notation coordinate to R1C1 notation. |
<static> String
|
convertR1C1ToA1(rowIdx, colIdx)
Converts a row index and column index to an A1 notation coordinate. |
<static> Microsoft.XMLDOM
|
createXMLDOM(xmlstring)
Utility function for creating Microsoft.XMLDOM object from string. |
<static> void
|
deleteCustomXMLPart(customXMLPartId)
Deletes custom part from Active Open XML package identified by id. |
<static> void
|
deleteFile(filePath)
Deletes file found with full path at parameter filePath, from the filesystem. |
<static> void
|
deletePicture(sheetName, imageName)
Deletes picture (image), specified by name, from specified sheet in Excel Workbook. |
<static> void
|
exportChartImagePNG(chartPath)
Saves chart in Excel Workbook to filesystem as .png. |
<static> MLA.Cell
|
getActiveCell()
Returns active cell from the active worksheet in active workbook. |
<static> String
|
getActiveCellText()
Get the Text for the cell at the current cursor position. |
<static> String
|
getActiveWorkbookName()
Returns the name of the active workbook. |
<static> Array
|
getActiveWorkbookWorksheetNames()
Returns the names of all worksheets for active workbook as array of strings. |
<static> String
|
getActiveWorksheetName()
Returns the name of the active worksheet. |
<static> Array
|
getAllWorkbookNames()
Returns the names of all workbooks available as array of strings. |
<static> MLA.config
|
getConfiguration()
Returns MLA.config. |
<static> Microsoft.XMLDOM
|
getCustomXMLPart(customXMLPartId)
Returns the custom XML part, identified by customXMLPartId, that is part of the active Open XML package. |
<static> Array
|
getCustomXMLPartIds()
Returns ids for custom parts (not built-in) that are part of the active Open XML package. |
<static> String
|
getMacroComments(index)
Returns macro comments for macro component specified by index for active workbook. |
<static> String
|
getMacroCount()
Returns count of macros in active workbook. |
<static> String
|
getMacroName(index)
Returns macro name for macro component specified by index for active workbook. |
<static> String
|
getMacroProcedureName(index)
Returns macro procedure name for macro component specified by index for active workbook. |
<static> String
|
getMacroSignature(index)
Returns macro signature for macro component specified by index for active workbook. |
<static> String
|
getMacroText(index)
Returns macro code as text from macro component specified by index for active workbook. |
<static> String
|
getMacroType(index)
Returns macro type for macro component specified by index for active workbook. |
<static> Array
|
getNamedRangeNames()
Returns all NamedRange names for the active workbook. |
<static> MLA.Cell
|
getSelectedCells()
Returns cells selected in active workbook. |
<static> String
|
getSelectedChartName()
Returns the name for the selected chart. |
<static> String
|
getSelectedRangeCoordinates()
Returns the selected range coordinates. |
<static> String
|
getSelectedRangeName()
Returns the name for the selected range if name exists. |
<static> String
|
getSheetType(sheetName)
Returns the type of the sheet specified by sheetName. |
<static> String
|
getTempPath()
Returns the path being used for the /temp dir on the client system. |
<static> String
|
getVersion()
Returns version of MarkLogicExcelAddin.js library. |
<static> Array
|
getWorksheetChartNames(sheetName)
Returns all Chart names for any charts found on sheet specified by sheetName. |
<static> Array
|
getWorksheetNamedRangeNames(sheetName)
Returns all named range names for any named ranges found on sheet specified by sheetName. |
<static> void
|
insertBase64ToImage(base64String, sheetName)
Inserts a base64 encoded string into sheet, specified by sheetName, as an image. |
<static> Object
|
openXlsx(tmpPath, docuri, url, uname, pwd)
Open a .xlsx from MarkLogic into Excel. |
<static> void
|
removeChartObjectMouseDownEvents(sheetName)
Removes chartObjectMouseDown events for each chart on sheet specified by sheetName. |
<static> void
|
removeMacro(macroName)
Removes macro, specified by macroName, from active workbook. |
<static> void
|
removeNamedRange(name)
Removes the NamedRange from the active workbook. |
<static> void
|
runMacro(macroName)
Runs macro, specified by macro name, in the active workbook. |
<static> void
|
saveActiveWorkbook(tmpPath, doctitle, url, uname,pwd)
Saves the active workbook to MarkLogic. |
<static> void
|
setActiveCellValue(value)
Set the value for the cell at the current cursor position. |
<static> void
|
setActiveRangeByName(name)
Sets focus to named range, specified by name, on active worksheet. |
<static> void
|
setActiveWorkbook(workbookname)
Sets the active workbook in Excel. |
<static> void
|
setActiveWorksheet(sheetname)
Sets the active worksheet in Excel. |
<static> void
|
setCellValue(cells, sheetname)
Sets the values for the cells identified by Cell.coordinate. |
Constructor Detail |
MLA()
Method Detail |
<static> void addAutoFilter(coord1, coord2, sheetName, criteria1, operator, criteria2)
coord1
- starting coordinate of range in A1 notation
coord2
- end coordinate of range in A1 notation
sheetName
- (optional) default 'active'
criteria1
- (optional) default '<>'
operator
- (optional) default 'AND'
criteria2
- (optional) default 'missing'
<static> void addChartObjectMouseDownEvents(sheetName)
sheetName
- the name of the sheet to add event listeners to
<static> String addCustomXMLPart(customPartXml)
customPartXML
- Either A) an XMLDOM object that is the custom part to be added to the active Open XML package, or B)The string serialization of the XML to be added as a custom part to the active Open XML package. ( The XML must be well-formed. )
<static> void addMacro(source, componenType)
source
- the source code (string) for the macro to be added
componentType
- the componentType to add the macro as to the active workbook
<static> void addNamedRange(coord1,coord2,rngName, sheetName)
coord1
- starting coordinate of range in A1 notation
coord2
- end coordinate of range in A1 notation
rngName
- the name to be assigned to the range
sheetName
- (optional) default 'active' ; the name of the worksheet to host the range
<static> String addWorkbook(worksheetname)
worksheetname
- a string that names the worksheet
<static> String addWorksheet(sheetName)
sheetName
- the name of the worksheet to be added
<static> String base64EncodeImage(chartPath)
chartPath
- the name of the image, including full path on filesystem, to be encoded
<static> void clearNamedRange(rangeName)
rangeName
- the name of the range to be cleared in the active workbook
<static> void clearRange(coord1,coord2)
coord1
- starting coordinate of range to be cleared in A1 notation
coord2
- end coordinate of range to be cleared in A1 notation
<static> void clearWorksheet(sheetName)
sheetName
- (optional) default 'active'
<static> String convertA1ToR1C1(coord)
coord
- the A1 coordinate to be converted
<static> String convertR1C1ToA1(rowIdx, colIdx)
rowIdx
- the row index
colIdx
- the column index
<static> Microsoft.XMLDOM createXMLDOM(xmlstring)
xmlString
- the string to be loaded into a XMLDOM object. The string must be serialized, well-formed XML
<static> void deleteCustomXMLPart(customXMLPartId)
customXMLPartId
- the id of the custom part to be deleted from the active Open XML package
<static> void deleteFile(filePath)
filePath
- the name of the file to be deleted
<static> void deletePicture(sheetName, imageName)
sheetName
- the name of the sheet containing picture to be deleted
imageName
- the name of the picture to be deleted
<static> void exportChartImagePNG(chartPath)
chartPath
- the path for the /tmp dir on the client system. (have to save a local copy) where you want to save the chart image
<static> MLA.Cell getActiveCell()
<static> String getActiveCellText()
<static> String getActiveWorkbookName()
<static> Array getActiveWorkbookWorksheetNames()
<static> String getActiveWorksheetName()
<static> Array getAllWorkbookNames()
<static> MLA.config getConfiguration()
<static> Microsoft.XMLDOM getCustomXMLPart(customXMLPartId)
customXMLPartId
- the id of the custom part to be fetched from the active package
<static> Array getCustomXMLPartIds()
<static> String getMacroComments(index)
index
- the index of the macro component
<static> String getMacroCount()
<static> String getMacroName(index)
index
- the index of the macro component
<static> String getMacroProcedureName(index)
index
- - the index of the macro component
<static> String getMacroSignature(index)
index
- the index of the macro component
<static> String getMacroText(index)
index
- the index of the macro to decompile and return as string
<static> String getMacroType(index)
index
- - the index of the macro component
<static> Array getNamedRangeNames()
<static> MLA.Cell getSelectedCells()
<static> String getSelectedChartName()
<static> String getSelectedRangeCoordinates()
<static> String getSelectedRangeName()
<static> String getSheetType(sheetName)
sheetName
- the name of the sheet to inspect
<static> String getTempPath()
<static> String getVersion()
<static> Array getWorksheetChartNames(sheetName)
sheetName
- the name of the sheet containing the charts
<static> Array getWorksheetNamedRangeNames(sheetName)
sheetName
- the name of the sheet containing the charts
<static> void insertBase64ToImage(base64String, sheetName)
base64String
- the base64 string to insert
sheetName
- (optional) default 'active'
<static> Object openXlsx(tmpPath, docuri, url, uname, pwd)
tmpPath
- the path for the /tmp dir on the client system. (have to save a local copy)
docuri
- the uri for the document in MarkLogic Server
url
- the url on MarkLogic Server where the XQuery to open the document specified by docuri can be found
uname
- the username for MarkLogic Server
pwd
- the password for MarkLogic Server
<static> void removeChartObjectMouseDownEvents(sheetName)
sheetName
- the name of the sheet to remove event listeners from
<static> void removeMacro(macroName)
macroName
- the componentType to add the macro as to the active workbook
<static> void removeNamedRange(name)
name
- the name of the NamedRange to be removed from the active workbook
sheetName
- (optional) default 'active'
<static> void runMacro(macroName)
macroName
- the name of the macro to run in the active workbook
<static> void saveActiveWorkbook(tmpPath, doctitle, url, uname,pwd)
tmpPath
- the path for the /tmp dir on the client system. (have to save a local copy)
url
- the url on MarkLogic Server where the XQuery to save can be found
uname
- the username for MarkLogic Server
pwd
- the password for MarkLogic Server
docTitle
- the title of the document
<static> void setActiveCellValue(value)
value
- the value to be inserted in the active cell
<static> void setActiveRangeByName(name)
name
- the name of the range to be set active in the workbook
<static> void setActiveWorkbook(workbookname)
workbookname
- a string that is the name of the workbook to receive focus
<static> void setActiveWorksheet(sheetname)
worksheetname
- a string that is the name of the worksheet to receive focus
<static> void setCellValue(cells, sheetname)
cells
- an array of MLA.Cell objects, the values of which will be used for the values for the given cells in the active workbook.
sheetname
- (optional) the name of the worksheet where the Cell values should be populated. If no sheetname is provided, the cells will be populated in the active worksheet.
|
|||||||||
PREV CLASS NEXT CLASS | FRAMES NO FRAMES | ||||||||
SUMMARY: FIELD | CONSTR | METHOD | DETAIL: FIELD | CONSTR | METHOD |