Config (Aspose.Cells for Java)

java.lang.Object
- com.aspose.gridjs.Config

public class Config
extends java.lang.Object

Represents all the static settings for GridJs

Constructor Summary

Constructors
Constructor and Description

Config()

Constructors
Constructor and Description
`Config()`

Method Summary

Methods
Modifier and Type	Method and Description
`static boolean`	`getAutoOptimizeForLargeCells()` Gets whether to automatically optimize the load performance for worksheet with large cells.
`static java.lang.String`	`getBaseRouteName()` Gets the base route name for GridJs controller URL.
`static int`	`getEmptySheetMaxCol()` Gets default max column for an empty worksheet.
`static int`	`getEmptySheetMaxRow()` Gets default max row for an empty worksheet.
`static java.lang.String`	`getFileCacheDirectory()` Gets the cache directory for storing spreadsheet file.
`static boolean`	`getIgnoreEmptyContent()` Gets whether to show the max range which includes data ,style, merged cells and shapes.
`static boolean`	`getIslimitShapeOrImage()` Gets whether to limit the total display shape/image count in one worksheet ,if set to true, GridJs will limit the total count of the display shapes or images in one worksheet to MaxShapeOrImageCount the default value is true.
`static boolean`	`getLazyLoading()` Gets whether to load active worksheet only,the default is false.
`static int`	`getMaxPdfSaveSeconds()` Gets the max timed out seconds when save to PDF.
`static int`	`getMaxShapeOrImageCount()` Gets the total count of the display shapes or images in the active sheet,it takes effect when IslimitShapeOrImage=true.
`static int`	`getMaxShapeOrImageWidthOrHeight()` Gets the max width or height for a shape or an image ,GridJs will ignore the shape or image with the width or height larger than this, it takes effect when IslimitShapeOrImage=true.
`static int`	`getMaxTotalShapeOrImageCount()` Gets the total count of the display shapes or images in the workbook,it takes effect when IslimitShapeOrImage=true.
`static java.lang.String`	`getMessageTopic()` Gets the websocket destinations prefixed with "/topic".
`static java.lang.String`	`getPictureCacheDirectory()` Gets the cache directory for pictures.(this takes effect when GridJsWorkbook.CacheImp is null) the default path will be "_piccache" inside the FileCacheDirectory.
`static boolean`	`getSameImageDetecting()` Gets whether to check if images have same source,the default is true the default value is true.
`static boolean`	`getSaveHtmlAsZip()` Gets whether to save html file as zip archive,the default is false.
`static boolean`	`getShowChartSheet()` Gets whether to show chart worksheet.
`static boolean`	`getSkipInvisibleShapes()` Gets whether to skip shapes that are invisble to UI ,the default value is true.
`static boolean`	`getUsePrintArea()` Gets whether to use PageSetup.PrintArea for the UI display range when the worksheet has PageSetup setting for PrintArea.
`static boolean`	`isCollaborative()` Gets whether to support collabrative editing,the default is false.
`static void`	`setAutoOptimizeForLargeCells(boolean value)` Sets whether to automatically optimize the load performance for worksheet with large cells.
`static void`	`setBaseRouteName(java.lang.String value)` Sets the base route name for GridJs controller URL.
`static void`	`setCollaborative(boolean value)` Sets whether to support collabrative editing,the default is false.
`static void`	`setEmptySheetMaxCol(int value)` Sets default max column for an empty worksheet.
`static void`	`setEmptySheetMaxRow(int value)` Sets default max row for an empty worksheet.
`static void`	`setFileCacheDirectory(java.lang.String value)` Sets the cache directory for storing spreadsheet file.
`static void`	`setFontFolder(java.lang.String fontFolder, boolean recursive)` Sets the fonts folder
`static void`	`setFontFolders(java.lang.String[] fontFolders, boolean recursive)` Sets the fonts folders
`static void`	`setIgnoreEmptyContent(boolean value)` Sets whether to show the max range which includes data ,style, merged cells and shapes.
`static void`	`setIslimitShapeOrImage(boolean value)` Sets whether to limit the total display shape/image count in one worksheet ,if set to true, GridJs will limit the total count of the display shapes or images in one worksheet to MaxShapeOrImageCount the default value is true.
`static void`	`setLazyLoading(boolean value)` Sets whether to load active worksheet only,the default is false.
`static void`	`setMaxPdfSaveSeconds(int value)` Sets the max timed out seconds when save to PDF.
`static void`	`setMaxShapeOrImageCount(int value)` Sets the total count of the display shapes or images in the active sheet,it takes effect when IslimitShapeOrImage=true.
`static void`	`setMaxShapeOrImageWidthOrHeight(int value)` Sets the max width or height for a shape or an image ,GridJs will ignore the shape or image with the width or height larger than this, it takes effect when IslimitShapeOrImage=true.
`static void`	`setMaxTotalShapeOrImageCount(int value)` Sets the total count of the display shapes or images in the workbook,it takes effect when IslimitShapeOrImage=true.
`static void`	`setMessageTopic(java.lang.String value)` Sets the websocket destinations prefixed with "/topic".
`static void`	`setPictureCacheDirectory(java.lang.String value)` Sets the cache directory for pictures.(this takes effect when GridJsWorkbook.CacheImp is null) the default path will be "_piccache" inside the FileCacheDirectory.
`static void`	`setSameImageDetecting(boolean value)` Sets whether to check if images have same source,the default is true the default value is true.
`static void`	`setSaveHtmlAsZip(boolean value)` Sets whether to save html file as zip archive,the default is false.
`static void`	`setShowChartSheet(boolean value)` Sets whether to show chart worksheet.
`static void`	`setSkipInvisibleShapes(boolean value)` Sets whether to skip shapes that are invisble to UI ,the default value is true.
`static void`	`setUsePrintArea(boolean value)` Sets whether to use PageSetup.PrintArea for the UI display range when the worksheet has PageSetup setting for PrintArea.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - Config
```
public Config()
```
- Method Detail
  - getSaveHtmlAsZip
