From Documentation

Jump to: navigation, search






Contents

Overview

Here we list all available library properties of Spreadsheet.


Chart's Font

For default font might not display your language properly, Spreadsheet allows you to specify fonts used in charts. There are 3 parts of a chart you can specify its font: title, legend, and x axis tick. Each part has a corresponding library property that you can specify its name, style, and size in zk.xml. Once you put the configuration, it affects to all charts of the whole application.

Example configuration in zk.xml

<library-property>
	<name>org.zkoss.zss.chart.title.font</name>
	<value>sansserif, italic, 30</value>
</library-property>
  • The above configuration sets title font to italic SansSerif with size 30.


Available property names:

Name Which font in chart

org.zkoss.zss.chart.title.font

title font

org.zkoss.zss.chart.legend.font

legend font

org.zkoss.zss.chart.xAxisTick.font

x axis tick font

Value's format:

[NAME], [STYLE], [SIZE]
  • [NAME] : Those font names your system supports.
  • [STYLE] : plain, bold, italic
  • If you specify a incorrect format in the property value, the property will be ignored.

Color Picker

Users can set a library property, org.zkoss.zss.useColorPickerEx, in zk.xml to specify which color picker used in the whole application. This property only works under Spreadsheet EE. The default value is true, and Spreadsheet uses ColorPicker of EE. If it's false, Spreadsheet uses OSE's ColorPicker.

ColorPicker of EE:

Zss-essentials-configuration-colorPickerEE.png

ColorPicker of OSE (fewer color choices):

Zss-essentials-configuration-colorPickerCE.png


Example in zk.xml

<library-property>
	<name>org.zkoss.zss.colorPickerExUsed</name>
	<value>false</value>
</library-property>
  • The configuration above will make Spreadsheet use Color Picker of CE.

Preferred Theme

since 3.5.0

Currently, ZSS provides the following different themes: Default (built-in theme) and Classic from Github

Default
Classic

Library property could be used to assign a preferred theme which is registered.

Example in zk.xml

<library-property>
    <name>org.zkoss.zss.theme.preferred</name>
    <value>classic</value>
</library-property>

Formula Cache

 since 3.7

Importing

Default value: false

Set the property to true and ZSS will import the formula cache of an Excel file, and it can reduce the file loading time because ZSS doesn't need to re-evaluate formulas at loading.

<library-property>
    <name>org.zkoss.zss.import.cache</name>
    <value>true</value>
</library-property>

Few things need to be noticed:

  1. If some functions not yet supported by ZK Spreadsheet are used in a formula, re-evaluation breaks the cached value even if precedent cells do not change.
  2. If some customized function only supported in ZK Spreadsheet are used in a formula, a cache is always #NAME! error. Users must enforce re-evaluation by calling Range.refresh(true, true, true).

Exporting

Default value: false

Set the property to true and ZSS will export the formula cache into an Excel file.

<library-property>
    <name>org.zkoss.zss.export.cache</name>
    <value>true</value> 
</library-property>

Keep Cell Selection

 since 3.8.1

Default value: true

Set the property to false and ZSS will set default value of keepCellSelection attribute to false. Before version 3.8.1, when ZK Spreadsheet component loses its focus, it will hide the cell selection mark automatically. However, sometimes an end user would need to know which range is selected when he/she is operating on another control component (e.g. a dialog window). We have set the default value of keepCellSelection to true to avoid the confusion. However, if you would like ZSS to behavior as before version 3.8.1, you can set this property to false.

<library-property>
    <name>org.zkoss.zss.ui.keepCellSelection</name>
    <value>false</value> <!-- turn the keep-cell-selection off; default is true if not specified -->
</library-property>


All source code listed in this book is at Github.



Copyright © Potix Corporation. This article is licensed under GNU Free Documentation License.