Setting Up ZK Charts"

From Documentation
(9 intermediate revisions by 3 users not shown)
Line 1: Line 1:
 
{{ZKChartsEssentialsPageHeader}}
 
{{ZKChartsEssentialsPageHeader}}
  
== Prerequisites ==
+
= Prerequisites =
  
 
* Downloaded ZK 7 from [http://www.zkoss.org/download/zk.dsp].
 
* Downloaded ZK 7 from [http://www.zkoss.org/download/zk.dsp].
 
* Downloaded ZK Charts 1.0.0 from [http://www.zkoss.org/download/zkcharts].
 
* Downloaded ZK Charts 1.0.0 from [http://www.zkoss.org/download/zkcharts].
  
=== Installing the Libraries ===
+
== Installing the Libraries ==
  
  
Line 13: Line 13:
 
The easiest way to create a compatible project is to use [http://www.zkoss.org/download/zkstudio.dsp ZK Studio] and then include charts.jar as a library
 
The easiest way to create a compatible project is to use [http://www.zkoss.org/download/zkstudio.dsp ZK Studio] and then include charts.jar as a library
  
=== Maven Project ===
+
== Maven Project ==
  
  
Line 22: Line 22:
 
    <groupId>org.zkoss.chart</groupId>
 
    <groupId>org.zkoss.chart</groupId>
 
    <artifactId>zkcharts</artifactId>
 
    <artifactId>zkcharts</artifactId>
    <version>1.0.0-BETA</version>
+
    <version>1.0.0</version>
 
</dependency>
 
</dependency>
 
</source>
 
</source>
  
==== Evaluating users (60-days free evaluation) ====
+
=== Evaluating users (60-days free evaluation) ===
  
 
* http://mavensync.zkoss.org/eval
 
* http://mavensync.zkoss.org/eval
  
'''Note''': The 1.0.0-BETA version is temporarily put in''' ZK PE-eval / EE- eval''' maven repository '''only'''. Please add the following config if you want to try the beta version.
+
'''Note''': ZK Charts evaluation version is put in''' ZK PE-eval / EE- eval''' maven repository. Please add the following config if you want to try the evaluation version.
 
<source lang="xml" line="false>
 
<source lang="xml" line="false>
 
     <repositories>
 
     <repositories>
Line 44: Line 44:
 
<references/>
 
<references/>
 
</blockquote>
 
</blockquote>
==== Premium users only ====
+
 
 +
=== Premium users only ===
  
 
* <span style="color:red">'''Notice'''</span>: Need [[ZK_Pivottable_Essentials/Quick_Start/Using_Maven#Login_authentication|Login authentication]]
 
* <span style="color:red">'''Notice'''</span>: Need [[ZK_Pivottable_Essentials/Quick_Start/Using_Maven#Login_authentication|Login authentication]]
Line 50: Line 51:
 
:  If you are our customer, please apply for a premium maven account to use ZK Premium Maven Repository.
 
:  If you are our customer, please apply for a premium maven account to use ZK Premium Maven Repository.
  
* http://maven.zkoss.org/repo/zk/ee
+
* https://maven.zkoss.org/repo/zk/ee
  
 
<source lang="xml">
 
<source lang="xml">
Line 76: Line 77:
 
<servers>
 
<servers>
 
<server>
 
<server>
<id>ZK EE</id><!-- Same as the repository name used in your pom.xml -->
+
<id>ZK EE</id>
<!-- Please replace the following with your premium username and password -->
+
<!-- Same as the repository name used in your pom.xml -->
 +
<!-- Please replace the following with  
 +
your premium username and password -->
 
<username>your account</username>
 
<username>your account</username>
 
<password>your password</password>
 
<password>your password</password>
Line 87: Line 90:
 
*Sample of pom.xml for using licensed ZK Charts
 
*Sample of pom.xml for using licensed ZK Charts
 
<source lang="xml">
 
<source lang="xml">
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
+
<project xmlns="http://maven.apache.org/POM/4.0.0"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
+
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
 +
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0  
 +
http://maven.apache.org/xsd/maven-4.0.0.xsd">
 
<modelVersion>4.0.0</modelVersion>
 
<modelVersion>4.0.0</modelVersion>
<groupId>zkpvt</groupId>
+
<groupId>zkcharts</groupId>
 
<artifactId>sample</artifactId>
 
<artifactId>sample</artifactId>
 
<version>0.0.1-SNAPSHOT</version>
 
<version>0.0.1-SNAPSHOT</version>
Line 140: Line 145:
 
 
 
<!-- ZK Charts -->
 
<!-- ZK Charts -->
              <dependency>
+
<dependency>
            <groupId>org.zkoss.chart</groupId>
+
<groupId>org.zkoss.chart</groupId>
            <artifactId>zkcharts</artifactId>
+
<artifactId>zkcharts</artifactId>
            <version>1.0.0</version>
+
<version>1.0.0</version>
      </dependency>
+
</dependency>
  
 
</dependencies>
 
</dependencies>
 
</project>
 
</project>
 
</source>
 
</source>
 +
 +
 +
= Display Version=
 +
You can display ZK Charts version in a zul page with EL:
 +
 +
<source lang='xml'>
 +
<?import org.zkoss.chart.Version ?>
 +
 +
    Charts ${Version.UID}
 +
 +
</source>
 +
 +
To know bundled Highcharts version, evaluate the javascript variable below:
 +
 +
<source lang='javascript'>
 +
Highcharts.version
 +
</source>
 +
 +
= Default License Loading Path =
 +
ZK Charts loads a license file from the default path:
 +
 +
'''WEB-INF/classes/metainfo/chart/license'''
 +
 +
If the license is loaded successfully, you should see some license information printed on your application console like:
 +
 +
<source lang='text'>
 +
*** Potix Corporation License Information ***
 +
(your license information)
 +
</source>
 +
 +
 
{{ZKChartsEssentialsPageFooter}}
 
{{ZKChartsEssentialsPageFooter}}

Revision as of 09:59, 20 June 2019


Prerequisites

  • Downloaded ZK 7 from [1].
  • Downloaded ZK Charts 1.0.0 from [2].

Installing the Libraries

Depending on your IDE the steps will differ, however the most important part is to include both ZK Charts and ZK’s JAR files in your project. The project should be a ZK Project or a Web Application Project depending on what environment you are using. Then, place the charts jar under WEB-INF/lib folder.

The easiest way to create a compatible project is to use ZK Studio and then include charts.jar as a library

Maven Project

If your project is managed by Maven already, you can adopt ZK Charts easily by simply adding a dependency like the following [1]:

1     <dependency>
2 	    <groupId>org.zkoss.chart</groupId>
3 	    <artifactId>zkcharts</artifactId>
4 	    <version>1.0.0</version>
5 	</dependency>

Evaluating users (60-days free evaluation)

Note: ZK Charts evaluation version is put in ZK PE-eval / EE- eval maven repository. Please add the following config if you want to try the evaluation version.

1     <repositories>
2         <repository>
3             <id>ZK PE/EE Evaluation</id>
4             <url>http://mavensync.zkoss.org/eval/</url>
5         </repository>
6     </repositories>

  1. If you didn't setup zk maven repository yet, you have to setup zk maven repository as well.

Premium users only

If you are our customer, please apply for a premium maven account to use ZK Premium Maven Repository.
<repositories>
	<repository>
		<id>ZK EE</id>
		<url>https://maven.zkoss.org/repo/zk/ee</url>
	</repository>
</repositories>
  • Login authentication

Please refer to the official documentation of Apache Maven project for storing login authentication credential in the global settings file.

  • Location (if not already existed, you can create it manually)
    • Maven installation root: $M2_HOME/conf/settings.xml - OR -
    • User's Maven root: ${user.home}/.m2/settings.xml
<settings xmlns="http://maven.apache.org/SETTINGS/1.0.0"
		xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
		xsi:schemaLocation="http://maven.apache.org/SETTINGS/1.0.0
		http://maven.apache.org/xsd/settings-1.0.0.xsd">
	<servers>
		<server>
			<id>ZK EE</id>
			<!-- Same as the repository name used in your pom.xml -->
			<!-- Please replace the following with 
				your premium username and password -->
			<username>your account</username>
			<password>your password</password>
		</server>
	</servers>
</settings>
  • Sample of pom.xml for using licensed ZK Charts
<project xmlns="http://maven.apache.org/POM/4.0.0"
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 
		http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>zkcharts</groupId>
	<artifactId>sample</artifactId>
	<version>0.0.1-SNAPSHOT</version>
	<properties>
		<!-- please change the version accordingly -->
		<zk.version>6.5.2</zk.version>
		<commons-io>1.3.1</commons-io>
	</properties>
	<packaging>war</packaging>
	<name>The sample Project</name>
	<repositories>
		<repository>
			<id>ZK CE</id>
			<name>ZK CE Repository</name>
			<url>http://mavensync.zkoss.org/maven2</url>
		</repository>
		<repository>
			<id>ZK EE</id>
			<url>https://maven.zkoss.org/repo/zk/ee</url>
		</repository>
	</repositories>
	<dependencies>
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zkbind</artifactId>
			<version>${zk.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zul</artifactId>
			<version>${zk.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zkplus</artifactId>
			<version>${zk.version}</version>
		</dependency>
		<dependency>
			<groupId>org.zkoss.zk</groupId>
			<artifactId>zhtml</artifactId>
			<version>${zk.version}</version>
		</dependency>
		
		<dependency>
			<groupId>commons-io</groupId>
			<artifactId>commons-io</artifactId>
			<version>${commons-io}</version>
		</dependency>
		
		<!-- ZK Charts -->
		<dependency>
			<groupId>org.zkoss.chart</groupId>
			<artifactId>zkcharts</artifactId>
			<version>1.0.0</version>
		</dependency>

	</dependencies>
</project>


Display Version

You can display ZK Charts version in a zul page with EL:

<?import org.zkoss.chart.Version ?>

    Charts ${Version.UID}

To know bundled Highcharts version, evaluate the javascript variable below:

Highcharts.version

Default License Loading Path

ZK Charts loads a license file from the default path:

WEB-INF/classes/metainfo/chart/license

If the license is loaded successfully, you should see some license information printed on your application console like:

*** Potix Corporation License Information ***
(your license information)


< Get Complete Source Code of This Book >


Last Update : 2019/06/20

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