```
public static boolean getSaveHtmlAsZip()
```
    Gets whether to save html file as zip archive,the default is false.
  - setSaveHtmlAsZip
```
public static void setSaveHtmlAsZip(boolean value)
```
    Sets whether to save html file as zip archive,the default is false.
  - getSkipInvisibleShapes
```
public static boolean getSkipInvisibleShapes()
```
    Gets whether to skip shapes that are invisble to UI ,the default value is true.
  - setSkipInvisibleShapes
```
public static void setSkipInvisibleShapes(boolean value)
```
    Sets whether to skip shapes that are invisble to UI ,the default value is true.
  - getLazyLoading
```
public static boolean getLazyLoading()
```
    Gets whether to load active worksheet only,the default is false.
  - setLazyLoading
```
public static void setLazyLoading(boolean value)
```
    Sets whether to load active worksheet only,the default is false.
  - getSameImageDetecting
```
public static boolean getSameImageDetecting()
```
    Gets whether to check if images have same source,the default is true the default value is true.
  - setSameImageDetecting
```
public static void setSameImageDetecting(boolean value)
```
    Sets whether to check if images have same source,the default is true the default value is true.
  - getAutoOptimizeForLargeCells
```
public static boolean getAutoOptimizeForLargeCells()
```
    Gets whether to automatically optimize the load performance for worksheet with large cells. it will ignore some style /borders to reduce the load time. the default value is true.
  - setAutoOptimizeForLargeCells
```
public static void setAutoOptimizeForLargeCells(boolean value)
```
    Sets whether to automatically optimize the load performance for worksheet with large cells. it will ignore some style /borders to reduce the load time. the default value is true.
  - getIslimitShapeOrImage
```
public static boolean getIslimitShapeOrImage()
```
    Gets whether to limit the total display shape/image count in one worksheet ,if set to true, GridJs will limit the total count of the display shapes or images in one worksheet to MaxShapeOrImageCount the default value is true.
  - setIslimitShapeOrImage
