GridJsOptions
Inheritance: java.lang.Object
public class GridJsOptions
Represents all the load options for GridJs
Constructors
| Constructor | Description |
|---|---|
| GridJsOptions() |
Fields
| Field | Description |
|---|---|
| CacheImp | Custom implemention for cache storage,If you want to store cache in stream way ,you need to set and implement it. |
Methods
| Method | Description |
|---|---|
| equals(Object arg0) | |
| getAutoOptimizeForLargeCells() | Gets whether to automatically optimize the load performance for worksheet with large cells. |
| getBaseRouteName() | Gets the route URL base name for GridJs controller.the default is GridJs2 |
| getClass() | |
| getEmptySheetMaxCol() | Gets default max column for an empty worksheet. |
| getEmptySheetMaxRow() | Gets default max row for an empty worksheet. |
| getFileCacheDirectory() | Gets the cache directory for storing spreadsheet file. |
| getFontFolders() | Gets the fonts folders for fonts in the rendered pictures/shapes |
| getIgnoreEmptyContent() | Gets whether to show the max range which includes data ,style, merged cells and shapes. |
| 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. |
| getLazyLoading() | Gets whether to load active worksheet only,the default is false. |
| getMaxPdfSaveSeconds() | Gets the max timed out seconds when save to PDF. |
| getMaxShapeOrImageCount() | Gets the total count of the display shapes or images in the active sheet,it takes effect when IslimitShapeOrImage=true. |
| 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. |
| getMaxTotalShapeOrImageCount() | Gets the total count of the display shapes or images in the workbook,it takes effect when IslimitShapeOrImage=true. |
| getMessageTopic() | Gets the websocket destinations prefixed with “/topic”. the default is “/topic/opr”.used in collaborative mode only. |
| getPictureCacheDirectory() | Gets the cache directory for pictures. |
| getSameImageDetecting() | Gets whether to check if images have same source,the default is true the default value is true. |
| getSaveHtmlAsZip() | Gets whether to save html file as zip archive,the default is false. |
| getShowChartSheet() | Gets whether to show chart worksheet. |
| getSkipInvisibleShapes() | Gets whether to skip shapes that are invisble to UI ,the default value is true. |
| getUsePrintArea() | Gets whether to use PageSetup.PrintArea for the UI display range when the worksheet has PageSetup setting for PrintArea. |
| hashCode() | |
| isCollaborative() | Gets whether to support collabrative editing,the default is false. |
| notify() | |
| notifyAll() | |
| setAutoOptimizeForLargeCells(boolean value) | Sets whether to automatically optimize the load performance for worksheet with large cells. |
| setBaseRouteName(String value) | Sets the route URL base name for GridJs controller.the default is GridJs2 |
| setCollaborative(boolean value) | Sets whether to support collabrative editing,the default is false. |
| setEmptySheetMaxCol(int value) | Sets default max column for an empty worksheet. |
| setEmptySheetMaxRow(int value) | Sets default max row for an empty worksheet. |
| setFileCacheDirectory(String value) | Sets the cache directory for storing spreadsheet file. |
| setFontFolders(String[] value) | Sets the fonts folders for fonts in the rendered pictures/shapes |
| setIgnoreEmptyContent(boolean value) | Sets whether to show the max range which includes data ,style, merged cells and shapes. |
| 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. |
| setLazyLoading(boolean value) | Sets whether to load active worksheet only,the default is false. |
| setMaxPdfSaveSeconds(int value) | Sets the max timed out seconds when save to PDF. |
| setMaxShapeOrImageCount(int value) | Sets the total count of the display shapes or images in the active sheet,it takes effect when IslimitShapeOrImage=true. |
| 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. |
| setMaxTotalShapeOrImageCount(int value) | Sets the total count of the display shapes or images in the workbook,it takes effect when IslimitShapeOrImage=true. |
| setMessageTopic(String value) | Sets the websocket destinations prefixed with “/topic”. the default is “/topic/opr”.used in collaborative mode only. |
| setPictureCacheDirectory(String value) | Sets the cache directory for pictures. |
| setSameImageDetecting(boolean value) | Sets whether to check if images have same source,the default is true the default value is true. |
| setSaveHtmlAsZip(boolean value) | Sets whether to save html file as zip archive,the default is false. |
| setShowChartSheet(boolean value) | Sets whether to show chart worksheet. |
| setSkipInvisibleShapes(boolean value) | Sets whether to skip shapes that are invisble to UI ,the default value is true. |
| setUsePrintArea(boolean value) | Sets whether to use PageSetup.PrintArea for the UI display range when the worksheet has PageSetup setting for PrintArea. |
| toString() | |
| wait() | |
| wait(long arg0) | |
| wait(long arg0, int arg1) |
GridJsOptions()
public GridJsOptions()
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.
equals(Object arg0)
public boolean equals(Object arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | java.lang.Object |
Returns: boolean
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.
Returns: boolean
getBaseRouteName()
public String getBaseRouteName()
Gets the route URL base name for GridJs controller.the default is GridJs2
Returns: java.lang.String
getClass()
public final native Class<?> getClass()
Returns: java.lang.Class
getEmptySheetMaxCol()
public int getEmptySheetMaxCol()
Gets default max column for an empty worksheet. the default value is 15.
Returns: int
getEmptySheetMaxRow()
public int getEmptySheetMaxRow()
Gets default max row for an empty worksheet. the default value is 12.
Returns: int
getFileCacheDirectory()
public String getFileCacheDirectory()
Gets the cache directory for storing spreadsheet file. We need to set it to a specific path before we use GridJs.
Returns: java.lang.String
getFontFolders()
public String[] getFontFolders()
Gets the fonts folders for fonts in the rendered pictures/shapes
Returns: java.lang.String[]
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\u9286?* the default value is true .
Returns: boolean
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.
Returns: boolean
getLazyLoading()
public boolean getLazyLoading()
Gets whether to load active worksheet only,the default is false.
Returns: boolean
getMaxPdfSaveSeconds()
public int getMaxPdfSaveSeconds()
Gets the max timed out seconds when save to PDF. the default value is 10.
Returns: int
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.
Returns: int
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.
Returns: int
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.
Returns: int
getMessageTopic()
public String getMessageTopic()
Gets the websocket destinations prefixed with “/topic”. the default is “/topic/opr”.used in collaborative mode only.
Returns: java.lang.String
getPictureCacheDirectory()
public 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.
Returns: java.lang.String
getSameImageDetecting()
public boolean getSameImageDetecting()
Gets whether to check if images have same source,the default is true the default value is true.
Returns: boolean
getSaveHtmlAsZip()
public boolean getSaveHtmlAsZip()
Gets whether to save html file as zip archive,the default is false.
Returns: boolean
getShowChartSheet()
public boolean getShowChartSheet()
Gets whether to show chart worksheet. the default value is false .
Returns: boolean
getSkipInvisibleShapes()
public boolean getSkipInvisibleShapes()
Gets whether to skip shapes that are invisble to UI ,the default value is true.
Returns: boolean
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 .
Returns: boolean
hashCode()
public native int hashCode()
Returns: int
isCollaborative()
public boolean isCollaborative()
Gets whether to support collabrative editing,the default is false.
Returns: boolean
notify()
public final native void notify()
notifyAll()
public final native void notifyAll()
setAutoOptimizeForLargeCells(boolean value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setBaseRouteName(String value)
public void setBaseRouteName(String value)
Sets the route URL base name for GridJs controller.the default is GridJs2
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setCollaborative(boolean value)
public void setCollaborative(boolean value)
Sets whether to support collabrative editing,the default is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setEmptySheetMaxCol(int value)
public void setEmptySheetMaxCol(int value)
Sets default max column for an empty worksheet. the default value is 15.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setEmptySheetMaxRow(int value)
public void setEmptySheetMaxRow(int value)
Sets default max row for an empty worksheet. the default value is 12.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setFileCacheDirectory(String value)
public void setFileCacheDirectory(String value)
Sets the cache directory for storing spreadsheet file. We need to set it to a specific path before we use GridJs.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setFontFolders(String[] value)
public void setFontFolders(String[] value)
Sets the fonts folders for fonts in the rendered pictures/shapes
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String[] |
setIgnoreEmptyContent(boolean value)
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\u9286?* the default value is true .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setIslimitShapeOrImage(boolean value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setLazyLoading(boolean value)
public void setLazyLoading(boolean value)
Sets whether to load active worksheet only,the default is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setMaxPdfSaveSeconds(int value)
public void setMaxPdfSaveSeconds(int value)
Sets the max timed out seconds when save to PDF. the default value is 10.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setMaxShapeOrImageCount(int value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setMaxShapeOrImageWidthOrHeight(int value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setMaxTotalShapeOrImageCount(int value)
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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | int |
setMessageTopic(String value)
public void setMessageTopic(String value)
Sets the websocket destinations prefixed with “/topic”. the default is “/topic/opr”.used in collaborative mode only.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setPictureCacheDirectory(String value)
public void setPictureCacheDirectory(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.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | java.lang.String |
setSameImageDetecting(boolean value)
public void setSameImageDetecting(boolean value)
Sets whether to check if images have same source,the default is true the default value is true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSaveHtmlAsZip(boolean value)
public void setSaveHtmlAsZip(boolean value)
Sets whether to save html file as zip archive,the default is false.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setShowChartSheet(boolean value)
public void setShowChartSheet(boolean value)
Sets whether to show chart worksheet. the default value is false .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setSkipInvisibleShapes(boolean value)
public void setSkipInvisibleShapes(boolean value)
Sets whether to skip shapes that are invisble to UI ,the default value is true.
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
setUsePrintArea(boolean value)
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 .
Parameters:
| Parameter | Type | Description |
|---|---|---|
| value | boolean |
toString()
public String toString()
Returns: java.lang.String
wait()
public final void wait()
wait(long arg0)
public final native void wait(long arg0)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long |
wait(long arg0, int arg1)
public final void wait(long arg0, int arg1)
Parameters:
| Parameter | Type | Description |
|---|---|---|
| arg0 | long | |
| arg1 | int |