GridJsOptions (Aspose.Cells for Java)

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

public class GridJsOptions
extends java.lang.Object

Represents all the load options for GridJs

Field Summary

Fields
Modifier and Type Field and Description

GridCacheForStream CacheImp
Custom implemention for cache storage,If you want to store cache in stream way ,you need to set and implement it.

Fields
Modifier and Type	Field and Description
`GridCacheForStream`	`CacheImp` Custom implemention for cache storage,If you want to store cache in stream way ,you need to set and implement it.

Constructor Summary

Constructors
Constructor and Description

GridJsOptions()

Constructors
Constructor and Description
`GridJsOptions()`

Method Summary

Methods
Modifier and Type	Method and Description
`boolean`	`getAutoOptimizeForLargeCells()` Gets whether to automatically optimize the load performance for worksheet with large cells.
`java.lang.String`	`getBaseRouteName()` Gets the route URL base name for GridJs controller.the default is GridJs2
`int`	`getEmptySheetMaxCol()` Gets default max column for an empty worksheet.
`int`	`getEmptySheetMaxRow()` Gets default max row for an empty worksheet.
`java.lang.String`	`getFileCacheDirectory()` Gets the cache directory for storing spreadsheet file.
`java.lang.String[]`	`getFontFolders()` Gets the fonts folders for fonts in the rendered pictures/shapes
`boolean`	`getIgnoreEmptyContent()` Gets whether to show the max range which includes data ,style, merged cells and shapes.
`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.
`boolean`	`getLazyLoading()` Gets whether to load active worksheet only,the default is false.
`int`	`getMaxPdfSaveSeconds()` Gets the max timed out seconds when save to PDF.
`int`	`getMaxShapeOrImageCount()` Gets the total count of the display shapes or images in the active sheet,it takes effect when IslimitShapeOrImage=true.
`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.
`int`	`getMaxTotalShapeOrImageCount()` Gets the total count of the display shapes or images in the workbook,it takes effect when IslimitShapeOrImage=true.
`java.lang.String`	`getMessageTopic()` Gets the websocket destinations prefixed with "/topic".
`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.
`boolean`	`getSameImageDetecting()` Gets whether to check if images have same source,the default is true the default value is true.
`boolean`	`getSaveHtmlAsZip()` Gets whether to save html file as zip archive,the default is false.
`boolean`	`getShowChartSheet()` Gets whether to show chart worksheet.
`boolean`	`getSkipInvisibleShapes()` Gets whether to skip shapes that are invisble to UI ,the default value is true.
`boolean`	`getUsePrintArea()` Gets whether to use PageSetup.PrintArea for the UI display range when the worksheet has PageSetup setting for PrintArea.
`boolean`	`isCollaborative()` Gets whether to support collabrative editing,the default is false.
`void`	`setAutoOptimizeForLargeCells(boolean value)` Sets whether to automatically optimize the load performance for worksheet with large cells.
`void`	`setBaseRouteName(java.lang.String value)` Sets the route URL base name for GridJs controller.the default is GridJs2
`void`	`setCollaborative(boolean value)` Sets whether to support collabrative editing,the default is false.
`void`	`setEmptySheetMaxCol(int value)` Sets default max column for an empty worksheet.
`void`	`setEmptySheetMaxRow(int value)` Sets default max row for an empty worksheet.
`void`	`setFileCacheDirectory(java.lang.String value)` Sets the cache directory for storing spreadsheet file.
`void`	`setFontFolders(java.lang.String[] value)` Sets the fonts folders for fonts in the rendered pictures/shapes
`void`	`setIgnoreEmptyContent(boolean value)` Sets whether to show the max range which includes data ,style, merged cells and shapes.
`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.
`void`	`setLazyLoading(boolean value)` Sets whether to load active worksheet only,the default is false.
`void`	`setMaxPdfSaveSeconds(int value)` Sets the max timed out seconds when save to PDF.
`void`	`setMaxShapeOrImageCount(int value)` Sets the total count of the display shapes or images in the active sheet,it takes effect when IslimitShapeOrImage=true.
`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.
`void`	`setMaxTotalShapeOrImageCount(int value)` Sets the total count of the display shapes or images in the workbook,it takes effect when IslimitShapeOrImage=true.
`void`	`setMessageTopic(java.lang.String value)` Sets the websocket destinations prefixed with "/topic".
`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.
`void`	`setSameImageDetecting(boolean value)` Sets whether to check if images have same source,the default is true the default value is true.
`void`	`setSaveHtmlAsZip(boolean value)` Sets whether to save html file as zip archive,the default is false.
`void`	`setShowChartSheet(boolean value)` Sets whether to show chart worksheet.
`void`	`setSkipInvisibleShapes(boolean value)` Sets whether to skip shapes that are invisble to UI ,the default value is true.
`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

- Field Detail
  - CacheImp
```
public GridCacheForStream CacheImp
```
    Custom implemention for cache storage,If you want to store cache in stream way ,you need to set and implement it.
- Constructor Detail
  - GridJsOptions
```
public GridJsOptions()
```
- Method Detail
  - getSaveHtmlAsZip
```
public boolean getSaveHtmlAsZip()
```
    Gets whether to save html file as zip archive,the default is false.
  - setSaveHtmlAsZip
```
public void setSaveHtmlAsZip(boolean value)
```
    Sets whether to save html file as zip archive,the default is false.
  - getSkipInvisibleShapes
```
public boolean getSkipInvisibleShapes()
```
    Gets whether to skip shapes that are invisble to UI ,the default value is true.
  - setSkipInvisibleShapes
```
public void setSkipInvisibleShapes(boolean value)
```
    Sets whether to skip shapes that are invisble to UI ,the default value is true.
  - getLazyLoading
```
public boolean getLazyLoading()
```
    Gets whether to load active worksheet only,the default is false.
  - setLazyLoading
```
public void setLazyLoading(boolean value)
```
    Sets whether to load active worksheet only,the default is false.
  - getSameImageDetecting
```
public boolean getSameImageDetecting()
```
    Gets whether to check if images have same source,the default is true the default value is true.
  - setSameImageDetecting
```
public void setSameImageDetecting(boolean value)
```
    Sets whether to check if images have same source,the default is true the default value is true.
  - getAutoOptimizeForLargeCells
```
public 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 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 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 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 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 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 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 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 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 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 int getMaxPdfSaveSeconds()
```
    Gets the max timed out seconds when save to PDF. the default value is 10.
  - setMaxPdfSaveSeconds
```
public void setMaxPdfSaveSeconds(int value)
```
    Sets the max timed out seconds when save to PDF. the default value is 10.
  - getIgnoreEmptyContent
```
public 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 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 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 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 boolean isCollaborative()
```
    Gets whether to support collabrative editing,the default is false.
  - setCollaborative
```
public void setCollaborative(boolean value)
```
    Sets whether to support collabrative editing,the default is false.
  - getShowChartSheet
```
public boolean getShowChartSheet()
```
    Gets whether to show chart worksheet. the default value is false .
  - setShowChartSheet
```
public void setShowChartSheet(boolean value)
```
    Sets whether to show chart worksheet. the default value is false .
  - getEmptySheetMaxRow
```
public int getEmptySheetMaxRow()
```
    Gets default max row for an empty worksheet. the default value is 12.
  - setEmptySheetMaxRow
```
public void setEmptySheetMaxRow(int value)
```
    Sets default max row for an empty worksheet. the default value is 12.
  - getEmptySheetMaxCol
```
public int getEmptySheetMaxCol()
```
    Gets default max column for an empty worksheet. the default value is 15.
  - setEmptySheetMaxCol
```
public void setEmptySheetMaxCol(int value)
```
    Sets default max column for an empty worksheet. the default value is 15.
  - getPictureCacheDirectory
```
public 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 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 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 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.
  - getFontFolders
```
public java.lang.String[] getFontFolders()
```
    Gets the fonts folders for fonts in the rendered pictures/shapes
  - setFontFolders
```
public void setFontFolders(java.lang.String[] value)
```
    Sets the fonts folders for fonts in the rendered pictures/shapes
  - getBaseRouteName
```
public java.lang.String getBaseRouteName()
```
    Gets the route URL base name for GridJs controller.the default is GridJs2
  - setBaseRouteName
```
public void setBaseRouteName(java.lang.String value)
```
    Sets the route URL base name for GridJs controller.the default is GridJs2
  - getMessageTopic
```
public java.lang.String getMessageTopic()
```
    Gets the websocket destinations prefixed with "/topic". the default is "/topic/opr".used in collaborative mode only.
  - setMessageTopic
```
public void setMessageTopic(java.lang.String value)
```
    Sets the websocket destinations prefixed with "/topic". the default is "/topic/opr".used in collaborative mode only.

Class GridJsOptions

Field Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

CacheImp

Constructor Detail

GridJsOptions

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

getFontFolders

setFontFolders

getBaseRouteName

setBaseRouteName

getMessageTopic

setMessageTopic