```
public static void setIslimitShapeOrImage(boolean value)
```
    Sets whether to limit the total display shape/image count in one worksheet ,if set to true, GridJs will limit the total count of the display shapes or images in one worksheet to MaxShapeOrImageCount the default value is true.
  - getMaxShapeOrImageCount
```
public static int getMaxShapeOrImageCount()
```
    Gets the total count of the display shapes or images in the active sheet,it takes effect when IslimitShapeOrImage=true. the default value is 100.
  - setMaxShapeOrImageCount
```
public static void setMaxShapeOrImageCount(int value)
```
    Sets the total count of the display shapes or images in the active sheet,it takes effect when IslimitShapeOrImage=true. the default value is 100.
  - getMaxTotalShapeOrImageCount
```
public static int getMaxTotalShapeOrImageCount()
```
    Gets the total count of the display shapes or images in the workbook,it takes effect when IslimitShapeOrImage=true. the default value is 300.
  - setMaxTotalShapeOrImageCount
```
public static void setMaxTotalShapeOrImageCount(int value)
```
    Sets the total count of the display shapes or images in the workbook,it takes effect when IslimitShapeOrImage=true. the default value is 300.
  - getMaxShapeOrImageWidthOrHeight
```
public static int getMaxShapeOrImageWidthOrHeight()
```
    Gets the max width or height for a shape or an image ,GridJs will ignore the shape or image with the width or height larger than this, it takes effect when IslimitShapeOrImage=true. the default value is 10000.
  - setMaxShapeOrImageWidthOrHeight
```
public static void setMaxShapeOrImageWidthOrHeight(int value)
```
    Sets the max width or height for a shape or an image ,GridJs will ignore the shape or image with the width or height larger than this, it takes effect when IslimitShapeOrImage=true. the default value is 10000.
  - getMaxPdfSaveSeconds
```
public static int getMaxPdfSaveSeconds()
```
    Gets the max timed out seconds when save to PDF. the default value is 10.
  - setMaxPdfSaveSeconds
```
public static void setMaxPdfSaveSeconds(int value)
```
    Sets the max timed out seconds when save to PDF. the default value is 10.
  - getIgnoreEmptyContent
```
public static boolean getIgnoreEmptyContent()
```
    Gets whether to show the max range which includes data ,style, merged cells and shapes. if the last row or column contains cells with no value and formula but has custom style then we will not show this row/column when this vlaue is true銆?* the default value is true .
  - setIgnoreEmptyContent
```
public static void setIgnoreEmptyContent(boolean value)
```
    Sets whether to show the max range which includes data ,style, merged cells and shapes. if the last row or column contains cells with no value and formula but has custom style then we will not show this row/column when this vlaue is true銆?* the default value is true .
  - getUsePrintArea
```
public static boolean getUsePrintArea()
```
    Gets whether to use PageSetup.PrintArea for the UI display range when the worksheet has PageSetup setting for PrintArea. the default value is false .
  - setUsePrintArea
```
public static void setUsePrintArea(boolean value)
```
    Sets whether to use PageSetup.PrintArea for the UI display range when the worksheet has PageSetup setting for PrintArea. the default value is false .
  - isCollaborative
```
public static boolean isCollaborative()
```
    Gets whether to support collabrative editing,the default is false.
  - setCollaborative
```
public static void setCollaborative(boolean value)
```
    Sets whether to support collabrative editing,the default is false.
  - getShowChartSheet
```
public static boolean getShowChartSheet()
```
    Gets whether to show chart worksheet. the default value is false .
  - setShowChartSheet
```
public static void setShowChartSheet(boolean value)
```
    Sets whether to show chart worksheet. the default value is false .
  - getEmptySheetMaxRow
```
public static int getEmptySheetMaxRow()
```
    Gets default max row for an empty worksheet. the default value is 12.
  - setEmptySheetMaxRow
