فهرست منبع

Update README => Installation description (by Gradle)

An An 4 سال پیش
والد
کامیت
13fab9e6fa
3فایلهای تغییر یافته به همراه99 افزوده شده و 178 حذف شده
  1. 33 57
      CHINESE-README.md
  2. 32 64
      README.md
  3. 34 57
      TRADITIONAL-CHINESE-README.md

+ 33 - 57
CHINESE-README.md

@@ -70,25 +70,44 @@
 
 ## 安装
 
-### 手动安装
+### 通过 Gradle 安装
 
-1. 下载 Demo  `AAChartCore-KotlinDemo`
-2. 将 Demo 中的名为 `AAInfographicsLib 的文件夹`和 `assets 文件夹下的所有文件`拖入至你的项目之中.
+#### Step 1. 添加 `JitPack 仓库支持` 到你的 `build` 文件中 
 
+在**项目根目录**的 `build.gradle(注意:不是 app/build.gradle)` 中添加对 `JitPack` 的支持:
+
+```groovy
+	allprojects {
+		repositories {
+			...
+			maven { url 'https://www.jitpack.io' }
+		}
+	}
+```
+	
+#### Step 2. 添加 `AAChartCore-Kotlin(AAInfographics)` 依赖
+
+```groovy
+	dependencies {
+	        implementation 'com.github.AAChartModel:AAChartCore-Kotlin:-SNAPSHOT'
+	}
+```
 
 ## 使用方法
 
 1. 创建视图*AAChartView*
+
 ```xml
-        <com.aachartmodel.aainfographics.AAInfographicsLib.AAChartConfiger.AAChartView
-        android:id="@+id/AAChartView"
+    <com.github.aachartmodel.aainfographics.aachartcreator.AAChartView
+        android:id="@+id/aa_chart_view"
         android:layout_width="match_parent"
-        android:layout_height="match_parent"
-        />
- ```
+        android:layout_height="match_parent">
+
+    </com.github.aachartmodel.aainfographics.aachartcreator.AAChartView>
+  ```
 
  ```kotlin
-        aaChartView = findViewById(R.id.AAChartView)
+    val aaChartView = findViewById<AAChartView>(R.id.aa_chart_view)
  ```
 2. 配置视图模型*AAChartModel*
 
@@ -100,8 +119,6 @@
     .subtitle("subtitle")
     .backgroundColor("#4b2b7f")
     .dataLabelEnabled(true)
-    .yAxisGridLineWidth(0)
-    .legendVerticalAlign(AAChartLegendVerticalAlignType.Bottom)
     .series(arrayOf(
         AASeriesElement()
             .name("Tokyo")
@@ -123,7 +140,7 @@
 
 ```kotlin
         /*图表视图对象调用图表模型对象,绘制最终图形*/
