From Documentation

Revision as of 02:20, 21 March 2019 by Hawk (Talk | contribs)
Jump to: navigation, search




Contents

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]:

    <dependency>
	    <groupId>org.zkoss.chart</groupId>
	    <artifactId>zkcharts</artifactId>
	    <version>1.0.0</version>
	</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.

    <repositories>
        <repository>
            <id>ZK PE/EE Evaluation</id>
            <url>http://mavensync.zkoss.org/eval/</url>
        </repository>
    </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}

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)




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