```
public static void setEmptySheetMaxRow(int value)
```
    Sets default max row for an empty worksheet. the default value is 12.
  - getEmptySheetMaxCol
```
public static int getEmptySheetMaxCol()
```
    Gets default max column for an empty worksheet. the default value is 15.
  - setEmptySheetMaxCol
```
public static void setEmptySheetMaxCol(int value)
```
    Sets default max column for an empty worksheet. the default value is 15.
  - getPictureCacheDirectory
```
public static java.lang.String getPictureCacheDirectory()
```
    Gets the cache directory for pictures.(this takes effect when GridJsWorkbook.CacheImp is null) the default path will be "_piccache" inside the FileCacheDirectory.
  - setPictureCacheDirectory
```
public static void setPictureCacheDirectory(java.lang.String value)
```
    Sets the cache directory for pictures.(this takes effect when GridJsWorkbook.CacheImp is null) the default path will be "_piccache" inside the FileCacheDirectory.
  - getFileCacheDirectory
```
public static java.lang.String getFileCacheDirectory()
```
    Gets the cache directory for storing spreadsheet file. We need to set it to a specific path before we use GridJs.
  - setFileCacheDirectory
```
public static void setFileCacheDirectory(java.lang.String value)
```
    Sets the cache directory for storing spreadsheet file. We need to set it to a specific path before we use GridJs.
  - getBaseRouteName
```
public static java.lang.String getBaseRouteName()
```
    Gets the base route name for GridJs controller URL. the default is "/GridJs2".
  - setBaseRouteName
```
public static void setBaseRouteName(java.lang.String value)
```
    Sets the base route name for GridJs controller URL. the default is "/GridJs2".
  - getMessageTopic
```
public static java.lang.String getMessageTopic()
```
    Gets the websocket destinations prefixed with "/topic". the default is "/topic/opr".used in collaborative mode only.
  - setMessageTopic
```
public static void setMessageTopic(java.lang.String value)
```
    Sets the websocket destinations prefixed with "/topic". the default is "/topic/opr".used in collaborative mode only.
  - setFontFolder
```
public static void setFontFolder(java.lang.String fontFolder,
                 boolean recursive)
```
    Sets the fonts folder
    
    Parameters:
    fontFolder - The folder that contains TrueType fonts.
    recursive - Determines whether or not to scan subfolders.
  - setFontFolders
```
public static void setFontFolders(java.lang.String[] fontFolders,
                  boolean recursive)
```
    Sets the fonts folders
    
    Parameters:
    fontFolders - The folders that contains TrueType fonts.
    recursive - Determines whether or not to scan subfolders.

Class Config

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Config

Method Detail

getSaveHtmlAsZip

setSaveHtmlAsZip

getSkipInvisibleShapes

setSkipInvisibleShapes

getLazyLoading

setLazyLoading

getSameImageDetecting

setSameImageDetecting

getAutoOptimizeForLargeCells

setAutoOptimizeForLargeCells

getIslimitShapeOrImage

setIslimitShapeOrImage

getMaxShapeOrImageCount

setMaxShapeOrImageCount

getMaxTotalShapeOrImageCount

setMaxTotalShapeOrImageCount

getMaxShapeOrImageWidthOrHeight

setMaxShapeOrImageWidthOrHeight

getMaxPdfSaveSeconds

setMaxPdfSaveSeconds

getIgnoreEmptyContent

setIgnoreEmptyContent

getUsePrintArea

setUsePrintArea

isCollaborative

setCollaborative

getShowChartSheet

setShowChartSheet

getEmptySheetMaxRow

setEmptySheetMaxRow

getEmptySheetMaxCol

setEmptySheetMaxCol

getPictureCacheDirectory

setPictureCacheDirectory

getFileCacheDirectory

setFileCacheDirectory

getBaseRouteName

setBaseRouteName

getMessageTopic

setMessageTopic

setFontFolder

setFontFolders