-        aaChartView.aa_drawChartWithChartModel(aaChartModel);
+        aaChartView.aa_drawChartWithChartModel(aaChartModel)
 ```
 
 🌹🌹🌹 好了,至此,有关于绘制图形的任务,一切皆已经搞定!!! 你将得到你想要的任意图形!!!
@@ -405,51 +422,10 @@ colorsTheme | 图表显示的颜色主题效果 |类似此 `arrayOf("#fe117c", "
 series | 图表的数据列 | AASeriesElement实例对象组成的有效数组,其中每个AASeriesElement都有与之对应的数据、类型、颜色、透明度等具体的值 | 
 
 
-* ### AAChartModel 所有属性列表说明
-```kotlin
-    var animationType: String? = null          //动画类型
-    var animationDuration: Int? = null         //动画时间
-    var title: String? = null                  //标题内容
-    var subtitle: String? = null               //副标题内容
-    var chartType: String? = null              //图表类型
-    var stacking: String? = null               //堆积样式
-    var symbol: String? = null                 //折线曲线连接点的类型:"circle", "square", "diamond", "triangle","triangle-down",默认是"circle"
-    var symbolStyle: String? = null
-    var zoomType: String? = null               //缩放类型 AAChartZoomTypeX表示可沿着 x 轴进行手势缩放
-    var pointHollow: Boolean? = null           //折线或者曲线的连接点是否为空心的
-    var inverted: Boolean? = null              //x 轴是否翻转(垂直)
-    var xAxisReversed: Boolean? = null         //x 轴翻转
-    var yAxisReversed: Boolean? = null         //y 轴翻转
-    var tooltipEnabled: Boolean? = null        //是否显示浮动提示框(默认显示)
-    var tooltipValueSuffix: String? = null     //浮动提示框单位后缀
-    var tooltipCrosshairs: Boolean? = null     //是否显示准星线(默认显示)
-    var gradientColorEnable: Boolean? = null   //是否要为渐变色
-    var polar: Boolean? = null                 //是否极化图形(变为雷达图)
-    var marginLeft: Float? = null              //左部外边距
-    var marginRight: Float? = null             //右边外边距
-    var dataLabelEnabled: Boolean? = null      //是否显示数据
-    var xAxisLabelsEnabled: Boolean? = null    //x轴是否显示数据
-    var categories: Array<String>? = null      //x轴是否显示数据
-    var xAxisGridLineWidth: Int? = null        //x轴网格线的宽度
-    var xAxisVisible: Boolean? = null          //x 轴是否显示
-    var yAxisVisible: Boolean? = null          //y 轴是否显示
-    var yAxisLabelsEnabled: Boolean? = null    //y轴是否显示数据
-    var yAxisTitle: String? = null             //y轴标题
-    var yAxisLineWidth: Float? = null          //y 轴轴线的宽度
-    var yAxisGridLineWidth: Int? = null        //y轴网格线的宽度
-    var colorsTheme: Array<Any>? = null        //图表主题颜色数组
-    var legendEnabled: Boolean? = null         //是否显示图例
-    var legendLayout: String? = null           //图例数据项的布局。布局类型: "horizontal" 或 "vertical" 即水平布局和垂直布局 默认是:horizontal.
-    var legendAlign: String? = null            //设定图例在图表区中的水平对齐方式,合法值有left,center 和 right。
-    var legendVerticalAlign: String? = null    //设定图例在图表区中的垂直对齐方式,合法值有 top,middle 和 bottom。垂直位置可以通过 y 选项做进一步设定。
-    var backgroundColor: String? = null        //图表背景色
-    var borderRadius: Int? = null              //柱状图长条图头部圆角半径(可用于设置头部的形状,仅对条形图,柱状图有效)
-    var markerRadius: Int? = null              //折线连接点的半径长度
-    var series: Array<AASeriesElement>? = null
-    var titleColor: String? = null             //标题颜色
-    var subTitleColor: String? = null          //副标题颜色
-    var axisColor: String? = null              //x 轴和 y 轴文字颜色
-```
+
+更多详尽的图表属性设置参数您可以在 `AAChartModel` 和 `AAOptions` 文件中找到, 详细内容参见 `AAChartCore-Kotlin(AAInfographics)` 源代码.
+
+
 
 
 ## 作者

+ 32 - 64
README.md

@@ -63,16 +63,29 @@
 ## Installation
 
 
-### Manually  (old school way)
+### Gradle
 
-1. Download the repository
-2. Locate the folders `AAInfographicsLib`and `assets files`. <br/>
-   You can find them at AAChartCore-Kotlin-master/app/src/main/*assets* <br/>
-   and AAChartCore-Kotlin-master/app/src/main/java/com/aachartmodel/*aainfographics* <br/>
-3. Place assets folder at ./your_project_folder/app/src/main
-4. Place the AAInfographicsLib library folder at ./your_project_folder/app/src/main/java/android/organisation/app_name/
-5. Add implementation 'com.google.code.gson:gson:2.8.6' to your gradle
-6. If missing - add mavenLocal()
+
+#### Step 1. Add the JitPack repository to your build file
+
+Add it in your root build.gradle at the end of repositories:
+
+```groovy
+	allprojects {
+		repositories {
+			...
+			maven { url 'https://www.jitpack.io' }
+		}
+	}
+```
+	
+#### Step 2. Add the dependency
+
+```groovy
+	dependencies {
+	        implementation 'com.github.AAChartModel:AAChartCore-Kotlin:-SNAPSHOT'
+	}
+```
 
 You're all set, enjoy!
 
@@ -80,15 +93,16 @@ You're all set, enjoy!
 
 1. Create the instance object of chart view:`AAChartView`
 ```xml
-         <com.aachartmodel.aainfographics.AAInfographicsLib.AAChartCreator.AAChartView
-        android:id="@+id/AAChartView"
+    <com.github.aachartmodel.aainfographics.aachartcreator.AAChartView
+        android:id="@+id/aa_chart_view"
         android:layout_width="match_parent"
-        android:layout_height="match_parent"
-        />
+        android:layout_height="match_parent">
+
+    </com.github.aachartmodel.aainfographics.aachartcreator.AAChartView>
   ```
 
 ```kotlin
-       val aaChartView : AAChartView = findViewById(R.id.AAChartView)
+    val aaChartView = findViewById<AAChartView>(R.id.aa_chart_view)
 ```
 
 2. Configure the properties of chart model:`AAChartModel`
@@ -100,7 +114,6 @@ You're all set, enjoy!
     .subtitle("subtitle")
     .backgroundColor("#4b2b7f")
     .dataLabelsEnabled(true)
-    .yAxisGridLineWidth(0f)
     .series(arrayOf(
         AASeriesElement()
             .name("Tokyo")
@@ -121,7 +134,7 @@ You're all set, enjoy!
 
 ```kotlin
         //The chart view object calls the instance object of AAChartModel and draws the final graphic
-        aaChartView?.aa_drawChartWithChartModel(aaChartModel)
+        aaChartView.aa_drawChartWithChartModel(aaChartModel)
 ```
 
 
@@ -135,13 +148,13 @@ if you want to refresh chart content,you should do something as follow.According
 
 ```kotlin
         //Only refresh the chart series data
-        aaChartView?.aa_onlyRefreshTheChartDataWithChartModelSeries(chartModelSeriesArray)
+        aaChartView.aa_onlyRefreshTheChartDataWithChartModelSeries(chartModelSeriesArray)
 ```
 
 *  Refresh the chart, minus the chart data (this method is recommended for subsequent refreshes after the first drawing of graphics has completed. If you want to update the chart data only, you should use the function `aa_onlyRefreshTheChartDataWithChartModelSeries`)
 ```kotlin
         //Refresh the chart after the AAChartModel whole content is updated
-        aaChartView?.aa_refreshChartWholeContentWithChartModel(aaChartModel!)
+        aaChartView.aa_refreshChartWholeContentWithChartModel(aaChartModel)
 ```
 
 ## Infographics sample
@@ -405,52 +418,7 @@ series | the series data of chart |  a list made of AASeriesElement instance obj
 
 
 
-
-* ### AAChartModel:chart all properties list
-```kotlin
-  var animationType: String? = null          
-    var animationDuration: Int? = null       
-    var title: String? = null                 
-    var subtitle: String? = null               
-    var chartType: String? = null             
-    var stacking: String? = null              
-    var symbol: String? = null               
-    var symbolStyle: String? = null
-    var zoomType: String? = null              
-    var pointHollow: Boolean? = null           
-    var inverted: Boolean? = null              
-    var xAxisReversed: Boolean? = null         
-    var yAxisReversed: Boolean? = null         
-    var tooltipEnabled: Boolean? = null        
-    var tooltipValueSuffix: String? = null    
-    var tooltipCrosshairs: Boolean? = null     
-    var gradientColorEnable: Boolean? = null  
-    var polar: Boolean? = null                
-    var marginLeft: Float? = null            
-    var marginRight: Float? = null           
-    var dataLabelEnabled: Boolean? = null     
-    var xAxisLabelsEnabled: Boolean? = null    
-    var categories: Array<String>? = null      
-    var xAxisGridLineWidth: Int? = null       
-    var xAxisVisible: Boolean? = null          
-    var yAxisVisible: Boolean? = null          
-    var yAxisLabelsEnabled: Boolean? = null    
-    var yAxisTitle: String? = null            
-    var yAxisLineWidth: Float? = null          
-    var yAxisGridLineWidth: Int? = null        
-    var colorsTheme: Array<Any>? = null        
-    var legendEnabled: Boolean? = null         
-    var legendLayout: String? = null           
-    var legendAlign: String? = null            
-    var legendVerticalAlign: String? = null    
-    var backgroundColor: String? = null        
-    var borderRadius: Int? = null              
-    var markerRadius: Int? = null             
-    var series: Array<AASeriesElement>? = null
-    var titleColor: String? = null            
-    var subTitleColor: String? = null        
-    var axisColor: String? = null             
-```
+More detailed chart property setting parameters can be found in the ʻAAChartModel` and ʻAAOptions` files. For details, please refer to the ʻAAChartCore-Kotlin(AAInfographics)` source code.
 
 
 

+ 34 - 57
TRADITIONAL-CHINESE-README.md

@@ -69,25 +69,46 @@
 
 ## 安裝
 
-### 手動安裝
+## 安裝
+
+### 通過 Gradle 安裝
 
-1. 下載 Demo  `AAChartCore-KotlinDemo`
-2. 將 Demo 中的名為`AAInfographicsLib` 的文件夾拖入至妳的項目之中.
+#### Step 1. 添加 `JitPack 倉庫支持` 到你的 `build` 文件中 
 
+在**項目根目錄**的 `build.gradle(注意:不是 app/build.gradle)` 中添加對 `JitPack` 的支持:
+
+```groovy
+	allprojects {
+		repositories {
+			...
+			maven { url 'https://www.jitpack.io' }
+		}
+	}
+```
+	
+#### Step 2. 添加 `AAChartCore-Kotlin(AAInfographics)` 依賴
+
+```groovy
+	dependencies {
+	        implementation 'com.github.AAChartModel:AAChartCore-Kotlin:-SNAPSHOT'
+	}
+```
 
 ## 使用方法
 
 1. 創建視圖*AAChartView*
+
 ```xml
-        <com.aachartmodel.aainfographics.AAInfographicsLib.AAChartConfiger.AAChartView
-        android:id="@+id/AAChartView"
+    <com.github.aachartmodel.aainfographics.aachartcreator.AAChartView
+        android:id="@+id/aa_chart_view"
         android:layout_width="match_parent"
-        android:layout_height="match_parent"
-        />
- ```
+        android:layout_height="match_parent">
+
+    </com.github.aachartmodel.aainfographics.aachartcreator.AAChartView>
+  ```
 
  ```kotlin
-        aaChartView = findViewById(R.id.AAChartView)
+    val aaChartView = findViewById<AAChartView>(R.id.aa_chart_view)
  ```
 2. 配置視圖模型*AAChartModel*
 
@@ -99,8 +120,6 @@
     .subtitle("subtitle")
     .backgroundColor("#4b2b7f")
     .dataLabelEnabled(true)
-    .yAxisGridLineWidth(0)
-    .legendVerticalAlign(AAChartLegendVerticalAlignType.Bottom)
     .series(arrayOf(
         AASeriesElement()
             .name("Tokyo")
@@ -122,7 +141,7 @@
 
 ```kotlin
         /*圖表視圖對象調用圖表模型對象,繪制最終圖形*/
-        aaChartView.aa_drawChartWithChartModel(aaChartModel);
+        aaChartView.aa_drawChartWithChartModel(aaChartModel)
 ```
 
 🌹🌹🌹 好了,至此,有關於繪制圖形的任務,壹切皆已經搞定!!! 妳將得到妳想要的任意圖形!!!
@@ -387,51 +406,9 @@ colorsTheme | 圖表顯示的顏色主題效果 |類似此 `new String[]{"#fe117
 series | 圖表的數據列 | AASeriesElement實例對象組成的有效數組,其中每個AASeriesElement都有與之對應的數據、類型、顏色、透明度等具體的值 | 
 
 
-* ### AAChartModel 所有屬性列表說明
-```kotlin
-    var animationType: String? = null          //動畫類型
-    var animationDuration: Int? = null         //動畫時間
-    var title: String? = null                  //標題內容
-    var subtitle: String? = null               //副標題內容
-    var chartType: String? = null              //圖表類型
-    var stacking: String? = null               //堆積樣式
-    var symbol: String? = null                 //折線曲線連接點的類型:"circle", "square", "diamond", "triangle","triangle-down",默認是"circle"
-    var symbolStyle: String? = null
-    var zoomType: String? = null               //縮放類型 AAChartZoomTypeX表示可沿著 x 軸進行手勢縮放
-    var pointHollow: Boolean? = null           //折線或者曲線的連接點是否為空心的
-    var inverted: Boolean? = null              //x 軸是否翻轉(垂直)
-    var xAxisReversed: Boolean? = null         //x 軸翻轉
-    var yAxisReversed: Boolean? = null         //y 軸翻轉
-    var tooltipEnabled: Boolean? = null        //是否顯示浮動提示框(默認顯示)
-    var tooltipValueSuffix: String? = null     //浮動提示框單位後綴
-    var tooltipCrosshairs: Boolean? = null     //是否顯示準星線(默認顯示)
-    var gradientColorEnable: Boolean? = null   //是否要為漸變色
-    var polar: Boolean? = null                 //是否極化圖形(變為雷達圖)
-    var marginLeft: Float? = null              //左部外邊距
-    var marginRight: Float? = null             //右邊外邊距
-    var dataLabelEnabled: Boolean? = null      //是否顯示數據
-    var xAxisLabelsEnabled: Boolean? = null    //x軸是否顯示數據
-    var categories: Array<String>? = null      //x軸是否顯示數據
-    var xAxisGridLineWidth: Int? = null        //x軸網格線的寬度
-    var xAxisVisible: Boolean? = null          //x 軸是否顯示
-    var yAxisVisible: Boolean? = null          //y 軸是否顯示
-    var yAxisLabelsEnabled: Boolean? = null    //y軸是否顯示數據
-    var yAxisTitle: String? = null             //y軸標題
-    var yAxisLineWidth: Float? = null          //y 軸軸線的寬度
-    var yAxisGridLineWidth: Int? = null        //y軸網格線的寬度
-    var colorsTheme: Array<Any>? = null        //圖表主題顏色數組
-    var legendEnabled: Boolean? = null         //是否顯示圖例
-    var legendLayout: String? = null           //圖例數據項的布局。布局類型: "horizontal" 或 "vertical" 即水平布局和垂直布局 默認是:horizontal.
-    var legendAlign: String? = null            //設定圖例在圖表區中的水平對齊方式,合法值有left,center 和 right。
-    var legendVerticalAlign: String? = null    //設定圖例在圖表區中的垂直對齊方式,合法值有 top,middle 和 bottom。垂直位置可以通過 y 選項做進壹步設定。
-    var backgroundColor: String? = null        //圖表背景色
-    var borderRadius: Int? = null              //柱狀圖長條圖頭部圓角半徑(可用於設置頭部的形狀,僅對條形圖,柱狀圖有效)
-    var markerRadius: Int? = null              //折線連接點的半徑長度
-    var series: Array<AASeriesElement>? = null
-    var titleColor: String? = null             //標題顏色
-    var subTitleColor: String? = null          //副標題顏色
-    var axisColor: String? = null              //x 軸和 y 軸文字顏色
-```
+
+更多詳盡的圖表屬性設置參數您可以在 `AAChartModel` 和 `AAOptions` 文件中找到, 詳細內容參見 `AAChartCore-Kotlin(AAInfographics)` 源代碼.
+
 
 
 ## 作者