diff --git a/docs/Controllers.md b/docs/Controllers.md index 0181f77c..dc9a84c0 100644 --- a/docs/Controllers.md +++ b/docs/Controllers.md @@ -21,10 +21,10 @@ For this reason, **Charba** provides the interfaces to create controllers **ONLY To create own chart type, you need to perform some specific and mandatory steps: - 1. create a [controller type](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/controllers/ControllerType.html) - 2. implement the [controller](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html) interface where all hooks are defined - 3. extend the [dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Dataset.html) class of the original chart type - 4. extend the [chart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) class of the original chart type + 1. create a [controller type](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/controllers/ControllerType.html) + 2. implement the [controller](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html) interface where all hooks are defined + 3. extend the [dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Dataset.html) class of the original chart type + 4. extend the [chart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) class of the original chart type ### Creating a controller type @@ -35,7 +35,7 @@ This id should follow the name convention (otherwise an [illegal argument](http * can not start with a dot or an underscore * can not contain any non-URL-safe characters -The [controller type](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/controllers/ControllerType.html) is an entity which must be implemented for every controller you want to implement. A controller type implements [Type](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Type.html) interface like all other chart types available out-of-the-box. +The [controller type](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/controllers/ControllerType.html) is an entity which must be implemented for every controller you want to implement. A controller type implements [Type](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Type.html) interface like all other chart types available out-of-the-box. Here are the way how to create a controller type: @@ -52,7 +52,7 @@ ControllerType myLine = new ControllerType("myline", ChartType.LINE, new Control }); ``` -The controller type constructor is getting a [controller provider](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/controllers/ControllerProvider.html) instance as argument in order to provide the controller during the registration. +The controller type constructor is getting a [controller provider](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/controllers/ControllerProvider.html) instance as argument in order to provide the controller during the registration. The controller is usually automatically registered in [Chart.JS](http://www.chartjs.org/) when used. Anyway the controller type object is providing the method to **register** the controller programmatically in [Chart.JS](http://www.chartjs.org/): @@ -61,7 +61,7 @@ The controller is usually automatically registered in [Chart.JS](http://www.char myControllerType.register(); ``` -You can also be notified when and if the registration of the controller ended correctly. This is done by the implementation of [ControllerRegistrationHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/controllers/ControllerRegistrationHandler.html) interface to set during the controller type creation. +You can also be notified when and if the registration of the controller ended correctly. This is done by the implementation of [ControllerRegistrationHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/controllers/ControllerRegistrationHandler.html) interface to set during the controller type creation. ```java // creates a chart extending the existing chart LINE @@ -95,7 +95,7 @@ ControllerType myLine = new ControllerType("myline", ChartType.LINE, myControlle ### Hooks -A controller must implement the [Controller](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html) interface which is containing all hooks which will be invoked during the whole chart life cycle. +A controller must implement the [Controller](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html) interface which is containing all hooks which will be invoked during the whole chart life cycle. The interface provides **before** and **after** hooks for each phases exposes by [Chart.JS controller](https://www.chartjs.org/docs/4.3.0/developers/charts.html): @@ -103,7 +103,7 @@ The interface provides **before** and **after** hooks for each phases exposes by Every controller is initialized every time new chart instance is creating. -The following hooks (the following ones are the methods definitions in the [Controller](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html)) can be used to initialize the chart: +The following hooks (the following ones are the methods definitions in the [Controller](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html)) can be used to initialize the chart: ```java /** @@ -140,8 +140,8 @@ flowchart TD style C fill:#FFFFFF,stroke:#000000 style D fill:#D5E8D4,stroke:#82B366 style E fill:#FFF2CC,stroke:#D6B656 - click B href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html#onBeforeInitialize(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart)" "onBeforeInitialize" _blank - click D href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html#onAfterInitialize(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart)" "onAfterInitialize" _blank + click B href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html#onBeforeInitialize(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart)" "onBeforeInitialize" _blank + click D href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html#onAfterInitialize(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart)" "onAfterInitialize" _blank ``` #### Rendering @@ -298,19 +298,19 @@ flowchart TD style T fill:#D5E8D4,stroke:#82B366 style U fill:#FFFFFF,stroke:#000000 style V fill:#FFF2CC,stroke:#D6B656 - click C href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html#onBeforeLinkScales(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart)" "onBeforeLinkScales" _blank - click E href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html#onAfterLinkScales(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart)" "onAfterLinkScales" _blank - click H href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html#onBeforeParse(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart,int,int)" "onBeforeParse" _blank - click O href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html#onBeforeUpdate(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart,org.pepstock.charba.client.options.TransitionMode)" "onBeforeUpdate" _blank - click L href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html#onAfterParse(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart,int,int)" "onAfterParse" _blank - click Q href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html#onAfterUpdate(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart,org.pepstock.charba.client.options.TransitionMode)" "onAfterUpdate" _blank - click R href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html#onBeforeDraw(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart)" "onBeforeDraw" _blank - click T href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Controller.html#onAfterDraw(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart)" "onAfterDraw" _blank + click C href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html#onBeforeLinkScales(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart)" "onBeforeLinkScales" _blank + click E href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html#onAfterLinkScales(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart)" "onAfterLinkScales" _blank + click H href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html#onBeforeParse(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart,int,int)" "onBeforeParse" _blank + click O href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html#onBeforeUpdate(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart,org.pepstock.charba.client.options.TransitionMode)" "onBeforeUpdate" _blank + click L href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html#onAfterParse(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart,int,int)" "onAfterParse" _blank + click Q href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html#onAfterUpdate(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart,org.pepstock.charba.client.options.TransitionMode)" "onAfterUpdate" _blank + click R href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html#onBeforeDraw(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart)" "onBeforeDraw" _blank + click T href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Controller.html#onAfterDraw(org.pepstock.charba.client.controllers.ControllerContext,org.pepstock.charba.client.IsChart)" "onAfterDraw" _blank ``` ### Implementing a controller -The easy way to implement a controller is to extends the [AbstractController](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/controllers/AbstractController.html) class and pass the controller type by the constructor. +The easy way to implement a controller is to extends the [AbstractController](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/controllers/AbstractController.html) class and pass the controller type by the constructor. ```java // new controller diff --git a/docs/DateAdapters.md b/docs/DateAdapters.md index e2a0f5b3..e40b777f 100644 --- a/docs/DateAdapters.md +++ b/docs/DateAdapters.md @@ -37,7 +37,7 @@ To see all available formats, have a look [here](https://moment.github.io/luxon/ [Luxon](https://moment.github.io/luxon/) can be configured in order to update some behavior during parsing, formatting and date management. -The [Luxon options](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/adapters/DateAdapterOptions.html) can be used as following: +The [Luxon options](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/adapters/DateAdapterOptions.html) can be used as following: ```java // creates a time series axis @@ -52,18 +52,18 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| locale | [CLocale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) | `null` | Using locale specifying the language to use generating or interpreting strings. -| zone | [TimeZone](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/TimeZone.html) | `null` | Implementation recognizes the time zone names of the IANA time zone database. -| outputCalendar | [Calendar](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/Calendar.html) | `null` | The calendar type to use. -| numberingSystem | [NumberingSystem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/NumberingSystem.html) | `null` | The numbering system to use. +| locale | [CLocale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) | `null` | Using locale specifying the language to use generating or interpreting strings. +| zone | [TimeZone](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/TimeZone.html) | `null` | Implementation recognizes the time zone names of the IANA time zone database. +| outputCalendar | [Calendar](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/Calendar.html) | `null` | The calendar type to use. +| numberingSystem | [NumberingSystem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/NumberingSystem.html) | `null` | The numbering system to use. For more details, have a look how to configure [time axes adapters](./axes/CartesianTimeAxes#adapters) and the [INTL locale](./intl/Locale) documentation. ## Using the date adapter -**Charba** enables the possibility to get a [date adapter](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/adapters/DateAdapter.html) instance from [Chart.JS](http://www.chartjs.org/) which can provides some capabilities, like formatting, parsing and date operations. +**Charba** enables the possibility to get a [date adapter](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/adapters/DateAdapter.html) instance from [Chart.JS](http://www.chartjs.org/) which can provides some capabilities, like formatting, parsing and date operations. -Here is an example how to use a [date adapter](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/adapters/DateAdapter.html) to format ticks by callback: +Here is an example how to use a [date adapter](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/adapters/DateAdapter.html) to format ticks by callback: ```java // creates a time axis diff --git a/docs/Overview.md b/docs/Overview.md index 6d2d50f7..915b064a 100644 --- a/docs/Overview.md +++ b/docs/Overview.md @@ -122,6 +122,6 @@ As of version **3**, **Charba** has got an own DOM tree manager which allows to * Tick callback to define the amount of decimals digits of the axis number values when all datasets are hidden * Legend callback to avoid to hide all datasets * Datalabels listeners callback to change cursor hovering the labels - * Datalabels listeners callback to select the labels, leveraging on [DatasetSelectionEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/DatasetSelectionEventHandler.html) + * Datalabels listeners callback to select the labels, leveraging on [DatasetSelectionEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/DatasetSelectionEventHandler.html) * Datalabels formatter callback to return the percentage as value to show in the chart diff --git a/docs/Regressions.md b/docs/Regressions.md index f8e69115..2972a2a1 100644 --- a/docs/Regressions.md +++ b/docs/Regressions.md @@ -74,9 +74,9 @@ Console.log(regression.toFormula(3)); // emit "f(x) = 2.00 * x - 1.00" ### Score -The [regression score](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/RegressionScore.html) provides the estimation and inference in the regressions. It can provide some methods which differ in computational simplicity of algorithms, presence of a closed-form solution, robustness with respect to heavy-tailed distributions, and theoretical assumptions needed to validate desirable statistical properties such as consistency and asymptotic efficiency. +The [regression score](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/RegressionScore.html) provides the estimation and inference in the regressions. It can provide some methods which differ in computational simplicity of algorithms, presence of a closed-form solution, robustness with respect to heavy-tailed distributions, and theoretical assumptions needed to validate desirable statistical properties such as consistency and asymptotic efficiency. -The [regression score](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/RegressionScore.html) provides: +The [regression score](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/RegressionScore.html) provides: * **R (R)**, which is the proportion of variation in the outcome that is explained by the predictor variables. In multiple regression models, R corresponds to the correlation between the observed outcome values and the predicted values by the model. The higher the _R_, the better the model * **R-squared (R2)**, which is the proportion of variation in the outcome that is explained by the predictor variables. In multiple regression models, _R2_ corresponds to the squared correlation between the observed outcome values and the predicted values by the model. The Higher the R-squared, the better the model @@ -105,7 +105,7 @@ Console.log(score.getRmsd()); // emit 0 The provided regression instances can be used separately from charts or can be used in order to add to the chart a specific dataset with the predicted data. -To create a specific [regression dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/RegressionDataset.html), which is an extended [line dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/LineDataset.html), **Charba** provides a specific builder in order to create the dataset which is created implementing a regression. +To create a specific [regression dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/RegressionDataset.html), which is an extended [line dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/LineDataset.html), **Charba** provides a specific builder in order to create the dataset which is created implementing a regression. ```java // creates chart @@ -139,7 +139,7 @@ chart.getData().setDatasets(dataset, trend);

-A regression [regression dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/RegressionDataset.html) can also be used to add a forecast line to show in the chart. +A regression [regression dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/RegressionDataset.html) can also be used to add a forecast line to show in the chart. ```java // creates chart @@ -205,7 +205,7 @@ The simple linear regression model can be represented using the below equation: #### Creating a linear regression -**Charba** provides a [builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/RegressionBuilder.html) to create a [simple linear regression](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/LinearRegression.html), passing the samples, in order to enable the use to predict values. +**Charba** provides a [builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/RegressionBuilder.html) to create a [simple linear regression](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/LinearRegression.html), passing the samples, in order to enable the use to predict values. ```java // creates samples @@ -240,7 +240,7 @@ Power regression is a non-linear regression technique that looks like this: #### Creating a power regression -**Charba** provides a [builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/RegressionBuilder.html) to create a [power regression](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/PowerRegression.html), passing the samples, in order to enable the use to predict values. +**Charba** provides a [builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/RegressionBuilder.html) to create a [power regression](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/PowerRegression.html), passing the samples, in order to enable the use to predict values. ```java // creates samples @@ -273,7 +273,7 @@ Exponential regression is a non-linear regression technique that looks like this #### Creating an exponential regression -**Charba** provides a [builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/RegressionBuilder.html) to create an [exponential regression](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/ExponentialRegression.html), passing the samples, in order to enable the use to predict values. +**Charba** provides a [builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/RegressionBuilder.html) to create an [exponential regression](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/ExponentialRegression.html), passing the samples, in order to enable the use to predict values. ```java // creates samples @@ -310,7 +310,7 @@ The polynomial regression model can be represented using the below equation: #### Creating a polynomial regression -**Charba** provides a [builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/RegressionBuilder.html) to create a [polynomial regression](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/PolynomialRegression.html), passing the samples, in order to enable the use to predict values. +**Charba** provides a [builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/RegressionBuilder.html) to create a [polynomial regression](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/PolynomialRegression.html), passing the samples, in order to enable the use to predict values. ```java // creates samples @@ -347,7 +347,7 @@ The robust polynomial regression model can be represented using the below equati #### Creating a robust polynomial regression -**Charba** provides a [builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/RegressionBuilder.html) to create a [robust polynomial regression](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/RobustPolynomialRegression.html), passing the samples, in order to enable the use to predict values. +**Charba** provides a [builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/RegressionBuilder.html) to create a [robust polynomial regression](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/RobustPolynomialRegression.html), passing the samples, in order to enable the use to predict values. ```java // creates samples @@ -380,7 +380,7 @@ The TheilSen regression model can be represented using the below equation: #### Creating a TheilSen regression -**Charba** provides a [builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/RegressionBuilder.html) to create a [TheilSen regression](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ml/TheilSenRegression.html), passing the samples, in order to enable the use to predict values. +**Charba** provides a [builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/RegressionBuilder.html) to create a [TheilSen regression](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ml/TheilSenRegression.html), passing the samples, in order to enable the use to predict values. ```java // creates samples diff --git a/docs/axes/AngleLines.md b/docs/axes/AngleLines.md index cfefe6a3..f6778653 100644 --- a/docs/axes/AngleLines.md +++ b/docs/axes/AngleLines.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Angle lines -The [angle lines](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/RadialAngleLines.html) options are used to configure angled lines that radiate from the center of the chart to the point labels. +The [angle lines](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/RadialAngleLines.html) options are used to configure angled lines that radiate from the center of the chart to the point labels. @@ -17,7 +17,7 @@ The angle lines can be **ONLY** applied to radial axes.
These options only apply if **display** is **true**. ::: -The [RadialAngleLines](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/RadialAngleLines.html) provides all **set** and **get** methods to manage the configuration, as following: +The [RadialAngleLines](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/RadialAngleLines.html) provides all **set** and **get** methods to manage the configuration, as following: ```java // creates a radial axis @@ -37,7 +37,7 @@ Table with options: | :- | :- | :- | :- | borderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes on grid lines. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | [Yes](#scriptable) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Color of angled lines. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Color of angled lines. | display | boolean | - | If `true`, angle lines are shown. | lineWidth | int | [Yes](#scriptable) | Width of angled lines. @@ -67,7 +67,7 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<ScaleContext> | int -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<ScaleContext> | double -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| lineWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<ScaleContext> | int +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<ScaleContext> | double +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| lineWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int diff --git a/docs/axes/Axes.md b/docs/axes/Axes.md index b62f5c8b..04127e0a 100644 --- a/docs/axes/Axes.md +++ b/docs/axes/Axes.md @@ -20,9 +20,9 @@ At the creation time, an axis needs to have the following 3 attributes: | Name | Type | Description | :- | :- | :- -| id | [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | The unique id of axis. -| type | [AxisType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/AxisType.html) | The type of scale being employed. -| axis | [AxisKind](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisKind.html) |The axis kind to define which directions are used in axis. +| id | [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | The unique id of axis. +| type | [AxisType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/AxisType.html) | The type of scale being employed. +| axis | [AxisKind](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisKind.html) |The axis kind to define which directions are used in axis. Here is an example how to create an axis: @@ -35,12 +35,12 @@ CartesianLinearAxis linearAxis = new CartesianLinearAxis(chart, scaleId, AxisKin ## Axis ID -All axes must have a unique id which must be passed when the axis is creating. When the id is not passed, the axis will use a [default id](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) based on type and kind of axis. +All axes must have a unique id which must be passed when the axis is creating. When the id is not passed, the axis will use a [default id](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) based on type and kind of axis. -If you are creating a axis by a custom id and [AxisKind](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisKind.html) is not provided, the kind of axis is automatically set checking the first character of axis id: +If you are creating a axis by a custom id and [AxisKind](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisKind.html) is not provided, the kind of axis is automatically set checking the first character of axis id: - * if axis id is starting with `x`, then the kind of axis is ['X'](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisKind.html#X). - * if axis id is starting with `y`, then the kind of axis is ['Y'](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisKind.html#Y). + * if axis id is starting with `x`, then the kind of axis is ['X'](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisKind.html#X). + * if axis id is starting with `y`, then the kind of axis is ['Y'](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisKind.html#Y). Every axis has got own default axis id and kind, as following: @@ -59,8 +59,8 @@ There are a number of configuration callbacks that can be used to change paramet All callbacks interfaces have got 2 arguments: - * [Axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Axis.html) instance - * [Axis item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AxisItem.html) object with all details about axis. + * [Axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Axis.html) instance + * [Axis item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AxisItem.html) object with all details about axis. To add a callback, see the following example: @@ -85,7 +85,7 @@ This callback can be used to change parameters in the scale during ticks buildin #### Calculate tick rotation callback -This callback can be used to change parameters in the scale during tick rotation. To implement this callback, you must implement [this interface](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AxisCalculateTickRotationCallback.html). +This callback can be used to change parameters in the scale during tick rotation. To implement this callback, you must implement [this interface](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AxisCalculateTickRotationCallback.html). ```java public interface AxisCalculateTickRotationCallback { @@ -111,7 +111,7 @@ public interface AxisCalculateTickRotationCallback { #### Data limit callback -This callback can be used to change parameters in the scale during data limits determination. To implement this callback, you must implement [this interface](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AxisDataLimitsCallback.html). +This callback can be used to change parameters in the scale during data limits determination. To implement this callback, you must implement [this interface](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AxisDataLimitsCallback.html). ```java public interface AxisDataLimitsCallback { @@ -136,7 +136,7 @@ public interface AxisDataLimitsCallback { #### Dimensions callback -This callback can be used to change parameters in the scale during setting dimensions. To implement this callback, you must implement [this interface](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AxisDimensionsCallback.html). +This callback can be used to change parameters in the scale during setting dimensions. To implement this callback, you must implement [this interface](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AxisDimensionsCallback.html). ```java public interface AxisDimensionsCallback { @@ -162,7 +162,7 @@ public interface AxisDimensionsCallback { #### Fit callback -This callback can be used to change parameters in the scale during fitting phase. To implement this callback, you must implement [this interface](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AxisFitCallback.html). +This callback can be used to change parameters in the scale during fitting phase. To implement this callback, you must implement [this interface](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AxisFitCallback.html). ```java public interface AxisFitCallback { @@ -188,7 +188,7 @@ public interface AxisFitCallback { #### Tick to label conversion callback -This callback can be used to change parameters in the scale during ticks label conversion. To implement this callback, you must implement [this interface](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AxisTickToLabelConversionCallback.html). +This callback can be used to change parameters in the scale during ticks label conversion. To implement this callback, you must implement [this interface](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AxisTickToLabelConversionCallback.html). ```java public interface AxisTickToLabelConversionCallback { @@ -214,7 +214,7 @@ public interface AxisTickToLabelConversionCallback { #### Update callback -This callback can be used to change parameters in the scale during updating. To implement this callback, you must implement [this interface](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AxisUpdateCallback.html). +This callback can be used to change parameters in the scale during updating. To implement this callback, you must implement [this interface](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AxisUpdateCallback.html). ```java public interface AxisUpdateCallback { @@ -255,11 +255,11 @@ Table with options: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Color of ticks.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Color of ticks.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | display | boolean | - | If `true`, the tick marks are shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | [Yes](#scriptable) | Font of ticks.
See [Font](../defaults/DefaultsCharts#font). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | [Yes](#scriptable) | Font of ticks.
See [Font](../defaults/DefaultsCharts#font). | padding | int | - | The padding between the tick label and the axis. -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The color of the stroke around the text. +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The color of the stroke around the text. | textStrokeWidth | int | [Yes](#scriptable) | Stroke width around the text. | z | int | - | The z-index of tick layer. Useful when ticks are drawn on chart area. Values less than or equals to 0 are drawn under data sets, greater than 0 on top. @@ -287,14 +287,14 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int ### Major Tick -The major tick configuration enables for the major tick marks that are generated by the axis. A major tick will affect auto-skipping and major will be defined on ticks in the scriptable options context, by [ScaleTickItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ScaleTickItem.html) class and [isMajor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ScaleTickItem.html#isMajor--) method. +The major tick configuration enables for the major tick marks that are generated by the axis. A major tick will affect auto-skipping and major will be defined on ticks in the scriptable options context, by [ScaleTickItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ScaleTickItem.html) class and [isMajor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ScaleTickItem.html#isMajor--) method. The major ticks configuration is nested in the ticks configuration as following: diff --git a/docs/axes/Category.md b/docs/axes/Category.md index 9eca308c..76cb3f42 100644 --- a/docs/axes/Category.md +++ b/docs/axes/Category.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Cartesian Category Axes -The [category axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianCategoryAxis.html) will draw the labels from one of the label arrays included in the chart data. +The [category axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianCategoryAxis.html) will draw the labels from one of the label arrays included in the chart data. @@ -56,14 +56,14 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- | alignToPixels | boolean | [Yes](#scriptable) | Align pixel values to device pixels. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The background color of scale area. -| bounds | [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Bounds.html) | [Yes](#scriptable) | Determines the scale bounds on axis. -| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) | [Yes](#scriptable) | If `Display.TRUE`, the axis is shown. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The background color of scale area. +| bounds | [Bounds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Bounds.html) | [Yes](#scriptable) | Determines the scale bounds on axis. +| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) | [Yes](#scriptable) | If `Display.TRUE`, the axis is shown. | max | String | [Yes](#scriptable) | User defined maximum string for the scale, overrides maximum value from data. | min | String | [Yes](#scriptable) | User defined minimum string for the scale, overrides minimum value from data. -| labels | [Labels](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Labels.html) | - | The labels to display. +| labels | [Labels](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Labels.html) | - | The labels to display. | offset | boolean | [Yes](#scriptable) | If `true`, extra space is added to the both edges and the axis is scaled to fit in the chart area. -| position | [AxisPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AxisPositionItem.html) | [Yes](#scriptable) | Position of the axis +| position | [AxisPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AxisPositionItem.html) | [Yes](#scriptable) | Position of the axis | reverse | boolean | [Yes](#scriptable) | Reverses order of tick labels. | singleStacked | boolean | - | If you might want to stack positive and negative values together. | stack | String | [Yes](#scriptable) | Sets the stack group. Axes at the same `position` with same `stack` are stacked. @@ -95,23 +95,23 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| alignToPixels | [AlignToPixelsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AlignToPixelsCallback.html) | boolean -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| bounds | [BoundsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BoundsCallback.html) | [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Bounds.html) -| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DisplayCallback.html) | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) -| max | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<String> | String -| min | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<String> | String -| offset | [ScaleOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleOffsetCallback.html) | boolean -| position | [ScalePositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScalePositionCallback.html) | [AxisPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AxisPositionItem.html) -| reverse | [ReverseCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ReverseCallback.html) | boolean -| stack | [StackCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackCallback.html) | String -| stacked | [StackedCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackedCallback.html) | boolean -| stackWeight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackedCallback.html) | double -| weight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleWeightCallback.html) | double +| alignToPixels | [AlignToPixelsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AlignToPixelsCallback.html) | boolean +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| bounds | [BoundsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BoundsCallback.html) | [Bounds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Bounds.html) +| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DisplayCallback.html) | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) +| max | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<String> | String +| min | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<String> | String +| offset | [ScaleOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleOffsetCallback.html) | boolean +| position | [ScalePositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScalePositionCallback.html) | [AxisPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AxisPositionItem.html) +| reverse | [ReverseCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ReverseCallback.html) | boolean +| stack | [StackCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackCallback.html) | String +| stacked | [StackedCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackedCallback.html) | boolean +| stackWeight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackedCallback.html) | double +| weight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleWeightCallback.html) | double ## Ticks -The category axis provides the following options for configuring [tick marks](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianCategoryTick.html). +The category axis provides the following options for configuring [tick marks](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianCategoryTick.html). ```java // creates a category axis @@ -128,15 +128,15 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| align | [TickAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TickAlign.html) | - | The tick alignment along the axis. +| align | [TickAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TickAlign.html) | - | The tick alignment along the axis. | autoSkip | boolean | - | If `true`, automatically calculates how many labels that can be shown and hides labels accordingly. Labels will be rotated up to `maxRotation` before skipping any. Turn `autoSkip` off to show all labels no matter what. | autoSkipPadding | int | - | The padding between the ticks on the horizontal axis when autoSkip is enabled. -| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of label backdrops. -| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | - | The padding of tick backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of ticks. -| crossAlign | [CrossAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CrossAlign.html) | - | The tick alignment perpendicular to the axis. +| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of label backdrops. +| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | - | The padding of tick backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of ticks. +| crossAlign | [CrossAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CrossAlign.html) | - | The tick alignment perpendicular to the axis. | display | boolean | - | If `true`, the tick marks are shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | [Yes](#ticks-scriptable-options) | Font of ticks. +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | [Yes](#ticks-scriptable-options) | Font of ticks. | includeBounds | boolean | - | If `true`, the defined `min` and `max` values should be presented as ticks even if they are not "nice". | labelOffset | int | - | Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis).

Note: *This can cause labels at the edges to be cropped by the edge of the canvas*. | maxRotation | int | - | The maximum rotation for tick labels when rotating to condense labels.

Note: *Rotation doesn't occur until necessary and only applicable to horizontal scales.* @@ -145,7 +145,7 @@ The following are the attributes that you can set: | padding | int | - | The padding between the tick label and the axis. | sampleSize | int | - | The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length. | showLabelBackdrop | boolean | [Yes](#ticks-scriptable-options) | If `true`, draw a background behind the tick labels -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | The color of the stroke around the text. +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | The color of the stroke around the text. | textStrokeWidth | int | [Yes](#ticks-scriptable-options) | Stroke width around the text. | z | int | - | z-index of tick layer. Useful when ticks are drawn on chart area. Values less than or equals to 0 are drawn under data sets, greater than 0 on top. @@ -177,18 +177,18 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| showLabelBackdrop | [ShowLabelBackdropCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ShowLabelBackdropCallback.html) | boolean -| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| showLabelBackdrop | [ShowLabelBackdropCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ShowLabelBackdropCallback.html) | boolean +| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int ### Callback It is also common to want to change the tick marks to include information about the data type. -To apply a custom callback, you can set a [CategoryTickCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CategoryTickCallback.html) instance to the axis options, as following: +To apply a custom callback, you can set a [CategoryTickCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CategoryTickCallback.html) instance to the axis options, as following: ```java axis.getTicks().setCallback(new CategoryTickCallback(){ diff --git a/docs/axes/Grid.md b/docs/axes/Grid.md index 8f10e70c..dcb8e49a 100644 --- a/docs/axes/Grid.md +++ b/docs/axes/Grid.md @@ -28,7 +28,7 @@ Table with options: | Name | Type | Scriptable | Description | :- | :- | :- | :- | circular | boolean | - | If `true`, grid lines are circular (on radar chart only). -| color | String - String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | [Yes](#scriptable) | The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line and so on.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| color | String - String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | [Yes](#scriptable) | The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line and so on.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | display | boolean | - | If `false`, do not display grid lines for this axis. | drawOnChartArea | boolean | - | If `true`, draw lines on the chart area inside the axis lines. This is useful when there are multiple axes and you need to control which grid lines are drawn. | drawTicks | boolean | - | If `true`, draw lines beside the ticks in the axis area beside the chart. @@ -36,7 +36,7 @@ Table with options: | offset | boolean | - | If `true`, grid lines will be shifted to be between labels. This is set to `true` in the bar chart by default. | tickBorderDash | int[] | [Yes](#scriptable) | Length and spacing of the tick mark line. If not set, defaults to the grid line `borderDash` value. | tickBorderDashOffset | double - double[] | - | Offset for the line dash of the tick mark. If unset, defaults to the grid line `borderDashOffset` value -| tickColor | String - String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | [Yes](#scriptable) | Color of the tick line. If unset, defaults to the grid line `color`. +| tickColor | String - String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | [Yes](#scriptable) | Color of the tick line. If unset, defaults to the grid line `color`. | tickLength | int | - | Length in pixels that the grid lines will draw in the axis area. | tickWidth | int - int[] | [Yes](#scriptable) | Width of the tick mark in pixels. If unset, defaults to the grid line `lineWidth`. | z | int | - | The z-index of gridline layer. Values less than or equals to 0 are drawn under data sets, greater than 0 on top. @@ -65,15 +65,15 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| lineWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int -| tickBorderDash | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<ScaleContext> | double -| tickColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| tickWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| lineWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| tickBorderDash | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<ScaleContext> | double +| tickColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| tickWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int ## Border -The [border](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/AxisBorder.html) defines options for the border that run perpendicular to the axis. +The [border](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/AxisBorder.html) defines options for the border that run perpendicular to the axis. ```java // creates the axis for chart @@ -90,7 +90,7 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- | display | boolean | - | If `true`, draw border at the edge between the axis and the chart area. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | - | If set, used as the color of the border line. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | - | If set, used as the color of the border line. | dash | int[] | [Yes](#border-scriptable) | Length and spacing of dashes on grid lines. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | dashOffset | double | [Yes](#border-scriptable) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). | width | int | - | If set, used as the width of the border line. @@ -120,5 +120,5 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| dash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<ScaleContext> | List<Integer> -| dashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<ScaleContext> | double +| dash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<ScaleContext> | List<Integer> +| dashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<ScaleContext> | double diff --git a/docs/axes/Linear.md b/docs/axes/Linear.md index a767de0d..446dfd2c 100644 --- a/docs/axes/Linear.md +++ b/docs/axes/Linear.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Cartesian Linear Axes -The [linear axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianLinearAxis.html) is use to chart numerical data. It can be placed on either the x or y axis. +The [linear axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianLinearAxis.html) is use to chart numerical data. It can be placed on either the x or y axis. @@ -56,16 +56,16 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- | alignToPixels | boolean | [Yes](#scriptable) | Align pixel values to device pixels. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The background color of scale area. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The background color of scale area. | beginAtZero | boolean | [Yes](#scriptable) | If `true`, scale will include 0 if it is not already included. -| bounds | [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Bounds.html) | [Yes](#scriptable) | Determines the scale bounds on axis. -| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) | [Yes](#scriptable) | If `Display.TRUE`, the axis is shown. +| bounds | [Bounds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Bounds.html) | [Yes](#scriptable) | Determines the scale bounds on axis. +| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) | [Yes](#scriptable) | If `Display.TRUE`, the axis is shown. | grace | int | [Yes](#scriptable) | Amount of pixels for added room in the scale range above and below data. | graceAsPercentage | double | [Yes](#scriptable) | Sets a value, between 0 and 1, as percentage, for added room in the scale range above and below data. | max | double | [Yes](#scriptable) | User defined maximum number for the scale, overrides maximum value from data. | min | double | [Yes](#scriptable) | User defined minimum number for the scale, overrides minimum value from data. | offset | boolean | [Yes](#scriptable) | If `true`, extra space is added to the both edges and the axis is scaled to fit in the chart area. -| position | [AxisPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AxisPositionItem.html) | [Yes](#scriptable) | Position of the axis. +| position | [AxisPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AxisPositionItem.html) | [Yes](#scriptable) | Position of the axis. | reverse | boolean | [Yes](#scriptable) | Reverses order of tick labels. | singleStacked | boolean | - | If you might want to stack positive and negative values together. | stack | String | [Yes](#scriptable) | Sets the stack group. Axes at the same `position` with same `stack` are stacked. @@ -99,27 +99,27 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| alignToPixels | [AlignToPixelsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AlignToPixelsCallback.html) | boolean -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| beginAtZero | [BeginAtZeroCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BeginAtZeroCallback.html) | boolean -| bounds | [BoundsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BoundsCallback.html) | [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Bounds.html) -| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DisplayCallback.html) | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) -| grace | [GraceCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/GraceCallback.html) | int - double -| max | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double -| min | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double -| offset | [ScaleOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleOffsetCallback.html) | boolean -| position | [ScalePositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScalePositionCallback.html) | [AxisPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AxisPositionItem.html) -| reverse | [ReverseCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ReverseCallback.html) | boolean -| stack | [StackCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackCallback.html) | String -| stacked | [StackedCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackedCallback.html) | boolean -| stackWeight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackedCallback.html) | double -| suggestedMax | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double -| suggestedMin | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double -| weight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleWeightCallback.html) | double +| alignToPixels | [AlignToPixelsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AlignToPixelsCallback.html) | boolean +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| beginAtZero | [BeginAtZeroCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BeginAtZeroCallback.html) | boolean +| bounds | [BoundsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BoundsCallback.html) | [Bounds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Bounds.html) +| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DisplayCallback.html) | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) +| grace | [GraceCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/GraceCallback.html) | int - double +| max | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double +| min | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double +| offset | [ScaleOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleOffsetCallback.html) | boolean +| position | [ScalePositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScalePositionCallback.html) | [AxisPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AxisPositionItem.html) +| reverse | [ReverseCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ReverseCallback.html) | boolean +| stack | [StackCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackCallback.html) | String +| stacked | [StackedCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackedCallback.html) | boolean +| stackWeight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackedCallback.html) | double +| suggestedMax | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double +| suggestedMin | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double +| weight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleWeightCallback.html) | double ## Ticks -The linear axis provides the following options for configuring [tick marks](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianLinearTick.html). +The linear axis provides the following options for configuring [tick marks](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianLinearTick.html). ```java // creates a linear axis @@ -136,29 +136,29 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| align | [TickAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TickAlign.html) | - | The tick alignment along the axis. +| align | [TickAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TickAlign.html) | - | The tick alignment along the axis. | autoSkip | boolean | - | If `true`, automatically calculates how many labels that can be shown and hides labels accordingly. Labels will be rotated up to `maxRotation` before skipping any. Turn `autoSkip` off to show all labels no matter what. | autoSkipPadding | int | - | The padding between the ticks on the horizontal axis when autoSkip is enabled. -| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of label backdrops. -| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | - | The padding of tick backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of ticks. +| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of label backdrops. +| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | - | The padding of tick backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of ticks. | count | int | [Yes](#ticks-scriptable-options) | The number of ticks to generate. If specified, this overrides the automatic generation. -| crossAlign | [CrossAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CrossAlign.html) | - | The tick alignment perpendicular to the axis. +| crossAlign | [CrossAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CrossAlign.html) | - | The tick alignment perpendicular to the axis. | display | boolean | - | If `true`, the tick marks are shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | [Yes](#ticks-scriptable-options) | Font of ticks.
See [Font](../defaults/DefaultsCharts#font). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | [Yes](#ticks-scriptable-options) | Font of ticks.
See [Font](../defaults/DefaultsCharts#font). | includeBounds | boolean | - | If `true`, the defined `min` and `max` values should be presented as ticks even if they are not "nice". | labelOffset | int | - | Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis).

Note: *This can cause labels at the edges to be cropped by the edge of the canvas*. | maxRotation | int | - | The maximum rotation for tick labels when rotating to condense labels.

Note: *Rotation doesn't occur until necessary and only applicable to horizontal scales.* | maxTicksLimit | int | [Yes](#ticks-scriptable-options) | Maximum number of ticks and gridlines to show. | minRotation | int | - | The minimum rotation for tick labels. | mirror | boolean | - | The flips tick labels around axis, displaying the labels inside the chart instead of outside.

Note: *Only applicable to vertical scales.* -| numberFormat | [NumberFormatOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/NumberFormatOptions.html) | [Yes](#ticks-scriptable-options) | The number format options used by the default label formatter.
See [INTL number format](../intl/NumberFormat) documentation. +| numberFormat | [NumberFormatOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/NumberFormatOptions.html) | [Yes](#ticks-scriptable-options) | The number format options used by the default label formatter.
See [INTL number format](../intl/NumberFormat) documentation. | padding | int | - | The padding between the tick label and the axis. | precision | int | [Yes](#ticks-scriptable-options) | If defined and `stepSize` is not specified, the step size will be rounded to this many decimal places. | sampleSize | int | - | The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length. | showLabelBackdrop | boolean | [Yes](#ticks-scriptable-options) | If `true`, draw a background behind the tick labels | stepSize | double | [Yes](#ticks-scriptable-options) | User defined fixed step size for the scale. -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | The color of the stroke around the text. +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | The color of the stroke around the text. | textStrokeWidth | int | [Yes](#ticks-scriptable-options) | Stroke width around the text. | z | int | - | z-index of tick layer. Useful when ticks are drawn on chart area. Values less than or equals to 0 are drawn under data sets, greater than 0 on top. @@ -196,23 +196,23 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| count | [CountCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CountCallback.html) | int -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| maxTicksLimit | [MaxTicksLimitCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MaxTicksLimitCallback.html) | int -| numberFormat | [NumberFormatCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/NumberFormatCallback.html) | [NumberFormatItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/NumberFormatItem.html) -| precision | [PrecisionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PrecisionCallback.html) | int -| showLabelBackdrop | [ShowLabelBackdropCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ShowLabelBackdropCallback.html) | boolean -| stepSize | [StepSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StepSizeCallback.html) | double -| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| count | [CountCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CountCallback.html) | int +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| maxTicksLimit | [MaxTicksLimitCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MaxTicksLimitCallback.html) | int +| numberFormat | [NumberFormatCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/NumberFormatCallback.html) | [NumberFormatItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/NumberFormatItem.html) +| precision | [PrecisionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PrecisionCallback.html) | int +| showLabelBackdrop | [ShowLabelBackdropCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ShowLabelBackdropCallback.html) | boolean +| stepSize | [StepSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StepSizeCallback.html) | double +| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int ### Callback It is also common to want to change the tick marks to include information about the data type. For example, adding a dollar sign ('$'). To do this, you need to implement a ticks callback in the axis configuration. -To apply a custom callback, you can set a [TickCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TickCallback.html) instance to the axis options, as following: +To apply a custom callback, you can set a [TickCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TickCallback.html) instance to the axis options, as following: ```java // creates the axis for chart diff --git a/docs/axes/Logarithmic.md b/docs/axes/Logarithmic.md index cc913849..27c87901 100644 --- a/docs/axes/Logarithmic.md +++ b/docs/axes/Logarithmic.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Cartesian Logarithmic Axes -The [logarithmic axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianLogarithmicAxis.html) is use to chart numerical data. It can be placed on either the x or y axis. As the name suggests, logarithmic interpolation is used to determine where a value lies on the axis. +The [logarithmic axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianLogarithmicAxis.html) is use to chart numerical data. It can be placed on either the x or y axis. As the name suggests, logarithmic interpolation is used to determine where a value lies on the axis. @@ -56,13 +56,13 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- | alignToPixels | boolean | [Yes](#scriptable) | Align pixel values to device pixels. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The background color of scale area. -| bounds | [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Bounds.html) | [Yes](#scriptable) | Determines the scale bounds on axis. -| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) | [Yes](#scriptable) | If `Display.TRUE`, the axis is shown. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The background color of scale area. +| bounds | [Bounds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Bounds.html) | [Yes](#scriptable) | Determines the scale bounds on axis. +| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) | [Yes](#scriptable) | If `Display.TRUE`, the axis is shown. | max | double | [Yes](#scriptable) | User defined maximum number for the scale, overrides maximum value from data. | min | double | [Yes](#scriptable) | User defined minimum number for the scale, overrides minimum value from data. | offset | boolean | [Yes](#scriptable) | If `true`, extra space is added to the both edges and the axis is scaled to fit in the chart area. -| position | [AxisPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AxisPositionItem.html) | [Yes](#scriptable) | Position of the axis. +| position | [AxisPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AxisPositionItem.html) | [Yes](#scriptable) | Position of the axis. | reverse | boolean | [Yes](#scriptable) | Reverses order of tick labels. | singleStacked | boolean | - | If you might want to stack positive and negative values together. | stack | String | [Yes](#scriptable) | Sets the stack group. Axes at the same `position` with same `stack` are stacked. @@ -96,25 +96,25 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| alignToPixels | [AlignToPixelsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AlignToPixelsCallback.html) | boolean -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| bounds | [BoundsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BoundsCallback.html) | [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Bounds.html) -| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DisplayCallback.html) | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) -| max | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double -| min | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double -| offset | [ScaleOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleOffsetCallback.html) | boolean -| position | [ScalePositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScalePositionCallback.html) | [AxisPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AxisPositionItem.html) -| reverse | [ReverseCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ReverseCallback.html) | boolean -| stack | [StackCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackCallback.html) | String -| stacked | [StackedCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackedCallback.html) | boolean -| stackWeight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackedCallback.html) | double -| suggestedMax | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double -| suggestedMin | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double -| weight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleWeightCallback.html) | double +| alignToPixels | [AlignToPixelsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AlignToPixelsCallback.html) | boolean +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| bounds | [BoundsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BoundsCallback.html) | [Bounds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Bounds.html) +| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DisplayCallback.html) | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) +| max | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double +| min | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double +| offset | [ScaleOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleOffsetCallback.html) | boolean +| position | [ScalePositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScalePositionCallback.html) | [AxisPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AxisPositionItem.html) +| reverse | [ReverseCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ReverseCallback.html) | boolean +| stack | [StackCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackCallback.html) | String +| stacked | [StackedCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackedCallback.html) | boolean +| stackWeight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackedCallback.html) | double +| suggestedMax | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double +| suggestedMin | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double +| weight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleWeightCallback.html) | double ## Ticks -The logarithmic axis provides the following options for configuring [tick marks](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianLogarithmicTick.html). +The logarithmic axis provides the following options for configuring [tick marks](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianLogarithmicTick.html). ```java // creates a logarithmic axis @@ -131,25 +131,25 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| align | [TickAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TickAlign.html) | - | The tick alignment along the axis. +| align | [TickAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TickAlign.html) | - | The tick alignment along the axis. | autoSkip | boolean | - | If `true`, automatically calculates how many labels that can be shown and hides labels accordingly. Labels will be rotated up to `maxRotation` before skipping any. Turn `autoSkip` off to show all labels no matter what. | autoSkipPadding | int | - | The padding between the ticks on the horizontal axis when autoSkip is enabled. -| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of label backdrops. -| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | - | The padding of tick backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of ticks. -| crossAlign | [CrossAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CrossAlign.html) | - | The tick alignment perpendicular to the axis. +| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of label backdrops. +| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | - | The padding of tick backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of ticks. +| crossAlign | [CrossAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CrossAlign.html) | - | The tick alignment perpendicular to the axis. | display | boolean | - | If `true`, the tick marks are shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | [Yes](#ticks-scriptable-options) | Font of ticks.
See [Font](../defaults/DefaultsCharts#font). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | [Yes](#ticks-scriptable-options) | Font of ticks.
See [Font](../defaults/DefaultsCharts#font). | includeBounds | boolean | - | If `true`, the defined `min` and `max` values should be presented as ticks even if they are not "nice". | labelOffset | int | - | Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis).

Note: *This can cause labels at the edges to be cropped by the edge of the canvas*. | maxRotation | int | - | The maximum rotation for tick labels when rotating to condense labels.

Note: *Rotation doesn't occur until necessary and only applicable to horizontal scales.* | minRotation | int | - | The minimum rotation for tick labels. | mirror | boolean | - | The flips tick labels around axis, displaying the labels inside the chart instead of outside.

Note: *Only applicable to vertical scales.* -| numberFormat | [NumberFormatOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/NumberFormatOptions.html) | [Yes](#ticks-scriptable-options) | The number format options used by the default label formatter.
See [INTL number format](../intl/NumberFormat) documentation +| numberFormat | [NumberFormatOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/NumberFormatOptions.html) | [Yes](#ticks-scriptable-options) | The number format options used by the default label formatter.
See [INTL number format](../intl/NumberFormat) documentation | padding | int | - | The padding between the tick label and the axis. | sampleSize | int | - | The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length. | showLabelBackdrop | boolean | [Yes](#ticks-scriptable-options) | If `true`, draw a background behind the tick labels -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | The color of the stroke around the text. +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | The color of the stroke around the text. | textStrokeWidth | int | [Yes](#ticks-scriptable-options) | Stroke width around the text. | z | int | - | z-index of tick layer. Useful when ticks are drawn on chart area. Values less than or equals to 0 are drawn under data sets, greater than 0 on top. @@ -179,19 +179,19 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| numberFormat | [NumberFormatCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/NumberFormatCallback.html) | [NumberFormatItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/NumberFormatItem.html) -| showLabelBackdrop | [ShowLabelBackdropCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ShowLabelBackdropCallback.html) | boolean -| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| numberFormat | [NumberFormatCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/NumberFormatCallback.html) | [NumberFormatItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/NumberFormatItem.html) +| showLabelBackdrop | [ShowLabelBackdropCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ShowLabelBackdropCallback.html) | boolean +| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int ### Callback It is also common to want to change the tick marks to include information about the data type. For example, adding a dollar sign ('$'). To do this, you need to implement a ticks callback in the axis configuration. -To apply a custom callback, you can set a [TickCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TickCallback.html) instance to the axis options, as following: +To apply a custom callback, you can set a [TickCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TickCallback.html) instance to the axis options, as following: ```java axis.getTicks().setCallback(new TickCallback(){ diff --git a/docs/axes/PointLabels.md b/docs/axes/PointLabels.md index 5f6c7340..ceb3a42c 100644 --- a/docs/axes/PointLabels.md +++ b/docs/axes/PointLabels.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Point Labels -The [point labels](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/RadialPointLabels.html) options are used to configure the point labels that are shown on the perimeter of the scale. They can be found in the pointLabels sub options object. +The [point labels](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/RadialPointLabels.html) options are used to configure the point labels that are shown on the perimeter of the scale. They can be found in the pointLabels sub options object. Note @@ -18,7 +18,7 @@ The point labels can be **ONLY** applied to radial axes.
These options only apply if **display** is **true**. ::: -The [RadialPointLabels](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/RadialPointLabels.html) provides all **set** and **get** methods to manage the configuration, as following: +The [RadialPointLabels](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/RadialPointLabels.html) provides all **set** and **get** methods to manage the configuration, as following: ```java // creates a radial axis @@ -35,13 +35,13 @@ Table with options: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Background color of the point label. -| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | - | The padding of label backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. -| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) | [Yes](#scriptable) | The border radius of the point label (in pixels). +| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Background color of the point label. +| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | - | The padding of label backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. +| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) | [Yes](#scriptable) | The border radius of the point label (in pixels). | centerPointLabels | boolean | - | If `true`, point labels are centered. -| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) | - | If `true`, point labels are shown. When Display.AUTO, the label is hidden if it overlaps with another label. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Color of point labels. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | [Yes](#scriptable) | Font of point labels. +| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) | - | If `true`, point labels are shown. When Display.AUTO, the label is hidden if it overlaps with another label. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Color of point labels. +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | [Yes](#scriptable) | Font of point labels. | padding | int | [Yes](#scriptable) | Padding between chart and point labels, in pixel. The further customization of point labels, a [callback](#callback) is provided. @@ -72,17 +72,17 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<ScaleContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| padding | [SimplePaddingCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimplePaddingCallback.html) | int +| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<ScaleContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| padding | [SimplePaddingCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimplePaddingCallback.html) | int ### Callback Callback implementation can transform data labels to point labels. The default implementation simply returns the current string. -To apply an own callback, you can set a [PointLabelCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointLabelCallback.html) instance to the axis options, as following: +To apply an own callback, you can set a [PointLabelCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointLabelCallback.html) instance to the axis options, as following: ```java // creates a radial axis diff --git a/docs/axes/Radial.md b/docs/axes/Radial.md index 9b52d56f..758a67a2 100644 --- a/docs/axes/Radial.md +++ b/docs/axes/Radial.md @@ -8,13 +8,13 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Radial Axes -[Radial axes](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/RadialAxis.html) are used specifically for the radar and polar area chart types. These axes overlay the chart area, rather than being positioned on one of the edges. +[Radial axes](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/RadialAxis.html) are used specifically for the radar and polar area chart types. These axes overlay the chart area, rather than being positioned on one of the edges. Radial axes could be only * **linear**, is use to chart numerical data. As the name suggests, linear interpolation is used to determine where a value lies in relation the center of the axis. -The [radial axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/RadialAxis.html) is use to chart numerical data. +The [radial axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/RadialAxis.html) is use to chart numerical data. @@ -28,7 +28,7 @@ RadialAxis axis = new RadialAxis(chart); chart.getOptions().setAxes(axis); ``` -The axis has configuration properties for [ticks](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/RadialLinearTick.html), [angle lines](AngleLines) (line that appear in a radar chart outward from the center), [point labels](PointLabels) (labels around the edge in a radar chart): +The axis has configuration properties for [ticks](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/RadialLinearTick.html), [angle lines](AngleLines) (line that appear in a radar chart outward from the center), [point labels](PointLabels) (labels around the edge in a radar chart): ## Options @@ -49,9 +49,9 @@ The following are the attributes that you can set: | :- | :- | :- | :- | alignToPixels | boolean | [Yes](#scriptable) | Align pixel values to device pixels. | animate | boolean | - | If `true`, animate scaling the chart from the center. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The background color of scale area. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The background color of scale area. | beginAtZero | boolean | [Yes](#scriptable) | If `true`, scale will include 0 if it is not already included. -| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) | [Yes](#scriptable) | If `Display.TRUE`, the axis is shown. +| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) | [Yes](#scriptable) | If `Display.TRUE`, the axis is shown. | max | double | [Yes](#scriptable) | User defined maximum number for the scale, overrides maximum value from data. | min | double | [Yes](#scriptable) | User defined minimum number for the scale, overrides minimum value from data. | reverse | boolean | [Yes](#scriptable) | Reverses order of tick labels. @@ -84,21 +84,21 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| alignToPixels | [AlignToPixelsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AlignToPixelsCallback.html) | boolean -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| beginAtZero | [BeginAtZeroCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BeginAtZeroCallback.html) | boolean -| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DisplayCallback.html) | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) -| max | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double -| min | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double -| reverse | [ReverseCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ReverseCallback.html) | boolean -| startAngle | [StartAngleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StartAngleCallback.html) | double -| suggestedMax | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double -| suggestedMin | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double -| weight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleWeightCallback.html) | double +| alignToPixels | [AlignToPixelsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AlignToPixelsCallback.html) | boolean +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| beginAtZero | [BeginAtZeroCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BeginAtZeroCallback.html) | boolean +| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DisplayCallback.html) | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) +| max | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double +| min | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double +| reverse | [ReverseCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ReverseCallback.html) | boolean +| startAngle | [StartAngleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StartAngleCallback.html) | double +| suggestedMax | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double +| suggestedMin | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Double> | double +| weight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleWeightCallback.html) | double ## Ticks -The radial linear axis provides the following options for configuring [tick marks](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/RadialLinearTick.html). +The radial linear axis provides the following options for configuring [tick marks](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/RadialLinearTick.html). ```java // creates a radial axis @@ -115,20 +115,20 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of label backdrops. -| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | | The padding of tick backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of ticks. +| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of label backdrops. +| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | | The padding of tick backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of ticks. | count | int | [Yes](#ticks-scriptable-options | The number of ticks to generate. If specified, this overrides the automatic generation. | display | boolean | - | If `true`, the tick marks are shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | [Yes](#ticks-scriptable-options) | Font of ticks.
See [Font](../defaults/DefaultsCharts#font). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | [Yes](#ticks-scriptable-options) | Font of ticks.
See [Font](../defaults/DefaultsCharts#font). | maxTicksLimit | int | [Yes](#ticks-scriptable-options | Maximum number of ticks and gridlines to show. -| numberFormat | [NumberFormatOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/NumberFormatOptions.html) | [Yes](#ticks-scriptable-options) | The number format options used by the default label formatter.
See [INTL number format](../intl/NumberFormat) documentation. +| numberFormat | [NumberFormatOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/NumberFormatOptions.html) | [Yes](#ticks-scriptable-options) | The number format options used by the default label formatter.
See [INTL number format](../intl/NumberFormat) documentation. | padding | int | - | The padding between the tick label and the axis. | precision | int | [Yes](#ticks-scriptable-options | If defined and `stepSize` is not specified, the step size will be rounded to this many decimal places. | sampleSize | int | - | The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length. | showLabelBackdrop | boolean | [Yes](#ticks-scriptable-options) | If `true`, draw a background behind the tick labels | stepSize | double | [Yes](#ticks-scriptable-options) | User defined fixed step size for the scale. -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | The color of the stroke around the text. +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | The color of the stroke around the text. | textStrokeWidth | int | [Yes](#ticks-scriptable-options) | Stroke width around the text. | z | int | - | z-index of tick layer. Useful when ticks are drawn on chart area. Values less than or equals to 0 are drawn under data sets, greater than 0 on top. @@ -160,23 +160,23 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| count | [CountCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CountCallback.html) | int -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| maxTicksLimit | [MaxTicksLimitCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MaxTicksLimitCallback.html) | int -| numberFormat | [NumberFormatCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/NumberFormatCallback.html) | [NumberFormatItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/NumberFormatItem.html) -| precision | [PrecisionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PrecisionCallback.html) | int -| showLabelBackdrop | [ShowLabelBackdropCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ShowLabelBackdropCallback.html) | boolean -| stepSize | [StepSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StepSizeCallback.html) | double -| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| count | [CountCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CountCallback.html) | int +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| maxTicksLimit | [MaxTicksLimitCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MaxTicksLimitCallback.html) | int +| numberFormat | [NumberFormatCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/NumberFormatCallback.html) | [NumberFormatItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/NumberFormatItem.html) +| precision | [PrecisionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PrecisionCallback.html) | int +| showLabelBackdrop | [ShowLabelBackdropCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ShowLabelBackdropCallback.html) | boolean +| stepSize | [StepSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StepSizeCallback.html) | double +| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int ### Callback It is also common to want to change the tick marks to include information about the data type. For example, adding a dollar sign ('$'). To do this, you need to implement a ticks callback in the axis configuration. -To apply a custom callback, you can set a [TickCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TickCallback.html) instance to the axis options, as following: +To apply a custom callback, you can set a [TickCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TickCallback.html) instance to the axis options, as following: ```java axis.getTicks().setCallback(new TickCallback(){ diff --git a/docs/axes/ScaleTitle.md b/docs/axes/ScaleTitle.md index 70716288..64421002 100644 --- a/docs/axes/ScaleTitle.md +++ b/docs/axes/ScaleTitle.md @@ -16,7 +16,7 @@ When creating a chart, you want to tell the viewer what data they are viewing. T The scale title can be **ONLY** applied to cartesian axes. ::: -The [axis title](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianScaleTitle.html) provides all **set** and **get** methods to manage the configuration, as following: +The [axis title](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianScaleTitle.html) provides all **set** and **get** methods to manage the configuration, as following: ```java // creates an axis @@ -33,8 +33,8 @@ The following are the attributes that you can set: | Name | Type | Description | :- | :- | :- -| align | [ScaleTitleAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ScaleTitleAlign.html) | Alignment of the scale label. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | Color of scale label. +| align | [ScaleTitleAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ScaleTitleAlign.html) | Alignment of the scale label. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | Color of scale label. | display | boolean | `false` | If `true`, the scale label is shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | Font of scale label. -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | The padding of title.
See [padding documentation](../configuration/Commons#padding) for more details. +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | Font of scale label. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | The padding of title.
See [padding documentation](../configuration/Commons#padding) for more details. diff --git a/docs/axes/Time.md b/docs/axes/Time.md index 490509d1..21b635a2 100644 --- a/docs/axes/Time.md +++ b/docs/axes/Time.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Cartesian Time Axes -The [time axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianTimeAxis.html) is used to display times and dates. When building its [ticks](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianTimeTick.html), it will automatically calculate the most comfortable unit base on the size of the scale. +The [time axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianTimeAxis.html) is used to display times and dates. When building its [ticks](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianTimeTick.html), it will automatically calculate the most comfortable unit base on the size of the scale. @@ -40,7 +40,7 @@ chart.getOptions().setAxes(axis1, ...); ## Datasets -To use time axis, you must use [DataPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/DataPoint.html) in order to set the date object in the axis. +To use time axis, you must use [DataPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/DataPoint.html) in order to set the date object in the axis. The `x` axis data points can be specified via the **setX** method when using the time axis. @@ -83,14 +83,14 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- | alignToPixels | boolean | [Yes](#scriptable) | Align pixel values to device pixels. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The background color of scale area. -| bounds | [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Bounds.html) | [Yes](#scriptable) | Determines the scale bounds on axis. -| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) | [Yes](#scriptable) | If `Display.TRUE`, the axis is shown. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The background color of scale area. +| bounds | [Bounds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Bounds.html) | [Yes](#scriptable) | Determines the scale bounds on axis. +| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) | [Yes](#scriptable) | If `Display.TRUE`, the axis is shown. | max | [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | [Yes](#scriptable) | User defined maximum date for the scale, overrides maximum value from data. | min | [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | [Yes](#scriptable) | User defined minimum date for the scale, overrides minimum value from data | offset | boolean | [Yes](#scriptable) | If `true`, extra space is added to the both edges and the axis is scaled to fit in the chart area. | offsetAfterAutoskip | boolean | - | If `true`, bar chart offsets are computed with auto skipped ticks. -| position | [AxisPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AxisPositionItem.html) | [Yes](#scriptable) | Position of the axis. +| position | [AxisPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AxisPositionItem.html) | [Yes](#scriptable) | Position of the axis. | reverse | boolean | [Yes](#scriptable) | Reverses order of tick labels. | singleStacked | boolean | - | If you might want to stack positive and negative values together. | stack | String | [Yes](#scriptable) | Sets the stack group. Axes at the same `position` with same `stack` are stacked. @@ -122,23 +122,23 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| alignToPixels | [AlignToPixelsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AlignToPixelsCallback.html) | boolean -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| bounds | [BoundsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BoundsCallback.html) | [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Bounds.html) -| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DisplayCallback.html) | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) -| max | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Object> | [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) - int - double -| min | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Object> | [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) - int - double -| offset | [ScaleOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleOffsetCallback.html) | boolean -| position | [ScalePositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScalePositionCallback.html) | [AxisPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AxisPositionItem.html) -| reverse | [ReverseCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ReverseCallback.html) | boolean -| stack | [StackCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackCallback.html) | String -| stacked | [StackedCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackedCallback.html) | boolean -| stackWeight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackedCallback.html) | double -| weight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleWeightCallback.html) | double +| alignToPixels | [AlignToPixelsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AlignToPixelsCallback.html) | boolean +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| bounds | [BoundsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BoundsCallback.html) | [Bounds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Bounds.html) +| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DisplayCallback.html) | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) +| max | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Object> | [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) - int - double +| min | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Object> | [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) - int - double +| offset | [ScaleOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleOffsetCallback.html) | boolean +| position | [ScalePositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScalePositionCallback.html) | [AxisPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AxisPositionItem.html) +| reverse | [ReverseCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ReverseCallback.html) | boolean +| stack | [StackCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackCallback.html) | String +| stacked | [StackedCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackedCallback.html) | boolean +| stackWeight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackedCallback.html) | double +| weight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleWeightCallback.html) | double ## Time -The time axis provides a [Time](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Time.html) object to configure how times must be managed on axis. It provides the **set** and **get** methods as following: +The time axis provides a [Time](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Time.html) object to configure how times must be managed on axis. It provides the **set** and **get** methods as following: ```java // creates a time axis @@ -155,14 +155,14 @@ The following are the attributes that you can set: | Name | Type | Description | :- | :- | :- -| isoWeekday | [IsoWeekDay](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsoWeekDay.html) | The first day of the week. -| minUnit | [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html) | The minimum display format to be used for a time unit. +| isoWeekday | [IsoWeekDay](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsoWeekDay.html) | The first day of the week. +| minUnit | [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html) | The minimum display format to be used for a time unit. | parser | String | `null` | Interpreted as a custom format to be used to parse the date. -| round | [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html) | If defined, dates will be rounded to the start of this unit. +| round | [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html) | If defined, dates will be rounded to the start of this unit. | tooltipFormat | String | Format string to use for the tooltip. -| unit | [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html) | If defined, will force the unit to be a certain type. +| unit | [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html) | If defined, will force the unit to be a certain type. -The following time measurements are supported and are mapped in the [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html) enumeration, to force a certain unit: +The following time measurements are supported and are mapped in the [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html) enumeration, to force a certain unit: * millisecond * second @@ -175,9 +175,9 @@ The following time measurements are supported and are mapped in the [TimeUnit](h * year -The [Time](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Time.html) object is also providing another object to set the display formats, based on [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html). +The [Time](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Time.html) object is also providing another object to set the display formats, based on [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html). -The [DisplayFormats](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/DisplayFormats.html) can be used as following: +The [DisplayFormats](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/DisplayFormats.html) can be used as following: ```java // creates a time axis @@ -194,7 +194,7 @@ This method can override the defaults. To see the defaults, see the [LUXON date The adapters options are used to configure the adapter for [LUXON date library](../DateAdapters). -The [adapters options](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Adapters.html) configuration is nested in the scale configuration as following: +The [adapters options](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Adapters.html) configuration is nested in the scale configuration as following: ```java // creates a time axis @@ -209,16 +209,16 @@ The following are the attributes that you can set: | Name | Type | Description | :- | :- | :- -| locale | [CLocale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) | Using locale specifying the language to use generating or interpreting strings. -| zone | [TimeZone](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/TimeZone.html) | Implementation recognizes the time zone names of the IANA time zone database. -| outputCalendar | [Calendar](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/Calendar.html) | The calendar type to use. -| numberingSystem | [NumberingSystem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/NumberingSystem.html) | The numbering system to use. +| locale | [CLocale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) | Using locale specifying the language to use generating or interpreting strings. +| zone | [TimeZone](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/TimeZone.html) | Implementation recognizes the time zone names of the IANA time zone database. +| outputCalendar | [Calendar](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/Calendar.html) | The calendar type to use. +| numberingSystem | [NumberingSystem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/NumberingSystem.html) | The numbering system to use. For more details, have a look how to configure a [Luxon](../DateAdapters) date adapters. ## Ticks -The time axis provides the following options for configuring [tick marks](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianTimeTick.html). +The time axis provides the following options for configuring [tick marks](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianTimeTick.html). ```java // creates a time axis @@ -235,15 +235,15 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| align | [TickAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TickAlign.html) | - | The tick alignment along the axis. +| align | [TickAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TickAlign.html) | - | The tick alignment along the axis. | autoSkip | boolean | - | If `true`, automatically calculates how many labels that can be shown and hides labels accordingly. Labels will be rotated up to `maxRotation` before skipping any. Turn `autoSkip` off to show all labels no matter what. | autoSkipPadding | int | - | The padding between the ticks on the horizontal axis when autoSkip is enabled. -| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of label backdrops. -| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | - | The padding of tick backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of ticks.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| crossAlign | [CrossAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CrossAlign.html) | CrossAlign.NEAR | The tick alignment perpendicular to the axis. +| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of label backdrops. +| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | - | The padding of tick backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of ticks.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| crossAlign | [CrossAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CrossAlign.html) | CrossAlign.NEAR | The tick alignment perpendicular to the axis. | display | boolean | - | If `true`, the tick marks are shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | [Yes](#ticks-scriptable-options) | Font of ticks.
See [Font](../defaults/DefaultsCharts#font). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | [Yes](#ticks-scriptable-options) | Font of ticks.
See [Font](../defaults/DefaultsCharts#font). | includeBounds | boolean | - | If `true`, the defined `min` and `max` values should be presented as ticks even if they are not "nice". | labelOffset | int | - | Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis).

Note: *This can cause labels at the edges to be cropped by the edge of the canvas*. | maxRotation | int | - | The maximum rotation for tick labels when rotating to condense labels.

Note: *Rotation doesn't occur until necessary and only applicable to horizontal scales.* @@ -252,9 +252,9 @@ The following are the attributes that you can set: | padding | int | - | The padding between the tick label and the axis. | sampleSize | int | - | The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length. | showLabelBackdrop | boolean | [Yes](#ticks-scriptable-options) | If `true`, draw a background behind the tick labels -| source | [TickSource](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TickSource.html) | - | How ticks are generated on axis time. +| source | [TickSource](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TickSource.html) | - | How ticks are generated on axis time. | stepSize | int | [Yes](#ticks-scriptable-options) | The number of units between grid lines. -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | The color of the stroke around the text. +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | The color of the stroke around the text. | textStrokeWidth | int |[Yes](#ticks-scriptable-options) | Stroke width around the text. | z | int | - | z-index of tick layer. Useful when ticks are drawn on chart area. Values less than or equals to 0 are drawn under data sets, greater than 0 on top. @@ -284,19 +284,19 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| showLabelBackdrop | [ShowLabelBackdropCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ShowLabelBackdropCallback.html) | boolean -| stepSize | [StepSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StepSizeCallback.html) | int -| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| showLabelBackdrop | [ShowLabelBackdropCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ShowLabelBackdropCallback.html) | boolean +| stepSize | [StepSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StepSizeCallback.html) | int +| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int ### Callback It is also common to want to change the tick marks to include information about the data type. -To apply a custom callback, you can set a [TimeTickCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TimeTickCallback.html) instance to the axis options, as following: +To apply a custom callback, you can set a [TimeTickCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TimeTickCallback.html) instance to the axis options, as following: ```java axis.getTicks().setCallback(new TimeTickCallback(){ @@ -321,7 +321,7 @@ axis.getTicks().setCallback(new TimeTickCallback(){ }); ``` -The callback is providing a specific list of items ([TimeTickItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/TimeTickItem.html)) which maps [Chart.JS](http://www.chartjs.org/) object with the values (as date) and major booleans. +The callback is providing a specific list of items ([TimeTickItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/TimeTickItem.html)) which maps [Chart.JS](http://www.chartjs.org/) object with the values (as date) and major booleans. See [INTL date time format](../intl/DateTimeFormat) documentation if you want to use a date formatter, provided out-of-the-box. diff --git a/docs/axes/TimeSeries.md b/docs/axes/TimeSeries.md index fa82c3b1..43385a1b 100644 --- a/docs/axes/TimeSeries.md +++ b/docs/axes/TimeSeries.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Cartesian Time Series Axes -The [time series axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianTimeSeriesAxis.html) is used to display times and dates. When building its [ticks](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianTimeTick.html), it will automatically calculate the most comfortable unit base on the size of the scale. +The [time series axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianTimeSeriesAxis.html) is used to display times and dates. When building its [ticks](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianTimeTick.html), it will automatically calculate the most comfortable unit base on the size of the scale. :::info The time series axis extends from the time axis and supports all the same options. However, for the time series scale, each data point is spread equidistant. @@ -44,7 +44,7 @@ chart.getOptions().setAxes(axis1, ...); ## Datasets -To use time series axis, you must use [DataPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/DataPoint.html) in order to set the date object in the axis. +To use time series axis, you must use [DataPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/DataPoint.html) in order to set the date object in the axis. The `x` axis data points can be specified via the **setX** method when using the time axis. @@ -87,14 +87,14 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- | alignToPixels | boolean | [Yes](#scriptable) | Align pixel values to device pixels. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The background color of scale area. -| bounds | [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Bounds.html) | [Yes](#scriptable) | Determines the scale bounds on axis. -| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) | [Yes](#scriptable) | If `Display.TRUE`, the axis is shown. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | The background color of scale area. +| bounds | [Bounds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Bounds.html) | [Yes](#scriptable) | Determines the scale bounds on axis. +| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) | [Yes](#scriptable) | If `Display.TRUE`, the axis is shown. | max | [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | [Yes](#scriptable) | User defined maximum date for the scale, overrides maximum value from data. | min | [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | [Yes](#scriptable) | User defined minimum date for the scale, overrides minimum value from data | offset | boolean | [Yes](#scriptable) | If `true`, extra space is added to the both edges and the axis is scaled to fit in the chart area. | offsetAfterAutoskip | boolean | - | If `true`, bar chart offsets are computed with auto skipped ticks. -| position | [AxisPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AxisPositionItem.html) | [Yes](#scriptable) | Position of the axis. +| position | [AxisPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AxisPositionItem.html) | [Yes](#scriptable) | Position of the axis. | reverse | boolean | [Yes](#scriptable) | Reverses order of tick labels. | singleStacked | boolean | - | If you might want to stack positive and negative values together. | stack | String | [Yes](#scriptable) | Sets the stack group. Axes at the same `position` with same `stack` are stacked. @@ -126,23 +126,23 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| alignToPixels | [AlignToPixelsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AlignToPixelsCallback.html) | boolean -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| bounds | [BoundsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BoundsCallback.html) | [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Bounds.html) -| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DisplayCallback.html) | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) -| max | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Object> | [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) - int - double -| min | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Object> | [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) - int - double -| offset | [ScaleOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleOffsetCallback.html) | boolean -| position | [ScalePositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScalePositionCallback.html) | [AxisPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AxisPositionItem.html) -| reverse | [ReverseCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ReverseCallback.html) | boolean -| stack | [StackCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackCallback.html) | String -| stacked | [StackedCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackedCallback.html) | boolean -| stackWeight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StackedCallback.html) | double -| weight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleWeightCallback.html) | double +| alignToPixels | [AlignToPixelsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AlignToPixelsCallback.html) | boolean +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| bounds | [BoundsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BoundsCallback.html) | [Bounds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Bounds.html) +| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DisplayCallback.html) | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) +| max | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Object> | [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) - int - double +| min | [MinMaxCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MinMaxCallback.html)<Object> | [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) - int - double +| offset | [ScaleOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleOffsetCallback.html) | boolean +| position | [ScalePositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScalePositionCallback.html) | [AxisPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisPosition.html) - [AxisPositionItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AxisPositionItem.html) +| reverse | [ReverseCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ReverseCallback.html) | boolean +| stack | [StackCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackCallback.html) | String +| stacked | [StackedCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackedCallback.html) | boolean +| stackWeight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StackedCallback.html) | double +| weight | [ScaleWeightCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleWeightCallback.html) | double ## Time -The time series axis provides a [Time](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Time.html) object to configure how times must be managed on axis. It provides the **set** and **get** methods as following: +The time series axis provides a [Time](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Time.html) object to configure how times must be managed on axis. It provides the **set** and **get** methods as following: ```java // creates a time series axis @@ -159,14 +159,14 @@ The following are the attributes that you can set: | Name | Type | Description | :- | :- | :- -| isoWeekday | [IsoWeekDay](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsoWeekDay.html) | The first day of the week. -| minUnit | [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html) | The minimum display format to be used for a time unit. +| isoWeekday | [IsoWeekDay](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsoWeekDay.html) | The first day of the week. +| minUnit | [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html) | The minimum display format to be used for a time unit. | parser | String | `null` | Interpreted as a custom format to be used to parse the date. -| round | [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html) | If defined, dates will be rounded to the start of this unit. +| round | [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html) | If defined, dates will be rounded to the start of this unit. | tooltipFormat | String | Format string to use for the tooltip. -| unit | [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html) | If defined, will force the unit to be a certain type. +| unit | [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html) | If defined, will force the unit to be a certain type. -The following time measurements are supported and are mapped in the [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html) enumeration, to force a certain unit: +The following time measurements are supported and are mapped in the [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html) enumeration, to force a certain unit: * millisecond * second @@ -179,9 +179,9 @@ The following time measurements are supported and are mapped in the [TimeUnit](h * year -The [Time](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Time.html) object is also providing another object to set the display formats, based on [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html). +The [Time](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Time.html) object is also providing another object to set the display formats, based on [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html). -The [DisplayFormats](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/DisplayFormats.html) can be used as following: +The [DisplayFormats](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/DisplayFormats.html) can be used as following: ```java // creates a time series axis @@ -198,7 +198,7 @@ This method can override the defaults. To see the defaults, see the [LUXON date The adapters options are used to configure the adapter for [LUXON date library](../DateAdapters). -The [adapters options](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Adapters.html) configuration is nested in the scale configuration as following: +The [adapters options](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Adapters.html) configuration is nested in the scale configuration as following: ```java // creates a time series axis @@ -213,16 +213,16 @@ The following are the attributes that you can set: | Name | Type | Description | :- | :- | :- -| locale | [CLocale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) | Using locale specifying the language to use generating or interpreting strings. -| zone | [TimeZone](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/TimeZone.html) | Implementation recognizes the time zone names of the IANA time zone database. -| outputCalendar | [Calendar](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/Calendar.html) | The calendar type to use. -| numberingSystem | [NumberingSystem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/NumberingSystem.html) | The numbering system to use. +| locale | [CLocale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) | Using locale specifying the language to use generating or interpreting strings. +| zone | [TimeZone](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/TimeZone.html) | Implementation recognizes the time zone names of the IANA time zone database. +| outputCalendar | [Calendar](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/Calendar.html) | The calendar type to use. +| numberingSystem | [NumberingSystem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/NumberingSystem.html) | The numbering system to use. For more details, have a look how to configure a [Luxon](../DateAdapters) date adapters. ## Ticks -The time series axis provides the following options for configuring [tick marks](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianTimeTick.html). +The time series axis provides the following options for configuring [tick marks](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianTimeTick.html). ```java // creates a time series axis @@ -239,15 +239,15 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| align | [TickAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TickAlign.html) | - | The tick alignment along the axis. +| align | [TickAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TickAlign.html) | - | The tick alignment along the axis. | autoSkip | boolean | - | If `true`, automatically calculates how many labels that can be shown and hides labels accordingly. Labels will be rotated up to `maxRotation` before skipping any. Turn `autoSkip` off to show all labels no matter what. | autoSkipPadding | int | - | The padding between the ticks on the horizontal axis when autoSkip is enabled. -| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of label backdrops. -| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | - | The padding of tick backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of ticks.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| crossAlign | [CrossAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CrossAlign.html) | CrossAlign.NEAR | The tick alignment perpendicular to the axis. +| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of label backdrops. +| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | - | The padding of tick backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | Color of ticks.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| crossAlign | [CrossAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CrossAlign.html) | CrossAlign.NEAR | The tick alignment perpendicular to the axis. | display | boolean | - | If `true`, the tick marks are shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | [Yes](#ticks-scriptable-options) | Font of ticks.
See [Font](../defaults/DefaultsCharts#font). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | [Yes](#ticks-scriptable-options) | Font of ticks.
See [Font](../defaults/DefaultsCharts#font). | includeBounds | boolean | - | If `true`, the defined `min` and `max` values should be presented as ticks even if they are not "nice". | labelOffset | int | - | Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis).

Note: *This can cause labels at the edges to be cropped by the edge of the canvas*. | maxRotation | int | - | The maximum rotation for tick labels when rotating to condense labels.

Note: *Rotation doesn't occur until necessary and only applicable to horizontal scales.* @@ -256,9 +256,9 @@ The following are the attributes that you can set: | padding | int | - | The padding between the tick label and the axis. | sampleSize | int | - | The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length. | showLabelBackdrop | boolean | [Yes](#ticks-scriptable-options) | If `true`, draw a background behind the tick labels -| source | [TickSource](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TickSource.html) | - | How ticks are generated on axis time. +| source | [TickSource](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TickSource.html) | - | How ticks are generated on axis time. | stepSize | int | [Yes](#ticks-scriptable-options) | The number of units between grid lines. -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | The color of the stroke around the text. +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#ticks-scriptable-options) | The color of the stroke around the text. | textStrokeWidth | int |[Yes](#ticks-scriptable-options) | Stroke width around the text. | z | int | - | z-index of tick layer. Useful when ticks are drawn on chart area. Values less than or equals to 0 are drawn under data sets, greater than 0 on top. @@ -288,19 +288,19 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| showLabelBackdrop | [ShowLabelBackdropCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ShowLabelBackdropCallback.html) | boolean -| stepSize | [StepSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/StepSizeCallback.html) | int -| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| backdropColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<ScaleContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| showLabelBackdrop | [ShowLabelBackdropCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ShowLabelBackdropCallback.html) | boolean +| stepSize | [StepSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/StepSizeCallback.html) | int +| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int ### Callback It is also common to want to change the tick marks to include information about the data type. -To apply a custom callback, you can set a [TimeTickCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TimeTickCallback.html) instance to the axis options, as following: +To apply a custom callback, you can set a [TimeTickCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TimeTickCallback.html) instance to the axis options, as following: ```java axis.getTicks().setCallback(new TimeTickCallback(){ @@ -325,7 +325,7 @@ axis.getTicks().setCallback(new TimeTickCallback(){ }); ``` -The callback is providing a specific list of items ([TimeTickItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/TimeTickItem.html)) which maps [Chart.JS](http://www.chartjs.org/) object with the values (as date) and major booleans. +The callback is providing a specific list of items ([TimeTickItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/TimeTickItem.html)) which maps [Chart.JS](http://www.chartjs.org/) object with the values (as date) and major booleans. See [INTL date time format](../intl/DateTimeFormat) documentation if you want to use a date formatter, provided out-of-the-box. diff --git a/docs/charts/Api.md b/docs/charts/Api.md index f854e894..b50d51ee 100644 --- a/docs/charts/Api.md +++ b/docs/charts/Api.md @@ -49,7 +49,7 @@ chart.update(); The update method can also be invoked providing a mode key or a mode configuration. -A [mode key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/TransitionMode.html) can be provided to indicate what should be updated and what animation configuration should be used. +A [mode key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/TransitionMode.html) can be provided to indicate what should be updated and what animation configuration should be used. ```java // creates a custom mode @@ -68,7 +68,7 @@ for (Dataset ds : datasets){ chart.update(mode); ``` -The defaults modes are mapped in the [DefaultTransitionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultTransitionMode.html) enumeration and they are: +The defaults modes are mapped in the [DefaultTransitionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultTransitionMode.html) enumeration and they are: * **ACTIVE** uses the animation configuration when an element is hovering * **HIDE** uses the animation configuration when a dataset is hidden (by using legend or [hide](#hide) method). @@ -90,7 +90,7 @@ chart.update(DefaultTransitionMode.HIDE); The update can be also invoke providing a specific animation configuration, created at runtime and not assigned to any mode. -A [configuration object](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/UpdateConfiguration.html) can be provided with additional configuration for the update process. This is useful when `update` is manually called inside an event handler and some different animation is desired. +A [configuration object](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/UpdateConfiguration.html) can be provided with additional configuration for the update process. This is useful when `update` is manually called inside an event handler and some different animation is desired. Example: @@ -117,7 +117,7 @@ chart.reconfigure(); The reconfigure method can also be invoked providing a mode key or a mode configuration. -A [mode key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsAnimationModeKey.html) can be provided to indicate what should be updated and what animation configuration should be used. +A [mode key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsAnimationModeKey.html) can be provided to indicate what should be updated and what animation configuration should be used. ```java // creates a custom mode @@ -132,7 +132,7 @@ chart.getOptions().getTitle().setText("new Title"); chart.reconfigure(mode); ``` -The defaults modes are mapped in the [DefaultTransitionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultTransitionMode.html) enumeration and they are: +The defaults modes are mapped in the [DefaultTransitionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultTransitionMode.html) enumeration and they are: * **ACTIVE** uses the animation configuration when an element is hovering * **HIDE** uses the animation configuration when a dataset is hidden (by using legend or [hide](#hide) method). @@ -150,7 +150,7 @@ chart.reconfigure(DefaultTransitionMode.HIDE); The update can be also invoke providing a specific animation configuration, created at runtime and not assigned to any mode. -A [configuration object](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/UpdateConfiguration.html) can be provided with additional configuration for the update process. This is useful when `update` is manually called inside an event handler and some different animation is desired. +A [configuration object](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/UpdateConfiguration.html) can be provided with additional configuration for the update process. This is useful when `update` is manually called inside an event handler and some different animation is desired. Example: @@ -220,7 +220,7 @@ chart.clear(); Returns a base 64 encoded string of the chart which containing a representation of the image in the different format and quality. -The method can accept the image format that you want by an [ImageMimeType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ImageMimeType.html) instance and a number between 0 and 1 indicating the image quality to use for image formats that use lossy compression. +The method can accept the image format that you want by an [ImageMimeType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ImageMimeType.html) instance and a number between 0 and 1 indicating the image quality to use for image formats that use lossy compression. The default image type is in [PNG](https://en.wikipedia.org/wiki/Portable_Network_Graphics) format and the default image quality is 0.92. @@ -239,7 +239,7 @@ String imagePngMaxQuality1 = chart.toBase64Image(1); Looks for the dataset that matches the current index and returns that the dataset item. -The [dataset item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/DatasetItem.html) will contain information about the dataset, depending on the chart type. +The [dataset item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/DatasetItem.html) will contain information about the dataset, depending on the chart type. ```java // gets the dataset item at index 0 @@ -255,7 +255,7 @@ if (item.isHidden() || !item.isVisible()){ Looks for the datasets that matches the position of the event and returns a list of dataset referencef. -The [dataset reference](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/DatasetReference.html) will contain information about indexes of dataset and the element which depends on the chart type. +The [dataset reference](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/DatasetReference.html) will contain information about indexes of dataset and the element which depends on the chart type. ```java // gets the dataset references by event instance @@ -281,7 +281,7 @@ if (chart.isDatasetVisible(0)){ ### getVisibleDatasetCount -Returns the amount of visible datasets on the chart. If chart is not initiated, it returns a [undefined value](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/Undefined.html#INTEGER). +Returns the amount of visible datasets on the chart. If chart is not initiated, it returns a [undefined value](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/Undefined.html#INTEGER). ```java // gets the amount of visible datasets of chart @@ -339,14 +339,14 @@ boolean visible = chart.isDataVisible(2); ### hide -If the data index is not specified, sets the visibility for the given dataset to `false`. Updates the chart and animates the dataset with [DefaultTransitionMode.HIDE](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultTransitionMode.html#HIDE) mode. +If the data index is not specified, sets the visibility for the given dataset to `false`. Updates the chart and animates the dataset with [DefaultTransitionMode.HIDE](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultTransitionMode.html#HIDE) mode. ```java // hides dataset at index 1 and does 'hide' animation. chart.hide(1); ``` -If the data index is specified, sets the hidden flag of that element to `true`. Updates the chart and animates the dataset with [DefaultTransitionMode.HIDE](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultTransitionMode.html#HIDE) mode. +If the data index is specified, sets the hidden flag of that element to `true`. Updates the chart and animates the dataset with [DefaultTransitionMode.HIDE](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultTransitionMode.html#HIDE) mode. ```java // hides data at index 1 of dataset at index 0 and does 'hide' animation. @@ -355,14 +355,14 @@ chart.hide(0, 1); ### show -If the data index is not specified, sets the visibility for the given dataset to `true`. Updates the chart and animates the dataset with [DefaultTransitionMode.SHOW](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultTransitionMode.html#SHOW) mode. +If the data index is not specified, sets the visibility for the given dataset to `true`. Updates the chart and animates the dataset with [DefaultTransitionMode.SHOW](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultTransitionMode.html#SHOW) mode. ```java // shows dataset at index 1 and does 'show' animation. chart.show(1); ``` -If the data index is specified, sets the hidden flag of that element to `false`. Updates the chart and animates the dataset with [DefaultTransitionMode.SHOW](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultTransitionMode.html#SHOW) mode. +If the data index is specified, sets the hidden flag of that element to `false`. Updates the chart and animates the dataset with [DefaultTransitionMode.SHOW](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultTransitionMode.html#SHOW) mode. ```java // shows data at index 1 of dataset at index 0 and does 'show' animation. @@ -371,7 +371,7 @@ chart.show(0, 1); ### Active elements -Sets the active (hovered) elements for the chart. You can create a list of [ActiveDatasetElement](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ActiveDatasetElement.html) and set which dataset and/or data must be active, programmatically. +Sets the active (hovered) elements for the chart. You can create a list of [ActiveDatasetElement](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ActiveDatasetElement.html) and set which dataset and/or data must be active, programmatically. ```java // creates a active element for data set at index 0 and for data at index 2 @@ -435,19 +435,19 @@ Provides `true` if [Chart.JS](http://www.chartjs.org/) chart instance has been i #### getId() -Returns the unique ID assigned to the chart which is set to DOM [DIV element](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Div.html). This is NOT the same id property, used by [Chart.JS](http://www.chartjs.org/). +Returns the unique ID assigned to the chart which is set to DOM [DIV element](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Div.html). This is NOT the same id property, used by [Chart.JS](http://www.chartjs.org/). #### getCanvas() -Provides the DOM [CANVAS element](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) instance used by [Chart.JS](http://www.chartjs.org/) to draw the chart. This is helpful when a plugin or controller is created to work directly on the canvas. +Provides the DOM [CANVAS element](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) instance used by [Chart.JS](http://www.chartjs.org/) to draw the chart. This is helpful when a plugin or controller is created to work directly on the canvas. #### getChartElement() -Provides the the object's underlying DOM [DIV element](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Div.html) used by **Charba** to wrap the chart. +Provides the the object's underlying DOM [DIV element](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Div.html) used by **Charba** to wrap the chart. #### getNode() -Provides an object which maps all [Chart.JS](http://www.chartjs.org/) internal objects used at runtime to draw and manage the chart. This is helpful when a plugin or controller is created to work directly on the canvas. The root object is mapped by [ChartNode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ChartNode.html) class. +Provides an object which maps all [Chart.JS](http://www.chartjs.org/) internal objects used at runtime to draw and manage the chart. This is helpful when a plugin or controller is created to work directly on the canvas. The root object is mapped by [ChartNode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ChartNode.html) class. #### getBaseType() @@ -467,7 +467,7 @@ It could be helpful to listen when the life-cycle of charts instances is changin For this reason, a life cycle listener interface has been implemented in order to be able to catch when a chart has been created and/or destroy, and when is configured. -The interface [ChartsLifecycleListener](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ChartsLifecycleListener.html) is the following: +The interface [ChartsLifecycleListener](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ChartsLifecycleListener.html) is the following: ```java /** diff --git a/docs/charts/Area.md b/docs/charts/Area.md index 260ac19e..e4379388 100644 --- a/docs/charts/Area.md +++ b/docs/charts/Area.md @@ -46,7 +46,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The area chart allows to define the data and a number of properties, used to display the data, by a [area dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/AreaDataset.html). +The area chart allows to define the data and a number of properties, used to display the data, by a [area dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/AreaDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -71,42 +71,42 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the area. -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the area. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/areaCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the area. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the area. +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the area. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/areaCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the area. | borderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setAreaDash). | borderDashOffset | double | [Yes](#scriptable) | Offset for area dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/areaDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Area joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/areaJoin). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Area joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/areaJoin). | borderWidth | int | [Yes](#scriptable) | The width of the area in pixels. -| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | [Yes](#scriptable) | Algorithm used to interpolate a smooth curve from the discrete data points. -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. +| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | [Yes](#scriptable) | Algorithm used to interpolate a smooth curve from the discrete data points. +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. | drawActiveElementsOnTop | boolean | [Yes](#scriptable) | Draw the active points of a dataset over the other points of the dataset. -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the area, when hovered. -| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the area, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/areaCap). -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the area, when hovered. +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the area, when hovered. +| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the area, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/areaCap). +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the area, when hovered. | hoverBorderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setAreaDash). | hoverBorderDashOffset | int | [Yes](#scriptable) | Offset for area dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/areaDashOffset). -| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Area joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/areaJoin). +| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Area joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/areaJoin). | hoverBorderWidth | int | [Yes](#scriptable) | The width of the area in pixels, when hovered. -| indexAxis | [IndexAxis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IndexAxis.html) | - | The base axis of the dataset. 'IndexAxis.X' for horizontal areas and 'IndexAxis.Y' for vertical areas. +| indexAxis | [IndexAxis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IndexAxis.html) | - | The base axis of the dataset. 'IndexAxis.X' for horizontal areas and 'IndexAxis.Y' for vertical areas. | label | String | - | The label for the dataset which appears in the legend and tooltips. | normalized | boolean | - | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | int | - | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | boolean | - | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. -| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. +| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. +| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. | pointBorderWidth | int[] | [Yes](#scriptable) | The width of the point border in pixels. | pointHitRadius | double[] | [Yes](#scriptable) | The pixel size of the non-displayed point that reacts to mouse events. -| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. -| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. +| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. +| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. | pointHoverBorderWidth | int[] | [Yes](#scriptable) | Border width of point when hovered. | pointHoverRadius | double[] | [Yes](#scriptable) | The radius of the point when hovered. | pointRadius | double[] | [Yes](#scriptable) | The radius of the point shape. If set to 0, the point is not rendered. | pointRotation | double[] | [Yes](#scriptable) | The rotation of the point in degrees. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. | showArea | boolean | - | If `false`, the area is not drawn for this dataset. | spanGaps | boolean - double | - | If `true`, areas will be drawn between points with no or null data. If `false`, points with `NaN` data will create a break in the area. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used. -| stepped | boolean - [Stepped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Stepped.html) | [Yes](#scriptable) | If the area is shown as a stepped area. +| stepped | boolean - [Stepped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Stepped.html) | [Yes](#scriptable) | If the area is shown as a stepped area. | tension | double | - | Bezier curve tension of the area. Set to 0 to draw straight areas. This option is ignored if monotone cubic interpolation is used. | xAxisID | String | - | The ID of the x axis to plot this dataset on. | yAxisID | String | - | The ID of the y axis to plot this dataset on. @@ -124,8 +124,8 @@ The general options for a area dataset can control behaviors not related to styl | normalized | `false` | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | 0 | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | `true` | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. -| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. +| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. +| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. ### Point styling @@ -263,38 +263,38 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) -| drawActiveElementsOnTop | [DrawActiveElementsOnTopCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DrawActiveElementsOnTopCallback.html) | boolean -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int -| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) -| stepped | [SteppedCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SteppedCallback.html) | [Stepped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Stepped.html) +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) +| drawActiveElementsOnTop | [DrawActiveElementsOnTopCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DrawActiveElementsOnTopCallback.html) | boolean +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int +| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) +| stepped | [SteppedCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SteppedCallback.html) | [Stepped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Stepped.html) ## Data structure -When the data is an array or list of doubles, the x axis is generally a category. The points are placed onto the axis using their position in the array. When a area chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. +When the data is an array or list of doubles, the x axis is generally a category. The points are placed onto the axis using their position in the array. When a area chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. ```java // sets data as an array of doubles @@ -310,7 +310,7 @@ dataset.setData(list); ## Options -The area chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/AreaOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The area chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/AreaOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. ```java // creates chart diff --git a/docs/charts/Bar.md b/docs/charts/Bar.md index dcb4d904..d59f0a84 100644 --- a/docs/charts/Bar.md +++ b/docs/charts/Bar.md @@ -48,7 +48,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The bar chart allows to define the data and a number of properties, used to display the data, by a [bar dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarDataset.html). +The bar chart allows to define the data and a number of properties, used to display the data, by a [bar dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -75,29 +75,29 @@ The following are the attributes that you can set: | :- | :- | :- | :- | autoInflateAmount | boolean | - | If `true`, the amount of pixels to inflate the bar rectangles, when drawing, is automatically calculating. | base | double - double[] | [Yes](#scriptable) | Base value for the bar in data units along the value axis. -| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) |The fill color/pattern of the bar. +| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) |The fill color/pattern of the bar. | barPercentage | double | - | The percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other. | barThickness | int | - | The width of each bar in pixels. -| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The color of the bar border. -| borderSkipped | boolean - [BorderSkipped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderSkipped.html) | [Yes](#scriptable) | Which edge to skip drawing the border for. -| borderRadius | int[] - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html)[] | [Yes](#scriptable) | The bar border radius (in pixels). -| borderWidth | int[] - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html)[] | [Yes](#scriptable) | The stroke width of the bar in pixels. +| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The color of the bar border. +| borderSkipped | boolean - [BorderSkipped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderSkipped.html) | [Yes](#scriptable) | Which edge to skip drawing the border for. +| borderRadius | int[] - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html)[] | [Yes](#scriptable) | The bar border radius (in pixels). +| borderWidth | int[] - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html)[] | [Yes](#scriptable) | The stroke width of the bar in pixels. | categoryPercentage | double | - | The percent (0-1) of the available width each category should be within the sample width. -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. When set to 0 means clip at chart area. +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. When set to 0 means clip at chart area. | enableBorderRadius | boolean | [Yes](#scriptable) | If `true`, it only shows the border radius of a bar when the bar is at the end of the stack. | grouped | boolean | - | Should the bars be grouped on index axis.
When `true`, all the datasets at same index value will be placed next to each other centering on that index value.
When `false`, each bar is placed on its actual index-axis value. -| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the bars when hovered. -| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The stroke color of the bars when hovered. +| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the bars when hovered. +| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The stroke color of the bars when hovered. | hoverBorderWidth | int[] | [Yes](#scriptable) | The stroke width of the bars when hovered. -| hoverBorderRadius | int[] - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html)[] | [Yes](#scriptable) | The bar border radius (in pixels) when hovered. -| indexAxis | [IndexAxis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IndexAxis.html) | - | The base axis of the dataset. 'IndexAxis.X' for vertical bars and 'IndexAxis.Y' for horizontal bars. +| hoverBorderRadius | int[] - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html)[] | [Yes](#scriptable) | The bar border radius (in pixels) when hovered. +| indexAxis | [IndexAxis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IndexAxis.html) | - | The base axis of the dataset. 'IndexAxis.X' for vertical bars and 'IndexAxis.Y' for horizontal bars. | inflateAmount | int[] | [Yes](#scriptable) | The amount of pixels to inflate the bar rectangles, when drawing. | label | String | - | The label for the dataset which appears in the legend and tooltips. | maxBarThickness | int | - | The maximum bar thickness, to ensure that bars are not sized thicker than this. | minBarLength | int | - | Set this to ensure that bars have a minimum length in pixels. | normalized | boolean | - | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | int | - | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | [Yes](#scriptable) | Point style for legend. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | [Yes](#scriptable) | Point style for legend. | parsing | boolean | - | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. | xAxisID | String | - | The ID of the x axis to plot this dataset on. | yAxisID | String | - | The ID of the y axis to plot this dataset on. @@ -114,8 +114,8 @@ The general options for a bar dataset can control behaviors not related to styli | normalized | `false` | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | 0 | The drawing order of dataset. Also affects order for stacking, tooltips, and legend. | parsing | `true` | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. -| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. +| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. +| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. ### Styling @@ -196,19 +196,19 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| base | [BaseCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BaseCallback.html) | double -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderSkipped | [BorderSkippedCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderSkippedCallback.html) | [BorderSkipped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderSkipped.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) -| borderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html) -| enableBorderRadius | [EnableBorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/EnableBorderRadiusCallback.html) | boolean -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html) -| hoverBorderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) -| inflateAmount | [InflateAmountCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/InflateAmountCallback.html) | int**(1)** -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) +| base | [BaseCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BaseCallback.html) | double +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderSkipped | [BorderSkippedCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderSkippedCallback.html) | [BorderSkipped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderSkipped.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) +| borderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html) +| enableBorderRadius | [EnableBorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/EnableBorderRadiusCallback.html) | boolean +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html) +| hoverBorderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) +| inflateAmount | [InflateAmountCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/InflateAmountCallback.html) | int**(1)** +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) **(1)**To enable `autoInflateAmount` by the inflate amount callback, the value to return must be `Undefined.INTEGER`. @@ -245,7 +245,7 @@ The data of a dataset for a bar chart can be passed in two formats. #### Data as doubles -When the data is an array or list of doubles, the x axis is generally a category. The points are placed onto the axis using their position in the array. When a bar chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. +When the data is an array or list of doubles, the x axis is generally a category. The points are placed onto the axis using their position in the array. When a bar chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. ```java // sets data as an array of doubles @@ -294,7 +294,7 @@ dataset.setFloatingData(fd1, fd2); ## Options -The bar chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/BarOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The bar chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/BarOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. ```java // creates the chart diff --git a/docs/charts/Bubble.md b/docs/charts/Bubble.md index 123384dc..e4167b96 100644 --- a/docs/charts/Bubble.md +++ b/docs/charts/Bubble.md @@ -52,7 +52,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The bubble chart allows to define the data and a number of properties, used to display the data, by [bubble dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BubbleDataset.html). +The bubble chart allows to define the data and a number of properties, used to display the data, by [bubble dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BubbleDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -77,20 +77,20 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The bubble background color. -| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The bubble border color. +| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The bubble background color. +| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The bubble border color. | borderWidth | int[] | [Yes](#scriptable) | The bubble border width (in pixels). -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. | drawActiveElementsOnTop | boolean | [Yes](#scriptable) | Draw the active bubbles of a dataset over the other bubbles of the dataset. | hitRadius | double[] | [Yes](#scriptable) | The bubble additional radius for hit detection (in pixels). -| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The bubble background color when hovered. -| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The bubble border color hovered. +| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The bubble background color when hovered. +| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The bubble border color hovered. | hoverBorderWidth | int[] | [Yes](#scriptable) | The bubble border width when hovered (in pixels) . | hoverRadius | double[] | [Yes](#scriptable) | The bubble additional radius when hovered (in pixels). | label | String | - | The label for the dataset which appears in the legend and tooltips. | order | int | - | The drawing order of dataset. Also affects order for stacking, tooltips, and legend. | normalized | boolean | - | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | The bubble shape style. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | The bubble shape style. | parsing | boolean | - | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. | radius | double[] | [Yes](#scriptable) | The bubble radius (in pixels). | rotation | double[] | [Yes](#scriptable) | The rotation of the point in degrees. @@ -187,17 +187,17 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| drawActiveElementsOnTop | [DrawActiveElementsOnTopCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DrawActiveElementsOnTopCallback.html) | boolean -| hitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) -| radius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| drawActiveElementsOnTop | [DrawActiveElementsOnTopCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DrawActiveElementsOnTopCallback.html) | boolean +| hitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) +| radius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double ## Data structure @@ -220,7 +220,7 @@ dataset.setDataPoint(dp1); ## Options -The bubble chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/BubbleOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The bubble chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/BubbleOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. ```java // creates chart diff --git a/docs/charts/Charts.md b/docs/charts/Charts.md index a665388e..99408508 100644 --- a/docs/charts/Charts.md +++ b/docs/charts/Charts.md @@ -12,13 +12,13 @@ Every **Charba** chart has got a common structure to define own configuration. There 3 main sections: - 1. **Type** which represents the chart type. See [Type](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Type.html) and [ChartType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ChartType.html) enumeration, with all available chart types out of the box. By controllers, you can create own charts and different types. - 2. **Data** which must be showed by the chart. See [Data](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html) and [the data section](#data) for details. - 3. **Options** which represents a set of options to configure the chart. See [Options](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/package-summary.html). + 1. **Type** which represents the chart type. See [Type](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Type.html) and [ChartType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ChartType.html) enumeration, with all available chart types out of the box. By controllers, you can create own charts and different types. + 2. **Data** which must be showed by the chart. See [Data](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html) and [the data section](#data) for details. + 3. **Options** which represents a set of options to configure the chart. See [Options](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/package-summary.html). ## Usage -A **Charba** chart extends always [AbstractChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/AbstractChart.html) which wraps a DOM [DIV element](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Div.html) and implements [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) interface which is passed to callbacks, events handlers, plugins and all other customization items. +A **Charba** chart extends always [AbstractChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/AbstractChart.html) which wraps a DOM [DIV element](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Div.html) and implements [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) interface which is passed to callbacks, events handlers, plugins and all other customization items. Programmatically, you could use a chart as following: @@ -35,7 +35,7 @@ DomGlobal.document.body.appendChild(element); ## Usage by widget (only GWT artifact) -A **Charba** chart widget for GWT extends always [AbstractChartWidget](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gwt/widgets/AbstractChartWidget.html) which is a [GWT SimplePanel](http://www.gwtproject.org/javadoc/latest/com/google/gwt/user/client/ui/SimplePanel.html) and implements [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) interface which is passed to callbacks, events handlers, plugins and all other customization items. +A **Charba** chart widget for GWT extends always [AbstractChartWidget](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gwt/widgets/AbstractChartWidget.html) which is a [GWT SimplePanel](http://www.gwtproject.org/javadoc/latest/com/google/gwt/user/client/ui/SimplePanel.html) and implements [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) interface which is passed to callbacks, events handlers, plugins and all other customization items. The charts can be implemented leveraging on [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) feature of GWT or also programmatically. @@ -76,7 +76,7 @@ Programmatically, you could implement a chart as following: ## Data -The [Data](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html) contains the [datasets](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Dataset.html) with data and configuration how data should be showed and the labels for each dataset and data. +The [Data](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html) contains the [datasets](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Dataset.html) with data and configuration how data should be showed and the labels for each dataset and data. ```java // creates the chart @@ -93,5 +93,5 @@ The following are the attributes that you can set: | Name | Defaults | Description | :- | :- | :- -| labels | String[] - [Labels](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Labels.html) | The labels to display. -| datasets | [Dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Dataset.html)[] | The datasets of the chart. +| labels | String[] - [Labels](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Labels.html) | The labels to display. +| datasets | [Dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Dataset.html)[] | The datasets of the chart. diff --git a/docs/charts/Doughnut.md b/docs/charts/Doughnut.md index da37fb4b..4a20c84d 100644 --- a/docs/charts/Doughnut.md +++ b/docs/charts/Doughnut.md @@ -50,7 +50,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The doughnut chart allows to define the data and a number of properties, used to display the data, by a [doughnut dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/DoughnutDataset.html). +The doughnut chart allows to define the data and a number of properties, used to display the data, by a [doughnut dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/DoughnutDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -75,17 +75,17 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the arcs in the dataset. -| borderAlign | [BorderAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderAlign.html) | [Yes](#scriptable) | The borders alignment of arcs. -| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color of the arcs in the dataset. -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html)[] | [Yes](#scriptable) | Arc line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). -| borderRadius | int[] - [ArcBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/ArcBorderRadius.html)[] | [Yes](#scriptable) | The arc border radius (in pixels). +| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the arcs in the dataset. +| borderAlign | [BorderAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderAlign.html) | [Yes](#scriptable) | The borders alignment of arcs. +| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color of the arcs in the dataset. +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html)[] | [Yes](#scriptable) | Arc line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderRadius | int[] - [ArcBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/ArcBorderRadius.html)[] | [Yes](#scriptable) | The arc border radius (in pixels). | borderWidth | int[] | [Yes](#scriptable) | The border width of the arcs in the dataset. | circumference | double | - | Sweep to allow arcs to cover.
For default value, see [doughnuts options](#options). -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. -| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the arcs when hovered. -| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The stroke color of the arcs when hovered. -| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html)[] | [Yes](#scriptable) | Arc line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. +| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the arcs when hovered. +| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The stroke color of the arcs when hovered. +| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html)[] | [Yes](#scriptable) | Arc line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | hoverBorderWidth | int[] | [Yes](#scriptable) | The stroke width of the arcs when hovered. | hoverOffset | int | [Yes](#scriptable) | The offset of the arc (in pixels) when hovered. | label | String | - | The label for the dataset. @@ -191,22 +191,22 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderAlign | [BorderAlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderAlignCallback.html) | [BorderAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderAlign.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [ArcBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/ArcBorderRadius.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| hoverOffset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DatasetContext> | int -| offset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DatasetContext> | int +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderAlign | [BorderAlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderAlignCallback.html) | [BorderAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderAlign.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [ArcBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/ArcBorderRadius.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| hoverOffset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DatasetContext> | int +| offset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DatasetContext> | int ## Data structure -The data of a dataset for a doughnut chart is specified as a an array of numbers. Each point in the data array corresponds to the [label](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) at the same index. +The data of a dataset for a doughnut chart is specified as a an array of numbers. Each point in the data array corresponds to the [label](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) at the same index. ```java // sets data as an array of doubles @@ -230,7 +230,7 @@ chart.getData().setLabels("label1", "label2"); ## Options -The doughnut chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/DoughnutOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The doughnut chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/DoughnutOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. ```java // creates chart diff --git a/docs/charts/Gauge.md b/docs/charts/Gauge.md index d085ddb3..aa272e81 100644 --- a/docs/charts/Gauge.md +++ b/docs/charts/Gauge.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Gauge chart -A [gauge chart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/charts/GaugeChart.html) is **Charba** extension of **[doughnut chart](ChartDoughnut)**, by a [controller](../Controllers) implementation. +A [gauge chart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/charts/GaugeChart.html) is **Charba** extension of **[doughnut chart](ChartDoughnut)**, by a [controller](../Controllers) implementation. The gauge charts are divided in the segments, the arc of each segment shows the proportional value of data. @@ -46,7 +46,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The gauge chart allows a number of properties to be specified for the [gauge dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/charts/GaugeDataset.html). +The gauge chart allows a number of properties to be specified for the [gauge dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/charts/GaugeDataset.html). ```java // creates the chart @@ -67,13 +67,13 @@ The following are the attributes that you can set: | Name | Type | Default | Description |:-|:-|:-|:- -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `color` option value | The border color of the arcs in the dataset. -| borderRadius | int - [ArcBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/ArcBorderRadius.html) | 0 | The arc border radius (in pixels). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `color` option value | The border color of the arcs in the dataset. +| borderRadius | int - [ArcBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/ArcBorderRadius.html) | 0 | The arc border radius (in pixels). | borderWidth | int | 0 | The border width of the arcs in the dataset. -| emptyColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | rgb(234,234,234) -          | The color to fill the segment of the chart which represents the empty part. +| emptyColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | rgb(234,234,234) -          | The color to fill the segment of the chart which represents the empty part. | max | double | 0 | The maximum value for the dataset. | percentageThreshold | boolean | `true` | If `true`, it uses the percentage as threshold instead of the value. -| thresholds | [Threshold](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/charts/Threshold.html)[] | [] | The thresholds to apply to the gauge dataset. +| thresholds | [Threshold](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/charts/Threshold.html)[] | [] | The thresholds to apply to the gauge dataset. :::caution A gauge chart can have **ONLY** 1 dataset. @@ -98,7 +98,7 @@ chart.getData().setDatasets(dataset); ### Using thresholds -The [thresholds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/charts/Threshold.html)is the entity which defines the color of the dataset, based on the value of the threshold. +The [thresholds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/charts/Threshold.html)is the entity which defines the color of the dataset, based on the value of the threshold. A threshold is composed by 3 attributes: @@ -126,7 +126,7 @@ dataset.setThresholds(myNorm, myWarn, myCrit); chart.getData().setDatasets(dataset); ``` -**Charba** provides a default threshold implementation by [gauge threshold](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/charts/DefaultThreshold.html) enumeration. +**Charba** provides a default threshold implementation by [gauge threshold](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/charts/DefaultThreshold.html) enumeration. | Threshold instance| Name | Value | Color | |:-|:-|:-|:- @@ -134,7 +134,7 @@ chart.getData().setDatasets(dataset); | DefaultThreshold.WARNING | "WARNING" | `90` | rgb(239, 198, 0) -          | DefaultThreshold.CRITICAL | "CRITICAL" | `Double.MAX_VALUE` | rgb(231, 24, 49) -          -You can reuse the [gauge threshold](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/charts/DefaultThreshold.html) enumeration, changing color or value or both. +You can reuse the [gauge threshold](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/charts/DefaultThreshold.html) enumeration, changing color or value or both. ```java Threshold myNorm = DefaultThreshold.NORMAL.getThreshold().setValue(50).setColor(HtmlColor.GREEN); @@ -177,10 +177,10 @@ The following are the attributes that you can set: | :- | :- | :- | :- | :- | animated | boolean | `false` | - |If the rendered label will be shown based on the animation of chart. | autoFontSize | boolean | `true` | - | If `true`, the font size to applied to the rendered label is automatically calculated at runtime, otherwise uses the `size` property of the font. -| color | [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgb(128, 128, 128) -          | [Yes](#scriptable) | Color of the content. +| color | [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgb(128, 128, 128) -          | [Yes](#scriptable) | Color of the content. | display | boolean | `true` | - | If `true`, the value label is shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | `null` | [Yes](#scriptable) | Font of rendered label. If `autoFontSize` is set to `true`, the `size` property is ignored because automatically calculated at runtime.

The default value is the font instance in the chart options.
See [Font](../defaults/DefaultsCharts#font). -| format | [MeterFormatCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MeterFormatCallback.html) | `null` | [Yes](#scriptable) | The callback instance which format the value. +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | `null` | [Yes](#scriptable) | Font of rendered label. If `autoFontSize` is set to `true`, the `size` property is ignored because automatically calculated at runtime.

The default value is the font instance in the chart options.
See [Font](../defaults/DefaultsCharts#font). +| format | [MeterFormatCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MeterFormatCallback.html) | `null` | [Yes](#scriptable) | The callback instance which format the value. | percentage | boolean | `false` | - | If `true`, the rendered label will show the dataset value as a percentage. | precision | int | `2` | - | The amount to decimals digits to apply to the value. @@ -209,10 +209,10 @@ The following are the attributes that you can set: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- | autoFontSize | boolean | `true` | - | If `true`, the font size to applied to the rendered label is automatically calculated at runtime, otherwise uses the `size` property of the font. -| color | [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgb(128, 128, 128) -          | [Yes](#scriptable) | Color of the content. +| color | [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgb(128, 128, 128) -          | [Yes](#scriptable) | Color of the content. | content | String | `null` | [Yes](#scriptable) | The content of description label. | display | boolean | `false` | - | If `true`, the value label is shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | `null` | [Yes](#scriptable) | Font of rendered label. If `autoFontSize` is set to `true`, the `size` property is ignored because automatically calculated at runtime.

The default value is the font instance in the chart options.
See [Font](../defaults/DefaultsCharts#font). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | `null` | [Yes](#scriptable) | Font of rendered label. If `autoFontSize` is set to `true`, the `size` property is ignored because automatically calculated at runtime.

The default value is the font instance in the chart options.
See [Font](../defaults/DefaultsCharts#font). ## Data structure @@ -276,17 +276,17 @@ dataset.getValueLabel().setColor(new ColorCallback(){ }); ``` -The callbacks are getting the only 1 argument, the [scriptable context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/charts/MeterContext.html) which contains the context of the callback execution. +The callbacks are getting the only 1 argument, the [scriptable context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/charts/MeterContext.html) which contains the context of the callback execution. The context object contains the following properties: | Name | Type | Description | :- | :- | :- -| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. -| chart | [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) | Chart instance. +| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. +| chart | [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) | Chart instance. | datasetLabel | String | The label of the dataset. | easing | double | The easing of drawing (between 0 and 1) for animation. -| type | [ContextType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.METER`. +| type | [ContextType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.METER`. | value | double | The value of meter or gauge dataset. The gauge chart can provide scriptable options by the gauge data set and the labels. @@ -295,10 +295,10 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<MeterContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| content | [MeterContentCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MeterContentCallback.html) | String -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<MeterContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| format | [MeterFormatCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MeterFormatCallback.html) | String +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<MeterContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| content | [MeterContentCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MeterContentCallback.html) | String +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<MeterContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| format | [MeterFormatCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MeterFormatCallback.html) | String Here is an example fo value formatting. diff --git a/docs/charts/HorizontalBar.md b/docs/charts/HorizontalBar.md index 9cf69552..4b439580 100644 --- a/docs/charts/HorizontalBar.md +++ b/docs/charts/HorizontalBar.md @@ -44,7 +44,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The horizontal bar chart allows to define the data and a number of properties, used to display the data, by a [horizontal bar dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/HorizontalBarDataset.html). +The horizontal bar chart allows to define the data and a number of properties, used to display the data, by a [horizontal bar dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/HorizontalBarDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -71,21 +71,21 @@ The following are the attributes that you can set: | :- | :- | :- | :- | autoInflateAmount | boolean | - | If `true`, the amount of pixels to inflate the bar rectangles, when drawing, is automatically calculating. | base | double - double[] | [Yes](#scriptable) | Base value for the bar in data units along the value axis. -| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) |The fill color/pattern of the bar. +| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) |The fill color/pattern of the bar. | barPercentage | double | - | The percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other. | barThickness | int | - | The width of each bar in pixels. -| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The color of the bar border. -| borderSkipped | boolean - [BorderSkipped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderSkipped.html) | [Yes](#scriptable) | Which edge to skip drawing the border for. -| borderRadius | int[] - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html)[] | [Yes](#scriptable) | The bar border radius (in pixels). -| borderWidth | int[] - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html)[] | [Yes](#scriptable) | The stroke width of the bar in pixels. +| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The color of the bar border. +| borderSkipped | boolean - [BorderSkipped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderSkipped.html) | [Yes](#scriptable) | Which edge to skip drawing the border for. +| borderRadius | int[] - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html)[] | [Yes](#scriptable) | The bar border radius (in pixels). +| borderWidth | int[] - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html)[] | [Yes](#scriptable) | The stroke width of the bar in pixels. | categoryPercentage | double | - | The percent (0-1) of the available width each category should be within the sample width. -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. When set to 0 means clip at chart area. +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. When set to 0 means clip at chart area. | enableBorderRadius| boolean | - | If `true`, it only shows the border radius of a bar when the bar is at the end of the stack. | grouped | boolean | - | Should the bars be grouped on index axis.
When `true`, all the datasets at same index value will be placed next to each other centering on that index value.
When `false`, each bar is placed on its actual index-axis value. -| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the bars when hovered. -| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The stroke color of the bars when hovered. +| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the bars when hovered. +| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The stroke color of the bars when hovered. | hoverBorderWidth | int[] | [Yes](#scriptable) | The stroke width of the bars when hovered. -| hoverBorderRadius | int[] - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html)[] | [Yes](#scriptable) | The bar border radius (in pixels) when hovered. +| hoverBorderRadius | int[] - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html)[] | [Yes](#scriptable) | The bar border radius (in pixels) when hovered. | inflateAmount | int[] | [Yes](#scriptable) | The amount of pixels to inflate the bar rectangles, when drawing. | label | String | - | The label for the dataset which appears in the legend and tooltips. | maxBarThickness | int | - | The maximum bar thickness, to ensure that bars are not sized thicker than this. @@ -93,7 +93,7 @@ The following are the attributes that you can set: | normalized | boolean | - | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | int | - | The drawing order of dataset. Also affects order for stacking, tooltips, and legend. | parsing | boolean | - | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | [Yes](#scriptable) | Point style for legend. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | [Yes](#scriptable) | Point style for legend. | xAxisID | String | - | The ID of the x axis to plot this dataset on. | yAxisID | String | - | The ID of the y axis to plot this dataset on. @@ -108,8 +108,8 @@ The general options for a horizontal bar dataset can control behaviors not relat | normalized | `false` | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | 0 | The drawing order of dataset. Also affects order for stacking, tooltips, and legend. | parsing | `true` | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. -| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. +| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. +| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. ### Styling @@ -190,18 +190,18 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| base | [BaseCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BaseCallback.html) | double -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderSkipped | [BorderSkippedCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderSkippedCallback.html) | [BorderSkipped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderSkipped.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) -| borderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html) -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html) -| hoverBorderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) -| inflateAmount | [InflateAmountCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/InflateAmountCallback.html) | int**(1)** -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) +| base | [BaseCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BaseCallback.html) | double +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderSkipped | [BorderSkippedCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderSkippedCallback.html) | [BorderSkipped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderSkipped.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) +| borderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html) +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html) +| hoverBorderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) +| inflateAmount | [InflateAmountCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/InflateAmountCallback.html) | int**(1)** +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) **(1)**To enable `autoInflateAmount` by the inflate amount callback, the value to return must be `Undefined.INTEGER`. @@ -238,7 +238,7 @@ The data of a dataset for an horizontal bar chart can be passed in two formats. #### Data as doubles -When the data is an array or list of doubles, the x axis is generally a category. The points are placed onto the axis using their position in the array. When an horizontal bar chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. +When the data is an array or list of doubles, the x axis is generally a category. The points are placed onto the axis using their position in the array. When an horizontal bar chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. ```java // sets data as an array of doubles @@ -287,7 +287,7 @@ dataset.setFloatingData(fd1, fd2); ## Options -The horizontal bar chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/HorizontalBarOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The horizontal bar chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/HorizontalBarOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. ```java // creates the chart diff --git a/docs/charts/Line.md b/docs/charts/Line.md index b9095f62..e05f307d 100644 --- a/docs/charts/Line.md +++ b/docs/charts/Line.md @@ -46,7 +46,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The line chart allows to define the data and a number of properties, used to display the data, by a [line dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/LineDataset.html). +The line chart allows to define the data and a number of properties, used to display the data, by a [line dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/LineDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -71,43 +71,43 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line. -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line. +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line. | borderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | [Yes](#scriptable) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderWidth | int | [Yes](#scriptable) | The width of the line in pixels. -| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | [Yes](#scriptable) | Algorithm used to interpolate a smooth curve from the discrete data points. -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. +| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | [Yes](#scriptable) | Algorithm used to interpolate a smooth curve from the discrete data points. +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. | drawActiveElementsOnTop | boolean | [Yes](#scriptable) | Draw the active points of a dataset over the other points of the dataset. -| fill | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsFill.html) | [Yes](#scriptable) | How to fill the area under the line. See [Filling modes](../coloring/Colors#filling). -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line, when hovered. -| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line, when hovered. +| fill | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsFill.html) | [Yes](#scriptable) | How to fill the area under the line. See [Filling modes](../coloring/Colors#filling). +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line, when hovered. +| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line, when hovered. | hoverBorderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | hoverBorderDashOffset | int | [Yes](#scriptable) | Offset for line dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | hoverBorderWidth | int | [Yes](#scriptable) | The width of the line in pixels, when hovered. -| indexAxis | [IndexAxis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IndexAxis.html) | - | The base axis of the dataset. 'IndexAxis.X' for horizontal lines and 'IndexAxis.Y' for vertical lines. +| indexAxis | [IndexAxis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IndexAxis.html) | - | The base axis of the dataset. 'IndexAxis.X' for horizontal lines and 'IndexAxis.Y' for vertical lines. | label | String | - | The label for the dataset which appears in the legend and tooltips. | normalized | boolean | - | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | int | - | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | boolean | - | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. -| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. +| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. +| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. | pointBorderWidth | int[] | [Yes](#scriptable) | The width of the point border in pixels. | pointHitRadius | double[] | [Yes](#scriptable) | The pixel size of the non-displayed point that reacts to mouse events. -| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. -| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. +| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. +| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. | pointHoverBorderWidth | int[] | [Yes](#scriptable) | Border width of point when hovered. | pointHoverRadius | double[] | [Yes](#scriptable) | The radius of the point when hovered. | pointRadius | double[] | [Yes](#scriptable) | The radius of the point shape. If set to 0, the point is not rendered. | pointRotation | double[] | [Yes](#scriptable) | The rotation of the point in degrees. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. | showLine | boolean | - | If `false`, the line is not drawn for this dataset. | spanGaps | boolean - double | - | If `true`, lines will be drawn between points with no or null data. If `false`, points with `NaN` data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used. -| stepped | boolean - [Stepped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Stepped.html) | [Yes](#scriptable) | If the line is shown as a stepped line. +| stepped | boolean - [Stepped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Stepped.html) | [Yes](#scriptable) | If the line is shown as a stepped line. | tension | double | - | Bezier curve tension of the line. Set to 0 to draw straight lines. This option is ignored if monotone cubic interpolation is used. | xAxisID | String | - | The ID of the x axis to plot this dataset on. | yAxisID | String | - | The ID of the y axis to plot this dataset on. @@ -125,8 +125,8 @@ The general options for a line dataset can control behaviors not related to styl | normalized | `false` | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | 0 | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | `true` | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. -| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. +| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. +| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. ### Point styling @@ -265,35 +265,35 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) -| drawActiveElementsOnTop | [DrawActiveElementsOnTopCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DrawActiveElementsOnTopCallback.html) | boolean -| fill | [FillCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FillCallback.html) | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsFill.html) -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int -| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) -| stepped | [SteppedCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SteppedCallback.html) | [Stepped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Stepped.html) +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) +| drawActiveElementsOnTop | [DrawActiveElementsOnTopCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DrawActiveElementsOnTopCallback.html) | boolean +| fill | [FillCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FillCallback.html) | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsFill.html) +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int +| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) +| stepped | [SteppedCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SteppedCallback.html) | [Stepped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Stepped.html) ## Data structure @@ -301,7 +301,7 @@ The data of a dataset for a line chart can be passed in three formats. #### Data as doubles -When the data is an array or list of doubles, the x axis is generally a category. The points are placed onto the axis using their position in the array. When a line chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. +When the data is an array or list of doubles, the x axis is generally a category. The points are placed onto the axis using their position in the array. When a line chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. ```java // sets data as an array of doubles @@ -348,7 +348,7 @@ dataset.setDataString("label1", "label2"); ## Options -The line chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/LineOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The line chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/LineOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. ```java // creates chart @@ -412,25 +412,25 @@ These are the options specific to line charts: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<SegmentContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<SegmentContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<SegmentContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<SegmentContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<SegmentContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<SegmentContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<SegmentContext> | int +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<SegmentContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<SegmentContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<SegmentContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<SegmentContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<SegmentContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<SegmentContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<SegmentContext> | int -The callbacks are getting the only 1 argument, the [segment context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SegmentContext.html) which contains the context of the callback execution. +The callbacks are getting the only 1 argument, the [segment context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SegmentContext.html) which contains the context of the callback execution. The context object contains the following properties: | Name | Type | Description | :- | :- | :- -| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. -| chart | [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) | Chart instance. +| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. +| chart | [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) | Chart instance. | datasetIndex | int | The index of the dataset. | endDataIndex | int | The index of second point in the data. -| endPoint | [PointElement](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PointElement.html) | The line element for the end point of the segment. +| endPoint | [PointElement](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PointElement.html) | The line element for the end point of the segment. | startDataIndex | int | The index of first point in the data. -| startPoint | [PointElement](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PointElement.html) | The line element for the start point of the segment. -| type | [ContextType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.SEGMENT`. +| startPoint | [PointElement](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PointElement.html) | The line element for the start point of the segment. +| type | [ContextType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.SEGMENT`. diff --git a/docs/charts/Matrix.md b/docs/charts/Matrix.md index c9bc2bd4..e73dd02d 100644 --- a/docs/charts/Matrix.md +++ b/docs/charts/Matrix.md @@ -70,7 +70,7 @@ defaultOptions.setBorderColor(HtmlColor.RED); ## Dataset -The matrix chart allows to define the data and a number of properties, used to display the data, by a [matrix dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/matrix/MatrixDataset.html). +The matrix chart allows to define the data and a number of properties, used to display the data, by a [matrix dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/matrix/MatrixDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -95,17 +95,17 @@ The following are the attributes that you can set: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | [Yes](#scriptable) | The fill color/pattern of the matrix element. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | [Yes](#scriptable) | The color of the matrix element border. -| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) | 0 | [Yes](#scriptable) | The border radius (in pixels) of matrix element. -| borderWidth | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html) | 0 | [Yes](#scriptable) | The stroke width of the matrix element in pixels. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | [Yes](#scriptable) | The fill color/pattern of the matrix element. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | [Yes](#scriptable) | The color of the matrix element border. +| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) | 0 | [Yes](#scriptable) | The border radius (in pixels) of matrix element. +| borderWidth | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html) | 0 | [Yes](#scriptable) | The stroke width of the matrix element in pixels. | height | double | 20 | [Yes](#scriptable) | The height of matrix element. -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | [Yes](#scriptable) | The fill color/pattern of the matrix elements when hovered. -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | [Yes](#scriptable) | The stroke color of the matrix elements when hovered. -| hoverBorderWidth | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html) | 0 | [Yes](#scriptable) | The stroke width of the matrix elements when hovered. +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | [Yes](#scriptable) | The fill color/pattern of the matrix elements when hovered. +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | [Yes](#scriptable) | The stroke color of the matrix elements when hovered. +| hoverBorderWidth | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html) | 0 | [Yes](#scriptable) | The stroke width of the matrix elements when hovered. | width | double | 20 | [Yes](#scriptable) | The width of matrix element. -| xAnchor | [Anchor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/matrix/enums/Anchor.html) | Anchor.CENTER | - | Set the horizontal anchor value of the matrix elements.
For this property, only Anchor.LEFT, Anchor.RIGHT and Anchor.CENTER are valid. -| yAnchor | [Anchor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/matrix/enums/Anchor.html) | Anchor.CENTER | - | Set the vertical anchor value of the matrix elements.
For this property, only Anchor.TOP, Anchor.BOTTOM and Anchor.CENTER are valid. +| xAnchor | [Anchor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/matrix/enums/Anchor.html) | Anchor.CENTER | - | Set the horizontal anchor value of the matrix elements.
For this property, only Anchor.LEFT, Anchor.RIGHT and Anchor.CENTER are valid. +| yAnchor | [Anchor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/matrix/enums/Anchor.html) | Anchor.CENTER | - | Set the vertical anchor value of the matrix elements.
For this property, only Anchor.TOP, Anchor.BOTTOM and Anchor.CENTER are valid. ### Scriptable @@ -131,19 +131,19 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) -| borderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html) -| height | [SizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/matrix/callbacks/SizeCallback.html) | double -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html) -| width | [SizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/matrix/callbacks/SizeCallback.html) | double +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) +| borderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html) +| height | [SizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/matrix/callbacks/SizeCallback.html) | double +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html) +| width | [SizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/matrix/callbacks/SizeCallback.html) | double ## Data structure -The data of a dataset for a matrix chart can be passed in [matrix data points](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/matrix/MatrixDataPoint.html). +The data of a dataset for a matrix chart can be passed in [matrix data points](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/matrix/MatrixDataPoint.html). :::caution The `setData` method is available but you can **NOT** use them otherwise an exception will throw.
Use `setDataPoints` instead. @@ -151,7 +151,7 @@ The `setData` method is available but you can **NOT** use them otherwise an exce #### Data as objects -Matrix data should be provided by a list of objects. The [matrix data point](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/matrix/MatrixDataPoint.html) needs to have `x` and `y` values to bind to the axes to set, and `value` which represents the value of the matrix element. +Matrix data should be provided by a list of objects. The [matrix data point](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/matrix/MatrixDataPoint.html) needs to have `x` and `y` values to bind to the axes to set, and `value` which represents the value of the matrix element. @@ -185,7 +185,7 @@ dataset.setDataPoints(points); ## Options -The matrix chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/matrix/MatrixOptions.html) to be configured. +The matrix chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/matrix/MatrixOptions.html) to be configured. ```java // creates chart diff --git a/docs/charts/Meter.md b/docs/charts/Meter.md index fb2f90bd..795da020 100644 --- a/docs/charts/Meter.md +++ b/docs/charts/Meter.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Meter chart -A [meter chart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/charts/MeterChart.html) is **Charba** extension of **[doughnut chart](ChartDoughnut)**, by a [controller](../Controllers) implementation. +A [meter chart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/charts/MeterChart.html) is **Charba** extension of **[doughnut chart](ChartDoughnut)**, by a [controller](../Controllers) implementation. The meter charts are divided in the 2 segments, the arc of each segment shows the proportional value of data. @@ -46,7 +46,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The meter chart allows a number of properties to be specified for the [meter dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/charts/MeterDataset.html). +The meter chart allows a number of properties to be specified for the [meter dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/charts/MeterDataset.html). ```java // creates the chart @@ -63,11 +63,11 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `color` option value | The border color of the arcs in the dataset. -| borderRadius | int - [ArcBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/ArcBorderRadius.html) | 0 | The arc border radius (in pixels). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `color` option value | The border color of the arcs in the dataset. +| borderRadius | int - [ArcBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/ArcBorderRadius.html) | 0 | The arc border radius (in pixels). | borderWidth | int | 0 | The border width of the arcs in the dataset. -| color | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | rgb(140,214,16) -          | The color to fill the segment of the chart which represents the value. -| emptyColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | rgb(234,234,234) -          | The color to fill the segment of the chart which represents the empty part. +| color | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | rgb(140,214,16) -          | The color to fill the segment of the chart which represents the value. +| emptyColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | rgb(234,234,234) -          | The color to fill the segment of the chart which represents the empty part. | max | double | 0 | The maximum value for the dataset. :::caution @@ -118,10 +118,10 @@ The following are the attributes that you can set: | :- | :- | :- | :- | :- | animated | boolean | `false` | - |If the rendered label will be shown based on the animation of chart. | autoFontSize | boolean | `true` | - | If `true`, the font size to applied to the rendered label is automatically calculated at runtime, otherwise uses the `size` property of the font. -| color | [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgb(128, 128, 128) -          | [Yes](#scriptable) | Color of the content. +| color | [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgb(128, 128, 128) -          | [Yes](#scriptable) | Color of the content. | display | boolean | `true` | - | If `true`, the value label is shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | `null` | [Yes](#scriptable) | Font of rendered label. If `autoFontSize` is set to `true`, the `size` property is ignored because automatically calculated at runtime.

The default value is the font instance in the chart options.
See [Font](../defaults/DefaultsCharts#font). -| format | [MeterFormatCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MeterFormatCallback.html) | `null` | [Yes](#scriptable) | The callback instance which format the value. +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | `null` | [Yes](#scriptable) | Font of rendered label. If `autoFontSize` is set to `true`, the `size` property is ignored because automatically calculated at runtime.

The default value is the font instance in the chart options.
See [Font](../defaults/DefaultsCharts#font). +| format | [MeterFormatCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MeterFormatCallback.html) | `null` | [Yes](#scriptable) | The callback instance which format the value. | percentage | boolean | `false` | - | If `true`, the rendered label will show the dataset value as a percentage. | precision | int | `2` | - | The amount to decimals digits to apply to the value. @@ -150,10 +150,10 @@ The following are the attributes that you can set: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- | autoFontSize | boolean | `true` | - | If `true`, the font size to applied to the rendered label is automatically calculated at runtime, otherwise uses the `size` property of the font. -| color | [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgb(128, 128, 128) -          | [Yes](#scriptable) | Color of the content. +| color | [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgb(128, 128, 128) -          | [Yes](#scriptable) | Color of the content. | content | String | `null` | [Yes](#scriptable) | The content of description label. | display | boolean | `false` | - | If `true`, the value label is shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | `null` | [Yes](#scriptable) | Font of rendered label. If `autoFontSize` is set to `true`, the `size` property is ignored because automatically calculated at runtime.

The default value is the font instance in the chart options.
See [Font](../defaults/DefaultsCharts#font). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | `null` | [Yes](#scriptable) | Font of rendered label. If `autoFontSize` is set to `true`, the `size` property is ignored because automatically calculated at runtime.

The default value is the font instance in the chart options.
See [Font](../defaults/DefaultsCharts#font). ## Data structure @@ -217,17 +217,17 @@ dataset.getValueLabel().setColor(new ColorCallback(){ }); ``` -The callbacks are getting the only 1 argument, the [scriptable context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/charts/MeterContext.html) which contains the context of the callback execution. +The callbacks are getting the only 1 argument, the [scriptable context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/charts/MeterContext.html) which contains the context of the callback execution. The context object contains the following properties: | Name | Type | Description | :- | :- | :- -| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. -| chart | [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) | Chart instance. +| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. +| chart | [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) | Chart instance. | datasetLabel | String | The label of the dataset. | easing | double | The easing of drawing (between 0 and 1) for animation. -| type | [ContextType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.METER`. +| type | [ContextType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.METER`. | value | double | The value of meter or gauge dataset. The meter chart can provide scriptable options by the meter data set and the labels. @@ -236,10 +236,10 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<MeterContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| content | [MeterContentCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MeterContentCallback.html) | String -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<MeterContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| format | [MeterFormatCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/MeterFormatCallback.html) | String +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<MeterContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| content | [MeterContentCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MeterContentCallback.html) | String +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<MeterContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| format | [MeterFormatCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/MeterFormatCallback.html) | String Here is an example fo value formatting. diff --git a/docs/charts/Pie.md b/docs/charts/Pie.md index b166a7ca..a684212c 100644 --- a/docs/charts/Pie.md +++ b/docs/charts/Pie.md @@ -50,7 +50,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The pie chart allows to define the data and a number of properties, used to display the data, by a [pie dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/PieDataset.html). +The pie chart allows to define the data and a number of properties, used to display the data, by a [pie dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/PieDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -75,17 +75,17 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the arcs in the dataset. -| borderAlign | [BorderAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderAlign.html) | [Yes](#scriptable) | The borders alignment of arcs. -| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color of the arcs in the dataset. -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html)[] | [Yes](#scriptable) | Arc line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). -| borderRadius | int[] - [ArcBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/ArcBorderRadius.html)[] | [Yes](#scriptable) | The arc border radius (in pixels). +| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the arcs in the dataset. +| borderAlign | [BorderAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderAlign.html) | [Yes](#scriptable) | The borders alignment of arcs. +| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color of the arcs in the dataset. +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html)[] | [Yes](#scriptable) | Arc line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderRadius | int[] - [ArcBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/ArcBorderRadius.html)[] | [Yes](#scriptable) | The arc border radius (in pixels). | borderWidth | int[] | [Yes](#scriptable) | The border width of the arcs in the dataset. | circumference | double | - | Sweep to allow arcs to cover.
For default value, see [pie options](#options). -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. -| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the arcs when hovered. -| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The stroke color of the arcs when hovered. -| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html)[] | [Yes](#scriptable) | Arc line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. +| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the arcs when hovered. +| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The stroke color of the arcs when hovered. +| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html)[] | [Yes](#scriptable) | Arc line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | hoverBorderWidth | int[] | [Yes](#scriptable) | The stroke width of the arcs when hovered. | hoverOffset | int | [Yes](#scriptable) | The offset of the arc (in pixels) when hovered. | label | String | - | The label for the dataset. @@ -191,22 +191,22 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderAlign | [BorderAlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderAlignCallback.html) | [BorderAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderAlign.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [ArcBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/ArcBorderRadius.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| hoverOffset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DatasetContext> | int -| offset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DatasetContext> | int +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderAlign | [BorderAlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderAlignCallback.html) | [BorderAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderAlign.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [ArcBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/ArcBorderRadius.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| hoverOffset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DatasetContext> | int +| offset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DatasetContext> | int ## Data structure -The data of a dataset for a pie chart is specified as a an array of numbers. Each point in the data array corresponds to the [label](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) at the same index. +The data of a dataset for a pie chart is specified as a an array of numbers. Each point in the data array corresponds to the [label](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) at the same index. ```java // sets data as an array of doubles @@ -230,7 +230,7 @@ chart.getData().setLabels("label1", "label2"); ## Options -The pie chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/PieOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The pie chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/PieOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. ```java // creates chart diff --git a/docs/charts/PolarArea.md b/docs/charts/PolarArea.md index 37208d36..184fa071 100644 --- a/docs/charts/PolarArea.md +++ b/docs/charts/PolarArea.md @@ -50,7 +50,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The polar area chart allows to define the data and a number of properties, used to display the data, by [polar area dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/PolarAreaDataset.html). +The polar area chart allows to define the data and a number of properties, used to display the data, by [polar area dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/PolarAreaDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -75,16 +75,16 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the arcs in the dataset. -| borderAlign | [BorderAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderAlign.html) | [Yes](#scriptable) | The borders alignment of arcs. -| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color of the arcs in the dataset. -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html)[] | [Yes](#scriptable) | Arc line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the arcs in the dataset. +| borderAlign | [BorderAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderAlign.html) | [Yes](#scriptable) | The borders alignment of arcs. +| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color of the arcs in the dataset. +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html)[] | [Yes](#scriptable) | Arc line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderWidth | int[] | [Yes](#scriptable) | The border width of the arcs in the dataset. -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. | circular | boolean | [Yes](#scriptable) | If the arc is curved. If `false` the arc will be flat. -| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the arcs when hovered. -| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The stroke color of the arcs when hovered. -| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html)[] | [Yes](#scriptable) | Arc line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the arcs when hovered. +| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The stroke color of the arcs when hovered. +| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html)[] | [Yes](#scriptable) | Arc line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | hoverBorderWidth | int[] | [Yes](#scriptable) | The stroke width of the arcs when hovered. | label | String | - | The label for the dataset. | normalized | boolean | - | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. @@ -180,20 +180,20 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderAlign | [BorderAlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderAlignCallback.html) | [BorderAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderAlign.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| circular | [CircularCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CircularCallback.html) | boolean -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderAlign | [BorderAlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderAlignCallback.html) | [BorderAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderAlign.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| circular | [CircularCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CircularCallback.html) | boolean +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int ## Data structure -The data of a dataset for a polar area chart is specified as a an array of numbers. Each point in the data array corresponds to the [label](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) at the same index on the axis. +The data of a dataset for a polar area chart is specified as a an array of numbers. Each point in the data array corresponds to the [label](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) at the same index on the axis. ```java // sets data as an array of doubles diff --git a/docs/charts/Radar.md b/docs/charts/Radar.md index 73a4bab6..8c7b8c6e 100644 --- a/docs/charts/Radar.md +++ b/docs/charts/Radar.md @@ -49,7 +49,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The radar chart allows to define the data and a number of properties, used to display the data, by a [radar dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/RadarDataset.html). +The radar chart allows to define the data and a number of properties, used to display the data, by a [radar dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/RadarDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -74,38 +74,38 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)| [Yes](#scriptable) | The fill color under the line. -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)| [Yes](#scriptable) | The fill color under the line. +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line. | borderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | [Yes](#scriptable) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderWidth | int | [Yes](#scriptable) | The width of the line in pixels. -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. | drawActiveElementsOnTop | boolean | [Yes](#scriptable) | Draw the active points of a dataset over the other points of the dataset. -| fill | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsFill.html) | [Yes](#scriptable) | How to fill the area under the line. See [Filling modes](../coloring/Colors#filling-modes). -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color under the line, when hovered. -| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line, when hovered. +| fill | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsFill.html) | [Yes](#scriptable) | How to fill the area under the line. See [Filling modes](../coloring/Colors#filling-modes). +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color under the line, when hovered. +| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line, when hovered. | hoverBorderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | hoverBorderDashOffset | int | [Yes](#scriptable) | Offset for line dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | hoverBorderWidth | int | [Yes](#scriptable) | The width of the line in pixels, when hovered. | label | String | - | The label for the dataset which appears in the legend and tooltips. | normalized | boolean | - | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | int | - | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | boolean | - | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. -| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. +| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. +| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. | pointBorderWidth | int[] | [Yes](#scriptable) | The width of the point border in pixels. | pointHitRadius | double[] | [Yes](#scriptable) | The pixel size of the non-displayed point that reacts to mouse events. -| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. -| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. +| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. +| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. | pointHoverBorderWidth | int[] | [Yes](#scriptable) | Border width of point when hovered. | pointHoverRadius | double[] | [Yes](#scriptable) | The radius of the point when hovered. | pointRadius | double[] | [Yes](#scriptable) | The radius of the point shape. If set to 0, the point is not rendered. | pointRotation | double[] | [Yes](#scriptable) | the rotation of the point in degrees. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. | spanGaps | boolean | - | If `true`, lines will be drawn between points with no or null data. If `false`, points with `NaN` data will create a break in the line. | tension | double | - | Bezier curve tension of the line. Set to 0 to draw straight lines. @@ -256,38 +256,38 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) -| drawActiveElementsOnTop | [DrawActiveElementsOnTopCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DrawActiveElementsOnTopCallback.html) | boolean -| fill | [FillCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FillCallback.html) | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsFill.html) -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int -| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) +| drawActiveElementsOnTop | [DrawActiveElementsOnTopCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DrawActiveElementsOnTopCallback.html) | boolean +| fill | [FillCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FillCallback.html) | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsFill.html) +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int +| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) ## Data structure -The data of a dataset for a radar chart is specified as a an array of numbers. Each point in the data array corresponds to the [label](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) at the same index on the x axis. +The data of a dataset for a radar chart is specified as a an array of numbers. Each point in the data array corresponds to the [label](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) at the same index on the x axis. ```java // sets data as an array of doubles @@ -311,7 +311,7 @@ chart.getData().setLabels("label1", "label2"); ## Options -The radar chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/RadarOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The radar chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/RadarOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. ```java // creates chart diff --git a/docs/charts/Sankey.md b/docs/charts/Sankey.md index 6a72bb12..b37a841e 100644 --- a/docs/charts/Sankey.md +++ b/docs/charts/Sankey.md @@ -72,7 +72,7 @@ defaultOptions.setColorMode(ColorMode.GRADIENT); ## Dataset -The sankey chart allows to define the data and a number of properties, used to display the data, by a [sankey dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/SankeyDataset.html). +The sankey chart allows to define the data and a number of properties, used to display the data, by a [sankey dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/SankeyDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -97,21 +97,21 @@ The following are the attributes that you can set: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.BLACK -          | - | The color of the node border. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.BLACK -          | - | The color of the node border. | borderWidth | int | 1 | - | The stroke width of the sankey nodes in pixels. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.BLACK -          | - | The color of the node label. -| colorFrom | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | empty list | [Yes](#scriptable) | The starting color of the flow between nodes. -| colorMode | [ColorMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/enums/ColorMode.html) | ColorMode.GRADIENT | [Yes](#scriptable) | How the flow is drawn on the chart. -| colorTo | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | empty list | [Yes](#scriptable) | The ending color of the flow between nodes. -| column | [Column](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/Column.html) | `null` | - | Is a map to apply a specific position, by column number, to the nodes, affecting the chart layout. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | `Defaults.get().getGlobal()`
`.getFont()` | [Yes](#scriptable) | Font of text of node label.
See [Font](../defaults/DefaultsCharts#font). -| hoverColorFrom | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | empty list | [Yes](#scriptable) | The starting color of the flow between nodes, when hovered. -| hoverColorTo | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | empty list | [Yes](#scriptable) | The ending color of the flow between nodes, when hovered. -| labels | [Labels](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/Labels.html) | `null` | - | Is a map to apply a different label to the nodes. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.BLACK -          | - | The color of the node label. +| colorFrom | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | empty list | [Yes](#scriptable) | The starting color of the flow between nodes. +| colorMode | [ColorMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/enums/ColorMode.html) | ColorMode.GRADIENT | [Yes](#scriptable) | How the flow is drawn on the chart. +| colorTo | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | empty list | [Yes](#scriptable) | The ending color of the flow between nodes. +| column | [Column](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/Column.html) | `null` | - | Is a map to apply a specific position, by column number, to the nodes, affecting the chart layout. +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | `Defaults.get().getGlobal()`
`.getFont()` | [Yes](#scriptable) | Font of text of node label.
See [Font](../defaults/DefaultsCharts#font). +| hoverColorFrom | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | empty list | [Yes](#scriptable) | The starting color of the flow between nodes, when hovered. +| hoverColorTo | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | empty list | [Yes](#scriptable) | The ending color of the flow between nodes, when hovered. +| labels | [Labels](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/Labels.html) | `null` | - | Is a map to apply a different label to the nodes. | nodeWidth | int | 10 | - | The width of node. | padding | double | `font.getLineheight() / 2` | [Yes](#scriptable) | The padding of the node label from the top. -| priority | [Priority](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/Priority.html) | `null` | - | Is a map to apply a different priority to the nodes, affecting the chart layout. -| size | [Size](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/enums/Size.html) | Size.MAX | [Yes](#scriptable) | Sets Size.MIN if flow overlap is preferred. +| priority | [Priority](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/Priority.html) | `null` | - | Is a map to apply a different priority to the nodes, affecting the chart layout. +| size | [Size](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/enums/Size.html) | Size.MAX | [Yes](#scriptable) | Sets Size.MIN if flow overlap is preferred. ### Scriptable @@ -137,18 +137,18 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| colorFrom | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| colorMode | [ColorModeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/callbacks/ColorModeCallback.html) | [ColorMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/enums/ColorMode.html) -| colorTo | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<DatasetContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| hoverColorFrom | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| hoverColorTo | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/callbacks/PaddingCallback.html) | double -| size | [SizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/callbacks/SizeCallback.html) | [Size](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/enums/Size.html) +| colorFrom | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| colorMode | [ColorModeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/callbacks/ColorModeCallback.html) | [ColorMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/enums/ColorMode.html) +| colorTo | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<DatasetContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| hoverColorFrom | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| hoverColorTo | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/callbacks/PaddingCallback.html) | double +| size | [SizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/callbacks/SizeCallback.html) | [Size](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/enums/Size.html) ## Data structure -The data of a dataset for a sankey chart can be passed in [sankey data points](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/SankeyDataPoint.html). +The data of a dataset for a sankey chart can be passed in [sankey data points](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/SankeyDataPoint.html). :::caution The `setData` method is available but you can **NOT** use them otherwise an exception will throw.
Use `setDataPoints` instead. @@ -156,7 +156,7 @@ The `setData` method is available but you can **NOT** use them otherwise an exce #### Data as objects -Sankey data should be provided by a list of objects. The [sankey data point](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/SankeyDataPoint.html) contains the relations between nodes and their value. +Sankey data should be provided by a list of objects. The [sankey data point](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/SankeyDataPoint.html) contains the relations between nodes and their value. It needs to have `from` and `to` values, which represent the nodes, and `value` which represents the value of the sankey element. @@ -181,7 +181,7 @@ dataset.setDataPoints(datapoints); ## Options -The sankey chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/sankey/SankeyOptions.html) to be configured. +The sankey chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/sankey/SankeyOptions.html) to be configured. ```java // creates chart diff --git a/docs/charts/Scatter.md b/docs/charts/Scatter.md index c58e4059..9af2ac3d 100644 --- a/docs/charts/Scatter.md +++ b/docs/charts/Scatter.md @@ -48,7 +48,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The scatter chart allows to define the data and a number of properties, used to display the data, by a [scatter dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/ScatterDataset.html). +The scatter chart allows to define the data and a number of properties, used to display the data, by a [scatter dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/ScatterDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -73,37 +73,37 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line. -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line. +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line. | borderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | [Yes](#scriptable) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderWidth | int | [Yes](#scriptable) | The width of the line in pixels. -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. | drawActiveElementsOnTop | boolean | [Yes](#scriptable) | Draw the active points of a dataset over the other points of the dataset. -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line, when hovered. -| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line, when hovered. +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line, when hovered. +| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line, when hovered. | hoverBorderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | hoverBorderDashOffset | int | [Yes](#scriptable) | Offset for line dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | hoverBorderWidth | int | [Yes](#scriptable) | The width of the line in pixels, when hovered. | label | String | - | The label for the dataset which appears in the legend and tooltips. | normalized | boolean | - | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | int | - | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | boolean | - | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. -| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. +| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. +| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. | pointBorderWidth | int[] | [Yes](#scriptable) | The width of the point border in pixels. | pointHitRadius | double[] | [Yes](#scriptable) | The pixel size of the non-displayed point that reacts to mouse events. -| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. -| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. +| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. +| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. | pointHoverBorderWidth | int[] | [Yes](#scriptable) | Border width of point when hovered. | pointHoverRadius | double[] | [Yes](#scriptable) | The radius of the point when hovered. | pointRadius | double[] | [Yes](#scriptable) | The radius of the point shape. If set to 0, the point is not rendered. | pointRotation | double[] | [Yes](#scriptable) | The rotation of the point in degrees. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. | spanGaps | boolean - double | - | If `true`, lines will be drawn between points with no or null data. If `false`, points with `NaN` data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used. | xAxisID | String | - | The ID of the x axis to plot this dataset on. | yAxisID | String | - | The ID of the y axis to plot this dataset on. @@ -120,8 +120,8 @@ The general options for a scatter dataset can control behaviors not related to s | normalized | `false` | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | 0 | The drawing order of dataset. Also affects order for stacking, tooltips, and legend. | parsing | `true` | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. -| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. +| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. +| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. ### Point styling @@ -256,32 +256,32 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| drawActiveElementsOnTop | [DrawActiveElementsOnTopCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DrawActiveElementsOnTopCallback.html) | boolean -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int -| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| drawActiveElementsOnTop | [DrawActiveElementsOnTopCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DrawActiveElementsOnTopCallback.html) | boolean +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int +| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) ## Data structure @@ -302,7 +302,7 @@ dataset.setDataPoint(dp1, dp2); ## Options -The scatter chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/ScatterOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The scatter chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/ScatterOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. ```java // creates chart diff --git a/docs/charts/StackedArea.md b/docs/charts/StackedArea.md index dfccae0f..525a74ba 100644 --- a/docs/charts/StackedArea.md +++ b/docs/charts/StackedArea.md @@ -45,7 +45,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The stacked area chart allows a number of properties to be specified for each [stacked area dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/StackedAreaDataset.html). These are used to set display properties for a specific dataset. +The stacked area chart allows a number of properties to be specified for each [stacked area dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/StackedAreaDataset.html). These are used to set display properties for a specific dataset. Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -70,41 +70,41 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line. -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line. +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line. | borderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | [Yes](#scriptable) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderWidth | int | [Yes](#scriptable) | The width of the line in pixels. -| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | [Yes](#scriptable) | Algorithm used to interpolate a smooth curve from the discrete data points. -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line, when hovered. -| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line, when hovered. +| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | [Yes](#scriptable) | Algorithm used to interpolate a smooth curve from the discrete data points. +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line, when hovered. +| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line, when hovered. | hoverBorderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | hoverBorderDashOffset | int | [Yes](#scriptable) | Offset for line dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | hoverBorderWidth | int | [Yes](#scriptable) | The width of the line in pixels, when hovered. -| indexAxis | [IndexAxis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IndexAxis.html) | - | The base axis of the dataset. 'IndexAxis.X' for horizontal lines and 'IndexAxis.Y' for vertical lines. +| indexAxis | [IndexAxis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IndexAxis.html) | - | The base axis of the dataset. 'IndexAxis.X' for horizontal lines and 'IndexAxis.Y' for vertical lines. | label | String | - | The label for the dataset which appears in the legend and tooltips. | normalized | boolean | - | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | int | - | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | boolean | - | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. -| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. +| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. +| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. | pointBorderWidth | int[] | [Yes](#scriptable) | The width of the point border in pixels. | pointHitRadius | double[] | [Yes](#scriptable) | The pixel size of the non-displayed point that reacts to mouse events. -| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. -| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. +| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. +| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. | pointHoverBorderWidth | int[] | [Yes](#scriptable) | Border width of point when hovered. | pointHoverRadius | double[] | [Yes](#scriptable) | The radius of the point when hovered. | pointRadius | double[] | [Yes](#scriptable) | The radius of the point shape. If set to 0, the point is not rendered. | pointRotation | double[] | [Yes](#scriptable) | The rotation of the point in degrees. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. | showLine | boolean | - | If `false`, the line is not drawn for this dataset. | spanGaps | boolean - double | - | If `true`, lines will be drawn between points with no or null data. If `false`, points with `NaN` data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used. -| stepped | [Stepped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Stepped.html) | - | If the line is shown as a stepped line. +| stepped | [Stepped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Stepped.html) | - | If the line is shown as a stepped line. | tension | double | - | Bezier curve tension of the line. Set to 0 to draw straight lines. This option is ignored if monotone cubic interpolation is used. | xAxisID | String | - | The ID of the x axis to plot this dataset on. | yAxisID | String | - | The ID of the y axis to plot this dataset on. @@ -121,8 +121,8 @@ The general options for a stacked area dataset can control behaviors not related | normalized | `false` | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | 0 | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | `true` | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. -| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. +| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. +| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. ### Point styling @@ -260,36 +260,36 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int -| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int +| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) ## Data structure -The data of a dataset for a stacked area chart are passed by an array or list of doubles and the x axis is generally a category. When a stacked area chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. +The data of a dataset for a stacked area chart are passed by an array or list of doubles and the x axis is generally a category. When a stacked area chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. ```java // sets data as an array of doubles @@ -305,7 +305,7 @@ dataset.setData(list); ## Options -The stacked area chart specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/StackedLineOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The stacked area chart specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/StackedLineOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. ```java // creates chart diff --git a/docs/charts/StackedBar.md b/docs/charts/StackedBar.md index 95f349b7..50fd6993 100644 --- a/docs/charts/StackedBar.md +++ b/docs/charts/StackedBar.md @@ -44,7 +44,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The stacked bar chart allows a number of properties to be specified for each [stacked bar dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/StackedBarDataset.html). These are used to set display properties for a specific dataset. +The stacked bar chart allows a number of properties to be specified for each [stacked bar dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/StackedBarDataset.html). These are used to set display properties for a specific dataset. Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -70,28 +70,28 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- | base | double - double[] | [Yes](#scriptable) | Base value for the bar in data units along the value axis. -| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) |The fill color/pattern of the bar. +| backgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) |The fill color/pattern of the bar. | barPercentage | double | - | The percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other. | barThickness | int | - | The width of each bar in pixels. -| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The color of the bar border. -| borderSkipped | boolean - [BorderSkipped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderSkipped.html) | [Yes](#scriptable) | Which edge to skip drawing the border for. -| borderRadius | int[] - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html)[] | [Yes](#scriptable) | The bar border radius (in pixels). -| borderWidth | int[] - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html)[] | [Yes](#scriptable) | The stroke width of the bar in pixels. +| borderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The color of the bar border. +| borderSkipped | boolean - [BorderSkipped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderSkipped.html) | [Yes](#scriptable) | Which edge to skip drawing the border for. +| borderRadius | int[] - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html)[] | [Yes](#scriptable) | The bar border radius (in pixels). +| borderWidth | int[] - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html)[] | [Yes](#scriptable) | The stroke width of the bar in pixels. | categoryPercentage | double | - | The percent (0-1) of the available width each category should be within the sample width. -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. When set to 0 means clip at chart area. +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. When set to 0 means clip at chart area. | enableBorderRadius| boolean | - | If `true`, it only shows the border radius of a bar when the bar is at the end of the stack. | grouped | boolean | - | Should the bars be grouped on index axis.
When `true`, all the datasets at same index value will be placed next to each other centering on that index value.
When `false`, each bar is placed on its actual index-axis value. -| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the bars when hovered. -| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The stroke color of the bars when hovered. +| hoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color/pattern of the bars when hovered. +| hoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The stroke color of the bars when hovered. | hoverBorderWidth | int[] | [Yes](#scriptable) | The stroke width of the bars when hovered. -| hoverBorderRadius | int[] - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html)[] | [Yes](#scriptable) | The bar border radius (in pixels) when hovered. +| hoverBorderRadius | int[] - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html)[] | [Yes](#scriptable) | The bar border radius (in pixels) when hovered. | label | String | - | The label for the dataset which appears in the legend and tooltips. | maxBarThickness | int | - | The maximum bar thickness, to ensure that bars are not sized thicker than this. | minBarLength | int | - | Set this to ensure that bars have a minimum length in pixels. | normalized | boolean | - | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | int | - | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | boolean | - | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | [Yes](#scriptable) | Point style for legend. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | [Yes](#scriptable) | Point style for legend. | xAxisID | String | - | The ID of the x axis to plot this dataset on. | yAxisID | String | - | The ID of the y axis to plot this dataset on. @@ -107,8 +107,8 @@ The general options for a stacked bar dataset can control behaviors not related | normalized | `false` | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | 0 | The drawing order of dataset. Also affects order for stacking, tooltips, and legend. | parsing | `true` | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. -| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. +| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. +| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. ### Styling @@ -188,21 +188,21 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| base | [BaseCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BaseCallback.html) | double -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderSkipped | [BorderSkippedCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderSkippedCallback.html) | [BorderSkipped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderSkipped.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) -| borderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html) -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderWidth.html) -| hoverBorderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) +| base | [BaseCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BaseCallback.html) | double +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderSkipped | [BorderSkippedCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderSkippedCallback.html) | [BorderSkipped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderSkipped.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) +| borderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html) +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderWidth | [BarBorderWidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BarBorderWidthCallback.html) | int - [BarBorderWidth](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderWidth.html) +| hoverBorderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) ## Data structure -When the data is an array or list of doubles, the x axis is generally a category. The points are placed onto the axis using their position in the array. When a stacked bar chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. +When the data is an array or list of doubles, the x axis is generally a category. The points are placed onto the axis using their position in the array. When a stacked bar chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. ```java // sets data as an array of doubles @@ -235,7 +235,7 @@ dataset.setFloatingData(fd1, fd2); ## Options -The stacked bar chart specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/StackedBarOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The stacked bar chart specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/StackedBarOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. To set the options at chart level, you can get a typed object accordingly with the chart type. @@ -305,7 +305,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ``` -The stacked horizontal bar allows a number of properties to be specified for each [stacked horizontal bar dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/StackedHorizontalBarDataset.html). These are used to set display properties for a specific dataset. +The stacked horizontal bar allows a number of properties to be specified for each [stacked horizontal bar dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/StackedHorizontalBarDataset.html). These are used to set display properties for a specific dataset. The properties are the same of the [stacked bar dataset](#dataset). diff --git a/docs/charts/StackedLine.md b/docs/charts/StackedLine.md index b7db2898..9103850f 100644 --- a/docs/charts/StackedLine.md +++ b/docs/charts/StackedLine.md @@ -45,7 +45,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The stacked line chart allows a number of properties to be specified for each [stacked line dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/StackedLineDataset.html). These are used to set display properties for a specific dataset. +The stacked line chart allows a number of properties to be specified for each [stacked line dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/StackedLineDataset.html). These are used to set display properties for a specific dataset. Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -70,41 +70,41 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line. -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line. +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line. | borderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | [Yes](#scriptable) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderWidth | int | [Yes](#scriptable) | The width of the line in pixels. -| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | [Yes](#scriptable) | Algorithm used to interpolate a smooth curve from the discrete data points. -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. -| fill | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsFill.html) | [Yes](#scriptable) | How to fill the area under the line. See [Filling modes](../coloring/Colors#filling). -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line, when hovered. -| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line, when hovered. +| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | [Yes](#scriptable) | Algorithm used to interpolate a smooth curve from the discrete data points. +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. +| fill | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsFill.html) | [Yes](#scriptable) | How to fill the area under the line. See [Filling modes](../coloring/Colors#filling). +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line, when hovered. +| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line, when hovered. | hoverBorderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | hoverBorderDashOffset | int | [Yes](#scriptable) | Offset for line dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | hoverBorderWidth | int | [Yes](#scriptable) | The width of the line in pixels, when hovered. | label | String | - | The label for the dataset which appears in the legend and tooltips. | normalized | boolean | - | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | int | - | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | boolean | - | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. -| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. +| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. +| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. | pointBorderWidth | int[] | [Yes](#scriptable) | The width of the point border in pixels. | pointHitRadius | double[] | [Yes](#scriptable) | The pixel size of the non-displayed point that reacts to mouse events. -| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. -| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. +| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. +| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. | pointHoverBorderWidth | int[] | [Yes](#scriptable) | Border width of point when hovered. | pointHoverRadius | double[] | [Yes](#scriptable) | The radius of the point when hovered. | pointRadius | double[] | [Yes](#scriptable) | The radius of the point shape. If set to 0, the point is not rendered. | pointRotation | double[] | [Yes](#scriptable) | The rotation of the point in degrees. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. | showLine | boolean | - | If `false`, the line is not drawn for this dataset. | spanGaps | boolean - double | - | If `true`, lines will be drawn between points with no or null data. If `false`, points with `NaN` data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used. -| stepped | [Stepped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Stepped.html) | - | If the line is shown as a stepped line. +| stepped | [Stepped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Stepped.html) | - | If the line is shown as a stepped line. | tension | double | - | Bezier curve tension of the line. Set to 0 to draw straight lines. This option is ignored if monotone cubic interpolation is used. | xAxisID | String | - | The ID of the x axis to plot this dataset on. | yAxisID | String | - | The ID of the y axis to plot this dataset on. @@ -121,8 +121,8 @@ The general options for a line dataset can control behaviors not related to styl | normalized | `false` | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | 0 | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | `true` | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. -| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. +| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. +| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. ### Point styling @@ -261,37 +261,37 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) -| fill | [FillCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FillCallback.html) | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsFill.html) -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int -| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) +| fill | [FillCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FillCallback.html) | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsFill.html) +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int +| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) ## Data structure -The data of a dataset for a stacked line chart are passed by an array or list of doubles and the x axis is generally a category. When a stacked line chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. +The data of a dataset for a stacked line chart are passed by an array or list of doubles and the x axis is generally a category. When a stacked line chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. ```java // sets data as an array of doubles @@ -307,7 +307,7 @@ dataset.setData(list); ## Options -The stacked line chart specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/StackedLineOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The stacked line chart specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/StackedLineOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. ```java // creates chart @@ -375,7 +375,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ``` -The stacked vertical line chart allows a number of properties to be specified for each [stacked vertical line dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/StackedVerticalLineDataset.html). These are used to set display properties for a specific dataset. +The stacked vertical line chart allows a number of properties to be specified for each [stacked vertical line dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/StackedVerticalLineDataset.html). These are used to set display properties for a specific dataset. The properties are the same of the [stacked line dataset](#dataset). diff --git a/docs/charts/TimeSeries.md b/docs/charts/TimeSeries.md index 0b10a847..67837c93 100644 --- a/docs/charts/TimeSeries.md +++ b/docs/charts/TimeSeries.md @@ -20,7 +20,7 @@ A time series chart have already defined the axes to use ([time series cartesian ## Dataset -The time series charts allow a number of properties to be specified for each time series [line](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/TimeSeriesLineDataset.html) or [bar](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/TimeSeriesBarDataset.html) datasets which are implementing the same properties of line and bar ones. +The time series charts allow a number of properties to be specified for each time series [line](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/TimeSeriesLineDataset.html) or [bar](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/TimeSeriesBarDataset.html) datasets which are implementing the same properties of line and bar ones. See **[line dataset](ChartLine#dataset)** or **[bar dataset](ChartBar#dataset)** configuration how to configure the time series dataset, because no additional options are defined. @@ -50,7 +50,7 @@ Even if the methods to load data by these methods are not hidden, you can NOT us #### Data as TimeSeriesItems -A [time series item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/TimeSeriesItem.html) is a wrapper to the data points in order to simplify how to set data in a time series chart. +A [time series item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/TimeSeriesItem.html) is a wrapper to the data points in order to simplify how to set data in a time series chart. The chart instance will sort automatically the time series items by date in ascending mode (as required). @@ -100,7 +100,7 @@ chart.getData().setDatasets(dataset); ## Options -The time series chart defines specific options implementation of [line](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/TimeSeriesLineOptions.html) or [bar](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/TimeSeriesBarOptions.html) to be configured. +The time series chart defines specific options implementation of [line](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/TimeSeriesLineOptions.html) or [bar](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/TimeSeriesBarOptions.html) to be configured. See **[line chart](ChartLine#options)** or **[bar chart](ChartBar#options)** options how to configure the time series chart, because no additional options are defined. @@ -175,25 +175,25 @@ These are the options specific to line charts: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<SegmentContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<SegmentContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<SegmentContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<SegmentContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<SegmentContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<SegmentContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<SegmentContext> | int +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<SegmentContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<SegmentContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<SegmentContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<SegmentContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<SegmentContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<SegmentContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<SegmentContext> | int -The callbacks are getting the only 1 argument, the [segment context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SegmentContext.html) which contains the context of the callback execution. +The callbacks are getting the only 1 argument, the [segment context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SegmentContext.html) which contains the context of the callback execution. The context object contains the following properties: | Name | Type | Description | :- | :- | :- -| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. -| chart | [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) | Chart instance. +| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. +| chart | [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) | Chart instance. | datasetIndex | int | The index of the dataset. | endDataIndex | int | The index of second point in the data. -| endPoint | [PointElement](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PointElement.html) | The line element for the end point of the segment. +| endPoint | [PointElement](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PointElement.html) | The line element for the end point of the segment. | startDataIndex | int | The index of first point in the data. -| startPoint | [PointElement](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PointElement.html) | The line element for the start point of the segment. -| type | [ContextType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.SEGMENT`. +| startPoint | [PointElement](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PointElement.html) | The line element for the start point of the segment. +| type | [ContextType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.SEGMENT`. diff --git a/docs/charts/TreeMap.md b/docs/charts/TreeMap.md index 330790bf..4d08ec1e 100644 --- a/docs/charts/TreeMap.md +++ b/docs/charts/TreeMap.md @@ -72,7 +72,7 @@ defaultOptions.setBorderColor(HtmlColor.RED); ## Dataset -The treemap chart allows to define the data and a number of properties, used to display the data, by a [treemap dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/TreeMapDataset.html). +The treemap chart allows to define the data and a number of properties, used to display the data, by a [treemap dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/TreeMapDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -97,19 +97,19 @@ The following are the attributes that you can set: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | [Yes](#scriptable) |The fill color/pattern of the treemap element. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | [Yes](#scriptable) | The color of the treemap element border. -| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) | 0 | [Yes](#scriptable) | The radius of the rectangle of treemap element (in pixels). +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | [Yes](#scriptable) |The fill color/pattern of the treemap element. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | [Yes](#scriptable) | The color of the treemap element border. +| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) | 0 | [Yes](#scriptable) | The radius of the rectangle of treemap element (in pixels). | borderWidth | int | 0 | - | The stroke width of the treemap element in pixels. -| groups | String[] - [Key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/Key.html)[] | | - | Set the properties names of the tree object to group by the data. -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | [Yes](#scriptable) | The fill color/pattern of the treemap elements when hovered. -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | [Yes](#scriptable) | The stroke color of the treemap elements when hovered. +| groups | String[] - [Key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/Key.html)[] | | - | Set the properties names of the tree object to group by the data. +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | [Yes](#scriptable) | The fill color/pattern of the treemap elements when hovered. +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | [Yes](#scriptable) | The stroke color of the treemap elements when hovered. | hoverBorderWidth | int | 0 | - | The stroke width of the treemap elements when hovered. -| key | String - [Key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/Key.html) | `null` | - | Set the property name of the tree object to use to get the value of the data. +| key | String - [Key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/Key.html) | `null` | - | Set the property name of the tree object to use to get the value of the data. | rtl | boolean | `false` | - | Set `true` for rendering the treemap elements from right to left. | spacing | double | 0.5 | - | Fixed distance between all treemap elements. -| sumKeys | String[] - [Key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/Key.html)[] | | - | Set the properties names of the tree object to define multiple keys to add additional sums, on top of the `key` one. -| treeLeafKey | String - [Key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/Key.html) | `"_leaf"` | - | The name of the key where the object key of leaf node of tree object is stored. Used only when tree is an object, as hierarchical data. +| sumKeys | String[] - [Key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/Key.html)[] | | - | Set the properties names of the tree object to define multiple keys to add additional sums, on top of the `key` one. +| treeLeafKey | String - [Key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/Key.html) | `"_leaf"` | - | The name of the key where the object key of leaf node of tree object is stored. Used only when tree is an object, as hierarchical data. ### Scriptable @@ -135,11 +135,11 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<DatasetContext> | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) ### Labels @@ -164,16 +164,16 @@ The following are the attributes that you can set: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| align | [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/enums/Align.html) | Align.LEFT | [Yes](#label-options-scriptable) | Specifies the text horizontal alignment used when drawing the label. -| [color](#fonts-and-colors) | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | HtmlColor.TRANSPARENT | [Yes](#label-options-scriptable) | Color of label.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| align | [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/enums/Align.html) | Align.LEFT | [Yes](#label-options-scriptable) | Specifies the text horizontal alignment used when drawing the label. +| [color](#fonts-and-colors) | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | HtmlColor.TRANSPARENT | [Yes](#label-options-scriptable) | Color of label.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | display | boolean | `false` | - | If `true`, the labels will be applied to the elements. -| [font](#fonts-and-colors) | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) - List<[FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)> - [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)[] | `Defaults.get().getGlobal()`
`.getFont()` | [Yes](#label-options-scriptable) | Font of text of label.
See [Font](../defaults/DefaultsCharts#font). -| formatter | [FormatterCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/callbacks/FormatterCallback.html) | `null` | [Yes](#label-formatter) | Scriptable options to enable custom formatting for the label text to show. -| [hoverColor](#fonts-and-colors) | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | HtmlColor.TRANSPARENT` | [Yes](#label-options-scriptable) | Color of label, when hovered.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| [hoverFont](#fonts-and-colors) | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) - List<[FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)> - [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)[] | `Defaults.get().getGlobal()`
`.getFont()` | [Yes](#label-options-scriptable) | Font of text of label, when hovered.
See [Font](../defaults/DefaultsCharts#font). -| overflow | [Overflow](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/enums/Overflow.html) | Overflow.CUT | [Yes](#label-options-scriptable) | The overflow property controls what happens to a label that is too big to fit into a rectangle. +| [font](#fonts-and-colors) | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) - List<[FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)> - [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)[] | `Defaults.get().getGlobal()`
`.getFont()` | [Yes](#label-options-scriptable) | Font of text of label.
See [Font](../defaults/DefaultsCharts#font). +| formatter | [FormatterCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/callbacks/FormatterCallback.html) | `null` | [Yes](#label-formatter) | Scriptable options to enable custom formatting for the label text to show. +| [hoverColor](#fonts-and-colors) | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | HtmlColor.TRANSPARENT` | [Yes](#label-options-scriptable) | Color of label, when hovered.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| [hoverFont](#fonts-and-colors) | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) - List<[FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)> - [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)[] | `Defaults.get().getGlobal()`
`.getFont()` | [Yes](#label-options-scriptable) | Font of text of label, when hovered.
See [Font](../defaults/DefaultsCharts#font). +| overflow | [Overflow](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/enums/Overflow.html) | Overflow.CUT | [Yes](#label-options-scriptable) | The overflow property controls what happens to a label that is too big to fit into a rectangle. | padding | int | 3 | - | Specifies the space, in pixels, to apply around labels. -| position | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/enums/Position.html) | Position.MIDDLE | [Yes](#label-options-scriptable) | Specifies the text vertical alignment used when drawing the label. +| position | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/enums/Position.html) | Position.MIDDLE | [Yes](#label-options-scriptable) | Specifies the text vertical alignment used when drawing the label. #### Fonts and colors @@ -203,19 +203,19 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| align | [AlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/callbacks/AlignCallback.html) | [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/enums/Align.html) -| color | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html))<DatasetContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| font | [FontsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontsCallback.html)<DatasetContext> | List<[FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)> -| hoverColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html))<DatasetContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| hoverFont | [FontsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontsCallback.html)<DatasetContext> | List<[FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)> -| overflow | [OverflowCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/callbacks/OverflowCallback.html) | [Overflow](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/enums/Overflow.html) -| position | [PositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/callbacks/PositionCallback.html) | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/enums/Position.html) +| align | [AlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/callbacks/AlignCallback.html) | [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/enums/Align.html) +| color | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html))<DatasetContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| font | [FontsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontsCallback.html)<DatasetContext> | List<[FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)> +| hoverColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html))<DatasetContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| hoverFont | [FontsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontsCallback.html)<DatasetContext> | List<[FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)> +| overflow | [OverflowCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/callbacks/OverflowCallback.html) | [Overflow](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/enums/Overflow.html) +| position | [PositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/callbacks/PositionCallback.html) | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/enums/Position.html) #### Label Formatter Data values are converted to string. If values are grouped, the value of the group and the value (as string) are shown. -This default behavior can be overridden by the `formatter` which is a [FormatterCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/callbacks/FormatterCallback.html). +This default behavior can be overridden by the `formatter` which is a [FormatterCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/callbacks/FormatterCallback.html). A `formatter` can return a string (for a single line) or a list of strings (for multiple lines, where each item represents a new line). @@ -256,13 +256,13 @@ The following are the attributes that you can set: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| align | [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/enums/Align.html) | Align.LEFT | [Yes](#caption-options-scriptable) | Specifies the text horizontal alignment used when drawing the caption. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#caption-options-scriptable) | Color of caption.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| align | [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/enums/Align.html) | Align.LEFT | [Yes](#caption-options-scriptable) | Specifies the text horizontal alignment used when drawing the caption. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#caption-options-scriptable) | Color of caption.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | display | boolean | `true` | - | If `true`, the captions will be applied to the elements. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | `Defaults.get().getGlobal()`
`.getFont()` | [Yes](#caption-options-scriptable) | Font of text of caption.
See [Font](../defaults/DefaultsCharts#font). -| formatter | [FormatterCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/callbacks/FormatterCallback.html) | `null` | [Yes](#caption-formatter) | Scriptable options to enable custom formatting for the caption text to show. -| hoverColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT` | [Yes](#caption-options-scriptable) | Color of caption, when hovered.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| hoverFont | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | `Defaults.get().getGlobal()`
`.getFont()` | [Yes](#caption-options-scriptable) | Font of text of caption, when hovered.
See [Font](../defaults/DefaultsCharts#font). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | `Defaults.get().getGlobal()`
`.getFont()` | [Yes](#caption-options-scriptable) | Font of text of caption.
See [Font](../defaults/DefaultsCharts#font). +| formatter | [FormatterCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/callbacks/FormatterCallback.html) | `null` | [Yes](#caption-formatter) | Scriptable options to enable custom formatting for the caption text to show. +| hoverColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT` | [Yes](#caption-options-scriptable) | Color of caption, when hovered.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| hoverFont | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | `Defaults.get().getGlobal()`
`.getFont()` | [Yes](#caption-options-scriptable) | Font of text of caption, when hovered.
See [Font](../defaults/DefaultsCharts#font). | padding | int | 3 | - | Specifies the space, in pixels, to apply around captions. #### Caption options scriptable @@ -289,18 +289,18 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| align | [AlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/callbacks/AlignCallback.html) | [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/enums/Align.html) -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<DatasetContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| hoverColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| hoverFont | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<DatasetContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) +| align | [AlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/callbacks/AlignCallback.html) | [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/enums/Align.html) +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<DatasetContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| hoverColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| hoverFont | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<DatasetContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) #### Caption Formatter If values are grouped, the value of the group is shown in the chart as caption for all elements belonging to the group. -This default behavior can be overridden by the `formatter` which is a [FormatterCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/callbacks/FormatterCallback.html). +This default behavior can be overridden by the `formatter` which is a [FormatterCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/callbacks/FormatterCallback.html). A `formatter` can return a string which represents the label text. @@ -345,8 +345,8 @@ The following are the attributes that you can set: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- | display | boolean | `false` | - | If `true`, the labels will be applied to the elements. -| lineCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT | - | Cap style of the divider line.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| lineColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.BLACK -          | - | The color of the divider line. +| lineCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT | - | Cap style of the divider line.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| lineColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.BLACK -          | - | The color of the divider line. | lineDash | int[] | [] | - | Length and spacing of dashes of the line.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | lineDashOffset | double | 0 | - | Offset for line dashes of the line.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). | lineWidth | int | 1 | - | The stroke width of the line, in pixels. @@ -358,7 +358,7 @@ The data of a dataset for a treemap chart can be passed in two formats. The data :::caution The `setData` and `setDataPoints` methods are available, inherited by the bar dataset, but you can **NOT** use them otherwise an exception will throw.
Use `setTree`, `setTreeObjects`, `setTreeObject` or `setTreeNativeObject` instead. -The `getDataPoints` methods is available and can provide a list of [TreeMapDataPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/TreeMapDataPoint.html). +The `getDataPoints` methods is available and can provide a list of [TreeMapDataPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/TreeMapDataPoint.html). ::: #### Data as doubles @@ -440,7 +440,7 @@ dataset.setGroups(Property.REGION, Property.DIVISION, Property.CODE); ## Options -The treemap chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/treemap/TreeMapOptions.html) to be configured. +The treemap chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/treemap/TreeMapOptions.html) to be configured. ```java // creates the chart diff --git a/docs/charts/VerticalLine.md b/docs/charts/VerticalLine.md index 0e0dcfe1..ce1ab17c 100644 --- a/docs/charts/VerticalLine.md +++ b/docs/charts/VerticalLine.md @@ -44,7 +44,7 @@ By [UIBinder](http://www.gwtproject.org/doc/latest/DevGuideUiBinder.html) (**ONL ## Dataset -The vertical line chart allows to define the data and a number of properties, used to display the data, by a [vertical line dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/VerticalLineDataset.html). +The vertical line chart allows to define the data and a number of properties, used to display the data, by a [vertical line dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/VerticalLineDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -69,42 +69,42 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line. -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line. +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line. | borderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | [Yes](#scriptable) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderWidth | int | [Yes](#scriptable) | The width of the line in pixels. -| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | [Yes](#scriptable) | Algorithm used to interpolate a smooth curve from the discrete data points. -| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. +| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | [Yes](#scriptable) | Algorithm used to interpolate a smooth curve from the discrete data points. +| clip | boolean - double - [Clip](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Clip.html) | - | How to clip relative to chart area. Positive value allows overflow, negative value clips that many pixels inside chart area. | drawActiveElementsOnTop | boolean | [Yes](#scriptable) | Draw the active points of a dataset over the other points of the dataset. -| fill | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsFill.html) | [Yes](#scriptable) | How to fill the area under the line. See [Filling modes](../coloring/Colors#filling). -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line, when hovered. -| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line, when hovered. +| fill | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsFill.html) | [Yes](#scriptable) | How to fill the area under the line. See [Filling modes](../coloring/Colors#filling). +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The fill color/pattern under the line, when hovered. +| hoverBorderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#scriptable) | Cap style of the line, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | [Yes](#scriptable) | The color of the line, when hovered. | hoverBorderDash | int[] | [Yes](#scriptable) | Length and spacing of dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | hoverBorderDashOffset | int | [Yes](#scriptable) | Offset for line dashes, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#scriptable) | Line joint style, when hovered. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | hoverBorderWidth | int | [Yes](#scriptable) | The width of the line in pixels, when hovered. | label | String | - | The label for the dataset which appears in the legend and tooltips. | normalized | boolean | - | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | int | - | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | boolean | - | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. -| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. +| pointBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The fill color for points. +| pointBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | The border color for points. | pointBorderWidth | int[] | [Yes](#scriptable) | The width of the point border in pixels. | pointHitRadius | double[] | [Yes](#scriptable) | The pixel size of the non-displayed point that reacts to mouse events. -| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. -| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. +| pointHoverBackgroundColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point background color when hovered. +| pointHoverBorderColor | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html)[] | [Yes](#scriptable) | Point border color when hovered. | pointHoverBorderWidth | int[] | [Yes](#scriptable) | Border width of point when hovered. | pointHoverRadius | double[] | [Yes](#scriptable) | The radius of the point when hovered. | pointRadius | double[] | [Yes](#scriptable) | The radius of the point shape. If set to 0, the point is not rendered. | pointRotation | double[] | [Yes](#scriptable) | The rotation of the point in degrees. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html)[] - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)[] - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html)[] | [Yes](#scriptable) | Style of the point. | showLine | boolean | - | If `false`, the line is not drawn for this dataset. | spanGaps | boolean - double | - | If `true`, lines will be drawn between points with no or null data. If `false`, points with `NaN` data will create a break in the line. Can also be a number specifying the maximum gap length to span. The unit of the value depends on the scale used. -| stepped | [Stepped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Stepped.html) | - | If the line is shown as a stepped line. +| stepped | [Stepped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Stepped.html) | - | If the line is shown as a stepped line. | tension | double | - | Bezier curve tension of the line. Set to 0 to draw straight lines. This option is ignored if monotone cubic interpolation is used. | xAxisID | String | - | The ID of the x axis to plot this dataset on. | yAxisID | String | - | The ID of the y axis to plot this dataset on. @@ -121,8 +121,8 @@ The general options for a vertical line dataset can control behaviors not relate | normalized | `false` | If `true`, you provide data with indices that are unique, sorted, and consistent across data sets and provide the normalized. | order | 0 | The drawing order of dataset. Also affects order for stacking, tooltip, and legend. | parsing | `true` | If `false`, the data set parsing is disable. If parsing is disabled, data must be sorted and in the formats the associated chart type and scales use internally. -| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. -| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. +| xAxisID | [DefaultScaleId.X](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the x axis to plot this dataset on. +| yAxisID | [DefaultScaleId.Y](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultScaleId.html) | The ID of the y axis to plot this dataset on. ### Point styling @@ -261,34 +261,34 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) -| drawActiveElementsOnTop | [DrawActiveElementsOnTopCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DrawActiveElementsOnTopCallback.html) | boolean -| fill | [FillCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FillCallback.html) | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsFill.html) -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int -| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) +| drawActiveElementsOnTop | [DrawActiveElementsOnTopCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DrawActiveElementsOnTopCallback.html) | boolean +| fill | [FillCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FillCallback.html) | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsFill.html) +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| hoverBorderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | int +| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointHoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| pointHoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| pointHoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointRotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) ## Data structure @@ -296,7 +296,7 @@ The data of a dataset for a line chart can be passed in three formats. #### Data as doubles -When the data is an array or list of doubles, the x axis is generally a category. The points are placed onto the axis using their position in the array. When a line chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. +When the data is an array or list of doubles, the x axis is generally a category. The points are placed onto the axis using their position in the array. When a line chart is created with a category axis, the [labels property of the data object](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Data.html#setLabels-java.lang.String...-) must be specified. ```java // sets data as an array of doubles @@ -329,7 +329,7 @@ dataset.setDataPoint(dp1, dp2); ## Options -The line chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/LineOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. +The line chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/LineOptions.html) to be configured. These options are merged with the global chart configuration options to form the options passed to the chart. ```java // creates chart @@ -389,25 +389,25 @@ These are the options specific to line charts: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<SegmentContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<SegmentContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<SegmentContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<SegmentContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<SegmentContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<SegmentContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<SegmentContext> | int +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<SegmentContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<SegmentContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<SegmentContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<SegmentContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<SegmentContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<SegmentContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<SegmentContext> | int -The callbacks are getting the only 1 argument, the [segment context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SegmentContext.html) which contains the context of the callback execution. +The callbacks are getting the only 1 argument, the [segment context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SegmentContext.html) which contains the context of the callback execution. The context object contains the following properties: | Name | Type | Description | :- | :- | :- -| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. -| chart | [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) | Chart instance. +| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. +| chart | [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) | Chart instance. | datasetIndex | int | The index of the dataset. | endDataIndex | int | The index of second point in the data. -| endPoint | [PointElement](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PointElement.html) | The line element for the end point of the segment. +| endPoint | [PointElement](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PointElement.html) | The line element for the end point of the segment. | startDataIndex | int | The index of first point in the data. -| startPoint | [PointElement](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PointElement.html) | The line element for the start point of the segment. -| type | [ContextType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.SEGMENT`. +| startPoint | [PointElement](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PointElement.html) | The line element for the start point of the segment. +| type | [ContextType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.SEGMENT`. diff --git a/docs/charts/geo/BubbleMap.md b/docs/charts/geo/BubbleMap.md index fbb4fed0..947b3c13 100644 --- a/docs/charts/geo/BubbleMap.md +++ b/docs/charts/geo/BubbleMap.md @@ -63,7 +63,7 @@ defaultOptions.setOutlineBorderColor(HtmlColor.RED); ## Dataset -The bubble map chart allows to define the data and a number of properties, used to display the data, by a [bubble map dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/BubbleMapDataset.html). +The bubble map chart allows to define the data and a number of properties, used to display the data, by a [bubble map dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/BubbleMapDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -90,23 +90,23 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| clipMap | boolean - [ClipMap](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/ClipMap.html)| ClipMap.TRUE | Whether to clip the rendering to the chart area of the graph or to another area. -| outline | [Feature](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Feature.html)[] | [] | The features used to scale and centralize the projection in the chart area. -| showGraticule | boolean - [Graticule](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Graticule.html) | `false` | If enabled it by `true` or graticule object instance, it renders the lines in the background. +| clipMap | boolean - [ClipMap](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/ClipMap.html)| ClipMap.TRUE | Whether to clip the rendering to the chart area of the graph or to another area. +| outline | [Feature](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Feature.html)[] | [] | The features used to scale and centralize the projection in the chart area. +| showGraticule | boolean - [Graticule](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Graticule.html) | `false` | If enabled it by `true` or graticule object instance, it renders the lines in the background. | showOutline | boolean | `false` | If `true` to render the outline in the background ### Styling The style of the dataset can be configured by a [Point](../../configuration/Elements#point) element. -The style for the geografical configuration of the dataset can be configured by [`geoFeature` element](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/GeoFeature.html), as following: +The style for the geografical configuration of the dataset can be configured by [`geoFeature` element](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/GeoFeature.html), as following: | Name | Type | Default | Description | :- | :- | :- | :- -| graticuleBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgb(204,204,204) -          | The graticule border color. +| graticuleBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgb(204,204,204) -          | The graticule border color. | graticuleBorderWidth | int | 0 | The outline border width. -| outlineBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `null` | The outline background color. -| outlineBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | The outline border color. +| outlineBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `null` | The outline background color. +| outlineBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | The outline border color. | outlineBorderWidth | int | 0 | The outline border width. ```java @@ -122,7 +122,7 @@ geoElement.setGraticuleBorderColor(HtmlColor.RED); Bubble map dataset needs to contain a data array of points, each data point has to contain the latitude and longitude of the point to render and containing the value for the coloring. -Bubble map data points are mapped by [ChoroplethDataPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/BubbleMapDataPoint.html). +Bubble map data points are mapped by [ChoroplethDataPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/BubbleMapDataPoint.html). ```java // creates data points container @@ -141,7 +141,7 @@ The `setData` and `setDataPoints` methods are available, inherited by the bubble ## Options -The bubble map chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/BubbleMapOptions.html) to be configured. +The bubble map chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/BubbleMapOptions.html) to be configured. ```java // creates the chart @@ -173,9 +173,9 @@ These are the options specific to bubble map charts: | Name | Type | Default | Description | :- | :- | :- | :- -| clipMap | boolean - [ClipMap](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/ClipMap.html)| ClipMap.OUTLINE_GRATICULE | Whether to clip the rendering to the chart area of the graph or to another area. -| outline | [Feature](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Feature.html)[] | empty list | The features used to scale and centralize the projection in the chart area. -| showGraticule | boolean - [Graticule](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Graticule.html) | `false` | If enabled it by `true` or graticule object instance, it renders the lines in the background. +| clipMap | boolean - [ClipMap](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/ClipMap.html)| ClipMap.OUTLINE_GRATICULE | Whether to clip the rendering to the chart area of the graph or to another area. +| outline | [Feature](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Feature.html)[] | empty list | The features used to scale and centralize the projection in the chart area. +| showGraticule | boolean - [Graticule](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Graticule.html) | `false` | If enabled it by `true` or graticule object instance, it renders the lines in the background. | showOutline | boolean | `false` | If `true` to render the outline in the background :::info @@ -191,7 +191,7 @@ A bubble map chart can have maximum 2 scales, of the following types: ### Projection axis -A [Projection axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/ProjectionAxis.html) is managing the map projection. +A [Projection axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/ProjectionAxis.html) is managing the map projection. A map projection is a way to flatten a globe's surface into a plane in order to make a map. @@ -228,8 +228,8 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | 0 to all dimensions | Sets padding applied during auto scaling of the map in pixels, i.e. the chart size is reduce by the padding before fitting the map. -| projection | [Projection](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Projection.html) | Projection.ALBERS_USA | The map projection which is a way to flatten a globe's surface into a plane in order to make a map +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | 0 to all dimensions | Sets padding applied during auto scaling of the map in pixels, i.e. the chart size is reduce by the padding before fitting the map. +| projection | [Projection](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Projection.html) | Projection.ALBERS_USA | The map projection which is a way to flatten a globe's surface into a plane in order to make a map | projectionOffset | [double, double] | [] | The map projection offset value. | projectionScale | double | Undefined.DOUBLE | How much the map will be scaled. @@ -239,8 +239,8 @@ A size axis is used to map the values to symbol radius size. There are 2 axis types to map the values to symbol radius size: - * [Size axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/SizeAxis.html) which extends the [cartesian linear axis](../../axes/CartesianLinearAxes) to repesent numbers. - * [Size logarithmic axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/SizeLogarithmicAxis.html) which extends the [cartesian logarithmic axis](../../axes/CartesianLogarithmicAxes) to represent number by logarithmic base. + * [Size axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/SizeAxis.html) which extends the [cartesian linear axis](../../axes/CartesianLinearAxes) to repesent numbers. + * [Size logarithmic axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/SizeLogarithmicAxis.html) which extends the [cartesian logarithmic axis](../../axes/CartesianLogarithmicAxes) to represent number by logarithmic base. Here is an example how to create a size axis: @@ -272,7 +272,7 @@ The following are the attributes that you can set: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| mode | [Mode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Mode.html) | Mode.AREA | [Yes](#scriptable) | The operation modes for the scale, area means that the area is linearly increasing whereas radius the radius is. +| mode | [Mode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Mode.html) | Mode.AREA | [Yes](#scriptable) | The operation modes for the scale, area means that the area is linearly increasing whereas radius the radius is. | missingRadius | double | 1 | [Yes](#scriptable) | The radius of the points to use the data is missing. | range | [int, int] | [2, 20] | [Yes](#scriptable) | The radius range in pixel, the minimal data value will be mapped to the first entry, the maximal one to the second and a linear interpolation for all values in between. @@ -293,11 +293,11 @@ The following are the attributes that you can set: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| align | [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Align.html) | Align.RIGHT | [Yes](#scriptable) | The alignment of the legend on the chart area. +| align | [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Align.html) | Align.RIGHT | [Yes](#scriptable) | The alignment of the legend on the chart area. | indicatorWidth | int | 10 | [Yes](#scriptable) | how many pixels should be used for the color bar. | length | int | 100 | [Yes](#scriptable) | The length of the legend, in terms of value. | margin | int | 8 | [Yes](#scriptable) | The margin pixels such that it doesn't stick to the edge of the chart. -| position | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Position.html) - [PositionPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/PositionPoint.html) | Position.BOTTOM_RIGHT | [Yes](#scriptable) | The location of the legend on the chart area. +| position | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Position.html) - [PositionPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/PositionPoint.html) | Position.BOTTOM_RIGHT | [Yes](#scriptable) | The location of the legend on the chart area. | width | int | 50 | [Yes](#scriptable) | How wide the scale is.
For a horizontal scale the height if a value less than 1 is given, is it assume to be a ratio of the corresponding chart area. #### Scriptable @@ -322,12 +322,12 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| mode | [ModeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/callbacks/ModeCallback.html) | [Mode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Mode.html) -| missingRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<ScaleContext> | double -| range | [RangeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/callbacks/RangeCallback.html) | List<Integer> -| align | [AlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/callbacks/AlignCallback.html) | [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Align.html) -| indicatorWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int -| length | [LengthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/callbacks/LengthCallback.html) | int -| margin | [MarginCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/callbacks/MarginCallback.html) | int - [Margin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Margin.html) -| position | [PositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/callbacks/PositionCallback.html) | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Position.html) - [PositionPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/PositionPoint.html) -| width | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| mode | [ModeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/callbacks/ModeCallback.html) | [Mode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Mode.html) +| missingRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<ScaleContext> | double +| range | [RangeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/callbacks/RangeCallback.html) | List<Integer> +| align | [AlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/callbacks/AlignCallback.html) | [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Align.html) +| indicatorWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| length | [LengthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/callbacks/LengthCallback.html) | int +| margin | [MarginCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/callbacks/MarginCallback.html) | int - [Margin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Margin.html) +| position | [PositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/callbacks/PositionCallback.html) | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Position.html) - [PositionPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/PositionPoint.html) +| width | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int diff --git a/docs/charts/geo/Choropleth.md b/docs/charts/geo/Choropleth.md index 0be81bee..0daad063 100644 --- a/docs/charts/geo/Choropleth.md +++ b/docs/charts/geo/Choropleth.md @@ -63,7 +63,7 @@ defaultOptions.setOutlineBorderColor(HtmlColor.RED); ## Dataset -The choropleth chart allows to define the data and a number of properties, used to display the data, by a [choropleth dataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/ChoroplethDataset.html). +The choropleth chart allows to define the data and a number of properties, used to display the data, by a [choropleth dataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/ChoroplethDataset.html). Every chart has got a method to create a typed dataset accordingly with the chart type. The dataset can be also created instantiating the constructor. @@ -88,21 +88,21 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| clipMap | boolean - [ClipMap](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/ClipMap.html)| ClipMap.TRUE | Whether to clip the rendering to the chart area of the graph or to another area. -| outline | [Feature](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Feature.html)[] | [] | The features used to scale and centralize the projection in the chart area. -| showGraticule | boolean - [Graticule](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Graticule.html) | `false` | If enabled it by `true` or graticule object instance, it renders the lines in the background. +| clipMap | boolean - [ClipMap](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/ClipMap.html)| ClipMap.TRUE | Whether to clip the rendering to the chart area of the graph or to another area. +| outline | [Feature](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Feature.html)[] | [] | The features used to scale and centralize the projection in the chart area. +| showGraticule | boolean - [Graticule](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Graticule.html) | `false` | If enabled it by `true` or graticule object instance, it renders the lines in the background. | showOutline | boolean | `false` | If `true` to render the outline in the background ### Styling -The style of the dataset can be configured by [`geoFeature` element](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/GeoFeature.html), which extends a [Bar](../../configuration/Elements#bar) elements, as following: +The style of the dataset can be configured by [`geoFeature` element](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/GeoFeature.html), which extends a [Bar](../../configuration/Elements#bar) elements, as following: | Name | Type | Default | Description | :- | :- | :- | :- -| graticuleBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgb(204,204,204) -          | The graticule border color. +| graticuleBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgb(204,204,204) -          | The graticule border color. | graticuleBorderWidth | int | 0 | The outline border width. -| outlineBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `null` | The outline background color. -| outlineBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | The outline border color. +| outlineBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `null` | The outline background color. +| outlineBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | The outline border color. | outlineBorderWidth | int | 0 | The outline border width. ```java @@ -116,9 +116,9 @@ geoElement.setGraticuleBorderColor(HtmlColor.RED); ## Data structure -Choropleth dataset needs to contain a data array of points, each data point has to contain the [Feature](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Feature.html) to render and containing the value for the coloring. +Choropleth dataset needs to contain a data array of points, each data point has to contain the [Feature](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Feature.html) to render and containing the value for the coloring. -Choropleth data points are mapped by [ChoroplethDataPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/ChoroplethDataPoint.html). +Choropleth data points are mapped by [ChoroplethDataPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/ChoroplethDataPoint.html). ```java // gets the topoJSON map as string @@ -147,7 +147,7 @@ The `setData` and `setDataPoints` methods are available, inherited by the bar da ## Options -The choropleth chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/ChoroplethOptions.html) to be configured. +The choropleth chart defines specific [options implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/ChoroplethOptions.html) to be configured. ```java // creates the chart @@ -180,9 +180,9 @@ These are the options specific to choropleth charts: | Name | Type | Default | Description | :- | :- | :- | :- -| clipMap | boolean - [ClipMap](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/ClipMap.html)| ClipMap.TRUE | Whether to clip the rendering to the chart area of the graph or to another area. -| outline | [Feature](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Feature.html)[] | empty list | The features used to scale and centralize the projection in the chart area. -| showGraticule | boolean - [Graticule](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Graticule.html) | `false` | If enabled it by `true` or graticule object instance, it renders the lines in the background. +| clipMap | boolean - [ClipMap](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/ClipMap.html)| ClipMap.TRUE | Whether to clip the rendering to the chart area of the graph or to another area. +| outline | [Feature](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Feature.html)[] | empty list | The features used to scale and centralize the projection in the chart area. +| showGraticule | boolean - [Graticule](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Graticule.html) | `false` | If enabled it by `true` or graticule object instance, it renders the lines in the background. | showOutline | boolean | `false` | If `true` to render the outline in the background :::info @@ -198,7 +198,7 @@ A choropleth chart can have maximum 2 scales, of the following types: ### Projection axis -A [Projection axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/ProjectionAxis.html) is managing the map projection. +A [Projection axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/ProjectionAxis.html) is managing the map projection. A map projection is a way to flatten a globe's surface into a plane in order to make a map. @@ -235,8 +235,8 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | 0 to all dimensions | Sets padding applied during auto scaling of the map in pixels, i.e. the chart size is reduce by the padding before fitting the map. -| projection | [Projection](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Projection.html) | Projection.ALBERS_USA | The map projection which is a way to flatten a globe's surface into a plane in order to make a map +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | 0 to all dimensions | Sets padding applied during auto scaling of the map in pixels, i.e. the chart size is reduce by the padding before fitting the map. +| projection | [Projection](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Projection.html) | Projection.ALBERS_USA | The map projection which is a way to flatten a globe's surface into a plane in order to make a map | projectionOffset | [double, double] | [] | The map projection offset value. | projectionScale | double | Undefined.DOUBLE | How much the map will be scaled. @@ -250,8 +250,8 @@ A color axis manages how the map must be colored providing also a legend to see There are 2 axis types for coloring the nodes: - * [Color axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/ColorAxis.html) which extends the [cartesian linear axis](../../axes/CartesianLinearAxes) to repesent numbers. - * [Color logarithmic axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/ColorLogarithmicAxis.html) which extends the [cartesian logarithmic axis](../../axes/CartesianLogarithmicAxes) to represent number by logarithmic base. + * [Color axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/ColorAxis.html) which extends the [cartesian linear axis](../../axes/CartesianLinearAxes) to repesent numbers. + * [Color logarithmic axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/ColorLogarithmicAxis.html) which extends the [cartesian logarithmic axis](../../axes/CartesianLogarithmicAxes) to represent number by logarithmic base. Here is an example how to create a color axis: @@ -283,8 +283,8 @@ The following are the attributes that you can set: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| interpolate | [Interpolate](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Interpolate.html) | Interpolate.BLUES | [Yes](#scriptable) | The color interpolation of the scale. -| missingColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#scriptable) | The color to use the data is missing. +| interpolate | [Interpolate](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Interpolate.html) | Interpolate.BLUES | [Yes](#scriptable) | The color interpolation of the scale. +| missingColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#scriptable) | The color to use the data is missing. | quantize | int | 0 | [Yes](#scriptable) | The amount of pieces to allow to split the color scale in N quantized equal bin. #### Interpolate callback @@ -293,7 +293,7 @@ You can set the color interpolation of the scale at runtime, providing different -The interpolate property can be set as [scriptable option](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/callbacks/InterpolateCallback.html), as following: +The interpolate property can be set as [scriptable option](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/callbacks/InterpolateCallback.html), as following: ```java // uses the color list of tableau color scheme @@ -336,11 +336,11 @@ The following are the attributes that you can set: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| align | [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Align.html) | Align.RIGHT | [Yes](#scriptable) | The alignment of the legend on the chart area. +| align | [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Align.html) | Align.RIGHT | [Yes](#scriptable) | The alignment of the legend on the chart area. | indicatorWidth | int | 10 | [Yes](#scriptable) | how many pixels should be used for the color bar. | length | int | 100 | [Yes](#scriptable) | The length of the legend, in terms of value. | margin | int | 8 | [Yes](#scriptable) | The margin pixels such that it doesn't stick to the edge of the chart. -| position | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Position.html) - [PositionPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/PositionPoint.html) | Position.BOTTOM_RIGHT | [Yes](#scriptable) | The location of the legend on the chart area. +| position | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Position.html) - [PositionPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/PositionPoint.html) | Position.BOTTOM_RIGHT | [Yes](#scriptable) | The location of the legend on the chart area. | width | int | 50 | [Yes](#scriptable) | How wide the scale is.
For a horizontal scale the height if a value less than 1 is given, is it assume to be a ratio of the corresponding chart area. #### Scriptable @@ -365,11 +365,11 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| missingColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| quantize | [QuantizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/callbacks/QuantizeCallback.html) | int -| align | [AlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/callbacks/AlignCallback.html) | [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Align.html) -| indicatorWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int -| length | [LengthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/callbacks/LengthCallback.html) | int -| margin | [MarginCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/callbacks/MarginCallback.html) | int - [Margin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Margin.html) -| position | [PositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/callbacks/PositionCallback.html) | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/enums/Position.html) - [PositionPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/PositionPoint.html) -| width | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| missingColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ScaleContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| quantize | [QuantizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/callbacks/QuantizeCallback.html) | int +| align | [AlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/callbacks/AlignCallback.html) | [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Align.html) +| indicatorWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int +| length | [LengthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/callbacks/LengthCallback.html) | int +| margin | [MarginCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/callbacks/MarginCallback.html) | int - [Margin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Margin.html) +| position | [PositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/callbacks/PositionCallback.html) | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/enums/Position.html) - [PositionPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/PositionPoint.html) +| width | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<ScaleContext> | int diff --git a/docs/charts/geo/Introduction.md b/docs/charts/geo/Introduction.md index 821f263c..d609d882 100644 --- a/docs/charts/geo/Introduction.md +++ b/docs/charts/geo/Introduction.md @@ -41,13 +41,13 @@ The maps can be loaded: * at runtime, invoking some HTTP services in order to get the needed [TopoJSON](https://github.com/topojson/topojson) definitions. * at project level, by [GWT Web toolkit clientBundle](http://www.gwtproject.org/doc/latest/DevGuideClientBundle.html#TextResource), if you are developing a [GWT Web toolkit](http://www.gwtproject.org/) project. - * at project level, by the implementation of a [AbstractInjectableResource](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/resources/AbstractInjectableResource.html) class. + * at project level, by the implementation of a [AbstractInjectableResource](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/resources/AbstractInjectableResource.html) class. An example how to load a map by [GWT Web toolkit clientBundle](http://www.gwtproject.org/doc/latest/DevGuideClientBundle.html#TextResource) is the following: 1. take the [TopoJSON](https://github.com/topojson/topojson) definition and store in your project in a resource folder. 1. create a GWT [ClientBundle](http://www.gwtproject.org/doc/latest/DevGuideClientBundle.html) to get the [TopoJSON](https://github.com/topojson/topojson) definition as GWT [TextResource](http://www.gwtproject.org/doc/latest/DevGuideClientBundle.html#TextResource) - 1. use [GeoUtil](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/GeoUtil.html) to get a [TopoJson](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/TopoJson.html) instance. + 1. use [GeoUtil](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/GeoUtil.html) to get a [TopoJson](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/TopoJson.html) instance. An example how to load a map by [GWT Web toolkit clientBundle](http://www.gwtproject.org/doc/latest/DevGuideClientBundle.html#TextResource) is the following: @@ -72,7 +72,7 @@ public interface MyResources extends ClientBundle { } ``` - * use [GeoUtil](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/GeoUtil.html) to get a [TopoJson](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/TopoJson.html) instance. + * use [GeoUtil](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/GeoUtil.html) to get a [TopoJson](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/TopoJson.html) instance. ```java // gets the topoJSON map as string @@ -87,7 +87,7 @@ A topology is a [TopoJSON](https://github.com/topojson/topojson) object where th A topology must have a member with the name `objects` whose value is another object. The value of each member of this object is a geometry object. -**Charba** provides methods, by [GeoUtil](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/GeoUtil.html), to parse the [TopoJSON](https://github.com/topojson/topojson) definition and provide a list of [Features](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Feature.html) which are mapping the topology needed to render in the chart. +**Charba** provides methods, by [GeoUtil](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/GeoUtil.html), to parse the [TopoJSON](https://github.com/topojson/topojson) definition and provide a list of [Features](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Feature.html) which are mapping the topology needed to render in the chart. Every [TopoJSON](https://github.com/topojson/topojson) definition object could be built with a different name spaces, therefore the node name to use as root of object must be provided by the developer. @@ -101,7 +101,7 @@ TopoJson world = GeoUtil.createTopoJson(topoJsonText); List features = GeoUtil.features(world, "countries"); ``` -A [Feature](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Feature.html) contains the properties of the topology. +A [Feature](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Feature.html) contains the properties of the topology. Even in this case, the properties names are not standard. Every feature can have own property names. @@ -126,9 +126,9 @@ for (Feature feature: features) { ### Labels -Usually the labels to display for the geographic map chart are stored in the properties of a [Feature](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/Feature.html), for instance the name of the country, state, regions, provinces, cities and so on. As said above, the properties names are not fixed for all topologies and every topology can have own properties. +Usually the labels to display for the geographic map chart are stored in the properties of a [Feature](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/Feature.html), for instance the name of the country, state, regions, provinces, cities and so on. As said above, the properties names are not fixed for all topologies and every topology can have own properties. -To improve to the access of topology definitions and to help the labels creation, **Charba** provides methods, by [GeoUtil](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/geo/GeoUtil.html), which creates a [Labels](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Labels.html) to set to the chart, as following: +To improve to the access of topology definitions and to help the labels creation, **Charba** provides methods, by [GeoUtil](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/geo/GeoUtil.html), which creates a [Labels](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Labels.html) to set to the chart, as following: ```java // defines the property name "name" diff --git a/docs/coloring/Colors.md b/docs/coloring/Colors.md index 32254dcd..348f703b 100644 --- a/docs/coloring/Colors.md +++ b/docs/coloring/Colors.md @@ -14,21 +14,21 @@ Usually the colors are managed as string, following the syntax defined for CSS, **Charba** provides: - * [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) interface to manage colors - * [Color](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Color.html) entity to create and manage colors + * [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) interface to manage colors + * [Color](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Color.html) entity to create and manage colors * 3 enumerations with - * all [color names](./tables/HTMLColorsNames) defined for HTML, by enumeration [HtmlColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/HtmlColor.html) - * all [color names](./tables/GWTMaterialColors) defined for GWT Material, by enumeration [GwtMaterialColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/GwtMaterialColor.html) - * first [31 color names](./tables/GoogleChartColors) defined for Google Charts, by enumeration [GoogleChartColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/GoogleChartColor.html) - * all gradients defined by [UiGradients.com](https://uigradients.com), by enumeration [UiGradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/UiGradient.html) + * all [color names](./tables/HTMLColorsNames) defined for HTML, by enumeration [HtmlColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/HtmlColor.html) + * all [color names](./tables/GWTMaterialColors) defined for GWT Material, by enumeration [GwtMaterialColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/GwtMaterialColor.html) + * first [31 color names](./tables/GoogleChartColors) defined for Google Charts, by enumeration [GoogleChartColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/GoogleChartColor.html) + * all gradients defined by [UiGradients.com](https://uigradients.com), by enumeration [UiGradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/UiGradient.html) -**Charba** is using [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) and colors as string in the methods where you must define a color. +**Charba** is using [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) and colors as string in the methods where you must define a color. ### Building colors Even if the usual method is to use strings which are representing colors, leveraging on colors structure of **Charba**, you can use color as objects, defining your base colors and play with transparency without creating a specific string every time. -The [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) interface (and then all colors defined out of the box) has got a method which returns a another color instance, based from source one, as following: +The [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) interface (and then all colors defined out of the box) has got a method which returns a another color instance, based from source one, as following: ```java // it can be a static reference @@ -39,7 +39,7 @@ IsColor myColorWithAlpha = myColor.alpha(0.2D); IsColor myDarkerColor = myColor.darker(); ``` -Another interesting utility is the [ColorBuilder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/ColorBuilder.html) which can create [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) instances by a string. +Another interesting utility is the [ColorBuilder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/ColorBuilder.html) which can create [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) instances by a string. ```java // parses color and creates new color. @@ -57,9 +57,9 @@ IsColor myColorHSLA = ColorBuilder.parse("hsla(100, 100%, 50%, 0.5)"); IsColor myColorName = ColorBuilder.parse("red"); ``` -The parser of [ColorBuilder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/ColorBuilder.html) is able to parse color string representation by HEX, RGB, RGBA, HSL and HSLA. +The parser of [ColorBuilder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/ColorBuilder.html) is able to parse color string representation by HEX, RGB, RGBA, HSL and HSLA. -The parser can also use HTML color names, defined in the [HtmlColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/HtmlColor.html) enumeration. +The parser can also use HTML color names, defined in the [HtmlColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/HtmlColor.html) enumeration. ### Default color palette @@ -105,7 +105,7 @@ Both [line](../charts/ChartLine) and [radar](../charts/ChartRadar) charts suppor ### Modes -**Charba** is providing an enumeration for fixed [filling modes](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Fill.html). +**Charba** is providing an enumeration for fixed [filling modes](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Fill.html). On top of these, you can set other kind of filling mode, as following: @@ -126,7 +126,7 @@ Furthermore **Charba** configuration enables the possibility to set directly abs By default, the filling of the datasets uses value equals to 0 of value axis to color the dataset above or below the line. -You can set a different value, setting the fill options with the axis value you want to use, using a number or a [FillBaseline](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FillBaseline.html) instance. +You can set a different value, setting the fill options with the axis value you want to use, using a number or a [FillBaseline](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FillBaseline.html) instance. ```java ```java @@ -154,7 +154,7 @@ chart.getData().setDatasets(dataset, datasetNew); You can decide to have different filling colors above and below the baseline. -You can set a different colors, setting the fill options with the your colors you want to use, using a [FillColors](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FillColors.html) instance. +You can set a different colors, setting the fill options with the your colors you want to use, using a [FillColors](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FillColors.html) instance. ```java ```java diff --git a/docs/coloring/Gradients.md b/docs/coloring/Gradients.md index 5956c260..1ef60a31 100644 --- a/docs/coloring/Gradients.md +++ b/docs/coloring/Gradients.md @@ -21,9 +21,9 @@ As with any interpolation involving colors, gradients are calculated in the alph **Charba** enables the usage of gradient providing some helpful configuration in order to enable you to do not use any dimensions or calculate them. -The gradient is mapped in the [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html), which can configure both linear and radial gradients. +The gradient is mapped in the [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html), which can configure both linear and radial gradients. -A [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) can be created only by a [gradient builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/GradientBuilder.html) in order to optimize the cache used for them. +A [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) can be created only by a [gradient builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/GradientBuilder.html) in order to optimize the cache used for them. ```java // creates a dataset @@ -40,13 +40,13 @@ dataset.setFill(Fill.origin); ## Types -Every gradient must be created setting which type represents. The [gradient type](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/GradientType.html) must be passed to constructor of new gradient. If omitted, the default is **[linear](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/GradientType.html#LINEAR)**. +Every gradient must be created setting which type represents. The [gradient type](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/GradientType.html) must be passed to constructor of new gradient. If omitted, the default is **[linear](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/GradientType.html#LINEAR)**. ## Orientation The **Charba** gradient implementation doesn't provide you to define the imaginary line or the direction from center but provides you a predefined sets of value, which can be used to create the canvas gradient. -The orientation values of the imaginary line or the direction from/to center are defined in an enumeration, [gradient orientation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/GradientOrientation.html). +The orientation values of the imaginary line or the direction from/to center are defined in an enumeration, [gradient orientation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/GradientOrientation.html). | Name | Type | Description | | :- | :- | :- | :- | @@ -65,7 +65,7 @@ The orientation values of the imaginary line or the direction from/to center are The **Charba** gradient implementation doesn't provide you to define the imaginary line or the direction from center but provides you a predefined sets of value, which can be used to create the canvas gradient. -The dimension of the area to use to calculate the gradient are defined in an enumeration, [gradient scope](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/GradientScope.html). +The dimension of the area to use to calculate the gradient are defined in an enumeration, [gradient scope](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/GradientScope.html). | Name | Description | | :- | :- | :- | @@ -78,7 +78,7 @@ The dimension of the area to use to calculate the gradient are defined in an enu To complete a gradient configuration, you need to set a list of colors, adds a new color stop to the gradient, setting the offset, as value between 0 and 1 for where the color stop is located, and the color at the stop. -The [gradient builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/GradientBuilder.html) provides the methods to add colors, building the [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html), as following: +The [gradient builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/GradientBuilder.html) provides the methods to add colors, building the [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html), as following: ```java // creates a gradient diff --git a/docs/coloring/Patterns.md b/docs/coloring/Patterns.md index 23aeb370..ab3d7e40 100644 --- a/docs/coloring/Patterns.md +++ b/docs/coloring/Patterns.md @@ -12,18 +12,18 @@ A pattern represents an opaque object, based on an image, that it can be used to Apart of the image, to create a pattern you could decide how to repeat the pattern's image. Possible values are: - * **[repeat](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/Repetition.html#REPEAT)** (both directions) - * **[repeat-x](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/Repetition.html#REPEAT_X)** (horizontal only) - * **[repeat-y](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/Repetition.html#REPEAT_Y)** (vertical only) - * **[no-repeat](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/Repetition.html#NO_REPEAT)** (neither direction) + * **[repeat](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/Repetition.html#REPEAT)** (both directions) + * **[repeat-x](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/Repetition.html#REPEAT_X)** (horizontal only) + * **[repeat-y](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/Repetition.html#REPEAT_Y)** (vertical only) + * **[no-repeat](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/Repetition.html#NO_REPEAT)** (neither direction) -If repetition is not specified creating a pattern, a value of **[repeat](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/Repetition.html#REPEAT)** will be used. +If repetition is not specified creating a pattern, a value of **[repeat](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/Repetition.html#REPEAT)** will be used. -A pattern is an alternative option to configure a dataset by [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) object, instead of using a color. +A pattern is an alternative option to configure a dataset by [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) object, instead of using a color. -A [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) can be created only by a [patter builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/PatternBuilder.html) in order to optimize the cache used for them. +A [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) can be created only by a [patter builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/PatternBuilder.html) in order to optimize the cache used for them. For example, if you wanted to fill a dataset with a pattern from an image, you could do the following: @@ -40,7 +40,7 @@ dataset.setBackgroundColor(pattern); dataset.setFill(Fill.origin); ``` -where `Images.INSTANCE.pattern()` is a method of a [ClientBundle](http://www.gwtproject.org/javadoc/latest/com/google/gwt/resources/client/ClientBundle.html), where the image is inside the project and using the [ImagesHelper](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gwt/ImagesHelper.html) can be cast of a [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html), as following: +where `Images.INSTANCE.pattern()` is a method of a [ClientBundle](http://www.gwtproject.org/javadoc/latest/com/google/gwt/resources/client/ClientBundle.html), where the image is inside the project and using the [ImagesHelper](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gwt/ImagesHelper.html) can be cast of a [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html), as following: ```java @@ -66,7 +66,7 @@ Image.prefetch(Images.INSTANCE.pattern().getSafeUri()); -The main class to use this feature is [TilesFactory](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/tiles/TilesFactory.html) which provides a set of methods to get a tile as canvas pattern or as **Charba** pattern which can be used in the datasets. +The main class to use this feature is [TilesFactory](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/tiles/TilesFactory.html) which provides a set of methods to get a tile as canvas pattern or as **Charba** pattern which can be used in the datasets. ```java // creates a dataset @@ -93,14 +93,14 @@ The complete configuration items are described by following table: | Name | Type | Default | Description | :- | :- | :- | :- -| shape | [Shape](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/tiles/Shape.html) | Shape.SQUARE | the shape to apply on tile -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgba(100, 100, 100, 0.7) -          | the background color of tile -| shapeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgba(255, 255, 255, 0.8) -          | the shape color on tile +| shape | [Shape](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/tiles/Shape.html) | Shape.SQUARE | the shape to apply on tile +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgba(100, 100, 100, 0.7) -          | the background color of tile +| shapeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgba(255, 255, 255, 0.8) -          | the shape color on tile | size | int | 20 | the size of the tile (always a square). The minimum size for a tile is **10**. -| lineCap | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.ROUND | determines the shape used to draw the end points of lines -| lineJoin | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.ROUND | determines the shape used to join two line segments where they meet +| lineCap | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.ROUND | determines the shape used to draw the end points of lines +| lineJoin | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.ROUND | determines the shape used to join two line segments where they meet -This is the **[list of shapes](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/tiles/Shape.html)**, available out-of-the-box: +This is the **[list of shapes](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/tiles/Shape.html)**, available out-of-the-box: * back slashed line * box @@ -133,7 +133,7 @@ This is the **[list of shapes](https://pepstock-org.github.io/Charba/6.4/org/pep ### Image shape -[ImageShape](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/tiles/ImageShape.html) enables to use an image and apply (scaling it) to the tile. The vantage is that we can decide the background of the image if it has got a transparent background. +[ImageShape](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/tiles/ImageShape.html) enables to use an image and apply (scaling it) to the tile. The vantage is that we can decide the background of the image if it has got a transparent background. ```java ImageShape imageShape = new ImageShape(ImagesHelper.toImg(Images.INSTANCE.myImage())); @@ -146,7 +146,7 @@ Pattern pattern = TilesFactory.createPattern(imageShape, "#990099"); ### Character shape -[CharacterShape](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/tiles/CharacterShape.html) enables to use a character (ONLY 1 otherwise you will get an exception) and apply to tile. +[CharacterShape](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/tiles/CharacterShape.html) enables to use a character (ONLY 1 otherwise you will get an exception) and apply to tile. ```java // creates a custom shape @@ -159,7 +159,7 @@ Pattern pattern = TilesFactory.createPattern(charShape, "#990099"); ### Point style shape -It is also possible to use [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) as shape for a tile. +It is also possible to use [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) as shape for a tile. ```java // creates a shape by a point style @@ -170,7 +170,7 @@ Pattern pattern = TilesFactory.createPattern(PointStyle.CIRCLE, "#990099"); ### Builder -**Charba** provides a [TilesBuilder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/tiles/TilesBuilder.html) to create tiles using the **set** methods in sequence and get a [pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) or [CanvasPatternItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/CanvasPatternItem.html) at the end of configuration. +**Charba** provides a [TilesBuilder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/tiles/TilesBuilder.html) to create tiles using the **set** methods in sequence and get a [pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) or [CanvasPatternItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/CanvasPatternItem.html) at the end of configuration. ```java // creates a CHARBA pattern diff --git a/docs/coloring/tables/GWTMaterialColors.md b/docs/coloring/tables/GWTMaterialColors.md index ed70b61b..fa477aad 100644 --- a/docs/coloring/tables/GWTMaterialColors.md +++ b/docs/coloring/tables/GWTMaterialColors.md @@ -6,7 +6,7 @@ sidebar_label: GWT Material --- ## GWT Material color table -The GWT Material colors are provided by an enumeration, [GwtMaterialColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/GwtMaterialColor.html). +The GWT Material colors are provided by an enumeration, [GwtMaterialColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/GwtMaterialColor.html). Here an example how to use it: diff --git a/docs/coloring/tables/GoogleChartColors.md b/docs/coloring/tables/GoogleChartColors.md index 7fff92c1..169b2bd3 100644 --- a/docs/coloring/tables/GoogleChartColors.md +++ b/docs/coloring/tables/GoogleChartColors.md @@ -7,7 +7,7 @@ sidebar_label: Google Chart ## Google Chart color table -The Google Chart colors are provided by an enumeration, [GoogleChartColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/GoogleChartColor.html). +The Google Chart colors are provided by an enumeration, [GoogleChartColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/GoogleChartColor.html). Here an example how to use it: diff --git a/docs/coloring/tables/HTMLColorsNames.md b/docs/coloring/tables/HTMLColorsNames.md index f31de388..1bf0ed31 100644 --- a/docs/coloring/tables/HTMLColorsNames.md +++ b/docs/coloring/tables/HTMLColorsNames.md @@ -6,7 +6,7 @@ sidebar_label: HTML color names --- ## HTML color names table -The HTML color names are provided by an enumeration, [HtmlColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/HtmlColor.html). +The HTML color names are provided by an enumeration, [HtmlColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/HtmlColor.html). Here an example how to use it: diff --git a/docs/configuration/Animation.md b/docs/configuration/Animation.md index 57d99c9d..15f553ec 100644 --- a/docs/configuration/Animation.md +++ b/docs/configuration/Animation.md @@ -12,11 +12,11 @@ The animation configuration consists in 3 different elements: 1. **[Animation](#animation)** to configure the common animation options. 2. **[Animations](#animations)** to configure the common animation options for a specific sets of element(like bar, point, arc and line) properties. - 3. **[Transitions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Transitions.html)** to configure the animation and animations options for a specific update mode. + 3. **[Transitions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Transitions.html)** to configure the animation and animations options for a specific update mode. ## Animation -[Animation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Animation.html) is used to configure the base options to animate the chart. +[Animation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Animation.html) is used to configure the base options to animate the chart. To get, change and apply own properties, you can invoke the **set** and **get** methods, as following: @@ -37,7 +37,7 @@ The following animation options are available. | animateScale | boolean | - | If `true`, will animate scaling the chart from the center outwards. | delay | int | [Yes](#scriptable) | Delay in milliseconds before starting the animations. | duration | int | [Yes](#scriptable) | The number of milliseconds an animation takes. -| easing | [Easing](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Easing.html) | [Yes](#scriptable) | Easing function to use.
See [Robert Penner's easing equations](http://robertpenner.com/easing/) for more details. +| easing | [Easing](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Easing.html) | [Yes](#scriptable) | Easing function to use.
See [Robert Penner's easing equations](http://robertpenner.com/easing/) for more details. | loop | boolean | [Yes](#scriptable) | If set to `true`, the animations loop endlessly. ### Scriptable @@ -64,16 +64,16 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| delay | [DelayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DelayCallback.html) | double -| duration | [DurationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DurationCallback.html) | double -| easing | [EasingCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/EasingCallback.html) | [Easing](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Easing.html) -| loop | [LoopCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/LoopCallback.html) | boolean +| delay | [DelayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DelayCallback.html) | double +| duration | [DurationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DurationCallback.html) | double +| easing | [EasingCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/EasingCallback.html) | [Easing](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Easing.html) +| loop | [LoopCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/LoopCallback.html) | boolean ## Animations -[Animations](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Animations.html) options configures which element properties are animated and how. +[Animations](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Animations.html) options configures which element properties are animated and how. -The animations element is a [container of configurations](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/AnimationCollection.html) which can be stored and retrieved by a [key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/Key.html). +The animations element is a [container of configurations](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/AnimationCollection.html) which can be stored and retrieved by a [key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/Key.html). To get, change and apply own properties, you can invoke the **set** and **get** methods, as following: @@ -94,29 +94,29 @@ int duration = animationCollection.getDuration(); The default values are set in global defaults options, see [default global animations options](../defaults/DefaultsCharts#animations). -The following options are available in [animation collection](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/AnimationCollection.html) object: +The following options are available in [animation collection](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/AnimationCollection.html) object: | Name | Type | Scriptable | Description | :- | :- | :- | :- | delay | int | [Yes](#scriptable) | Delay in milliseconds before starting the animations. | duration | int | [Yes](#scriptable) | The number of milliseconds an animation takes. -| easing | [Easing](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Easing.html) | [Yes](#scriptable) | Easing function to use.
See [Robert Penner's easing equations](http://robertpenner.com/easing/) for more details. -| from | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Start value for the animation. -| interpolator | [NativeInterpolator](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/NativeInterpolator.html) | - | Enables a custom interpolation during the animations. Only coding in java script for performance reasons. +| easing | [Easing](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Easing.html) | [Yes](#scriptable) | Easing function to use.
See [Robert Penner's easing equations](http://robertpenner.com/easing/) for more details. +| from | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Start value for the animation. +| interpolator | [NativeInterpolator](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/NativeInterpolator.html) | - | Enables a custom interpolation during the animations. Only coding in java script for performance reasons. | loop | boolean | [Yes](#scriptable) | If set to `true`, the animations loop endlessly. -| properties | String[] - [Key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/Key.html)[] | The properties of elements to use to animate. -| type | [AnimationType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AnimationType.html) | Type of property, determines the interpolator used. -| to | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | End value for the animation. +| properties | String[] - [Key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/Key.html)[] | The properties of elements to use to animate. +| type | [AnimationType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AnimationType.html) | Type of property, determines the interpolator used. +| to | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | End value for the animation. ### Default animations -[Chart.JS](http://www.chartjs.org/) provides a default configuration for every specific [animation type](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AnimationType.html): +[Chart.JS](http://www.chartjs.org/) provides a default configuration for every specific [animation type](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AnimationType.html): | AnimationType | DefaultAnimationCollectionKey | Properties | :- | :- | :- -| NUMBERS | [NUMBERS](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultAnimationCollectionKey.html) | DefaultAnimationPropertyKey.X,
DefaultAnimationPropertyKey.Y,
DefaultAnimationPropertyKey.BORDER_WIDTH,
DefaultAnimationPropertyKey.RADIUS,
DefaultAnimationPropertyKey.TENSION -| COLORS | [COLORS](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultAnimationCollectionKey.html) | DefaultAnimationPropertyKey.COLOR, DefaultAnimationPropertyKey.BORDER_COLOR, DefaultAnimationPropertyKey.BACKGROUND_COLOR -| BOOLEAN | [VISIBLE](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultAnimationCollectionKey.html) | DefaultAnimationPropertyKey.VISIBLE +| NUMBERS | [NUMBERS](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultAnimationCollectionKey.html) | DefaultAnimationPropertyKey.X,
DefaultAnimationPropertyKey.Y,
DefaultAnimationPropertyKey.BORDER_WIDTH,
DefaultAnimationPropertyKey.RADIUS,
DefaultAnimationPropertyKey.TENSION +| COLORS | [COLORS](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultAnimationCollectionKey.html) | DefaultAnimationPropertyKey.COLOR, DefaultAnimationPropertyKey.BORDER_COLOR, DefaultAnimationPropertyKey.BACKGROUND_COLOR +| BOOLEAN | [VISIBLE](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultAnimationCollectionKey.html) | DefaultAnimationPropertyKey.VISIBLE :::info These default animations are overridden by most of the charts default configuration. @@ -148,18 +148,18 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| delay | [DelayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DelayCallback.html) | double -| duration | [DurationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DurationCallback.html) | double -| easing | [EasingCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/EasingCallback.html) | [Easing](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Easing.html) -| from | [FromCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FromCallback.html) | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| loop | [LoopCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/LoopCallback.html) | boolean -| to | [ToCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/toCallback.html) | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) +| delay | [DelayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DelayCallback.html) | double +| duration | [DurationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DurationCallback.html) | double +| easing | [EasingCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/EasingCallback.html) | [Easing](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Easing.html) +| from | [FromCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FromCallback.html) | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| loop | [LoopCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/LoopCallback.html) | boolean +| to | [ToCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/toCallback.html) | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) ## Transitions -The [transitions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Transitions.html) are a set of animation configuration related to a specific update mode. +The [transitions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Transitions.html) are a set of animation configuration related to a specific update mode. -Every [transition animation configuration](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/AnimationTransition.html) contains an instance of [Animation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Animation.html) and one of [Animations](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Animations.html) to configure the animation for a specific mode. +Every [transition animation configuration](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/AnimationTransition.html) contains an instance of [Animation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Animation.html) and one of [Animations](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Animations.html) to configure the animation for a specific mode. ```java // creates a custom mode @@ -175,7 +175,7 @@ Animations animations = animationMode.getAnimations(); The default values are set in global defaults options, see [default global transitions options](../defaults/DefaultsCharts#transitions). -The defaults modes are mapped in the [DefaultTransitionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultTransitionMode.html) enumeration and they are: +The defaults modes are mapped in the [DefaultTransitionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultTransitionMode.html) enumeration and they are: * **ACTIVE** uses the animation configuration when an element is hovering * **HIDE** uses the animation configuration when a dataset is hidden (by using legend or [hide](../charts/Api#hide) method). @@ -237,7 +237,7 @@ A chart can emits events during the animation phases, when it's the animation is ### Progressing -The progress event is thrown on each step of an animation. To catch the event and manage it, you can add a [AnimationProgressEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/AnimationProgressEventHandler.html) instance to the chart options, as following: +The progress event is thrown on each step of an animation. To catch the event and manage it, you can add a [AnimationProgressEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/AnimationProgressEventHandler.html) instance to the chart options, as following: ```java chart.addHandler(new AnimationProgressEventHandler(){ @@ -256,11 +256,11 @@ chart.addHandler(new AnimationProgressEventHandler(){ }, AnimationProgressEvent.TYPE); ``` -The event provides the [animation item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AnimationItem.html) object with all information about animation status. +The event provides the [animation item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AnimationItem.html) object with all information about animation status. ### Completed -The complete event is thrown at the end of an animation. To catch the event and manage it, you can add a [AnimationCompleteEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/AnimationCompleteEventHandler.html) instance to the chart options, as following: +The complete event is thrown at the end of an animation. To catch the event and manage it, you can add a [AnimationCompleteEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/AnimationCompleteEventHandler.html) instance to the chart options, as following: ```java chart.addHandler(new AnimationCompleteEventHandler(){ @@ -279,4 +279,4 @@ chart.addHandler(new AnimationCompleteEventHandler(){ }, AnimationCompleteEvent.TYPE); ``` -The event provides the [animation item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/AnimationItem.html) object with all information about animation status. +The event provides the [animation item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/AnimationItem.html) object with all information about animation status. diff --git a/docs/configuration/Commons.md b/docs/configuration/Commons.md index 62d9481f..bb882512 100644 --- a/docs/configuration/Commons.md +++ b/docs/configuration/Commons.md @@ -95,7 +95,7 @@ Table with options: For applications where the numbers of ticks on scales must be formatted accordingly with a language sensitive number formatting, you can enable this kind of formatting by setting the locale option. -The locale is a [CLocale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) object which represents a string that is a [Unicode BCP 47 locale identifier](https://www.unicode.org/reports/tr35/tr35.html#BCP_47_Conformance). +The locale is a [CLocale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) object which represents a string that is a [Unicode BCP 47 locale identifier](https://www.unicode.org/reports/tr35/tr35.html#BCP_47_Conformance). A Unicode BCP 47 locale identifier consists of @@ -122,7 +122,7 @@ Table with options: | Name | Type | Description | :- | :- | :- -| locale | [CLocale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) | A string with a BCP 47 language tag.
See [INTL locale](../intl/Locale#locale). +| locale | [CLocale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) | A string with a BCP 47 language tag.
See [INTL locale](../intl/Locale#locale). ## Colors @@ -145,9 +145,9 @@ Table with options: | :- | :- | :- | autoColors | boolean | `true` if the chart will cycle through a palette of seven [Chart.JS](http://www.chartjs.org/) brand colors. See [color](../coloring/Colors#default-color-palette) section. | autoColorsForceOverride | boolean | `true` if you want to force the auto colors to always color your datasets, for example when using dynamic datasets at runtime. See [color](../coloring/Colors#default-color-palette) section. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | The default background color to use in the chart. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | The default border color to use in the chart. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | The default font color to use in the chart. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | The default background color to use in the chart. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | The default border color to use in the chart. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | The default font color to use in the chart. ## Font @@ -166,15 +166,15 @@ int size = chart.getOptions().getFont().getSize(); | :- | :- | :- | family | String | Font family for all text. | size | int | Font size (in px) for text. -| style | [FontStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/FontStyle.html) | Font style -| weight | [Weight](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Weight.html) | Default font weight (boldness).
See [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight). +| style | [FontStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/FontStyle.html) | Font style +| weight | [Weight](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Weight.html) | Default font weight (boldness).
See [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight). | lineHeight | double - String | Height of an individual line of text.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height). ## Padding Many elements use the padding to apply space around the element itself. -The [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) provides all **set** and **get** methods to manage the configuration, as following: +The [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) provides all **set** and **get** methods to manage the configuration, as following: ```java // creates a radial axis @@ -196,7 +196,7 @@ The following are the attributes that you can set: | right | int | The padding right in pixel. | top | int | The padding top in pixel. -The [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) provides the methods to: +The [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) provides the methods to: * set the same value to all dimensions, by `set(int)`. * set the same value to X dimensions (left and right), by `setX(int)`. diff --git a/docs/configuration/Datasets.md b/docs/configuration/Datasets.md index 4693fefd..eb024228 100644 --- a/docs/configuration/Datasets.md +++ b/docs/configuration/Datasets.md @@ -8,7 +8,7 @@ sidebar_label: Datasets The datasets options are managing the set options which will affect the datasets management. -The datasets configuration is passed using the [Datasets](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Datasets.html) object in the chart options and mapped to [TypedDataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/TypedDataset.html). +The datasets configuration is passed using the [Datasets](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Datasets.html) object in the chart options and mapped to [TypedDataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/TypedDataset.html). To get, change and apply own properties, you can invoke the **set** and **get** methods, as following: @@ -23,14 +23,14 @@ The following are the attributes that you can set: | Name | Type | Description | :- | :- | :- -| animation | [Animation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Animation.html) | See [animation configuration](Animation#animation) section for more details. -| animations | [Animations](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Animations.html) | See [animation configuration](Animation#animations) section for more details. +| animation | [Animation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Animation.html) | See [animation configuration](Animation#animation) section for more details. +| animations | [Animations](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Animations.html) | See [animation configuration](Animation#animations) section for more details. | barPercentage | double | Percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other. | categoryPercentage | double | Percent (0-1) of the available width each category should be within the sample width. -| barThickness | int | Manually set width of each bar in pixels.
If set to [DefaultDatasets.FLEX_BAR_THICKNESS](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/defaults/globals/DefaultDatasets.html#FLEX_BAR_THICKNESS), it computes "optimal" sample widths that globally arrange bars side by side.
If not set (default), bars are equally sized based on the smallest interval. +| barThickness | int | Manually set width of each bar in pixels.
If set to [DefaultDatasets.FLEX_BAR_THICKNESS](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/defaults/globals/DefaultDatasets.html#FLEX_BAR_THICKNESS), it computes "optimal" sample widths that globally arrange bars side by side.
If not set (default), bars are equally sized based on the smallest interval. | grouped | boolean | Should the bars be grouped on index axis.
When `true`, all the datasets at same index value will be placed next to each other centering on that index value.
When `false`, each bar is placed on its actual index-axis value. | maxBarThickness | int | Set this to ensure that bars are not sized thicker than this. | minBarLength | int | Set this to ensure that bars have a minimum length in pixels. | showLine | boolean | If `true`, the line is drawn for dataset. -| transitions | [Transitions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Transitions.html) | See [animation configuration](Animation#transitions) section for more details. +| transitions | [Transitions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Transitions.html) | See [animation configuration](Animation#transitions) section for more details. diff --git a/docs/configuration/Elements.md b/docs/configuration/Elements.md index 737ab8c7..85cf3d87 100644 --- a/docs/configuration/Elements.md +++ b/docs/configuration/Elements.md @@ -6,11 +6,11 @@ sidebar_label: Elements --- ## Elements -The [elements](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Elements.html) allows the user to configure the different type of shapes which are used to draw the datasets. +The [elements](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Elements.html) allows the user to configure the different type of shapes which are used to draw the datasets. Options can be configured for four different types of elements: **[arc](#arc)**, **[lines](#line)**, **[points](#point)**, and **[bar](#bar)**. -The [elements](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Elements.html) configuration is nested in the global configuration as following: +The [elements](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Elements.html) configuration is nested in the global configuration as following: ```java // gets elements node @@ -38,15 +38,15 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#point-scriptable-options) | Point fill color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#point-scriptable-options) | Point stroke color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#point-scriptable-options) | Point fill color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#point-scriptable-options) | Point stroke color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | borderWidth | int | [Yes](#point-scriptable-options) | Point stroke width. | hitRadius | int | [Yes](#point-scriptable-options) | Extra radius added to point radius for hit detection. -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#point-scriptable-options) | Point fill color when hovered. -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#point-scriptable-options) | Point stroke color when hovered. +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#point-scriptable-options) | Point fill color when hovered. +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#point-scriptable-options) | Point stroke color when hovered. | hoverBorderWidth | int | [Yes](#point-scriptable-options) | Stroke width when hovered. | hoverRadius | int | [Yes](#point-scriptable-options) | Point radius when hovered. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | [Yes](#point-scriptable-options) | Point style. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | [Yes](#point-scriptable-options) | Point style. | radius | int | [Yes](#point-scriptable-options) | Point radius. | rotation | double | [Yes](#point-scriptable-options) | The point rotation (in degrees). @@ -72,17 +72,17 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| hitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| hoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) -| radius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double -| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| hitRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| hoverRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) +| radius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DatasetContext> | double +| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<DatasetContext> | double ### Line @@ -105,20 +105,20 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#line-scriptable-options) | Line fill color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#line-scriptable-options) | Determines the shape used to draw the end points of lines.
See [MDN](https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#line-scriptable-options) | Line stroke color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#line-scriptable-options) | Line fill color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | [Yes](#line-scriptable-options) | Determines the shape used to draw the end points of lines.
See [MDN](https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#line-scriptable-options) | Line stroke color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | borderDash | int[] | [Yes](#line-scriptable-options) |The line dash pattern used when stroking lines. It uses an array of values that specify alternating lengths of lines and gaps which describe the pattern.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | [Yes](#line-scriptable-options) | Line dash offset.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#line-scriptable-options) | The shape used to join two line segments where they meet.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#line-scriptable-options) | The shape used to join two line segments where they meet.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderWidth | int | [Yes](#line-scriptable-options) | Line stroke width. | capBezierPoints | boolean | - | Set `true` to keep Bezier control inside the chart, `false` for no restriction. -| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | [Yes](#line-scriptable-options) | Interpolation mode to apply. -| fill | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsFill.html) | [Yes](#line-scriptable-options) | How to fill the area under the line.
See [Filling modes](../coloring/Colors#filling-modes) -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#line-scriptable-options) | Line fill color when hovered. -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#line-scriptable-options) | Line stroke color when hovered. +| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | [Yes](#line-scriptable-options) | Interpolation mode to apply. +| fill | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsFill.html) | [Yes](#line-scriptable-options) | How to fill the area under the line.
See [Filling modes](../coloring/Colors#filling-modes) +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#line-scriptable-options) | Line fill color when hovered. +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#line-scriptable-options) | Line stroke color when hovered. | hoverBorderWidth | int | [Yes](#line-scriptable-options) | Stroke width when hovered. -| stepped | boolean - [Stepped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Stepped.html) | [Yes](#line-scriptable-options) | If the line is shown as a stepped line. +| stepped | boolean - [Stepped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Stepped.html) | [Yes](#line-scriptable-options) | If the line is shown as a stepped line. | tension | double | - | Bezier curve tension (`0` for no Bezier curves). #### Line scriptable options @@ -143,19 +143,19 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) -| fill | [FillCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FillCallback.html) | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsFill.html) -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| stepped | [SteppedCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SteppedCallback.html) | [Stepped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Stepped.html) +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<DatasetContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<DatasetContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<DatasetContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| cubicInterpolationMode | [CubicInterpolationModeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CubicInterpolationModeCallback.html) | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) +| fill | [FillCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FillCallback.html) | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsFill.html) +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| stepped | [SteppedCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SteppedCallback.html) | [Stepped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Stepped.html) ### Arc @@ -179,16 +179,16 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- | angle | double | [Yes](#arc-scriptable-options) | Arc angle to cover, for polar chart only. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#arc-scriptable-options) | Arc fill color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| borderAlign | [BorderAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderAlign.html) | [Yes](#arc-scriptable-options) | Arc stroke alignment. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#arc-scriptable-options) | Arc stroke color. -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#arc-scriptable-options) | Arc line join style. The default is JoinStyle.ROUND when `borderAlign` is BorderAlign.INNER.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#arc-scriptable-options) | Arc fill color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| borderAlign | [BorderAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderAlign.html) | [Yes](#arc-scriptable-options) | Arc stroke alignment. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#arc-scriptable-options) | Arc stroke color. +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#arc-scriptable-options) | Arc line join style. The default is JoinStyle.ROUND when `borderAlign` is BorderAlign.INNER.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderWidth | int | [Yes](#arc-scriptable-options) | Arc stroke width. | borderRadius | int | [Yes](#arc-scriptable-options) | The arc border radius (in pixels). | circular | boolean | - | If the arc is curved. If `false` the arc will be flat. -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#arc-scriptable-options) | Arc fill color when hovered. -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#arc-scriptable-options) | Arc stroke color when hovered. -| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#arc-scriptable-options) | Arc line join style when hovered.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#arc-scriptable-options) | Arc fill color when hovered. +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#arc-scriptable-options) | Arc stroke color when hovered. +| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | [Yes](#arc-scriptable-options) | Arc line join style when hovered.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | hoverBorderWidth | int | [Yes](#arc-scriptable-options) | Stroke width when hovered. | hoverOffset | int | [Yes](#arc-scriptable-options) | The offset of the arc (in pixels) when hovered. | offset | int | [Yes](#arc-scriptable-options) | The offset of the arc (in pixels). @@ -216,19 +216,19 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| angle | [AngleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/AngleCallback.html) | double -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderAlign | [BorderAlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderAlignCallback.html) | [BorderAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderAlign.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html) | int -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| hoverOffset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DatasetContext> | int -| offset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DatasetContext> | int +| angle | [AngleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/AngleCallback.html) | double +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderAlign | [BorderAlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderAlignCallback.html) | [BorderAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderAlign.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html) | int +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<DatasetContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| hoverOffset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DatasetContext> | int +| offset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DatasetContext> | int ### Bar @@ -252,19 +252,19 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- | autoInflateAmount | boolean | - | If `true`, the amount of pixels to inflate the bar rectangles, when drawing, is automatically calculating. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#bar-scriptable-options) | Bar fill color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#bar-scriptable-options) | Bar fill color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | base | double | - | Base value for the bar in data units along the value axis. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#bar-scriptable-options) | Bar stroke color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#bar-scriptable-options) | Bar stroke color.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | borderRadius | int | [Yes](#bar-scriptable-options) | The bar border radius (in pixels). -| borderSkipped | boolean - [BorderSkipped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderSkipped.html) | [Yes](#bar-scriptable-options) | The edge to skip when drawing bar. +| borderSkipped | boolean - [BorderSkipped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderSkipped.html) | [Yes](#bar-scriptable-options) | The edge to skip when drawing bar. | borderWidth | int | [Yes](#bar-scriptable-options) | The bar border width (in pixels). | enableBorderRadius| boolean | [Yes](#bar-scriptable-options) | If `true`, it only shows the border radius of a bar when the bar is at the end of the stack. -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#bar-scriptable-options) | Bar fill color when hovered. -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#bar-scriptable-options) | Bar stroke color when hovered. +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#bar-scriptable-options) | Bar fill color when hovered. +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#bar-scriptable-options) | Bar stroke color when hovered. | hoverBorderWidth | int | [Yes](#bar-scriptable-options) | Stroke width when hovered. | hoverBorderRadius | int | [Yes](#bar-scriptable-options) | The bar border radius (in pixels) when hovered. | inflateAmount | int | [Yes](#bar-scriptable-options) | The amount of pixels to inflate the bar rectangles, when drawing. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | [Yes](#bar-scriptable-options) | Point style for legend. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | [Yes](#bar-scriptable-options) | Point style for legend. #### Bar scriptable options @@ -288,18 +288,18 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| borderSkipped | [BorderSkippedCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderSkippedCallback.html) | [BorderSkipped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderSkipped.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html) | int -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| enableBorderRadius | [EnableBorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/EnableBorderRadiusCallback.html) | boolean -| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) -| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int -| hoverBorderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html) | int -| inflateAmount | [InflateAmountCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/InflateAmountCallback.html) | int**(1)** -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| borderSkipped | [BorderSkippedCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderSkippedCallback.html) | [BorderSkipped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderSkipped.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html) | int +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| enableBorderRadius | [EnableBorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/EnableBorderRadiusCallback.html) | boolean +| hoverBackgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DatasetContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) +| hoverBorderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DatasetContext> | int +| hoverBorderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html) | int +| inflateAmount | [InflateAmountCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/InflateAmountCallback.html) | int**(1)** +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<DatasetContext> | boolean - [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) **(1)**To enable `autoInflateAmount` by the inflate amount callback, the value to return must be `Undefined.INTEGER`. diff --git a/docs/configuration/FillerAndDecimation.md b/docs/configuration/FillerAndDecimation.md index 5f14facc..ff56ab27 100644 --- a/docs/configuration/FillerAndDecimation.md +++ b/docs/configuration/FillerAndDecimation.md @@ -12,7 +12,7 @@ The decimation element can be used with line charts to automatically decimate da Before enabling it, review the [requirements](#requirements) to ensure that it will work with the chart you want to create. -The [decimation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Decimation.html) configuration is nested in the chart configuration as following: +The [decimation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Decimation.html) configuration is nested in the chart configuration as following: ```java // sets the sample at chart level @@ -27,7 +27,7 @@ The following are the attributes that you can set: | Name | Type | Description | :- | :- | :- | enabled | boolean | If `true`, the data decimation is enabled. -| algorithm | [DecimationAlgorithm](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DecimationAlgorithm.html) | Decimation algorithm to use. +| algorithm | [DecimationAlgorithm](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DecimationAlgorithm.html) | Decimation algorithm to use. | samples | double | If the `DecimationAlgorithm.LTTB` is used, this is the number of samples in the output dataset. Defaults to the canvas width to pick 1 sample per pixel. | threshold | double | If the number of samples in the current axis range is above this value, the decimation will be triggered.
Defaults to 4 times the canvas width.
The number of point after decimation can be higher than the `threshold` value. @@ -42,16 +42,16 @@ The available decimation algorithms to use for data are the following: To use the decimation, the following requirements must be met: -1. The dataset must have an [IndexAxis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IndexAxis.html) of `IndexAxis.X`. -2. The dataset must be a [line](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/LineDataset.html). +1. The dataset must have an [IndexAxis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IndexAxis.html) of `IndexAxis.X`. +2. The dataset must be a [line](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/LineDataset.html). 3. The dataset must not need any parsing for instance having `parsing` option set to `false`. -4. The X axis for the dataset must be either a [linear](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianLinearAxis.html) or [time](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianTimeAxis.html) axis. +4. The X axis for the dataset must be either a [linear](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianLinearAxis.html) or [time](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianTimeAxis.html) axis. ## Filler Filler element configures the engine which is in charge to manage the filling of the datasets, by the property `fill`. See [here](../coloring/Colors#filling) how filling a dataset. -The [filler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Filler.html) configuration is nested in the chart configuration as following: +The [filler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Filler.html) configuration is nested in the chart configuration as following: ```java // disables the propagation at chart level @@ -67,4 +67,4 @@ The following are the attributes that you can set: | Name | Type | Description | :- | :- | :- | propagate | boolean | If `true`, the fill area will be recursively extended to the visible target defined by the fill value of hidden data set targets. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DrawTime.html) | Filler draw time. +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DrawTime.html) | Filler draw time. diff --git a/docs/configuration/Interaction.md b/docs/configuration/Interaction.md index 5167de14..a82f96bb 100644 --- a/docs/configuration/Interaction.md +++ b/docs/configuration/Interaction.md @@ -23,10 +23,10 @@ Table with options: | Name | Type | Default | Description | :- | :- | :- | :- -| axis | [InteractionAxis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/InteractionAxis.html) | InteractionAxis.X | Define which directions are used in calculating distances. +| axis | [InteractionAxis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/InteractionAxis.html) | InteractionAxis.X | Define which directions are used in calculating distances. | intersect | boolean | `true` | if `true`, the hover mode only applies when the mouse position intersects an item on the chart. | includeInvisible | boolean | `false` | if `true`, the invisible points that are outside of the chart area will also be included when evaluating interactions. -| mode | String - [IsInteractionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsInteractionMode.html) | DefaultInteractionMode.NERAEST | Sets which elements managed by event or tooltip. +| mode | String - [IsInteractionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsInteractionMode.html) | DefaultInteractionMode.NERAEST | Sets which elements managed by event or tooltip. ## Hover @@ -47,15 +47,15 @@ Table with options: | Name | Type | Default | Description | :- | :- | :- | :- -| axis | [InteractionAxis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/InteractionAxis.html) | InteractionAxis.X | Define which directions are used in calculating distances. +| axis | [InteractionAxis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/InteractionAxis.html) | InteractionAxis.X | Define which directions are used in calculating distances. | intersect | boolean | `true` | if `true`, the hover mode only applies when the mouse position intersects an item on the chart. -| mode | String - [IsInteractionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsInteractionMode.html) | DefaultInteractionMode.NERAEST | Sets which elements will be hovered. +| mode | String - [IsInteractionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsInteractionMode.html) | DefaultInteractionMode.NERAEST | Sets which elements will be hovered. ### Custom interaction modes When configuring the interaction with the chart via interaction, hover or tooltip, a number of different modes are available. -Possible [interaction modes](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultInteractionMode.html) out-of the box are: +Possible [interaction modes](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultInteractionMode.html) out-of the box are: * `DefaultInteractionMode.POINT`, it will find all of the items that intersect the point. * `DefaultInteractionMode.NEAREST`, it will get the item that is nearest to the point.T he nearest item is determined based on the distance to the center of the chart item (point, bar). If 2 or more items are at the same distance, the one with the smallest area is used. @@ -64,9 +64,9 @@ Possible [interaction modes](https://pepstock-org.github.io/Charba/6.4/org/pepst * `DefaultInteractionMode.X`, it will find all items that would intersect based on the X coordinate of the position only. Note that this only applies to cartesian charts. * `DefaultInteractionMode.Y`, it will find all items that would intersect based on the Y coordinate of the position. Note that this only applies to cartesian charts. -New modes can be defined by adding a custom implementation, by a [IsInteractionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsInteractionMode.html) and [Interactioner](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/interaction/Interactioner.html) which can provide the items from the chart based on own logic. +New modes can be defined by adding a custom implementation, by a [IsInteractionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsInteractionMode.html) and [Interactioner](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/interaction/Interactioner.html) which can provide the items from the chart based on own logic. -By the [Interactions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/interaction/Interactions.html) singleton, you could register and unregister custom interaction mode. +By the [Interactions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/interaction/Interactions.html) singleton, you could register and unregister custom interaction mode. ```java // creates my interaction mode @@ -96,7 +96,7 @@ chart.getOptions().getTooltips().setMode("myMode"); Because the interaction mode is activated when every event is caught by the chart, sometimes the performance of a custom interaction mode could affect the chart interaction. -To address it, you can also register a custom interaction mode written in JavaScript, passing the code to [Interactions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/interaction/Interactions.html): +To address it, you can also register a custom interaction mode written in JavaScript, passing the code to [Interactions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/interaction/Interactions.html): ```java // creates my tooltip position @@ -146,11 +146,11 @@ Table with options: | Name | Type | Default | Description | :- | :- | :- | :- -| events | [IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)> | DefaultEvent.MOUSEMOVE, DefaultEvent.MOUSEOUT, DefaultEvent.CLICK, DefaultEvent.TOUCHSTART, DefaultEvent.TOUCHMOVE | The events option defines the browser events that the chart should listen to. +| events | [IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)> | DefaultEvent.MOUSEMOVE, DefaultEvent.MOUSEOUT, DefaultEvent.CLICK, DefaultEvent.TOUCHSTART, DefaultEvent.TOUCHMOVE | The events option defines the browser events that the chart should listen to. ### Clicking -The click event is thrown if the browser event type is `mouseup` or `click`. To catch the event and manage it, you can add a [ChartClickEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/ChartClickEventHandler.html) instance to the chart options, as following: +The click event is thrown if the browser event type is `mouseup` or `click`. To catch the event and manage it, you can add a [ChartClickEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/ChartClickEventHandler.html) instance to the chart options, as following: ```java // adds click event handler @@ -171,7 +171,7 @@ chart.addHandler(new ChartClickEventHandler(){ ### Hovering -The hover event is thrown when any of the events fire on the chart. To catch the event and manage it, you can add a [ChartHoverEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/ChartHoverEvent.html) instance to the chart options, as following: +The hover event is thrown when any of the events fire on the chart. To catch the event and manage it, you can add a [ChartHoverEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/ChartHoverEvent.html) instance to the chart options, as following: ```java // adds hover event handler @@ -192,7 +192,7 @@ chart.addHandler(new ChartHoverEventHandler(){ ### Resizing -The resize event is thrown when the chart has been resized. To catch the event and manage it, you can add a [ChartResizeEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/ChartClickEventHandler.html) instance to the chart options, as following: +The resize event is thrown when the chart has been resized. To catch the event and manage it, you can add a [ChartResizeEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/ChartClickEventHandler.html) instance to the chart options, as following: ```java // adds resize event handler @@ -213,7 +213,7 @@ chart.addHandler(new ChartResizeEventHandler(){ ### Selecting a dataset -When a [click](#clicking) event is fired hovering a dataset element, you can add a [DatasetSelectionEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/DatasetSelectionEventHandler.html) instance to the chart options and considering it how a dataset selection, as following: +When a [click](#clicking) event is fired hovering a dataset element, you can add a [DatasetSelectionEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/DatasetSelectionEventHandler.html) instance to the chart options and considering it how a dataset selection, as following: ```java // adds dataset selection event handler @@ -231,7 +231,7 @@ chart.addHandler(new DatasetSelectionEventHandler(){ }, DatasetSelectionEvent.TYPE); ``` -The dataset selection [event](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/DatasetSelectionEvent.html) contains the selected dataset [reference](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/DatasetReference.html) with all info about the selected dataset and item. +The dataset selection [event](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/DatasetSelectionEvent.html) contains the selected dataset [reference](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/DatasetReference.html) with all info about the selected dataset and item. ## Title events @@ -243,7 +243,7 @@ There are 3 different kinds of events that you can catch from the chart title: ### Clicking -The click event is throw if the event type is `mouseup` or `click`. When the event is fired hovering the title element, you can add a [TitleClickEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/TitleClickEventHandler.html) instance to the chart options, as following: +The click event is throw if the event type is `mouseup` or `click`. When the event is fired hovering the title element, you can add a [TitleClickEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/TitleClickEventHandler.html) instance to the chart options, as following: ```java // adds title click event handler @@ -263,7 +263,7 @@ chart.addHandler(new TitleClickEventHandler(){ ### Entering -The enter event is throw if the event type is `mousemove` and you start hovering the title element. To catch the event and manage it, you can add a [TitleEnterEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/TitleEnterEventHandler.html) instance to the chart options, as following: +The enter event is throw if the event type is `mousemove` and you start hovering the title element. To catch the event and manage it, you can add a [TitleEnterEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/TitleEnterEventHandler.html) instance to the chart options, as following: ```java // adds title enter event handler @@ -283,7 +283,7 @@ chart.addHandler(new TitleHoverEventHandler(){ ### Leaving -The leave event is throw if the event type is `mousemove` and you end hovering the title element. To catch the event and manage it, you can add a [TitleLeaveEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/TitleLeaveEventHandler.html) instance to the chart options, as following: +The leave event is throw if the event type is `mousemove` and you end hovering the title element. To catch the event and manage it, you can add a [TitleLeaveEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/TitleLeaveEventHandler.html) instance to the chart options, as following: ```java // adds title leave event handler @@ -311,7 +311,7 @@ There are 3 different kinds of events that you can catch from the chart subtitle ### Clicking -The click event is throw if the event type is `mouseup` or `click`. When the event is fired hovering the subtitle element, you can add a [SubtitleClickEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/SubtitleClickEventHandler.html) instance to the chart options, as following: +The click event is throw if the event type is `mouseup` or `click`. When the event is fired hovering the subtitle element, you can add a [SubtitleClickEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/SubtitleClickEventHandler.html) instance to the chart options, as following: ```java // adds subtitle click event handler @@ -331,7 +331,7 @@ chart.addHandler(new SubtitleClickEventHandler(){ ### Entering -The enter event is throw if the event type is `mousemove` and you start hovering the subtitle element. To catch the event and manage it, you can add a [SubtitleEnterEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/SubtitleEnterEventHandler.html) instance to the chart options, as following: +The enter event is throw if the event type is `mousemove` and you start hovering the subtitle element. To catch the event and manage it, you can add a [SubtitleEnterEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/SubtitleEnterEventHandler.html) instance to the chart options, as following: ```java // adds subtitle enter event handler @@ -351,7 +351,7 @@ chart.addHandler(new SubtitleHoverEventHandler(){ ### Leaving -The leave event is throw if the event type is `mousemove` and you end hovering the subtitle element. To catch the event and manage it, you can add a [SubtitleLeaveEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/SubtitleLeaveEventHandler.html) instance to the chart options, as following: +The leave event is throw if the event type is `mousemove` and you end hovering the subtitle element. To catch the event and manage it, you can add a [SubtitleLeaveEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/SubtitleLeaveEventHandler.html) instance to the chart options, as following: ```java // adds subtitle leave event handler @@ -378,13 +378,13 @@ There are 4 different kinds of events that you can catch from the chart axis: 1. `hover`, when you are hovering on the axis 1. `leave`, when you leave from axis element. -The axis event contain the selected scale [item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ScaleItem.html) with all info about the selected scale. +The axis event contain the selected scale [item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ScaleItem.html) with all info about the selected scale. -Due to charts can be created with specific axes, the axis event can provide the [axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Axis.html) configurations if there are, enabling you to get the instance used to configure the chart. +Due to charts can be created with specific axes, the axis event can provide the [axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Axis.html) configurations if there are, enabling you to get the instance used to configure the chart. ### Clicking -The click event is throw if the event type is `mouseup` or `click`. When the event is fired hovering an axis element, you can add a [AxisClickEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/AxisClickEventHandler.html) instance to the chart options, as following: +The click event is throw if the event type is `mouseup` or `click`. When the event is fired hovering an axis element, you can add a [AxisClickEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/AxisClickEventHandler.html) instance to the chart options, as following: ```java // adds axis click event handler @@ -404,7 +404,7 @@ chart.addHandler(new AxisClickEventHandler(){ ### Entering -The enter event is throw if the event type is `mousemove` and you start hovering the axis element. To catch the event and manage it, you can add a [AxisEnterEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/AxisEnterEventHandler.html) instance to the chart options, as following: +The enter event is throw if the event type is `mousemove` and you start hovering the axis element. To catch the event and manage it, you can add a [AxisEnterEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/AxisEnterEventHandler.html) instance to the chart options, as following: ```java // adds axis enter event handler @@ -424,7 +424,7 @@ chart.addHandler(new AxisEnterEventHandler(){ ### Hovering -The enter event is throw if the event type is `mousemove` and you are hovering the axis element. To catch the event and manage it, you can add a [AxisHoverEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/AxisHoverEventHandler.html) instance to the chart options, as following: +The enter event is throw if the event type is `mousemove` and you are hovering the axis element. To catch the event and manage it, you can add a [AxisHoverEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/AxisHoverEventHandler.html) instance to the chart options, as following: ```java // adds axis hover event handler @@ -444,7 +444,7 @@ chart.addHandler(new AxisHoverEventHandler(){ ### Leaving -The leave event is throw if the event type is `mousemove` and you end hovering the axis element. To catch the event and manage it, you can add a [AxisLeaveEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/AxisLeaveEventHandler.html) instance to the chart options, as following: +The leave event is throw if the event type is `mousemove` and you end hovering the axis element. To catch the event and manage it, you can add a [AxisLeaveEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/AxisLeaveEventHandler.html) instance to the chart options, as following: ```java // adds axis leave event handler diff --git a/docs/configuration/Layout.md b/docs/configuration/Layout.md index 8f8e91d5..edfd6470 100644 --- a/docs/configuration/Layout.md +++ b/docs/configuration/Layout.md @@ -8,7 +8,7 @@ sidebar_label: Layout The layout component enables the padding configuration to add to a chart. -The [layout](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Layout.html) configuration is nested in the configuration using +The [layout](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Layout.html) configuration is nested in the configuration using ```java // get layout @@ -32,7 +32,7 @@ The following layout options are available. | Name | Type | Description | :- | :- | :- | autoPadding | boolean | If `true`, apply automatic padding so visible elements are completely drawn. -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | To set specific padding for specific sides. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | To set specific padding for specific sides. See [padding documentation](Commons#padding) for more details. @@ -40,7 +40,7 @@ See [padding documentation](Commons#padding) for more details. Padding also accepts a callback which is called at runtime and that takes the context as single argument, see [here](ScriptableOptions#chart-context) the details, which is representing contextual information and chart instance. -The padding element can be set as a [callback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PaddingCallback.html), providing a [padding item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PaddingItem.html) instance, as following: +The padding element can be set as a [callback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PaddingCallback.html), providing a [padding item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PaddingItem.html) instance, as following: ```java // get layout @@ -61,4 +61,4 @@ The following option can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PaddingCallback.html)<ChartContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PaddingItem.html) +| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PaddingCallback.html)<ChartContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PaddingItem.html) diff --git a/docs/configuration/Legend.md b/docs/configuration/Legend.md index 915f1c95..5fd6ff59 100644 --- a/docs/configuration/Legend.md +++ b/docs/configuration/Legend.md @@ -25,16 +25,16 @@ The following legend options are available. | Name | Type | Description | :- | :- | :- -| align | [ElementAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ElementAlign.html) | Alignment of the legend. +| align | [ElementAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ElementAlign.html) | Alignment of the legend. | display | boolean | If `true`, the legend is shown. -| events | [IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)> | The events option defines the browser events that the legend should listen to. +| events | [IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)> | The events option defines the browser events that the legend should listen to. | fullSize | boolean | Marks that this box should take the full width/height of the canvas (moving other boxes). | maxHeight | int | Maximum height of the legend, in pixels. | maxWidth | int | Maximum width of the legend, in pixels. -| position | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html) | Position of the legend. +| position | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html) | Position of the legend. | reverse | boolean | Legend will show data sets in reverse order. | rtl | boolean | Set `true` for rendering the legends from right to left. -| textDirection | [TextDirection](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextDirection.html) | This will force the text direction on the canvas for rendering the legend, regardless of the CSS specified on the canvas. +| textDirection | [TextDirection](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextDirection.html) | This will force the text direction on the canvas for rendering the legend, regardless of the CSS specified on the canvas. ## Events @@ -42,7 +42,7 @@ A chart legend can emits events during its life cycle, when the user clicks, hov ### Clicking -The click event is thrown when a `click` event is registered on a label item. To catch the event and manage it, you can add a [LegendClickEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/LegendClickEventHandler.html) instance to the chart options, as following: +The click event is thrown when a `click` event is registered on a label item. To catch the event and manage it, you can add a [LegendClickEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/LegendClickEventHandler.html) instance to the chart options, as following: ```java chart.addHandler(new LegendClickEventHandler(){ @@ -60,13 +60,13 @@ chart.addHandler(new LegendClickEventHandler(){ }, LegendClickEvent.TYPE); ``` -The event provides the [legend item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/LegendItem.html) object with all information about the clicked item. +The event provides the [legend item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/LegendItem.html) object with all information about the clicked item. -When a [LegendClickEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/LegendClickEventHandler.html) instance, the default behavior of the chart (enable and disable datasets) is not performed. To invoke it, you can use [invokeLegendOnClick](../defaults/#methods) method of `Defaults` object. +When a [LegendClickEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/LegendClickEventHandler.html) instance, the default behavior of the chart (enable and disable datasets) is not performed. To invoke it, you can use [invokeLegendOnClick](../defaults/#methods) method of `Defaults` object. ### Hovering -The hover event is thrown when a `mousemove` event is registered on top of a label item. To catch the event and manage it, you can add a [LegendHoverEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/LegendHoverEventHandler.html) instance to the chart options, as following: +The hover event is thrown when a `mousemove` event is registered on top of a label item. To catch the event and manage it, you can add a [LegendHoverEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/LegendHoverEventHandler.html) instance to the chart options, as following: ```java chart.addHandler(new LegendHoverEventHandler(){ @@ -84,13 +84,13 @@ chart.addHandler(new LegendHoverEventHandler(){ }, LegendHoverEvent.TYPE); ``` -The event provides the [legend item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/LegendItem.html) object with all information about the hovered item. +The event provides the [legend item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/LegendItem.html) object with all information about the hovered item. -When a [LegendHoverEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/LegendHoverEventHandler.html) instance, the default behavior of the chart is not performed. To invoke it, you can use [invokeLegendOnHover](../defaults/#methods) method of `Defaults` object. +When a [LegendHoverEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/LegendHoverEventHandler.html) instance, the default behavior of the chart is not performed. To invoke it, you can use [invokeLegendOnHover](../defaults/#methods) method of `Defaults` object. ### Leaving -The leave event is thrown when a `mouseout` event is registered on top of a label item. To catch the event and manage it, you can add a [LegendLeaveEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/LegendLeaveEventHandler.html) instance to the chart options, as following: +The leave event is thrown when a `mouseout` event is registered on top of a label item. To catch the event and manage it, you can add a [LegendLeaveEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/LegendLeaveEventHandler.html) instance to the chart options, as following: ```java chart.addHandler(new LegendleaveEventHandler(){ @@ -108,9 +108,9 @@ chart.addHandler(new LegendleaveEventHandler(){ }, LegendLeaveEvent.TYPE); ``` -The event provides the [legend item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/LegendItem.html) object with all information about the left item. +The event provides the [legend item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/LegendItem.html) object with all information about the left item. -When a [LegendLeaveEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/LegendLeaveEventHandler.html) instance, the default behavior of the chart is not performed. To invoke it, you can use [invokeLegendOnLeave](../defaults/#methods) method of `Defaults` object. +When a [LegendLeaveEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/LegendLeaveEventHandler.html) instance, the default behavior of the chart is not performed. To invoke it, you can use [invokeLegendOnLeave](../defaults/#methods) method of `Defaults` object. ## Legend labels @@ -137,12 +137,12 @@ The following are the attributes that you can set: | borderRadius | int | Override the borderRadius to use. | boxWidth | int | Width of colored box. | boxHeight | int | Height of the colored box. -| color | String - String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | The color of the legend text label.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | Font family of legend text label.
See [Font](../defaults/DefaultsCharts#font). +| color | String - String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | The color of the legend text label.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | Font family of legend text label.
See [Font](../defaults/DefaultsCharts#font). | padding | int | Padding between rows of colored boxes. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | This style of point is used for the legend. Only used if `usePointStyle` is `true`. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | This style of point is used for the legend. Only used if `usePointStyle` is `true`. | pointStyleWidth | double | If `usePointStyle` is `true`, the width of the point style used for the legend. -| textAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | Horizontal alignment of the label text. +| textAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | Horizontal alignment of the label text. | useBorderRadius | boolean | Label border radius will match corresponding border radius. | usePointStyle | boolean | Label style will match corresponding point style (size is based on fontSize, boxWidth is not used in this case). @@ -154,7 +154,7 @@ A chart legend labels can be configured at runtime, providing some interfaces fo Allows filtering of legend items. -To apply a filter callback, you can set a [LegendFilterCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/LegendFilterCallback.html) instance to the chart options, as following: +To apply a filter callback, you can set a [LegendFilterCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/LegendFilterCallback.html) instance to the chart options, as following: ```java chart.getOptions().getLegend().getLabels().setFilterCallback(new LegendFilterCallback(){ @@ -176,13 +176,13 @@ chart.getOptions().getLegend().getLabels().setFilterCallback(new LegendFilterCal }); ``` -The callback uses [LegendItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/LegendItem.html) to enable filtering. +The callback uses [LegendItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/LegendItem.html) to enable filtering. #### `itemSort` callback Allows sorting of legend items. -To apply a item sort callback, you can set a [LegendItemSortCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/LegendItemSortCallback.html) instance to the chart options, as following: +To apply a item sort callback, you can set a [LegendItemSortCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/LegendItemSortCallback.html) instance to the chart options, as following: ```java chart.getOptions().getLegend().getLabels().setItemSortCallback(new LegendItemSortCallback(){ @@ -204,13 +204,13 @@ chart.getOptions().getLegend().getLabels().setItemSortCallback(new LegendItemSor }); ``` -The callback uses [LegendItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/LegendItem.html) to enable filtering. +The callback uses [LegendItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/LegendItem.html) to enable filtering. #### `generateLabels` callback Generates legend label items for each thing in the legend. Default implementation returns the text and styling for the color box. -To apply a custom callback, you can set a [legend labels callback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/LegendLabelsCallback.html) instance to the chart options, as following: +To apply a custom callback, you can set a [legend labels callback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/LegendLabelsCallback.html) instance to the chart options, as following: ```java chart.getOptions().getLegend().getLegendLabels().setLabelsCallback(new LegendLabelsCallback(){ @@ -235,7 +235,7 @@ The callback gets the list of legend items, as argument, that [Chart.JS](http:// This helps the implementation of the callback because you can change ONLY what you need to update. -The callback returns a list of [label items](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/LegendLabelItem.html), which the properties to be applied. +The callback returns a list of [label items](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/LegendLabelItem.html), which the properties to be applied. ## Legend title @@ -261,9 +261,9 @@ The following are the attributes that you can set: | Name | Type | | Description | :- | :- | :- | display | boolean | If `true`, the legend title is shown. -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | Number of pixels to add above and below the title text.
See [padding documentation](Commons#padding) for more details. -| color | String - String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | The color of the legend text title.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | Font family of legend text title.
See [Font](../defaults/DefaultsCharts#font). +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | Number of pixels to add above and below the title text.
See [padding documentation](Commons#padding) for more details. +| color | String - String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | The color of the legend text title.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | Font family of legend text title.
See [Font](../defaults/DefaultsCharts#font). ## AtLeastOneDatasetHandler event handler diff --git a/docs/configuration/ScriptableOptions.md b/docs/configuration/ScriptableOptions.md index 663e4fe2..10ab631a 100644 --- a/docs/configuration/ScriptableOptions.md +++ b/docs/configuration/ScriptableOptions.md @@ -34,23 +34,23 @@ The object is preserved, so it can be used to store and pass information between There are the following different types of context objects, to be consumed on scriptable options on chart elements (plugins excluded): - * [chart context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ChartContext.html) used for scriptable options that apply at chart configuration level. - * [dataset context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DatasetContext.html) used for scriptable options that apply at dataset or data configuration level. - * [scale context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleContext.html) used for scriptable options that apply at scale or ticks level. + * [chart context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ChartContext.html) used for scriptable options that apply at chart configuration level. + * [dataset context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DatasetContext.html) used for scriptable options that apply at dataset or data configuration level. + * [scale context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleContext.html) used for scriptable options that apply at scale or ticks level. Apart for the options stored by the user in the context (attributes), all other options must be considered as read-only properties. ### Chart context -The [chart context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ChartContext.html) is used for scriptable options set in the chart configuration and is providing all necessary information about the chart in order to apply own logic. +The [chart context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ChartContext.html) is used for scriptable options set in the chart configuration and is providing all necessary information about the chart in order to apply own logic. The context object contains the following properties: | Name | Type | Description | :- | :- | :- -| chart | [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) | Chart instance. -| type | [ContextType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can only be `ContextType.CHART`. -| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. +| chart | [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) | Chart instance. +| type | [ContextType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can only be `ContextType.CHART`. +| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. ### Custom attributes @@ -58,7 +58,7 @@ You can set custom attributes in the context. When the context is persistent, th | Name | Type | Description | :- | :- | :- -| [Key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/Key.html) instance | boolean - double - int - String | The key could not be the same of the existing context properties and can set custom attributes. +| [Key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/Key.html) instance | boolean - double - int - String | The key could not be the same of the existing context properties and can set custom attributes. ```java // creates datasets instance from chart @@ -99,7 +99,7 @@ dataset.setBackgroundColor(new ColorCallback(){ ### Dataset context -The [dataset context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DatasetContext.html) is used for data set scriptable options which are providing all necessary information to get the data and data set links in order to apply own logic. +The [dataset context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DatasetContext.html) is used for data set scriptable options which are providing all necessary information to get the data and data set links in order to apply own logic. Here is an example: @@ -133,14 +133,14 @@ The context object contains the following properties: | Name | Type | Description | :- | :- | :- | active | boolean | Whether the associated element is hovered. -| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. -| chart | [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) | Chart instance. +| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. +| chart | [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) | Chart instance. | dataIndex | int | The index of the current data. -| element | [ChartElement](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ChartElement.html) | The element (point, arc, bar, etc.) for this data +| element | [ChartElement](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ChartElement.html) | The element (point, arc, bar, etc.) for this data | datasetIndex | int | The index of the current data set. -| datasetItem | [DatasetItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/DatasetItem.html) | The data set information for this data -| mode | [TransitionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/TransitionMode.html) | The update mode, brought by conte -| type | [ContextType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be `ContextType.DATASET` or `ContextType.DATA`. +| datasetItem | [DatasetItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/DatasetItem.html) | The data set information for this data +| mode | [TransitionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/TransitionMode.html) | The update mode, brought by conte +| type | [ContextType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be `ContextType.DATASET` or `ContextType.DATA`. The following matrix will report which properties are available based on the context type. @@ -198,7 +198,7 @@ The following matrix will report which properties are available based on the con ### Scale context -The [scale context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ScaleContext.html) is used for scales and ticks scriptable options which are providing all necessary information to get the scale and ticks links in order to apply own logic. +The [scale context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ScaleContext.html) is used for scales and ticks scriptable options which are providing all necessary information to get the scale and ticks links in order to apply own logic. Here is an example: @@ -220,14 +220,14 @@ The context object contains the following properties: | Name | Type | Description | :- | :- | :- -| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. -| axis | [Axis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Axis.html) | Axis instance. -| chart | [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) | Chart instance. +| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. +| axis | [Axis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Axis.html) | Axis instance. +| chart | [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) | Chart instance. | index | int | The index of the current tick or the label (wfor [point labels](../axes/PointLabels#scriptable) callback). | label | String | the label that is shown on the perimeter of the scale. Only for [point labels](../axes/PointLabels#scriptable) callback. -| scale | [ScaleItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ScaleItem.html) | The scale associated to this context. -| tick | [ScaleTickItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ScaleTickItem.html)| The tick associated to this context. -| type | [ContextType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be `ContextType.SCALE`, `ContextType.TICK` or `ContextType.POINT_LABEL`. +| scale | [ScaleItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ScaleItem.html) | The scale associated to this context. +| tick | [ScaleTickItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ScaleTickItem.html)| The tick associated to this context. +| type | [ContextType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be `ContextType.SCALE`, `ContextType.TICK` or `ContextType.POINT_LABEL`. The following matrix will report which properties are available based on the context type. @@ -290,9 +290,9 @@ The following matrix will report which properties are available based on the con There are use cases where the scriptable options callbacks are called several hundreds because are related to the amount of data set on datasets of the charts. -When you are in above use case and you need the best performance, you can set a scriptable options by a [native java script callback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/NativeCallback.html). +When you are in above use case and you need the best performance, you can set a scriptable options by a [native java script callback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/NativeCallback.html). -A [native java script callback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/NativeCallback.html) is built with java script code in order to be execute directly from [Chart.JS](http://www.chartjs.org/). +A [native java script callback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/NativeCallback.html) is built with java script code in order to be execute directly from [Chart.JS](http://www.chartjs.org/). ```java // creates a callback diff --git a/docs/configuration/Subtitle.md b/docs/configuration/Subtitle.md index 5fa119fe..d10e7464 100644 --- a/docs/configuration/Subtitle.md +++ b/docs/configuration/Subtitle.md @@ -28,13 +28,13 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| align | [ElementAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ElementAlign.html) | [Yes](#scriptable) | Alignment of the subtitle. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Color of text of the subtitle.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| align | [ElementAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ElementAlign.html) | [Yes](#scriptable) | Alignment of the subtitle. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Color of text of the subtitle.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | display | boolean | [Yes](#scriptable) | If `true`, the subtitle is shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | [Yes](#scriptable) | Font of subtitle text. The default value is the global font with the style set to FontStyle.BOLD.
See [Font](../defaults/DefaultsCharts#font). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | [Yes](#scriptable) | Font of subtitle text. The default value is the global font with the style set to FontStyle.BOLD.
See [Font](../defaults/DefaultsCharts#font). | fullSize | boolean | [Yes](#scriptable) | Marks that this box should take the full width/height of the canvas (moving other boxes). -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | [Yes](#scriptable) | Number of pixels to add above and below the subtitle text.
See [padding documentation](Commons#padding) for more details. -| position | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html) | [Yes](#scriptable) | Position of subtitle. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | [Yes](#scriptable) | Number of pixels to add above and below the subtitle text.
See [padding documentation](Commons#padding) for more details. +| position | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html) | [Yes](#scriptable) | Position of subtitle. ## Scriptable @@ -59,10 +59,10 @@ The following option can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| align | [ElementAlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ElementAlignCallback.html)<ChartContext> | [ElementAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ElementAlign.html) -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ChartContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<ChartContext> | boolean -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<ChartContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| fullSize | [FullSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FullSizeCallback.html)<ChartContext> | boolean -| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PaddingCallback.html)<ChartContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PaddingItem.html) -| position | [PositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PositionCallback.html)<ChartContext> | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html) +| align | [ElementAlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ElementAlignCallback.html)<ChartContext> | [ElementAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ElementAlign.html) +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ChartContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<ChartContext> | boolean +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<ChartContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| fullSize | [FullSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FullSizeCallback.html)<ChartContext> | boolean +| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PaddingCallback.html)<ChartContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PaddingItem.html) +| position | [PositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PositionCallback.html)<ChartContext> | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html) diff --git a/docs/configuration/Title.md b/docs/configuration/Title.md index 86187ec7..8fb70e81 100644 --- a/docs/configuration/Title.md +++ b/docs/configuration/Title.md @@ -28,13 +28,13 @@ The following are the attributes that you can set: | Name | Type | Scriptable | Description | :- | :- | :- | :- -| align | [ElementAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ElementAlign.html) | [Yes](#scriptable) | Alignment of the title. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Color of text of the title.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| align | [ElementAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ElementAlign.html) | [Yes](#scriptable) | Alignment of the title. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [Yes](#scriptable) | Color of text of the title.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | display | boolean | [Yes](#scriptable) | If `true`, the title is shown. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | [Yes](#scriptable) | Font of title text. The default value is the global font with the style set to FontStyle.BOLD.
See [Font](../defaults/DefaultsCharts#font). +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | [Yes](#scriptable) | Font of title text. The default value is the global font with the style set to FontStyle.BOLD.
See [Font](../defaults/DefaultsCharts#font). | fullSize | boolean | [Yes](#scriptable) | Marks that this box should take the full width/height of the canvas (moving other boxes). -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | [Yes](#scriptable) | Number of pixels to add above and below the title text.
See [padding documentation](Commons#padding) for more details. -| position | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html) | [Yes](#scriptable) | Position of title. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | [Yes](#scriptable) | Number of pixels to add above and below the title text.
See [padding documentation](Commons#padding) for more details. +| position | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html) | [Yes](#scriptable) | Position of title. ## Scriptable @@ -59,10 +59,10 @@ The following option can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| align | [ElementAlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ElementAlignCallback.html)<ChartContext> | [ElementAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ElementAlign.html) -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<ChartContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<ChartContext> | boolean -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<ChartContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| fullSize | [FullSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FullSizeCallback.html)<ChartContext> | boolean -| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PaddingCallback.html)<ChartContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PaddingItem.html) -| position | [PositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PositionCallback.html)<ChartContext> | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html) +| align | [ElementAlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ElementAlignCallback.html)<ChartContext> | [ElementAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ElementAlign.html) +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<ChartContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<ChartContext> | boolean +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<ChartContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| fullSize | [FullSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FullSizeCallback.html)<ChartContext> | boolean +| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PaddingCallback.html)<ChartContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PaddingItem.html) +| position | [PositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PositionCallback.html)<ChartContext> | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html) diff --git a/docs/configuration/Tooltip.md b/docs/configuration/Tooltip.md index 46b2815b..1fb1417f 100644 --- a/docs/configuration/Tooltip.md +++ b/docs/configuration/Tooltip.md @@ -31,52 +31,52 @@ The following are the attributes that you can set: | Name | Type | Description | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | Background color of the tooltips. -| bodyColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | Color of body text. -| bodyFont | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | Font of body text. The default value is the global font with the style set to FontStyle.NORMAL.
See [Font](../defaults/DefaultsCharts#font). -| bodyAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | Alignment of body element of the tooltips. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | Background color of the tooltips. +| bodyColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | Color of body text. +| bodyFont | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | Font of body text. The default value is the global font with the style set to FontStyle.NORMAL.
See [Font](../defaults/DefaultsCharts#font). +| bodyAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | Alignment of body element of the tooltips. | bodySpacing | int | Spacing to add to top and bottom of each tooltip item. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | Color of the border. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | Color of the border. | borderWidth | int | Size of the border. | boxWidth | int | Width of the color box if `displayColors` is `true`. | boxHeight | int | Height of the color box if `displayColors` is `true`. | caretPadding | int | Extra distance to move the end of the tooltip arrow away from the tooltip point. | caretSize | int | Size, in px, of the tooltip arrow. -| cornerRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) | Radius of tooltip corner curves. +| cornerRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) | Radius of tooltip corner curves. | displayColors | boolean | If `true`, color boxes are shown in the tooltip. | enabled | boolean | If `true`, the tooltips are enabled. -| events | [IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)> | The events option defines the browser events that the tooltip should listen to. -| footerColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | Color of the footer. -| footerFont | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | Font of footer text. The default value is the global font with the style set to FontStyle.BOLD.
See [Font](../defaults/DefaultsCharts#font). -| footerAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | Alignment of footer element of the tooltips. +| events | [IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)> | The events option defines the browser events that the tooltip should listen to. +| footerColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | Color of the footer. +| footerFont | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | Font of footer text. The default value is the global font with the style set to FontStyle.BOLD.
See [Font](../defaults/DefaultsCharts#font). +| footerAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | Alignment of footer element of the tooltips. | footerMarginTop | int | Margin to add before drawing the footer. | footerSpacing | int | Spacing to add to top and bottom of each footer line. | intersect | boolean | if `true`, the tooltip mode applies only when the mouse position intersects with an element. If `false`, the mode will be applied at all times. -| mode | String - [IsInteractionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultInteractionMode.html) | Sets which elements appear in the tooltip. -| multiKeyBackground | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | Color to draw behind the colored boxes when multiple items are in the tooltip. -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | The padding to add inside the tooltip.
See [padding documentation](Commons#padding) for more details. -| position | [TooltipPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TooltipPosition.html) | The mode for positioning the tooltip. +| mode | String - [IsInteractionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultInteractionMode.html) | Sets which elements appear in the tooltip. +| multiKeyBackground | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | Color to draw behind the colored boxes when multiple items are in the tooltip. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | The padding to add inside the tooltip.
See [padding documentation](Commons#padding) for more details. +| position | [TooltipPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TooltipPosition.html) | The mode for positioning the tooltip. | rtl | boolean | `true` for rendering the tooltips from right to left. -| textDirection | [TextDirection](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextDirection.html) | This will force the text direction on the canvas for rendering the tooltips, regardless of the CSS specified on the canvas -| titleColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | Color of the footer. -| titleFont | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | Font of title text. The default value is the global font with the style set to FontStyle.BOLD.
See [Font](../defaults/DefaultsCharts#font). -| titleAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | Alignment of title element of the tooltips. +| textDirection | [TextDirection](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextDirection.html) | This will force the text direction on the canvas for rendering the tooltips, regardless of the CSS specified on the canvas +| titleColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | Color of the footer. +| titleFont | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | Font of title text. The default value is the global font with the style set to FontStyle.BOLD.
See [Font](../defaults/DefaultsCharts#font). +| titleAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | Alignment of title element of the tooltips. | titleMarginBottom | int | Margin to add on bottom of title section. | titleSpacing | int | Spacing to add to top and bottom of each title line. | usePointStyle | boolean | Use the corresponding point style (from dataset options) instead of color boxes (size is based on the minimum value between box width and box height). -| xAlign | [TooltipAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TooltipAlign.html) | Position of the tooltip caret in the X direction.
Can accept only TooltipAlign.LEFT, TooltipAlign.CENTER and TooltipAlign.RIGHT. -| yAlign | [TooltipAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TooltipAlign.html) | Position of the tooltip caret in the Y direction.
Can accept only TooltipAlign.TOP, TooltipAlign.CENTER and TooltipAlign.BOTTOM. +| xAlign | [TooltipAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TooltipAlign.html) | Position of the tooltip caret in the X direction.
Can accept only TooltipAlign.LEFT, TooltipAlign.CENTER and TooltipAlign.RIGHT. +| yAlign | [TooltipAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TooltipAlign.html) | Position of the tooltip caret in the Y direction.
Can accept only TooltipAlign.TOP, TooltipAlign.CENTER and TooltipAlign.BOTTOM. ### Positioning -Possible [tooltip position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TooltipPosition.html) out-of the box are: +Possible [tooltip position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TooltipPosition.html) out-of the box are: * `TooltipPosition.AVERAGE`, it will place the tooltip at the average position of the items displayed in the tooltip. * `TooltipPosition.NEAREST`, it will place the tooltip at the position of the element closest to the event position. -New modes can be defined by adding a custom implementation, by a [TooltipPositioner](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/positioner/TooltipPositioner.html) which can provide the tooltip position based on own logic. +New modes can be defined by adding a custom implementation, by a [TooltipPositioner](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/positioner/TooltipPositioner.html) which can provide the tooltip position based on own logic. -By the [Positioner](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/positioner/Positioner.html) singleton, you could register and unregister custom positioners. +By the [Positioner](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/positioner/Positioner.html) singleton, you could register and unregister custom positioners. ```java // creates my tooltip position @@ -119,7 +119,7 @@ chart.getOptions().getTooltips().setPosition(myPosition); If the positioner will return `null` instead of a point, the tooltip will disappear. -The [Positioner](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/positioner/Positioner.html) provides a method to get the position calculated by defined tooltip position. +The [Positioner](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/positioner/Positioner.html) provides a method to get the position calculated by defined tooltip position. ```java // creates my tooltip position @@ -175,7 +175,7 @@ A chart tooltips can be configured at runtime, providing some interfaces for a s ### Sorting -The implementation of [TooltipItemSortCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TooltipItemSortCallback.html) allows sorting of tooltip items. +The implementation of [TooltipItemSortCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TooltipItemSortCallback.html) allows sorting of tooltip items. To apply the callback, you can set a instance to the chart options, as following: @@ -200,11 +200,11 @@ chart.getOptions().getTooltips().setItemSortCallback(new TooltipItemSortCallback }); ``` -The callback uses a couple of [TooltipItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/TooltipItem.html) to enable the sort. +The callback uses a couple of [TooltipItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/TooltipItem.html) to enable the sort. ### Filtering -The implementation of [TooltipFilterCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TooltipFilterCallback.html) allows filtering of tooltip items. +The implementation of [TooltipFilterCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TooltipFilterCallback.html) allows filtering of tooltip items. To apply the callback, you can set a instance to the chart options, as following: @@ -228,7 +228,7 @@ chart.getOptions().getTooltips().setFilterCallback(new TooltipFilterCallback(){ }); ``` -The callback uses [TooltipItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/TooltipItem.html) to enable filtering. +The callback uses [TooltipItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/TooltipItem.html) to enable filtering. ## Elements callbacks @@ -254,7 +254,7 @@ To invoke the default behavior of the chart, you can use [defaults](../defaults/ ### Title -The [TooltipTitleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TooltipTitleCallback.html) is triggered for providing text of title. +The [TooltipTitleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TooltipTitleCallback.html) is triggered for providing text of title. All methods must return a list of strings which are treated as multiple lines of text. @@ -302,7 +302,7 @@ public interface TooltipTitleCallback { } ``` -To apply the callback, you can set a [TooltipTitleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TooltipTitleCallback.html) instance to the chart options, as following: +To apply the callback, you can set a [TooltipTitleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TooltipTitleCallback.html) instance to the chart options, as following: ```java chart.getOptions().getTooltips().getCallbacks().setTitleCallback(new TooltipTitleCallback){ @@ -314,7 +314,7 @@ chart.getOptions().getTooltips().getCallbacks().setTitleCallback(new TooltipTitl ### Body -The [TooltipBodyCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TooltipBodyCallback.html) is triggered for providing text of body. +The [TooltipBodyCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TooltipBodyCallback.html) is triggered for providing text of body. All methods must return a list of strings which are treated as multiple lines of text. @@ -349,7 +349,7 @@ public interface TooltipBodyCallback { } ``` -To apply the callback, you can set a [TooltipBodyCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TooltipBodyCallback.html) instance to the chart options, as following: +To apply the callback, you can set a [TooltipBodyCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TooltipBodyCallback.html) instance to the chart options, as following: ```java chart.getOptions().getTooltips().getCallbacks().setBodyCallback(new TooltipBodyCallback){ @@ -361,7 +361,7 @@ chart.getOptions().getTooltips().getCallbacks().setBodyCallback(new TooltipBodyC ### Footer -The [TooltipFooterCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TooltipFooterCallback.html) is triggered for providing text of footer. +The [TooltipFooterCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TooltipFooterCallback.html) is triggered for providing text of footer. All methods must return a list of strings which are treated as multiple lines of text. @@ -408,7 +408,7 @@ public interface TooltipFooterCallback { } ``` -To apply the callback, you can set a [TooltipFooterCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TooltipFooterCallback.html) instance to the chart options, as following: +To apply the callback, you can set a [TooltipFooterCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TooltipFooterCallback.html) instance to the chart options, as following: ```java chart.getOptions().getTooltips().getCallbacks().setFooterCallback(new TooltipFooterCallback){ @@ -420,7 +420,7 @@ chart.getOptions().getTooltips().getCallbacks().setFooterCallback(new TooltipFoo ### Label -The [TooltipLabelCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TooltipLabelCallback.html) is triggered for providing the text and colors that displays for a given data point. +The [TooltipLabelCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TooltipLabelCallback.html) is triggered for providing the text and colors that displays for a given data point. This callback takes care about labels and styles to apply to the tooltip items, all methods are implemented by own defaults in order that you can implement only the method where you are interested in: @@ -502,7 +502,7 @@ public interface TooltipLabelCallback { } ``` -To apply the callback, you can set a [TooltipLabelCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TooltipLabelCallback.html) instance to the chart options, as following: +To apply the callback, you can set a [TooltipLabelCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TooltipLabelCallback.html) instance to the chart options, as following: ```java chart.getOptions().getTooltips().getCallbacks().setLabelCallback(new TooltipLabelCallback){ @@ -512,13 +512,13 @@ chart.getOptions().getTooltips().getCallbacks().setLabelCallback(new TooltipLabe }); ``` -To set the color or borders of labels, there is [TooltipLabelColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/TooltipLabelColor.html) class which enable the setting of colors and borders. +To set the color or borders of labels, there is [TooltipLabelColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/TooltipLabelColor.html) class which enable the setting of colors and borders. -To set the point style of labels, there is [TooltipLabelPointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/TooltipLabelPointStyle.html) class which enable the setting of point style and the rotation to apply. +To set the point style of labels, there is [TooltipLabelPointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/TooltipLabelPointStyle.html) class which enable the setting of point style and the rotation to apply. ## External rendering callback -The implementation of [TooltipExternalCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TooltipExternalCallback.html) allows you to hook in the tooltip rendering process so that you can render the tooltip in own custom way. +The implementation of [TooltipExternalCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TooltipExternalCallback.html) allows you to hook in the tooltip rendering process so that you can render the tooltip in own custom way. @@ -550,4 +550,4 @@ chart.getOptions().getTooltips().setExternalCallback(new TooltipExternalCallback }); ``` -The callback can use the [tooltip model](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/TooltipModel.html), with the complete model about the tooltip. +The callback can use the [tooltip model](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/TooltipModel.html), with the complete model about the tooltip. diff --git a/docs/defaults/Defaults.md b/docs/defaults/Defaults.md index 6e120efb..cdc46a72 100644 --- a/docs/defaults/Defaults.md +++ b/docs/defaults/Defaults.md @@ -19,9 +19,9 @@ There are 4 main defaults entities that you can manage to configure your charts, 1. [Global](#global): global options, containing the configuration items which can be applied to all charts, whatever type of chart. Scale configuration is excluded. 1. [Chart option](#charts-type): global options related to a specific type of chart, containing both options and scales configuration. 1. [Scale](#scales): global options related to scale, containing the configuration items which can be applied to all charts (with scales), whatever type of chart. - 1. [Scale type](#scales-type): global options related to a specific [type](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/AxisType.htmll) of scale which can be applied to all charts which are using that type of scale. + 1. [Scale type](#scales-type): global options related to a specific [type](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/AxisType.htmll) of scale which can be applied to all charts which are using that type of scale. -**Charba** is providing a singleton [Defaults](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Defaults.html) which allows you to manage all defaults entities above mentioned. +**Charba** is providing a singleton [Defaults](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Defaults.html) which allows you to manage all defaults entities above mentioned. :::info It's not possible to apply any callbacks or any events handlers at global level, but only on at chart instance one. @@ -29,7 +29,7 @@ It's not possible to apply any callbacks or any events handlers at global level, ## Global -To change the global options, **Charba** is providing the method `getGlobal` in the [Defaults](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Defaults.html) class. These options will be applied to all charts, whatever type of chart. +To change the global options, **Charba** is providing the method `getGlobal` in the [Defaults](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Defaults.html) class. These options will be applied to all charts, whatever type of chart. With above method you can get all global configurations of [Chart.JS](http://www.chartjs.org/) and you have got all `set` and `get` methods to change or retrieve the global configuration items. @@ -45,11 +45,11 @@ double circumference = Defaults.get().getGlobal().getCircumference(); ## Charts type -To change the global options for a specific chart type, **Charba** is providing the method `getOptions` in the [Defaults](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Defaults.html) class. +To change the global options for a specific chart type, **Charba** is providing the method `getOptions` in the [Defaults](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Defaults.html) class. With this method you can get all global configurations for a specific chart of [Chart.JS](http://www.chartjs.org/) and you have got all `set` and `get` methods to change or retrieve the global configuration items. -The chart type are defined in a enumeration, [ChartType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ChartType.html) but, by controllers, you can create your chart type, therefore the method will accept a [Type](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Type.html) object. +The chart type are defined in a enumeration, [ChartType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ChartType.html) but, by controllers, you can create your chart type, therefore the method will accept a [Type](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Type.html) object. ```java // -------------------------------------- @@ -65,9 +65,9 @@ Defaults.get().getOptions(ChartType.LINE).getElements().getPoint().setPointStyle ## Scales -To change the global scale, **Charba** is providing the method `getScale` in the [defaults](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Defaults.html). +To change the global scale, **Charba** is providing the method `getScale` in the [defaults](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Defaults.html). -With this method you can get all global configuration of [Chart.JS](http://www.chartjs.org/) for [scale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/GlobalScale.html) (common one, not related to chart type) and you have got all `set` and `get` methods to change or retrieve the global configuration items. +With this method you can get all global configuration of [Chart.JS](http://www.chartjs.org/) for [scale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/GlobalScale.html) (common one, not related to chart type) and you have got all `set` and `get` methods to change or retrieve the global configuration items. ```java // -------------------------------------- @@ -78,7 +78,7 @@ Defaults.get().getScale().setStacked(true); ## Scales type -To change the global scale for a specific scale type, **Charba** is providing the method `getScale` in the [Defaults](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Defaults.html) class, passing the [type](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/AxisType.html) of the scale. +To change the global scale for a specific scale type, **Charba** is providing the method `getScale` in the [Defaults](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Defaults.html) class, passing the [type](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/AxisType.html) of the scale. With this method you can get all global configurations for a specific type of scale and you have got all `set` and `get` methods to change or retrieve the global configuration items. diff --git a/docs/defaults/DefaultsCharts.md b/docs/defaults/DefaultsCharts.md index d15b4d95..97b6beb4 100644 --- a/docs/defaults/DefaultsCharts.md +++ b/docs/defaults/DefaultsCharts.md @@ -7,7 +7,7 @@ sidebar_label: Charts ## Commons charts options -To change the global options, **Charba** is providing the method `getGlobal` in the [Defaults](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Defaults.html) class. These options will be applied to all charts, whatever type of chart. +To change the global options, **Charba** is providing the method `getGlobal` in the [Defaults](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Defaults.html) class. These options will be applied to all charts, whatever type of chart. With above method you can get all global configurations of [Chart.JS](http://www.chartjs.org/) and you have got all `set` and `get` methods to change or retrieve the global configuration items. @@ -29,18 +29,18 @@ The following are the attributes that you can set: | aspectRatio | double | 2 | Canvas aspect ratio (i.e. width / height, a value of 1 representing a square canvas). | autoColors | boolean | `true` | `true` if the chart will cycle through a palette of seven [Chart.JS](http://www.chartjs.org/) brand colors. See [color](../coloring/Colors#default-color-palette) section. | autoColorsForceOverride | boolean | `false` | `true` if you want to force the auto colors to always color your datasets, for example when using dynamic datasets at runtime. See [color](../coloring/Colors#default-color-palette) section. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgba(0,0,0,0.1) -          | The default background color to use in the chart. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgba(0,0,0,0.1) -          | The default border color to use in the chart. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgba(0,0,0,0.1) -          | The default background color to use in the chart. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgba(0,0,0,0.1) -          | The default border color to use in the chart. | circumference | double | 360 | The sweep to allow arcs to cover. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | #666 -          | The default font color to use in the chart. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | #666 -          | The default font color to use in the chart. | cutoutPercentage | String | `null` | The percentage of the chart that is cut out of the middle. It's a string, ending with '%', as percentage of the chart radius.
See pie and doughnut chart configuration for defaults. | cutout | double | `Undefined.DOUBLE` | The portion of the chart that is cut out of the middle, in pixels.
See pie and doughnut chart configuration for defaults. | destroyOnDetach | boolean | `true` | `true` if the chart is configured to be destroyed on the detach from element. -| devicePixelRatio | double | [Window.getDevicePixelRatio()](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/Window.html#getDevicePixelRatio--) | Default device pixel ratio. By default the chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio. +| devicePixelRatio | double | [Window.getDevicePixelRatio()](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/Window.html#getDevicePixelRatio--) | Default device pixel ratio. By default the chart's canvas will use a 1:1 pixel ratio, unless the physical display has a higher pixel ratio. | drawOnAttach | boolean | `true` | `true` if the chart is configured to be draw on the attach of element -| events | [IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)> | DefaultEvent.MOUSEMOVE,
DefaultEvent.MOUSEOUT,
DefaultEvent.CLICK,
DefaultEvent.TOUCHSTART,
DefaultEvent.TOUCHMOVE | The events option defines the browser events that the chart should listen to. -| indexAxis | [IndexAxis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IndexAxis.html) | IndexAxis.X | The base axis for the BAR dataset. Use 'y' for horizontal bar. -| locale | [CLocale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) | `CLocale.getDefaults()` | A string with a BCP 47 language tag.
See [INTL locale](../intl/Locale#locale). +| events | [IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)> | DefaultEvent.MOUSEMOVE,
DefaultEvent.MOUSEOUT,
DefaultEvent.CLICK,
DefaultEvent.TOUCHSTART,
DefaultEvent.TOUCHMOVE | The events option defines the browser events that the chart should listen to. +| indexAxis | [IndexAxis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IndexAxis.html) | IndexAxis.X | The base axis for the BAR dataset. Use 'y' for horizontal bar. +| locale | [CLocale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) | `CLocale.getDefaults()` | A string with a BCP 47 language tag.
See [INTL locale](../intl/Locale#locale). | maintainAspectRatio | boolean | `true` | Maintain the original canvas aspect ratio (width / height) when resizing. | radiusPercentage | String | `100%` | the outer radius of the chart. It's a string, ending with '%', as percentage of the maximum radius. | radius | double | `Undefined.DOUBLE` | The outer radius of the chart, in pixels. @@ -71,15 +71,15 @@ int size = Defaults.get().getGlobal().getFont().getSize(); | :- | :- | :- | :- | family | String | "'Helvetica Neue', 'Helvetica', 'Arial', sans-serif" | Font family for all text. | size | int | 12 | Font size (in px) for text. -| style | [FontStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/FontStyle.html) | FontStyle.NORMAL | Font style for text. -| weight | [Weight](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Weight.html) | Weight.NORMAL | Font weight (boldness) for text.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight). +| style | [FontStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/FontStyle.html) | FontStyle.NORMAL | Font style for text. +| weight | [Weight](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Weight.html) | Weight.NORMAL | Font weight (boldness) for text.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/font-weight). | lineHeight | double - String | 1.2 | Height of an individual line of text.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/CSS/line-height). ## Interaction The interaction options are managing the ways how to act on the charts. -The interaction configuration is passed using the [Hover](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Interaction.html) object in the defaults one: +The interaction configuration is passed using the [Hover](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Interaction.html) object in the defaults one: ```java // -------------------------------------- @@ -94,16 +94,16 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| axis | [InteractionAxis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/InteractionAxis.html) | InteractionAxis.X | Define which directions are used in calculating distances. +| axis | [InteractionAxis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/InteractionAxis.html) | InteractionAxis.X | Define which directions are used in calculating distances. | intersect | boolean | `true` | if `true`, the hover mode only applies when the mouse position intersects an item on the chart. | includeInvisible | boolean | `false` | if `true`, the invisible points that are outside of the chart area will also be included when evaluating interactions. -| mode | String - [IsInteractionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsInteractionMode.html) | DefaultInteractionMode.NEAREST | Sets which elements managed by event or tooltip. +| mode | String - [IsInteractionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsInteractionMode.html) | DefaultInteractionMode.NEAREST | Sets which elements managed by event or tooltip. ## Hover The hover options are managing the ways how the datasets of the chart can change when hovered. -The hover configuration is passed using the [Hover](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Hover.html) object in the defaults one: +The hover configuration is passed using the [Hover](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Hover.html) object in the defaults one: ```java // -------------------------------------- @@ -118,15 +118,15 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| axis | [InteractionAxis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/InteractionAxis.html) | InteractionAxis.X | Define which directions are used in calculating distances. +| axis | [InteractionAxis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/InteractionAxis.html) | InteractionAxis.X | Define which directions are used in calculating distances. | intersect | boolean | `true` | if `true`, the hover mode only applies when the mouse position intersects an item on the chart. -| mode | String - [IsInteractionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsInteractionMode.html) | DefaultInteractionMode.NEAREST | Sets which elements will be hovered. +| mode | String - [IsInteractionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsInteractionMode.html) | DefaultInteractionMode.NEAREST | Sets which elements will be hovered. ## Animation Animation is used to configure the base options to animate the chart. -The hover configuration is passed using the [animation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Animation.html) object in the defaults one: +The hover configuration is passed using the [animation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Animation.html) object in the defaults one: ```java // -------------------------------------- @@ -145,14 +145,14 @@ The following animation options are available. | animateScale | boolean | `false` | If `true`, will animate scaling the chart from the center outwards. | delay | int | Undefined.INTEGER | Delay in milliseconds before starting the animations. | duration | int | 1000 | The number of milliseconds an animation takes. -| easing | [Easing](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Easing.html) | Easing.EASE_OUT_QUART | Easing function to use.
See [Robert Penner's easing equations](http://robertpenner.com/easing/) for more details. +| easing | [Easing](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Easing.html) | Easing.EASE_OUT_QUART | Easing function to use.
See [Robert Penner's easing equations](http://robertpenner.com/easing/) for more details. | loop | boolean | `false` | If set to `true`, the animations loop endlessly. ## Animations -[Animations](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Animations.html) options configures which element properties are animated and how. +[Animations](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Animations.html) options configures which element properties are animated and how. -The animations element is a [container of configurations](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/AnimationCollection.html) which can be stored and retrieved by a [key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/Key.html). +The animations element is a [container of configurations](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/AnimationCollection.html) which can be stored and retrieved by a [key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/Key.html). To get, change and apply own properties, you can invoke the **set** and **get** methods, as following: @@ -175,25 +175,25 @@ int duration = animationCollection.getDuration(); ``` -The following options are available in [AnimationCollection](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/AnimationCollection.html). +The following options are available in [AnimationCollection](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/AnimationCollection.html). | Name | Type | Defaults | Description | :- | :- | :- | :- | delay | int | Undefined.INTEGER | Delay in milliseconds before starting the animations. | duration | int | 1000 | The number of milliseconds an animation takes. -| easing | [Easing](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Easing.html) | Easing.EASE_OUT_QUART | Easing function to use.
See [Robert Penner's easing equations](http://robertpenner.com/easing/) for more details. -| interpolator | [NativeInterpolator](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/NativeInterpolator.html) | - | Enables a custom interpolation during the animations. Only coding in java script for performance reasons. +| easing | [Easing](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Easing.html) | Easing.EASE_OUT_QUART | Easing function to use.
See [Robert Penner's easing equations](http://robertpenner.com/easing/) for more details. +| interpolator | [NativeInterpolator](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/NativeInterpolator.html) | - | Enables a custom interpolation during the animations. Only coding in java script for performance reasons. | loop | boolean | `false` | If set to `true`, the animations loop endlessly. -| properties | String[] - [Key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/Key.html)[] | [] | The properties of elements to use to animate. -| type | [AnimationType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AnimationType.html) | AnimationType.NUMBER | Type of property, determines the interpolator used. -| from | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | Undefined.BOOLEAN
Undefined.DOUBLE
`null` | Start value for the animation. -| to | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | Undefined.BOOLEAN
Undefined.DOUBLE
`null` | End value for the animation. +| properties | String[] - [Key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/Key.html)[] | [] | The properties of elements to use to animate. +| type | [AnimationType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AnimationType.html) | AnimationType.NUMBER | Type of property, determines the interpolator used. +| from | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | Undefined.BOOLEAN
Undefined.DOUBLE
`null` | Start value for the animation. +| to | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | Undefined.BOOLEAN
Undefined.DOUBLE
`null` | End value for the animation. ## Transitions -The [transitions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Transitions.html) are a set of animation configuration related to a specific update mode. +The [transitions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Transitions.html) are a set of animation configuration related to a specific update mode. -Every [transition animation configuration](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/AnimationTransition.html) contains an instance of [Animation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Animation.html) and one of [Animations](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Animations.html) to configure the animation for a specific mode. +Every [transition animation configuration](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/AnimationTransition.html) contains an instance of [Animation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Animation.html) and one of [Animations](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Animations.html) to configure the animation for a specific mode. ```java // -------------------------------------- @@ -214,7 +214,7 @@ Animations animations = mode.getAnimations(); The chart legend displays data about the datasets that area appearing on the chart. -The legend configuration is passed using the [Legend](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Legend.html) object in the defaults one: +The legend configuration is passed using the [Legend](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Legend.html) object in the defaults one: ```java // -------------------------------------- @@ -229,20 +229,20 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| align | [LegendAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/LegendAlign.html) | LegendAlign.CENTER | Alignment of the legend. +| align | [LegendAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/LegendAlign.html) | LegendAlign.CENTER | Alignment of the legend. | display | boolean | `true` | If `true`, the legend is shown. -| events | [IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)> | `Defaults.get().getGlobal()`
`.getEvents()` | The events option defines the browser events that the legend should listen to. This overrides the options at chart level. +| events | [IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)> | `Defaults.get().getGlobal()`
`.getEvents()` | The events option defines the browser events that the legend should listen to. This overrides the options at chart level. | fullSize | boolean | `true` | Marks that this box should take the full width/height of the canvas (moving other boxes). | maxHeight | int | Undefined.INTEGER | Maximum height of the legend, in pixels. | maxWidth | int | Undefined.INTEGER | Maximum width of the legend, in pixels. -| position | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html) | Position.TOP | Position of the legend. +| position | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html) | Position.TOP | Position of the legend. | reverse | boolean | `false` | Legend will show datasets in reverse order. | rtl | boolean | `false` | `true` for rendering the legends from right to left. -| textDirection | [TextDirection](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextDirection.html) | TextDirection.LEFT_TO_RIGHT | This will force the text direction on the canvas for rendering the legend, regardless of the CSS specified on the canvas. +| textDirection | [TextDirection](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextDirection.html) | TextDirection.LEFT_TO_RIGHT | This will force the text direction on the canvas for rendering the legend, regardless of the CSS specified on the canvas. ### Legend labels -The [Legend Labels](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/LegendLabels.html) configuration is nested below the legend configuration using +The [Legend Labels](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/LegendLabels.html) configuration is nested below the legend configuration using ```java // -------------------------------------- @@ -260,18 +260,18 @@ The following are the attributes that you can set: | borderRadius | int | 0 | Override the borderRadius to use. | boxHeight | int | `getFont().getSize()` | Height of the colored box. | boxWidth | int | 40 | Width of colored box. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of label.
See [default colors](DefaultsCharts#commons-charts-options). -| font | [Font](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Font.html) | `Defaults.get().getGlobal()`
`.getFont()` | Font of label.
See [Font](DefaultsCharts#font). +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of label.
See [default colors](DefaultsCharts#commons-charts-options). +| font | [Font](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Font.html) | `Defaults.get().getGlobal()`
`.getFont()` | Font of label.
See [Font](DefaultsCharts#font). | padding | int | 10 | Padding between rows of colored boxes. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | PointStyle.CIRCLE | This style of point is used for the legend. Only used if `usePointStyle` is `true`. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | PointStyle.CIRCLE | This style of point is used for the legend. Only used if `usePointStyle` is `true`. | pointStyleWidth | double | Undefined.DOUBLE | If `usePointStyle` is `true`, the width of the point style used for the legend. -| textAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.CENTER | Horizontal alignment of the label text. +| textAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.CENTER | Horizontal alignment of the label text. | useBorderRadius | boolean | `false` | Label border radius will match corresponding border radius. | usePointStyle | boolean | `false` | Label style will match corresponding point style (size is based on fontSize, boxWidth is not used in this case). ### Legend title -The [legend title](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/LegendTitle.html) configuration is nested below the legend configuration using +The [legend title](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/LegendTitle.html) configuration is nested below the legend configuration using ```java // -------------------------------------- @@ -286,14 +286,14 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of text of title.
See [default colors](DefaultsCharts#commons-charts-options). +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of text of title.
See [default colors](DefaultsCharts#commons-charts-options). | display | boolean | `false` | If `true`, the legend title is shown. -| font | [Font](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Font.html) | `Defaults.get().getGlobal()`
`.getFont()` | Font of text of title.
See [Font](DefaultsCharts#font). -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Padding.html) | 0 to all dimensions | Padding around the title.
See [padding documentation](../configuration/Commons#padding) for more details. +| font | [Font](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Font.html) | `Defaults.get().getGlobal()`
`.getFont()` | Font of text of title.
See [Font](DefaultsCharts#font). +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Padding.html) | 0 to all dimensions | Padding around the title.
See [padding documentation](../configuration/Commons#padding) for more details. ## Tooltips -The tooltips configuration is passed using the [tooltips](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Tooltips.html) object in the defaults one: +The tooltips configuration is passed using the [tooltips](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Tooltips.html) object in the defaults one: ```java // -------------------------------------- @@ -308,47 +308,47 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgba(0,0,0,0.8) -          | Background color of the tooltips. -| bodyColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | #fff -          | Color of body text. -| bodyFont | [Font](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Font.html) | See description | Font of body text. The default value is the global font with the style set to FontStyle.NORMAL.
See [Font](DefaultsCharts#font). -| bodyAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.LEFT | Alignment of body element of the tooltips. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgba(0,0,0,0.8) -          | Background color of the tooltips. +| bodyColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | #fff -          | Color of body text. +| bodyFont | [Font](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Font.html) | See description | Font of body text. The default value is the global font with the style set to FontStyle.NORMAL.
See [Font](DefaultsCharts#font). +| bodyAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.LEFT | Alignment of body element of the tooltips. | bodySpacing | int | 2 | Spacing to add to top and bottom of each tooltip item. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgba(0,0,0,0) -          | Color of the border. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgba(0,0,0,0) -          | Color of the border. | borderWidth | int | 0 | Size of the border. | boxWidth | int | `getBodyFont().getSize()` | Width of the color box if `displayColors` is `true`. | boxHeight | int | `getBodyFont().getSize()` | Height of the color box if `displayColors` is `true`. | caretPadding | int | 2 | Extra distance to move the end of the tooltip arrow away from the tooltip point. | caretSize | int | 5 | Size, in px, of the tooltip arrow. -| cornerRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) | 6 | Radius of tooltip corner curves. +| cornerRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) | 6 | Radius of tooltip corner curves. | displayColors | boolean | `true` | If `true`, color boxes are shown in the tooltip. | enabled | boolean | `true` | If `true`, the tooltips are enabled. -| events | [IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)> | `Defaults.get().getGlobal()`
`.getEvents()` | The events option defines the browser events that the tooltip should listen to. This overrides the options at chart level. -| footerColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | #fff -          | Color of the footer. -| footerFont | [Font](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Font.html) | See description | Font of footer text. The default value is the global font with the style set to Weight.BOLD.
See [Font](DefaultsCharts#font). -| footerAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.LEFT | Alignment of footer element of the tooltips. +| events | [IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)> | `Defaults.get().getGlobal()`
`.getEvents()` | The events option defines the browser events that the tooltip should listen to. This overrides the options at chart level. +| footerColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | #fff -          | Color of the footer. +| footerFont | [Font](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Font.html) | See description | Font of footer text. The default value is the global font with the style set to Weight.BOLD.
See [Font](DefaultsCharts#font). +| footerAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.LEFT | Alignment of footer element of the tooltips. | footerMarginTop | int | 6 | Margin to add before drawing the footer. | footerSpacing | int | 2 | Spacing to add to top and bottom of each footer line. | intersect | boolean | `Defaults.get().getGlobal()`
`.getInteraction().isIntersect()` | if `true`, the tooltip mode applies only when the mouse position intersects with an element. If `false`, the mode will be applied at all times. -| mode | String - [IsInteractionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsInteractionMode.html) | `Defaults.get().getGlobal()`
`.getInteraction().getMode()` | Sets which elements appear in the tooltip. -| multiKeyBackground | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | #fff -          | Color to draw behind the colored boxes when multiple items are in the tooltip. -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Padding.html) | 6 to all dimensions | The padding to add inside the tooltip.
See [padding documentation](../configuration/Commons#padding) for more details. -| position | [TooltipPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TooltipPosition.html) | TooltipPosition.AVERAGE | The mode for positioning the tooltip. +| mode | String - [IsInteractionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsInteractionMode.html) | `Defaults.get().getGlobal()`
`.getInteraction().getMode()` | Sets which elements appear in the tooltip. +| multiKeyBackground | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | #fff -          | Color to draw behind the colored boxes when multiple items are in the tooltip. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Padding.html) | 6 to all dimensions | The padding to add inside the tooltip.
See [padding documentation](../configuration/Commons#padding) for more details. +| position | [TooltipPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TooltipPosition.html) | TooltipPosition.AVERAGE | The mode for positioning the tooltip. | rtl | boolean | `false` | `true` for rendering the tooltips from right to left. -| textDirection | [TextDirection](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextDirection.html) | TextDirection.LEFT_TO_RIGHT | This will force the text direction on the canvas for rendering the tooltips, regardless of the CSS specified on the canvas -| titleColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | #fff -          | Color of the footer. -| titleFont | [Font](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Font.html) | See description | Font of title text. The default value is the global font with the style set to Weight.BOLD.
See [Font](DefaultsCharts#font). -| titleAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.LEFT | Alignment of title element of the tooltips. +| textDirection | [TextDirection](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextDirection.html) | TextDirection.LEFT_TO_RIGHT | This will force the text direction on the canvas for rendering the tooltips, regardless of the CSS specified on the canvas +| titleColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | #fff -          | Color of the footer. +| titleFont | [Font](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Font.html) | See description | Font of title text. The default value is the global font with the style set to Weight.BOLD.
See [Font](DefaultsCharts#font). +| titleAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.LEFT | Alignment of title element of the tooltips. | titleMarginBottom | int | 6 | Margin to add on bottom of title section. | titleSpacing | int | 2 | Spacing to add to top and bottom of each title line. | usePointStyle | boolean | `false` | Use the corresponding point style (from dataset options) instead of color boxes (size is based on the minimum value between box width and box height). -| xAlign | [TooltipAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TooltipAlign.html) | TooltipAlign.AUTO | Position of the tooltip caret in the X direction.
Can accept only TooltipAlign.LEFT, TooltipAlign.CENTER and TooltipAlign.RIGHT. -| yAlign | [TooltipAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TooltipAlign.html) | TooltipAlign.AUTO | Position of the tooltip caret in the Y direction.
Can accept only TooltipAlign.TOP, TooltipAlign.CENTER and TooltipAlign.BOTTOM. +| xAlign | [TooltipAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TooltipAlign.html) | TooltipAlign.AUTO | Position of the tooltip caret in the X direction.
Can accept only TooltipAlign.LEFT, TooltipAlign.CENTER and TooltipAlign.RIGHT. +| yAlign | [TooltipAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TooltipAlign.html) | TooltipAlign.AUTO | Position of the tooltip caret in the Y direction.
Can accept only TooltipAlign.TOP, TooltipAlign.CENTER and TooltipAlign.BOTTOM. ## Title The chart title defines text to draw at the top of the chart. -The title configuration is passed using the [Title](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Title.html) object in the defaults one: +The title configuration is passed using the [Title](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Title.html) object in the defaults one: ```java // -------------------------------------- @@ -363,19 +363,19 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| align | [ElementAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ElementAlign.html) | ElementAlign.CENTER | Alignment of the title. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of text of the title.
See [default colors](DefaultsCharts#commons-charts-options). +| align | [ElementAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ElementAlign.html) | ElementAlign.CENTER | Alignment of the title. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of text of the title.
See [default colors](DefaultsCharts#commons-charts-options). | display | boolean | `false` | If `true`, the title is shown. -| font | [Font](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Font.html) | See description | Font of title text. The default value is the global font with the style set to Weight.BOLD.
See [Font](DefaultsCharts#font). +| font | [Font](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Font.html) | See description | Font of title text. The default value is the global font with the style set to Weight.BOLD.
See [Font](DefaultsCharts#font). | fullSize | boolean | `true` | Marks that this box should take the full width/height of the canvas (moving other boxes). -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Padding.html) | 10 to all dimensions | Number of pixels to add above and below the title text.
See [padding documentation](../configuration/Commons#padding) for more details. -| position | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html) | Position.TOP | Position of title. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Padding.html) | 10 to all dimensions | Number of pixels to add above and below the title text.
See [padding documentation](../configuration/Commons#padding) for more details. +| position | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html) | Position.TOP | Position of title. ## Subtitle The chart subtitle defines text to draw at the bottom of the chart title. -The subtitle configuration is passed using the [Title](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Subtitle.html) object in the defaults one: +The subtitle configuration is passed using the [Title](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Subtitle.html) object in the defaults one: ```java // -------------------------------------- @@ -390,19 +390,19 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| align | [ElementAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ElementAlign.html) | ElementAlign.CENTER | Alignment of the subtitle. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of text of the subtitle.
See [default colors](DefaultsCharts#commons-charts-options). +| align | [ElementAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ElementAlign.html) | ElementAlign.CENTER | Alignment of the subtitle. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of text of the subtitle.
See [default colors](DefaultsCharts#commons-charts-options). | display | boolean | `false` | If `true`, the title is shown. -| font | [Font](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Font.html) | See description | Font of subtitle text. The default value is the global font with the style set to Weight.NORMAL.
See [Font](DefaultsCharts#font). +| font | [Font](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Font.html) | See description | Font of subtitle text. The default value is the global font with the style set to Weight.NORMAL.
See [Font](DefaultsCharts#font). | fullSize | boolean | `true` | Marks that this box should take the full width/height of the canvas (moving other boxes). -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Padding.html) | 0 to all dimensions | Number of pixels to add above and below the subtitle text.
See [padding documentation](../configuration/Commons#padding) for more details. -| position | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html) | Position.TOP | Position of subtitle. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Padding.html) | 0 to all dimensions | Number of pixels to add above and below the subtitle text.
See [padding documentation](../configuration/Commons#padding) for more details. +| position | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html) | Position.TOP | Position of subtitle. ## Elements Options can be configured for four different types of elements: **[arc](#arc)**, **[lines](#line)**, **[points](#point)**, and **[bar](#bar)**. -The [elements](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Elements.html) configuration is nested in the global configuration as following: +The [elements](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Elements.html) configuration is nested in the global configuration as following: ```java Defaults.get().getGlobal().getElements(); @@ -412,7 +412,7 @@ Defaults.get().getGlobal().getElements(); Point element is used to represent the points, like in a line or bubble charts. -The [point](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Point.html) configuration is nested in the elements configuration as following: +The [point](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Point.html) configuration is nested in the elements configuration as following: ```java // -------------------------------------- @@ -427,15 +427,15 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | Point fill color.
See [default colors](DefaultsCharts#commons-charts-options). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | Point stroke color.
See [default colors](DefaultsCharts#commons-charts-options). +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | Point fill color.
See [default colors](DefaultsCharts#commons-charts-options). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | Point stroke color.
See [default colors](DefaultsCharts#commons-charts-options). | borderWidth | int | 1 | Point stroke width. | hitRadius | int | 1 | Extra radius added to point radius for hit detection. -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | See `backgroundColor` | Point fill color when hovered. -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | See `borderColor` | Point stroke color when hovered. +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | See `backgroundColor` | Point fill color when hovered. +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | See `borderColor` | Point stroke color when hovered. | hoverBorderWidth | int | See `borderWidth` | Stroke width when hovered. | hoverRadius | int | 4 | Point radius when hovered. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | PointStyle.CIRCLE | Point style. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | PointStyle.CIRCLE | Point style. | radius | int | 3 | Point radius. | rotation | double | 0 | The point rotation (in degrees). @@ -443,7 +443,7 @@ The following are the attributes that you can set: Line element is used to represent the line, like in a line or radar charts. -The [line](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Line.html) configuration is nested in the elements configuration as following: +The [line](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Line.html) configuration is nested in the elements configuration as following: ```java // -------------------------------------- @@ -458,27 +458,27 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | Line fill color.
See [default colors](DefaultsCharts#commons-charts-options). -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT | Determines the shape used to draw the end points of lines.
See [MDN](https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | Line stroke color.
See [default colors](DefaultsCharts#commons-charts-options). +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | Line fill color.
See [default colors](DefaultsCharts#commons-charts-options). +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT | Determines the shape used to draw the end points of lines.
See [MDN](https://developer.mozilla.org/en/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | Line stroke color.
See [default colors](DefaultsCharts#commons-charts-options). | borderDash | int[] | [] | The line dash pattern used when stroking lines. It uses an array of values that specify alternating lengths of lines and gaps which describe the pattern.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | 0D | Line dash offset.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | The shape used to join two line segments where they meet.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | The shape used to join two line segments where they meet.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderWidth | int | 3 | Line stroke width. | capBezierPoints | boolean | `true` | Set true` to keep Bezier control inside the chart, `false` for no restriction. -| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | CubicInterpolationMode.DEFAULT | Interpolation mode to apply. -| fill | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsFill.html) | Fill.FALSE | How to fill the area under the line.
See [Filling modes](../coloring/Colors#filling-modes) -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | See `backgroundColor` | Line fill color when hovered. -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | See `borderColor` | Line stroke color when hovered. +| cubicInterpolationMode | [CubicInterpolationMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CubicInterpolationMode.html) | CubicInterpolationMode.DEFAULT | Interpolation mode to apply. +| fill | String - int - boolean - [IsFill](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsFill.html) | Fill.FALSE | How to fill the area under the line.
See [Filling modes](../coloring/Colors#filling-modes) +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | See `backgroundColor` | Line fill color when hovered. +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | See `borderColor` | Line stroke color when hovered. | hoverBorderWidth | int | See `borderWidth` | Stroke width when hovered. -| stepped | boolean - [Stepped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Stepped.html) | Stepped.FALSE | If the line is shown as a stepped line. +| stepped | boolean - [Stepped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Stepped.html) | Stepped.FALSE | If the line is shown as a stepped line. | tension | double | 0 | Bezier curve tension (`0` for no Bezier curves). ### Arc Arc element is used in the polar area, doughnut and pie charts. -The [Arc](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Arc.html) configuration is nested in the elements configuration as following: +The [Arc](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Arc.html) configuration is nested in the elements configuration as following: ```java // -------------------------------------- @@ -494,16 +494,16 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- | angle | double | `Double.NaN` | Arc angle to cover, for polar chart only. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | Arc fill color.
See [default colors](DefaultsCharts#commons-charts-options). -| borderAlign | [BorderAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderAlign.html) | BorderAlign.CENTER | Arc stroke alignment. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | #fff -          | Arc stroke color. -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.BEVEL | Arc line join style. The default is JoinStyle.ROUND when `borderAlign` is BorderAlign.INNER.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | Arc fill color.
See [default colors](DefaultsCharts#commons-charts-options). +| borderAlign | [BorderAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderAlign.html) | BorderAlign.CENTER | Arc stroke alignment. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | #fff -          | Arc stroke color. +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.BEVEL | Arc line join style. The default is JoinStyle.ROUND when `borderAlign` is BorderAlign.INNER.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderRadius | int | 0 | The arc border radius (in pixels). | borderWidth | int | 2 | Arc stroke width. | circular | boolean | `true` | If the arc is curved. If `false` the arc will be flat. -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | See `backgroundColor` | Arc fill color when hovered. -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | See `borderColor` | Arc stroke color when hovered. -| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.BEVEL | Arc line join style when hovered.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | See `backgroundColor` | Arc fill color when hovered. +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | See `borderColor` | Arc stroke color when hovered. +| hoverBorderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.BEVEL | Arc line join style when hovered.
See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | hoverBorderWidth | int | See `borderWidth` | Stroke width when hovered. | hoverOffset | int | See `offset` | The offset of the arc (in pixels) when hovered. | offset | int | 0 | The offset of the arc (in pixels). @@ -513,7 +513,7 @@ The following are the attributes that you can set: Bar element is used to represent the bars in a bar chart. -The [bar](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Bar.html) configuration is nested in the elements configuration as following: +The [bar](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Bar.html) configuration is nested in the elements configuration as following: ```java // -------------------------------------- @@ -529,25 +529,25 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- | autoInflateAmount | boolean | `true` | If `true`, the amount of pixels to inflate the bar rectangles, when drawing, is automatically calculating. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | Bar fill color.
See [default colors](DefaultsCharts#commons-charts-options). +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | Bar fill color.
See [default colors](DefaultsCharts#commons-charts-options). | base | double | Undefined.DOUBLE | Base value for the bar in data units along the value axis. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()`) | Bar stroke color.
See [default colors](DefaultsCharts#commons-charts-options). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()`) | Bar stroke color.
See [default colors](DefaultsCharts#commons-charts-options). | borderRadius | int | 0 | The bar border radius (in pixels). -| borderSkipped | boolean - [BorderSkipped](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/BorderSkipped.html) | BorderSkipped.START | The edge to skip when drawing bar. +| borderSkipped | boolean - [BorderSkipped](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/BorderSkipped.html) | BorderSkipped.START | The edge to skip when drawing bar. | borderWidth | int | 0 | The bar border width (in pixels). | enableBorderRadius| boolean | `true` | If `true`, it only shows the border radius of a bar when the bar is at the end of the stack. -| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | See `backgroundColor` | Bar fill color when hovered. -| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | See `borderColor` | Bar stroke color when hovered. +| hoverBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | See `backgroundColor` | Bar fill color when hovered. +| hoverBorderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | See `borderColor` | Bar stroke color when hovered. | hoverBorderWidth | int | See `borderWidth` | Stroke width when hovered. | hoverBorderRadius | int | See `borderRadius` | The bar border radius (in pixels) when hovered. | inflateAmount | int | Undefined.INTEGER | The amount of pixels to inflate the bar rectangles, when drawing. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | PointStyle.CIRCLE | Point style for legend. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | PointStyle.CIRCLE | Point style for legend. ## Datasets The datasets options are managing the set options which will affect the datasets management. -The [datasets](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Datasets.html) configuration is nested in the global configuration using: +The [datasets](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Datasets.html) configuration is nested in the global configuration using: ```java // -------------------------------------- @@ -558,35 +558,35 @@ Defaults.get().getOptions(ChartType.LINE).getDatasets().get(ChartType.LINE).setS boolean globalShowLine = Defaults.get().getOptions(ChartType.LINE).getDatasets().get(ChartType.LINE).isShowLine(); ``` -The datasets configuration is passed using the [Datasets](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Datasets.html) object in the chart options and mapped to [TypedDataset](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/TypedDataset.html). +The datasets configuration is passed using the [Datasets](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Datasets.html) object in the chart options and mapped to [TypedDataset](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/TypedDataset.html). The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| animation | [Animation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Animation.html) | - | See [animation options](#animation) section for more details. -| animations | [Animations](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Animations.html) | - | See [animation options](#animations) section for more details. +| animation | [Animation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Animation.html) | - | See [animation options](#animation) section for more details. +| animations | [Animations](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Animations.html) | - | See [animation options](#animations) section for more details. | barPercentage | double | 0.9 | Percent (0-1) of the available width each bar should be within the category width. 1.0 will take the whole category width and put the bars right next to each other. | categoryPercentage | double | 0.8 | Percent (0-1) of the available width each category should be within the sample width. -| barThickness | int | 0 | Manually set width of each bar in pixels.
If set to [DefaultDatasets.FLEX_BAR_THICKNESS](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/defaults/globals/DefaultDatasets.html#FLEX_BAR_THICKNESS), it computes "optimal" sample widths that globally arrange bars side by side.
If not set (default), bars are equally sized based on the smallest interval. +| barThickness | int | 0 | Manually set width of each bar in pixels.
If set to [DefaultDatasets.FLEX_BAR_THICKNESS](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/defaults/globals/DefaultDatasets.html#FLEX_BAR_THICKNESS), it computes "optimal" sample widths that globally arrange bars side by side.
If not set (default), bars are equally sized based on the smallest interval. | grouped | boolean | `true` | Should the bars be grouped on index axis.
When `true`, all the datasets at same index value will be placed next to each other centering on that index value.
When `false`, each bar is placed on its actual index-axis value. | maxBarThickness | int | 0 | Set this to ensure that bars are not sized thicker than this. | minBarLength | int | 0 | Set this to ensure that bars have a minimum length in pixels. | showLine | boolean | `true` | If `true`, the line is drawn for dataset. -| transitions | [Transitions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Transitions.html) | - | See [animation options](#transitions) section for more details. +| transitions | [Transitions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Transitions.html) | - | See [animation options](#transitions) section for more details. ## Layout Options can be configured for the the padding to add inside the chart. -The [layout](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Layout.html) configuration is nested in the global configuration using: +The [layout](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Layout.html) configuration is nested in the global configuration using: ```java // gets layout instance Layout layout = Defaults.get().getGlobal().getLayout(); ``` -The [padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Padding.html) configuration is nested in the layout configuration as following: +The [padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Padding.html) configuration is nested in the layout configuration as following: ```java // -------------------------------------- @@ -604,7 +604,7 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- | autoPadding | boolean | `true` | If `true`, apply automatic padding so visible elements are completely drawn. -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Padding.html) | `0` on all sides | To set specific padding for specific sides. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Padding.html) | `0` on all sides | To set specific padding for specific sides. See [padding documentation](../configuration/Commons#padding) for more details. @@ -614,7 +614,7 @@ The decimation element can be used with line charts to automatically decimate da Before enabling it, review the [requirements](#requirements) to ensure that it will work with the chart you want to create. -The [decimation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Decimation.html) configuration is nested in the global configuration as following: +The [decimation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Decimation.html) configuration is nested in the global configuration as following: ```java // -------------------------------------- @@ -630,7 +630,7 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- | enabled | boolean | `false` | If `true`, the data decimation is enabled. -| algorithm | [DecimationAlgorithm](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DecimationAlgorithm.html) | DecimationAlgorithm.MIN_MAX | Decimation algorithm to use. +| algorithm | [DecimationAlgorithm](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DecimationAlgorithm.html) | DecimationAlgorithm.MIN_MAX | Decimation algorithm to use. | samples | double | Undefined.DOUBLE | If the `DecimationAlgorithm.LTTB` is used, this is the number of samples in the output dataset. Defaults to the canvas width to pick 1 sample per pixel. | threshold | double | Undefined.DOUBLE | If the number of samples in the current axis range is above this value, the decimation will be triggered.
Defaults to 4 times the canvas width.
The number of point after decimation can be higher than the `threshold` value. @@ -645,15 +645,15 @@ The available decimation algorithms to use for data are the following: To use the decimation, the following requirements must be met: -1. The dataset must have an [IndexAxis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IndexAxis.html) of `IndexAxis.X`. -2. The dataset must be a [line](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/LineDataset.html). -3. The X axis for the dataset must be either a [linear](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianLinearAxis.html) or [time](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/CartesianTimeAxis.html) axis. +1. The dataset must have an [IndexAxis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IndexAxis.html) of `IndexAxis.X`. +2. The dataset must be a [line](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/LineDataset.html). +3. The X axis for the dataset must be either a [linear](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianLinearAxis.html) or [time](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/CartesianTimeAxis.html) axis. ## Filler Filler element configures the engine which is in charge to manage the filling of the datasets, by the property `fill`. See [here](../coloring/Colors#filling) how filling a dataset. -The [filler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Filler.html) configuration is nested in the global configuration as following: +The [filler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Filler.html) configuration is nested in the global configuration as following: ```java // -------------------------------------- @@ -669,4 +669,4 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- | propagate | boolean | `true` | If `true`, the fill area will be recursively extended to the visible target defined by the fill value of hidden data set targets. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DrawTime.html) | DrawTime.BEFORE_DATASET_DRAW | Filler draw time. +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DrawTime.html) | DrawTime.BEFORE_DATASET_DRAW | Filler draw time. diff --git a/docs/defaults/DefaultsScales.md b/docs/defaults/DefaultsScales.md index 4fa47921..c2b85d30 100644 --- a/docs/defaults/DefaultsScales.md +++ b/docs/defaults/DefaultsScales.md @@ -7,9 +7,9 @@ sidebar_label: Scales ## Commons scales options -To change the global scale, **Charba** is providing the method `getScale` in the [defaults](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Defaults.html). +To change the global scale, **Charba** is providing the method `getScale` in the [defaults](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Defaults.html). -With this method you can get all global configuration of [Chart.JS](http://www.chartjs.org/) for [scale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/GlobalScale.html) (common one, not related to chart type) and you have got all `set` and `get` methods to change or retrieve the global configuration items. +With this method you can get all global configuration of [Chart.JS](http://www.chartjs.org/) for [scale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/GlobalScale.html) (common one, not related to chart type) and you have got all `set` and `get` methods to change or retrieve the global configuration items. ```java // -------------------------------------- @@ -26,18 +26,18 @@ The following are the attributes that you can set: | :- | :- | :- | :- | alignToPixels | boolean | `false` | Align pixel values to device pixels. | animate | boolean | `true` | If `true`, animate scaling the chart from the center. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgba(255,255,255,0) -          | The background color of scale area. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgba(255,255,255,0) -          | The background color of scale area. | beginAtZero | boolean | `false` | If `true`, scale will include 0 if it is not already included. -| bounds | [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Bounds.html) | Bounds.TICKS | Determines the scale bounds on time axis. -| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) | Display.TRUE | If `Display.TRUE`, the axis is shown. +| bounds | [Bounds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Bounds.html) | Bounds.TICKS | Determines the scale bounds on time axis. +| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) | Display.TRUE | If `Display.TRUE`, the axis is shown. | grace | int | 0 | Amount of pixels for added room in the scale range above and below data. | graceAsPercentage | double | 0 | Sets a value, between 0 and 1, as percentage, for added room in the scale range above and below data. -| labels | [Labels](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/Labels.html) | empty `Labels` | The labels to display. +| labels | [Labels](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/Labels.html) | empty `Labels` | The labels to display. | max | double - String - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | See description | User defined maximum number for the scale, overrides maximum value from data.
As value, you can set a:
- `double` for linear, logarithmic and radial scales, with `Double.MAX_VALUE` as default;
- `Date` for time and time series scales, with `null` as default;
- `String` for category scales, with `null` as default. | min | double - String - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | See description | User defined minimum number for the scale, overrides minimum value from data.
As value, you can set a:
- `double` for linear, logarithmic and radial scales, with `Double.MIN_VALUE` as default;
- `Date` for time and time series scales, with `null` as default;
- `String` for category scales, with `null` as default. | offset | boolean | `false` | If `true`, extra space is added to the both edges and the axis is scaled to fit in the chart area. | offsetAfterAutoskip | boolean | `false` | If `true`, bar chart offsets are computed with auto skipped ticks. -| position | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html) | Position.TOP | Position of the axis. +| position | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html) | Position.TOP | Position of the axis. | reverse | boolean | `false` | Reverses order of tick labels. | singleStacked | boolean | `false` | If you might want to stack positive and negative values together. | stack | String | Undefined.STRING | Sets the stack group. Axes at the same `position` with same `stack` are stacked. @@ -48,7 +48,7 @@ The following are the attributes that you can set: | suggestedMin | double - String - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | See description | Adjustment used when calculating the minimum data value.
As value, you can set a:
- `double` for linear, logarithmic and radial scales, with `Double.MIN_VALUE` as default;
- `Date` for time and time series scales, with `null` as default;
- `String` for category scales, with `null` as default. | weight | double | 0 | The weight used to sort the axis. Higher weights are further away from the chart area. -The [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Bounds.html) controls the scale boundary strategy (bypassed by min/max time options): +The [Bounds](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Bounds.html) controls the scale boundary strategy (bypassed by min/max time options): * `Bounds.DATA`: make sure data are fully visible, labels outside are removed. * `Bounds.TICKS`: make sure ticks are fully visible, data outside are truncated. @@ -57,7 +57,7 @@ The [Bounds](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/clien The grid configuration defines options for the lines that are run perpendicular to the axis. -The [grid](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Grid.html) configuration is nested in the scale configuration as following: +The [grid](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Grid.html) configuration is nested in the scale configuration as following: ```java // -------------------------------------- @@ -73,7 +73,7 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- | circular | boolean | `false` | If `true`, grid lines are circular (on radar chart only). -| color | String - String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line and so on.
See [default colors](DefaultsCharts#commons-charts-options). +| color | String - String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | The color of the grid lines. If specified as an array, the first color applies to the first grid line, the second to the second grid line and so on.
See [default colors](DefaultsCharts#commons-charts-options). | display | boolean | `true` | If `false`, do not display grid lines for this axis. | drawOnChartArea | boolean | `true` | If `true`, draw lines on the chart area inside the axis lines. This is useful when there are multiple axes and you need to control which grid lines are drawn. | drawTicks | boolean | `true` | If `true`, draw lines beside the ticks in the axis area beside the chart. @@ -81,14 +81,14 @@ The following are the attributes that you can set: | offset | boolean | `false` | If `true`, grid lines will be shifted to be between labels. This is set to `true` in the bar chart by default. | tickBorderDash | int[] | See description | Length and spacing of the tick mark line. If not set, defaults to the grid line `borderDash` value. | tickBorderDashOffset | double - double[] | See description | Offset for the line dash of the tick mark. If unset, defaults to the grid line `borderDashOffset` value -| tickColor | String - String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | See description | Color of the tick line. If unset, defaults to the grid line `color`. +| tickColor | String - String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | See description | Color of the tick line. If unset, defaults to the grid line `color`. | tickLength | int | 10 | Length in pixels that the grid lines will draw in the axis area. | tickWidth | int - int[] | See description | Width of the tick mark in pixels. If unset, defaults to the grid line `lineWidth`. | z | int | -1 | z-index of the grid line layer. Values less than or equals to 0 are drawn under datasets, greater than 0 on top. ## Border -The [border](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleBorder.html) defines options for the border that run perpendicular to the axis. +The [border](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleBorder.html) defines options for the border that run perpendicular to the axis. ```java // -------------------------------------- @@ -105,7 +105,7 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- | display | boolean | `true` | If `true`, draw border at the edge between the axis and the chart area. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | If set, used as the color of the border line. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | If set, used as the color of the border line. | dash | int[] | [] | Length and spacing of dashes on grid lines. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | dashOffset | double | 0 | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). | width | int | 1 | If set, used as the width of the border line. @@ -115,7 +115,7 @@ The following are the attributes that you can set: The tick configuration defines options for the tick marks that are generated by the axis. -The [ticks](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Ticks.html) configuration is nested in the scale configuration as following: +The [ticks](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Ticks.html) configuration is nested in the scale configuration as following: ```java // -------------------------------------- @@ -130,36 +130,36 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| align | [TickAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TickAlign.html) | TickAlign.CENTER | The tick alignment along the axis. +| align | [TickAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TickAlign.html) | TickAlign.CENTER | The tick alignment along the axis. | autoSkip | boolean | `true` | If `true`, automatically calculates how many labels that can be shown and hides labels accordingly. Labels will be rotated up to `maxRotation` before skipping any. Turn `autoSkip` off to show all labels no matter what. | autoSkipPadding | int | 3 | The padding between the ticks on the horizontal axis when autoSkip is enabled. -| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgba(255,255,255,0.75) -          | Color of label backdrops. -| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Padding.html) | 2 to all dimensions | The padding of label backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of ticks.
See [default colors](DefaultsCharts#commons-charts-options). +| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgba(255,255,255,0.75) -          | Color of label backdrops. +| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Padding.html) | 2 to all dimensions | The padding of label backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of ticks.
See [default colors](DefaultsCharts#commons-charts-options). | count | int | UnefinedValues.INTEGER | The number of ticks to generate. If specified, this overrides the automatic generation. -| crossAlign | [CrossAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CrossAlign.html) | CrossAlign.NEAR | The tick alignment perpendicular to the axis. +| crossAlign | [CrossAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CrossAlign.html) | CrossAlign.NEAR | The tick alignment perpendicular to the axis. | display | boolean | `true` | If `true`, the tick marks are shown. -| font | [Font](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Font.html) | `Defaults.get().getGlobal()`
`.getFont()` | Font of ticks.
See [Font](DefaultsCharts#font). +| font | [Font](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Font.html) | `Defaults.get().getGlobal()`
`.getFont()` | Font of ticks.
See [Font](DefaultsCharts#font). | includeBounds | boolean | `true` | If `true`, the defined `min` and `max` values should be presented as ticks even if they are not "nice". | labelOffset | int | 0 | Distance in pixels to offset the label from the centre point of the tick (in the x-direction for the x-axis, and the y-direction for the y-axis).

Note: *This can cause labels at the edges to be cropped by the edge of the canvas*. | maxRotation | int | 50 | The maximum rotation for tick labels when rotating to condense labels.

Note: *Rotation doesn't occur until necessary and only applicable to horizontal scales.* | maxTicksLimit | int | 11 | Maximum number of ticks and gridlines to show. | minRotation | int | 0 | The minimum rotation for tick labels. | mirror | boolean | `false` | The flips tick labels around axis, displaying the labels inside the chart instead of outside.

Note: *Only applicable to vertical scales.* -| numberFormat | [NumberFormatOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/NumberFormatOptions.html) | | The number format options used by the default label formatter.
See [INTL number format](../intl/NumberFormat) documentation. +| numberFormat | [NumberFormatOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/NumberFormatOptions.html) | | The number format options used by the default label formatter.
See [INTL number format](../intl/NumberFormat) documentation. | padding | int | 0 | The padding between the tick label and the axis. | precision | int | 0 | If defined and `stepSize` is not specified, the step size will be rounded to this many decimal places. | sampleSize | int | Undefined.INTEGER | The number of ticks to examine when deciding how many labels will fit. Setting a smaller value will be faster, but may be less accurate when there is large variability in label length. | showLabelBackdrop | boolean | `true` | If `true`, draw a background behind the tick labels -| source | [TickSource](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TickSource.html) | TickSource.AUTO | How ticks are generated on axis time. +| source | [TickSource](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TickSource.html) | TickSource.AUTO | How ticks are generated on axis time. | stepSize | double | `Double.MIN_VALUE` | User defined fixed step size for the scale. -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | The color of the stroke around the text. +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | The color of the stroke around the text. | textStrokeWidth | int | 0 | Stroke width around the text. | z | int | 0 | z-index of tick layer. Useful when ticks are drawn on chart area. Values less than or equals to 0 are drawn under data sets, greater than 0 on top. ### Major Tick -The major tick configuration enables for the major tick marks that are generated by the axis. A major tick will affect auto-skipping and major will be defined on ticks in the scriptable options context, by [ScaleTickItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ScaleTickItem.html) class and [isMajor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ScaleTickItem.html#isMajor--) method. +The major tick configuration enables for the major tick marks that are generated by the axis. A major tick will affect auto-skipping and major will be defined on ticks in the scriptable options context, by [ScaleTickItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ScaleTickItem.html) class and [isMajor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ScaleTickItem.html#isMajor--) method. The major ticks configuration is nested in the ticks configuration as following: @@ -182,7 +182,7 @@ The following are the attributes that you can set: The scale title configuration defines options for the title of the scale. Note that this only applies to cartesian axes. -The [scale title](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleTitle.html) configuration is nested in the scale configuration as following: +The [scale title](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleTitle.html) configuration is nested in the scale configuration as following: ```java // -------------------------------------- @@ -197,17 +197,17 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| align | [ScaleTitleAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ScaleTitleAlign.html) | ScaleLabelAlign.CENTER | Alignment of the scale label. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of scale label.
See [default colors](DefaultsCharts#commons-charts-options). +| align | [ScaleTitleAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ScaleTitleAlign.html) | ScaleLabelAlign.CENTER | Alignment of the scale label. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of scale label.
See [default colors](DefaultsCharts#commons-charts-options). | display | boolean | `false` | If `true`, the scale label is shown. -| font | [Font](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Font.html) | `Defaults.get().getGlobal()`
`.getFont()` | Font of scale label.
See [Font](DefaultsCharts#font). -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Padding.html) | 4 to all dimensions | The padding of title. Only `top` and `bottom` are implemented.
See [padding documentation](../configuration/Commons#padding) for more details. +| font | [Font](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Font.html) | `Defaults.get().getGlobal()`
`.getFont()` | Font of scale label.
See [Font](DefaultsCharts#font). +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Padding.html) | 4 to all dimensions | The padding of title. Only `top` and `bottom` are implemented.
See [padding documentation](../configuration/Commons#padding) for more details. ## AngleLines The angle lines options are used to configure angled lines that are radiated from the center of the chart to the point labels. -The [angle lines](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/AngleLines.html) configuration is nested in the scale configuration as following: +The [angle lines](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/AngleLines.html) configuration is nested in the scale configuration as following: ```java // -------------------------------------- @@ -224,7 +224,7 @@ The following are the attributes that you can set: | :- | :- | :- | :- | borderDash | int[] | [] | Length and spacing of dashes on grid lines. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | 0 | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | Color of angled lines.
See [default colors](DefaultsCharts#commons-charts-options). +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBorderColorAsString()` | Color of angled lines.
See [default colors](DefaultsCharts#commons-charts-options). | display | boolean | `true` | If `true`, angle lines are shown. | lineWidth | int | 1 | Width of angled lines. @@ -232,7 +232,7 @@ The following are the attributes that you can set: The point labels options are used to configure the point labels that are shown on the perimeter of the scale. -The [point labels](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/PointLabels.html) configuration is nested in the scale configuration as following +The [point labels](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/PointLabels.html) configuration is nested in the scale configuration as following ```java // -------------------------------------- @@ -247,19 +247,19 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | Background color of the point label. -| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Padding.html) | 2 to all dimensions | The padding of label backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. -| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) | 0 | The border radius of the point label (in pixels). -| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) | `true` | If `true`, point labels are shown. When Display.AUTO, the label is hidden if it overlaps with another label. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of point labels.
See [default colors](DefaultsCharts#commons-charts-options). -| font | [Font](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Font.html) | `Defaults.get().getGlobal()`
`.getFont()` | Font of point labels.
See [Font](DefaultsCharts#font). +| backdropColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getBackgroundColorAsString()` | Background color of the point label. +| backdropPadding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Padding.html) | 2 to all dimensions | The padding of label backdrop.
See [padding documentation](../configuration/Commons#padding) for more details. +| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) | 0 | The border radius of the point label (in pixels). +| display | boolean - [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) | `true` | If `true`, point labels are shown. When Display.AUTO, the label is hidden if it overlaps with another label. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | Color of point labels.
See [default colors](DefaultsCharts#commons-charts-options). +| font | [Font](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Font.html) | `Defaults.get().getGlobal()`
`.getFont()` | Font of point labels.
See [Font](DefaultsCharts#font). | padding | int | 5 | Padding between chart and point labels, in pixel. ## Time The time options are used to configure the time axis. -The [time](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Time.html) configuration is nested in the scale configuration as following: +The [time](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Time.html) configuration is nested in the scale configuration as following: ```java // -------------------------------------- @@ -274,13 +274,13 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| isoWeekday | [IsoWeekDay](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/IsoWeekDay.html) | IsoWeekDay.SUNDAY | The first day of the week. -| minUnit | [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html) | TimeUnit.MILLISECOND | The minimum display format to be used for a time unit. +| isoWeekday | [IsoWeekDay](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/IsoWeekDay.html) | IsoWeekDay.SUNDAY | The first day of the week. +| minUnit | [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html) | TimeUnit.MILLISECOND | The minimum display format to be used for a time unit. | parser | String | `null` | Interpreted as a custom format to be used to parse the date. -| round | [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html) | `null` | If defined, dates will be rounded to the start of this unit. +| round | [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html) | `null` | If defined, dates will be rounded to the start of this unit. | stepSize | int | 1 | The number of units between grid lines. | tooltipFormat | String | `null` | Format string to use for the tooltip. -| unit | [TimeUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TimeUnit.html) | `null` | If defined, will force the unit to be a certain type. +| unit | [TimeUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TimeUnit.html) | `null` | If defined, will force the unit to be a certain type. For more details, have a look how to configure a [cartesian time axis](../axes/CartesianTimeAxes). @@ -288,7 +288,7 @@ For more details, have a look how to configure a [cartesian time axis](../axes/C The display formats are used to configure how different time units are formed in the strings for the axis tick marks. -The [display formats](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/DisplayFormats.html) configuration is nested in the scale configuration as following: +The [display formats](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/DisplayFormats.html) configuration is nested in the scale configuration as following: ```java // -------------------------------------- @@ -304,7 +304,7 @@ String displayFormat = Defaults.get().getScale().getTime().getDisplayFormats().g The adapters options are used to configure the adapter for external date library if that adapter needs or supports options. The options are leveraging in [INTL](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl) framework -The [adapters options](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/Adapters.html) configuration is nested in the scale configuration as following: +The [adapters options](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/Adapters.html) configuration is nested in the scale configuration as following: ```java // -------------------------------------- @@ -319,9 +319,9 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| locale | [CLocale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) | `null` | Using locale specifying the language to use generating or interpreting strings. -| zone | [TimeZone](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/TimeZone.html) | `null` | Implementation recognizes the time zone names of the IANA time zone database. -| outputCalendar | [Calendar](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/Calendar.html) | `null` | The calendar type to use. -| numberingSystem | [NumberingSystem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/NumberingSystem.html) | `null` | The numbering system to use. +| locale | [CLocale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) | `null` | Using locale specifying the language to use generating or interpreting strings. +| zone | [TimeZone](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/TimeZone.html) | `null` | Implementation recognizes the time zone names of the IANA time zone database. +| outputCalendar | [Calendar](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/Calendar.html) | `null` | The calendar type to use. +| numberingSystem | [NumberingSystem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/NumberingSystem.html) | `null` | The numbering system to use. For more details, have a look how to configure a [Luxon](../DateAdapters#Luxon) date adapters and the [locale](../intl/Locale) documentation. diff --git a/docs/extensions/Annotation.md b/docs/extensions/Annotation.md index 98c9f76c..52ff65ab 100644 --- a/docs/extensions/Annotation.md +++ b/docs/extensions/Annotation.md @@ -24,7 +24,7 @@ The annotation plugin will not work on any chart that does not have exactly two The annotation plugin is injected directly in the document. -The plugin ID is a constant everywhere available, `AnnotationPlugin.ID`, in [AnnotationPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AnnotationPlugin.html) entry point. +The plugin ID is a constant everywhere available, `AnnotationPlugin.ID`, in [AnnotationPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AnnotationPlugin.html) entry point. This plugin registers itself globally, meaning that once injected, all charts will display annotations. In case you want it enabled only for a few charts, you can enable it as following: @@ -71,7 +71,7 @@ The plugin options can be changed at 2 different levels and are evaluated with t * per chart by `chart.getOptions().getPlugins().setOptions` method * or globally by `Defaults.get().getGlobal().getPlugins().setOptions` method -The configuration [AnnotationOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AnnotationOptions.html) class is the entry point of plugin configuration. +The configuration [AnnotationOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AnnotationOptions.html) class is the entry point of plugin configuration. ```java // ------------------------- @@ -111,7 +111,7 @@ Defaults.get().getGlobal().getPlugin().setOptions(options); options.store(); ``` -If you need to read the plugin options, there is the specific factory, [AnnotationOptionsFactory](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AnnotationOptionsFactory.html) as static reference inside the [AnnotationPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AnnotationPlugin.html) entry point which can be used to retrieve the options from chart as following: +If you need to read the plugin options, there is the specific factory, [AnnotationOptionsFactory](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AnnotationOptionsFactory.html) as static reference inside the [AnnotationPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AnnotationPlugin.html) entry point which can be used to retrieve the options from chart as following: ```java // gets options reference @@ -135,7 +135,7 @@ Every annotation type is a chart element and the common options for a specific t * per chart by `chart.getOptions().getElements().getElement(ElementFactory)` method * or globally by `Defaults.get().getGlobal().getElements().getElement(ElementFactory)` method -The annotation options are providing a [ElementFactory](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ElementFactory.html) instance in order to enable to get and change the options at annotation type level. +The annotation options are providing a [ElementFactory](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ElementFactory.html) instance in order to enable to get and change the options at annotation type level. ```java // ---------------------------------------------------- @@ -164,9 +164,9 @@ If the annotation plugin is not activated (see [Activation](#activation)), the a ## Identifier -Every annotation configuration can be add to the [AnnotationOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AnnotationOptions.html), assigning a unique identifier. +Every annotation configuration can be add to the [AnnotationOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AnnotationOptions.html), assigning a unique identifier. -The identifier of a label configuration can be set by a string or by a specific class, [AnnotationId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AnnotationId.html). +The identifier of a label configuration can be set by a string or by a specific class, [AnnotationId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AnnotationId.html). ```java // ------------------------- @@ -213,7 +213,7 @@ AbstractAnnotation annotation2 = options.getAnnotation("myAnnotation2"); ## Options -The configuration class [AnnotationOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AnnotationOptions.html) contains all properties needed to configure the plugin. +The configuration class [AnnotationOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AnnotationOptions.html) contains all properties needed to configure the plugin. ```java // creates a plugin options @@ -226,31 +226,31 @@ The following options are available at the top level. They apply to all annotati | Name | Type | Default | Description | :- | :- | :- | :- -| animations | [Animations](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Animations.html) | - | See [animation options](#animations) section for more details. +| animations | [Animations](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Animations.html) | - | See [animation options](#animations) section for more details. | clip | boolean | `true` | If `true`, the annotations are clipped to the chart area. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.AFTER_DATASETS_DRAW | Defines when the annotations are drawn. This allows positioning of the annotation relative to the other elements of the graph. -| events | [IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)> | `Defaults.get().getGlobal()`
`.getEvents()` | The events option defines the browser events that the plugin should listen to. This overrides the options at chart level. -| interaction | [Interaction](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/Interaction.html) | [see below](#interaction) | To configure which events trigger plugin interactions. +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.AFTER_DATASETS_DRAW | Defines when the annotations are drawn. This allows positioning of the annotation relative to the other elements of the graph. +| events | [IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)> | `Defaults.get().getGlobal()`
`.getEvents()` | The events option defines the browser events that the plugin should listen to. This overrides the options at chart level. +| interaction | [Interaction](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/Interaction.html) | [see below](#interaction) | To configure which events trigger plugin interactions. ### Animations -[Animations](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/Animations.html) options configures which element properties are animated and how. +[Animations](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/Animations.html) options configures which element properties are animated and how. -The animations element is a [container of configurations](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/AnimationCollection.html) which can be stored and retrieved by a [key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/Key.html). +The animations element is a [container of configurations](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/AnimationCollection.html) which can be stored and retrieved by a [key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/Key.html). -The following options are available in [AnimationCollection](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/AnimationCollection.html). +The following options are available in [AnimationCollection](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/AnimationCollection.html). | Name | Type | Defaults | Description | :- | :- | :- | :- | delay | int | Undefined.INTEGER | Delay in milliseconds before starting the animations. | duration | int | 1000 | The number of milliseconds an animation takes. -| easing | [Easing](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Easing.html) | Easing.EASE_OUT_QUART | Easing function to use.
See [Robert Penner's easing equations](http://robertpenner.com/easing/) for more details. -| interpolator | [NativeInterpolator](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/NativeInterpolator.html) | - | Enables a custom interpolation during the animations. Only coding in java script for performance reasons. +| easing | [Easing](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Easing.html) | Easing.EASE_OUT_QUART | Easing function to use.
See [Robert Penner's easing equations](http://robertpenner.com/easing/) for more details. +| interpolator | [NativeInterpolator](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/NativeInterpolator.html) | - | Enables a custom interpolation during the animations. Only coding in java script for performance reasons. | loop | boolean | `false` | If set to `true`, the animations loop endlessly. -| properties | String[] - [Key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/Key.html)[] | [] | The properties of elements to use to animate. -| type | [AnimationType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AnimationType.html) | AnimationType.NUMBER | Type of property, determines the interpolator used. -| from | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | Undefined.BOOLEAN
Undefined.DOUBLE
`null` | Start value for the animation. -| to | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | Undefined.BOOLEAN
Undefined.DOUBLE
`null` | End value for the animation. +| properties | String[] - [Key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/Key.html)[] | [] | The properties of elements to use to animate. +| type | [AnimationType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AnimationType.html) | AnimationType.NUMBER | Type of property, determines the interpolator used. +| from | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | Undefined.BOOLEAN
Undefined.DOUBLE
`null` | Start value for the animation. +| to | boolean - double - String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | Undefined.BOOLEAN
Undefined.DOUBLE
`null` | End value for the animation. ### Interaction @@ -264,7 +264,7 @@ Interaction uses the same format as [a chart instance](../configuration/interact ### Draw time -The [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) option for an annotation determines where in the chart life cycle the drawing occurs. Four potential options are available: +The [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) option for an annotation determines where in the chart life cycle the drawing occurs. Four potential options are available: | Option | Description | :- | :- @@ -303,18 +303,18 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- | adjustScaleRange | boolean | `true` | [Yes](#box-scriptable-options) | If `true`, the scale range should be adjusted if this annotation is out of range. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#box-scriptable-options) | The fill color of the box.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#box-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT | [Yes](#box-scriptable-options) | Cap style of the border line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#box-scriptable-options) | The stroke color of the box.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#box-scriptable-options) | The fill color of the box.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#box-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT | [Yes](#box-scriptable-options) | Cap style of the border line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#box-scriptable-options) | The stroke color of the box.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | borderDash | int[]| [] | [Yes](#box-scriptable-options) | The length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | 0 | [Yes](#box-scriptable-options) | The offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | [Yes](#box-scriptable-options) | Border line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin) -| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) | 0 | [Yes](#box-scriptable-options) | The radius in pixels of box rectangle. -| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#box-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | [Yes](#box-scriptable-options) | Border line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin) +| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) | 0 | [Yes](#box-scriptable-options) | The radius in pixels of box rectangle. +| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#box-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). | borderWidth | int | 1 | [Yes](#box-scriptable-options) | The stroke width of the box. | display | boolean | `true` | [Yes](#box-scriptable-options) | Whether or not this annotation is visible. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.
AFTER_DATASETS_DRAW | [Yes](#box-scriptable-options) | Defines when the annotation is drawn. This allows positioning of the annotation relative to the other elements of the graph. +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.
AFTER_DATASETS_DRAW | [Yes](#box-scriptable-options) | Defines when the annotation is drawn. This allows positioning of the annotation relative to the other elements of the graph. | [init](#initial-animation) | boolean | false | - | If `true` or customized by [callback](#initial-animation), the annotation element will be animated since the initial phase. | rotation | double | 0 | [Yes](#box-scriptable-options) | The rotation of annotation, in degrees. | shadowBlur | double | 0 | [Yes](#box-scriptable-options) | The amount of blur applied to shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur). @@ -322,10 +322,10 @@ The complete options are described by following table: | shadowOffsetY | int | 0 | [Yes](#box-scriptable-options) | The distance that shadows will be offset vertically. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY). | xMax | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#box-scriptable-options) | Right edge of the box in units along the x axis. | xMin | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#box-scriptable-options) | Left edge of the box in units along the x axis. -| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the X scale to bind onto. +| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the X scale to bind onto. | yMax | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#box-scriptable-options) | Top edge of the box in units along the y axis. | yMin | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#box-scriptable-options) | Bottom edge of the box in units along the y axis. -| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the Y scale to bind onto. +| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the Y scale to bind onto. | z | int | 0 | [Yes](#box-scriptable-options) | All visible elements will be drawn in ascending order of `z` option, with the same `drawTime` option. If one of the axes does not match an axis in the chart, the box will take the entire chart dimension. @@ -358,28 +358,28 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| adjustScaleRange | [AdjustScaleRangeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustScaleRangeCallback.html) | boolean -| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) -| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<AnnotationContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<AnnotationContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<AnnotationContext> | int - - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) -| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean -| drawTime | [DrawTimeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/DrawTimeCallback.html) | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) -| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double -| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double -| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| xMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| xMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| z | [ZCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int +| adjustScaleRange | [AdjustScaleRangeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustScaleRangeCallback.html) | boolean +| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) +| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<AnnotationContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<AnnotationContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<AnnotationContext> | int - - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) +| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean +| drawTime | [DrawTimeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/DrawTimeCallback.html) | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) +| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double +| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double +| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| xMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| xMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| z | [ZCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int ### Box label @@ -404,19 +404,19 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| [color](#fonts-and-colors) | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | #fff -          | [Yes](#box-label-scriptable-options) | The text color of the label. -| content | String - String[] - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | `null` | [Yes](#box-label-scriptable-options) | The content to show in the label. Provide an array to display values on a new line. +| [color](#fonts-and-colors) | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | #fff -          | [Yes](#box-label-scriptable-options) | The text color of the label. +| content | String - String[] - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | `null` | [Yes](#box-label-scriptable-options) | The content to show in the label. Provide an array to display values on a new line. | display | boolean | `false` | [Yes](#box-label-scriptable-options) | Whether or not the label is shown. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) | See description | - | Defines when the label is drawn.
Defaults to the box annotation draw time if unset. -| [font](#fonts-and-colors) | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) - List<[FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)> - [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)[] | See description | [Yes](#box-label-scriptable-options) | The text font of the label. The default value is the global font with the weight set to Weight.BOLD.
See [Font](../defaults/DefaultsCharts#font). +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) | See description | - | Defines when the label is drawn.
Defaults to the box annotation draw time if unset. +| [font](#fonts-and-colors) | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) - List<[FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)> - [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)[] | See description | [Yes](#box-label-scriptable-options) | The text font of the label. The default value is the global font with the weight set to Weight.BOLD.
See [Font](../defaults/DefaultsCharts#font). | imageHeight | int - String | Undefined.INTEGER - `null` | [Yes](#box-label-scriptable-options) | Overrides the height of the image. Could be set in pixel by a number, or in percentage of current height of image by a string. If uset, uses the height of the image. It is used only when the content is an image. | imageOpacity | double | 0 | [Yes](#box-label-scriptable-options) | Overrides the opacity of the image or canvas element. Could be set a number in the range 0.0 to 1.0, inclusive. It is used only when the content is an image or canvas element. | imageWidth | int - String | Undefined.INTEGER - `null` | [Yes](#box-label-scriptable-options) | Overrides the width of the image. Could be set in pixel by a number, or in percentage of current width of image by a string. If unset, uses the width of the image. It is used only when the content is an image. -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | 6 | [Yes](#box-label-scriptable-options) | Number of pixels to add above and below the title text.
See [padding documentation](../configuration/Commons#padding) for more details. -| position | [AlignPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AlignPosition.html) | See [position](#box-label-position) | [Yes](#box-label-scriptable-options) | Anchor position of label on box. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | 6 | [Yes](#box-label-scriptable-options) | Number of pixels to add above and below the title text.
See [padding documentation](../configuration/Commons#padding) for more details. +| position | [AlignPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AlignPosition.html) | See [position](#box-label-position) | [Yes](#box-label-scriptable-options) | Anchor position of label on box. | rotation | double | 0 | [Yes](#line-label-scriptable-options) | The rotation of label, in degrees. -| textAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.START | [Yes](#box-label-scriptable-options) | Horizontal alignment on the label content when is set as a multiple lines text. -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#box-label-scriptable-options) | The stroke color of the text. +| textAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.START | [Yes](#box-label-scriptable-options) | Horizontal alignment on the label content when is set as a multiple lines text. +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#box-label-scriptable-options) | The stroke color of the text. |textStrokeWidth | int | 0 | [Yes](#box-label-scriptable-options) | The stroke width of the text. | xAdjust | double | 0 | [Yes](#box-label-scriptable-options) | Adjustment along x-axis (left-right) of label relative to computed position. Negative values move the label left, positive right. | yAdjust | double | 0 | [Yes](#box-label-scriptable-options) | Adjustment along y-axis (top-bottom) of label relative to computed position. Negative values move the label up, positive down. @@ -424,7 +424,7 @@ The complete options are described by following table: #### Box label position -[AlignPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AlignPosition.html) can define the `x` property for the horizontal alignment in the box. Similarly, the `y` property defines the vertical alignment in the box. +[AlignPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AlignPosition.html) can define the `x` property for the horizontal alignment in the box. Similarly, the `y` property defines the vertical alignment in the box. Possible options for both properties are LabelPosition.START, LabelPosition.CENTER, LabelPosition.END, or a double, a value between 0 and 1, is representing the percentage on the size where the label will be located. @@ -456,22 +456,22 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| [color](#fonts-and-colors) | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| content | [ContentCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ContentCallback.html) | String - List<String> - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean -| [font](#fonts-and-colors) | [FontsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontsCallback.html)<AnnotationContext> | List<[FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)> -| imageHeight | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int -| imageOpacity | [ImageOpacityCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ImageOpacityCallback.html) | double -| imageWidth | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int -| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PaddingCallback.html)<AnnotationContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PaddingItem.html) -| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double -| position | [LabelAlignPositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/LabelAlignPositionCallback.html) | [AlignPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AlignPosition.html) -| textAlign | [TextAlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TextAlignCallback.html)<AnnotationContext> | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) -| textStrokeColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| xAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double -| yAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double -| z | [ZCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int +| [color](#fonts-and-colors) | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| content | [ContentCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ContentCallback.html) | String - List<String> - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean +| [font](#fonts-and-colors) | [FontsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontsCallback.html)<AnnotationContext> | List<[FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)> +| imageHeight | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int +| imageOpacity | [ImageOpacityCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ImageOpacityCallback.html) | double +| imageWidth | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int +| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PaddingCallback.html)<AnnotationContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PaddingItem.html) +| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double +| position | [LabelAlignPositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/LabelAlignPositionCallback.html) | [AlignPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AlignPosition.html) +| textAlign | [TextAlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TextAlignCallback.html)<AnnotationContext> | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) +| textStrokeColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| xAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double +| yAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double +| z | [ZCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int ## Ellipse @@ -511,15 +511,15 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- | adjustScaleRange | boolean | `true` | [Yes](#ellipse-scriptable-options) | If `true`, the scale range should be adjusted if this annotation is out of range. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#ellipse-scriptable-options) | The fill color of the ellipse.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#ellipse-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#ellipse-scriptable-options) | The stroke color of the ellipse.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#ellipse-scriptable-options) | The fill color of the ellipse.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#ellipse-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#ellipse-scriptable-options) | The stroke color of the ellipse.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | borderDash | int[]| [] | [Yes](#ellipse-scriptable-options) | The length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | 0 | [Yes](#ellipse-scriptable-options) | The offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#ellipse-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#ellipse-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). | borderWidth | int | 1 | [Yes](#ellipse-scriptable-options) | The stroke width of the ellipse. | display | boolean | `true` | [Yes](#ellipse-scriptable-options) | Whether or not this annotation is visible. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.
AFTER_DATASETS_DRAW | [Yes](#ellipse-scriptable-options) | Defines when the annotation is drawn. This allows positioning of the annotation relative to the other elements of the graph. +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.
AFTER_DATASETS_DRAW | [Yes](#ellipse-scriptable-options) | Defines when the annotation is drawn. This allows positioning of the annotation relative to the other elements of the graph. | [init](#initial-animation) | boolean | false | - | If `true` or customized by [callback](#initial-animation), the annotation element will be animated since the initial phase. | rotation | double | 0 | [Yes](#ellipse-scriptable-options) | The rotation of annotation, in degrees. | shadowBlur | double | 0 | [Yes](#ellipse-scriptable-options) | The amount of blur applied to shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur). @@ -527,10 +527,10 @@ The complete options are described by following table: | shadowOffsetY | int | 0 | [Yes](#ellipse-scriptable-options) | The distance that shadows will be offset vertically. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY). | xMax | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` |[Yes](#ellipse-scriptable-options) | Right edge of the ellipse in units along the x axis. | xMin | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#ellipse-scriptable-options) | Left edge of the ellipse in units along the x axis. -| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the X scale to bind onto. +| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the X scale to bind onto. | yMax | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#ellipse-scriptable-options) | Top edge of the ellipse in units along the y axis. | yMin | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#ellipse-scriptable-options) | Bottom edge of the ellipse in units along the y axis. -| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the Y scale to bind onto. +| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the Y scale to bind onto. | z | int | 0 | [Yes](#ellipse-scriptable-options) | All visible elements will be drawn in ascending order of `z` option, with the same `drawTime` option. #### Ellipse scriptable options @@ -559,25 +559,25 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| adjustScaleRange | [AdjustScaleRangeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustScaleRangeCallback.html) | boolean -| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) -| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double -| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean -| drawTime | [DrawTimeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/DrawTimeCallback.html) | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) -| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double -| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double -| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| xMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| xMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| z | [ZCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int +| adjustScaleRange | [AdjustScaleRangeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustScaleRangeCallback.html) | boolean +| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) +| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double +| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean +| drawTime | [DrawTimeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/DrawTimeCallback.html) | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) +| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double +| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double +| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| xMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| xMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| z | [ZCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int ### Ellipse label @@ -602,19 +602,19 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| [color](#fonts-and-colors) | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | #fff -          | [Yes](#ellipse-label-scriptable-options) | The text color of the label. -| content | String - String[] - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | `null` | [Yes](#ellipse-label-scriptable-options) | The content to show in the label. Provide an array to display values on a new line. +| [color](#fonts-and-colors) | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | #fff -          | [Yes](#ellipse-label-scriptable-options) | The text color of the label. +| content | String - String[] - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | `null` | [Yes](#ellipse-label-scriptable-options) | The content to show in the label. Provide an array to display values on a new line. | display | boolean | `false` | [Yes](#ellipse-label-scriptable-options) | Whether or not the label is shown. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) | See description | - | Defines when the label is drawn.
Defaults to the box annotation draw time if unset. -| [font](#fonts-and-colors) | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) - List<[FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)> - [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)[] | See description | [Yes](#ellipse-label-scriptable-options) | The text font of the label. The default value is the global font with the weight set to Weight.BOLD.
See [Font](../defaults/DefaultsCharts#font). +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) | See description | - | Defines when the label is drawn.
Defaults to the box annotation draw time if unset. +| [font](#fonts-and-colors) | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) - List<[FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)> - [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)[] | See description | [Yes](#ellipse-label-scriptable-options) | The text font of the label. The default value is the global font with the weight set to Weight.BOLD.
See [Font](../defaults/DefaultsCharts#font). | imageHeight | int - String | Undefined.INTEGER - `null` | [Yes](#ellipse-label-scriptable-options) | Overrides the height of the image. Could be set in pixel by a number, or in percentage of current height of image by a string. If uset, uses the height of the image. It is used only when the content is an image. | imageOpacity | double | 0 | [Yes](#ellipse-label-scriptable-options) | Overrides the opacity of the image or canvas element. Could be set a number in the range 0.0 to 1.0, inclusive. It is used only when the content is an image or canvas element. | imageWidth | int - String | Undefined.INTEGER - `null` | [Yes](#ellipse-label-scriptable-options) | Overrides the width of the image. Could be set in pixel by a number, or in percentage of current width of image by a string. If unset, uses the width of the image. It is used only when the content is an image. -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | 6 | [Yes](#ellipse-label-scriptable-options) | Number of pixels to add above and below the title text.
See [padding documentation](../configuration/Commons#padding) for more details. -| position | [AlignPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AlignPosition.html) | See [position](#box-label-position) | [Yes](#ellipse-label-scriptable-options) | Anchor position of label on box. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | 6 | [Yes](#ellipse-label-scriptable-options) | Number of pixels to add above and below the title text.
See [padding documentation](../configuration/Commons#padding) for more details. +| position | [AlignPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AlignPosition.html) | See [position](#box-label-position) | [Yes](#ellipse-label-scriptable-options) | Anchor position of label on box. | rotation | double | 0 | [Yes](#line-label-scriptable-options) | The rotation of label, in degrees. -| textAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.START | [Yes](#ellipse-label-scriptable-options) | Horizontal alignment on the label content when is set as a multiple lines text. -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#ellipse-label-scriptable-options) | The stroke color of the text. +| textAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.START | [Yes](#ellipse-label-scriptable-options) | Horizontal alignment on the label content when is set as a multiple lines text. +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#ellipse-label-scriptable-options) | The stroke color of the text. |textStrokeWidth | int | 0 | [Yes](#ellipse-label-scriptable-options) | The stroke width of the text. | xAdjust | double | 0 | [Yes](#ellipse-label-scriptable-options) | Adjustment along x-axis (left-right) of label relative to computed position. Negative values move the label left, positive right. | yAdjust | double | 0 | [Yes](#ellipse-label-scriptable-options) | Adjustment along y-axis (top-bottom) of label relative to computed position. Negative values move the label up, positive down. @@ -646,22 +646,22 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| [color](#fonts-and-colors) | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| content | [ContentCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ContentCallback.html) | String - List<String> - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean -| [font](#fonts-and-colors) | [FontsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontsCallback.html)<AnnotationContext> | List<[FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)> -| imageHeight | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int -| imageOpacity | [ImageOpacityCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ImageOpacityCallback.html) | double -| imageWidth | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int -| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PaddingCallback.html)<AnnotationContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PaddingItem.html) -| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double -| position | [LabelAlignPositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/LabelAlignPositionCallback.html) | [AlignPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AlignPosition.html) -| textAlign | [TextAlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TextAlignCallback.html)<AnnotationContext> | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) -| textStrokeColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| xAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double -| yAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double -| z | [ZCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int +| [color](#fonts-and-colors) | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| content | [ContentCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ContentCallback.html) | String - List<String> - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean +| [font](#fonts-and-colors) | [FontsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontsCallback.html)<AnnotationContext> | List<[FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)> +| imageHeight | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int +| imageOpacity | [ImageOpacityCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ImageOpacityCallback.html) | double +| imageWidth | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int +| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PaddingCallback.html)<AnnotationContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PaddingItem.html) +| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double +| position | [LabelAlignPositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/LabelAlignPositionCallback.html) | [AlignPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AlignPosition.html) +| textAlign | [TextAlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TextAlignCallback.html)<AnnotationContext> | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) +| textStrokeColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| xAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double +| yAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double +| z | [ZCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int ## Label @@ -692,43 +692,43 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- | adjustScaleRange | boolean | `true` | [Yes](#label-scriptable-options) | If `true`, the scale range should be adjusted if this annotation is out of range. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#label-scriptable-options) | The fill color of the label box.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#label-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT | [Yes](#label-scriptable-options) | Cap style of the border label box. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#label-scriptable-options) | The stroke color of the label box.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#label-scriptable-options) | The fill color of the label box.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#label-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT | [Yes](#label-scriptable-options) | Cap style of the border label box. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#label-scriptable-options) | The stroke color of the label box.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). | borderDash | int[]| [] | [Yes](#label-scriptable-options) | The length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | 0 | [Yes](#label-scriptable-options) | The offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | [Yes](#label-scriptable-options) | Border line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin) -| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) | 0 | [Yes](#label-scriptable-options) | The radius in pixels of label box. -| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#label-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | [Yes](#label-scriptable-options) | Border line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin) +| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) | 0 | [Yes](#label-scriptable-options) | The radius in pixels of label box. +| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#label-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). | borderWidth | int | 0 | [Yes](#label-scriptable-options) | The stroke width of the label box. -| [color](#fonts-and-colors) | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | HtmlColor.BLACK -          | [Yes](#label-scriptable-options) | The text color of the label. -| content | String - String[] - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | `null` | [Yes](#label-scriptable-options) | The content to show in the label. Provide an array to display values on a new line. +| [color](#fonts-and-colors) | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | HtmlColor.BLACK -          | [Yes](#label-scriptable-options) | The text color of the label. +| content | String - String[] - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | `null` | [Yes](#label-scriptable-options) | The content to show in the label. Provide an array to display values on a new line. | display | boolean | `true` | [Yes](#label-scriptable-options) | Whether or not this annotation is visible. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.
AFTER_DATASETS_DRAW | [Yes](#label-scriptable-options) | Defines when the annotation is drawn. This allows positioning of the annotation relative to the other elements of the graph. -| [font](#fonts-and-colors) | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) - List<[FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)> - [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)[] | See description | [Yes](#label-scriptable-options) | The text font of the label. The default value is the global font.
See [Font](../defaults/DefaultsCharts#font). +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.
AFTER_DATASETS_DRAW | [Yes](#label-scriptable-options) | Defines when the annotation is drawn. This allows positioning of the annotation relative to the other elements of the graph. +| [font](#fonts-and-colors) | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) - List<[FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)> - [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)[] | See description | [Yes](#label-scriptable-options) | The text font of the label. The default value is the global font.
See [Font](../defaults/DefaultsCharts#font). | imageHeight | int - String | Undefined.INTEGER - `null` | [Yes](#label-scriptable-options) | Overrides the height of the image. Could be set in pixel by a number, or in percentage of current height of image by a string. If uset, uses the height of the image. It is used only when the content is an image. | imageOpacity | double | 0 | [Yes](#label-scriptable-options) | Overrides the opacity of the image or canvas element. Could be set a number in the range 0.0 to 1.0, inclusive. It is used only when the content is an image or canvas element. | imageWidth | int - String | Undefined.INTEGER - `null` | [Yes](#label-scriptable-options) | Overrides the width of the image. Could be set in pixel by a number, or in percentage of current width of image by a string. If unset, uses the width of the image. It is used only when the content is an image. | [init](#initial-animation) | boolean | false | - | If `true` or customized by [callback](#initial-animation), the annotation element will be animated since the initial phase. -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | 6 | [Yes](#label-scriptable-options) | Number of pixels to add above and below the title text.
See [padding documentation](../configuration/Commons#padding) for more details. -| position | [AlignPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AlignPosition.html) | See [position](#label-position) | [Yes](#label-scriptable-options) | Anchor position of label. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | 6 | [Yes](#label-scriptable-options) | Number of pixels to add above and below the title text.
See [padding documentation](../configuration/Commons#padding) for more details. +| position | [AlignPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AlignPosition.html) | See [position](#label-position) | [Yes](#label-scriptable-options) | Anchor position of label. | rotation | double | 0 | [Yes](#label-scriptable-options) | The rotation of annotation, in degrees. | shadowBlur | double | 0 | [Yes](#label-scriptable-options) | The amount of blur applied to shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur). | shadowOffsetX | int | 0 | [Yes](#label-scriptable-options) | The distance that shadows will be offset horizontally. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX). | shadowOffsetY | int | 0 | [Yes](#label-scriptable-options) | The distance that shadows will be offset vertically. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY). -| textAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.CENTER | [Yes](#label-scriptable-options) | Horizontal alignment on the label content when is set as a multiple lines text. -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#label-scriptable-options) | The stroke color of the text. +| textAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.CENTER | [Yes](#label-scriptable-options) | Horizontal alignment on the label content when is set as a multiple lines text. +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#label-scriptable-options) | The stroke color of the text. |textStrokeWidth | int | 0 | [Yes](#label-scriptable-options) | The stroke width of the text. | xAdjust | double | 0 | [Yes](#label-scriptable-options) | Adjustment along x-axis (left-right) of point relative to computed position. Negative values move the point left, positive right. | xMax | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#label-scriptable-options) | X coordinate of end two of the box, whose center is used as the center of the point, in units along the x axis. | xMin | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#label-scriptable-options) | X coordinate of end one of the box, whose center is used as the center of the point, in units along the x axis. -| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the X scale to bind onto. +| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the X scale to bind onto. | xValue | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#label-scriptable-options) | X coordinate of the center of point in units along the x axis. | yAdjust | double | 0 | [Yes](#label-scriptable-options) | Adjustment along y-axis (top-bottom) of point relative to computed position. Negative values move the point up, positive down. | yMax | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#label-scriptable-options) | Y coordinate of end one of the box, whose center is used as the center of the point, in units along the y axis. | yMin | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#label-scriptable-options) | Y coordinate of end one of the box, whose center is used as the center of the point, in units along the y axis. -| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the Y scale to bind onto. +| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the Y scale to bind onto. | yValue | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#label-scriptable-options) | Y coordinate of the center of point in units along the y axis. | z | int | 0 | [Yes](#label-scriptable-options) | All visible elements will be drawn in ascending order of `z` option, with the same `drawTime` option. @@ -738,7 +738,7 @@ The 4 coordinates, xMin, xMax, yMin, yMax are optional. If not specified, the bo #### Label position -[AlignPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AlignPosition.html) can define the `x` property for the horizontal alignment of the label with respect to the selected point. Similarly, the `y` property defines the vertical alignment. +[AlignPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AlignPosition.html) can define the `x` property for the horizontal alignment of the label with respect to the selected point. Similarly, the `y` property defines the vertical alignment. Possible options for both properties are LabelPosition.START, LabelPosition.CENTER, LabelPosition.END, or a double, a value between 0 and 1, is representing the percentage on the size where the label will be located. @@ -770,43 +770,43 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| adjustScaleRange | [AdjustScaleRangeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustScaleRangeCallback.html) | boolean -| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) -| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<AnnotationContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<AnnotationContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<AnnotationContext> | int - - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) -| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| [color](#fonts-and-colors) | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| content | [ContentCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ContentCallback.html) | String - List<String> - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean -| drawTime | [DrawTimeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/DrawTimeCallback.html) | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) -| [font](#fonts-and-colors) | [FontsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontsCallback.html)<AnnotationContext> | List<[FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)> -| imageHeight | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int -| imageOpacity | [ImageOpacityCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ImageOpacityCallback.html) | double -| imageWidth | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int -| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PaddingCallback.html)<AnnotationContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PaddingItem.html) -| position | [LabelAlignPositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/LabelAlignPositionCallback.html) | [AlignPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AlignPosition.html) -| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double -| textAlign | [TextAlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TextAlignCallback.html)<AnnotationContext> | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) -| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double -| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| textStrokeColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| xAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double -| xMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| xMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| xValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double -| yMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| z | [ZCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int +| adjustScaleRange | [AdjustScaleRangeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustScaleRangeCallback.html) | boolean +| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) +| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<AnnotationContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<AnnotationContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<AnnotationContext> | int - - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) +| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| [color](#fonts-and-colors) | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| content | [ContentCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ContentCallback.html) | String - List<String> - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean +| drawTime | [DrawTimeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/DrawTimeCallback.html) | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) +| [font](#fonts-and-colors) | [FontsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontsCallback.html)<AnnotationContext> | List<[FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)> +| imageHeight | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int +| imageOpacity | [ImageOpacityCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ImageOpacityCallback.html) | double +| imageWidth | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int +| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PaddingCallback.html)<AnnotationContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PaddingItem.html) +| position | [LabelAlignPositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/LabelAlignPositionCallback.html) | [AlignPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AlignPosition.html) +| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double +| textAlign | [TextAlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TextAlignCallback.html)<AnnotationContext> | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) +| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double +| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| textStrokeColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| xAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double +| xMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| xMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| xValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double +| yMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| z | [ZCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int ### Callout @@ -830,15 +830,15 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT| [Yes](#callout-scriptable-options) | Cap style of the callout line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)| HtmlColor.BLACK -          | [Yes](#callout-scriptable-options) | The color of the callout line. +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT| [Yes](#callout-scriptable-options) | Cap style of the callout line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)| HtmlColor.BLACK -          | [Yes](#callout-scriptable-options) | The color of the callout line. | borderDash | int[] | [] | [Yes](#callout-scriptable-options) | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | 0 | [Yes](#callout-scriptable-options) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | [Yes](#callout-scriptable-options) | Callout line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | [Yes](#callout-scriptable-options) | Callout line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderWidth | int | 1 | [Yes](#callout-scriptable-options) | The width of the callout line in pixels. | display | boolean | `false` | [Yes](#callout-scriptable-options) | Whether or not the callout is shown. | margin | int | 5 | [Yes](#callout-scriptable-options) | Amount of pixels between the label and the callout separator. -| position | [CalloutPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/CalloutPosition.html) | CalloutPosition.AUTO | [Yes](#callout-scriptable-options) | The position of callout, with respect to the label. +| position | [CalloutPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/CalloutPosition.html) | CalloutPosition.AUTO | [Yes](#callout-scriptable-options) | The position of callout, with respect to the label. | side | int | 5 | [Yes](#callout-scriptable-options) | Width of the starter line of callout pointer. | start | double - int | 0.5D | [Yes](#callout-scriptable-options) | The percentage of the separator dimension to use as starting point for callout pointer. Could be set in pixel by an integer, or in percentage of the separator dimension by a double, a value between 0 and 1. @@ -868,17 +868,17 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<AnnotationContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<AnnotationContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean -| margin | [MarginCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/MarginCallback.html) | int -| position | [CalloutPositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/CalloutPositionCallback.html) | [CalloutPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/CalloutPosition.html) -| side | [SideCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/SideCallback.html) | int -| start | [StartCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/StartCallback](https.html) | double - int +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<AnnotationContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<AnnotationContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean +| margin | [MarginCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/MarginCallback.html) | int +| position | [CalloutPositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/CalloutPositionCallback.html) | [CalloutPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/CalloutPosition.html) +| side | [SideCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/SideCallback.html) | int +| start | [StartCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/StartCallback](https.html) | double - int ## Line @@ -912,28 +912,28 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- | adjustScaleRange | boolean | `true` | [Yes](#line-scriptable-options) | If `true`, the scale range should be adjusted if this annotation is out of range. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#line-scriptable-options) | The stroke color of the line. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#line-scriptable-options) | The stroke color of the line. | borderDash | int[] | [] | [Yes](#line-scriptable-options) | the line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern. | borderDashOffset | int | 0 | [Yes](#line-scriptable-options) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset) -| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#line-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#line-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). | borderWidth | int | 2 | [Yes](#line-scriptable-options) | The stroke width of the line. -| controlPoint | double - String - [ControlPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/ControlPoint.html) | `{y:'-50%'}` | [Yes](#line-scriptable-options) | If `curve` is enabled, it configures the control point to drawn the curve, calculated in pixels. It can be set by a string in percentage format `"number%"` which are representing the percentage of the distance between the start and end point from the center. +| controlPoint | double - String - [ControlPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/ControlPoint.html) | `{y:'-50%'}` | [Yes](#line-scriptable-options) | If `curve` is enabled, it configures the control point to drawn the curve, calculated in pixels. It can be set by a string in percentage format `"number%"` which are representing the percentage of the distance between the start and end point from the center. | curve | boolean | `false` | [Yes](#line-scriptable-options) | Whether or not a quadratic [Bézier curve](https://developer.mozilla.org/en-US/docs/Glossary/Bezier_curve) is drawn. | display | boolean | `true` | [Yes](#line-scriptable-options) | Whether or not this annotation is visible. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.
AFTER_DATASETS_DRAW | [Yes](#line-scriptable-options) | Defines when the annotation is drawn. This allows positioning of the annotation relative to the other elements of the graph. +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.
AFTER_DATASETS_DRAW | [Yes](#line-scriptable-options) | Defines when the annotation is drawn. This allows positioning of the annotation relative to the other elements of the graph. | endValue | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#line-scriptable-options) | End two of the line when a single scale is specified. | [init](#initial-animation) | boolean | false | - | If `true` or customized by [callback](#initial-animation), the annotation element will be animated since the initial phase. -| scaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | ID of the scale in single scale mode. If unset, `xScaleID` and `yScaleID` are used. +| scaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | ID of the scale in single scale mode. If unset, `xScaleID` and `yScaleID` are used. | shadowBlur | double | 0 | [Yes](#line-scriptable-options) | The amount of blur applied to shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur). | shadowOffsetX | int | 0 | [Yes](#line-scriptable-options) | The distance that shadows will be offset horizontally. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX). | shadowOffsetY | int | 0 | [Yes](#line-scriptable-options) | The distance that shadows will be offset vertically. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY). | value | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#line-scriptable-options) | End one of the line when a single scale is specified. | xMax | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#line-scriptable-options) | X coordinate of end two of the line in units along the x axis. | xMin | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#line-scriptable-options) | X coordinate of end one of the line in units along the x axis. -| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the X scale to bind onto. +| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the X scale to bind onto. | yMax | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#line-scriptable-options) | Y coordinate of end one of the line in units along the y axis. | yMin | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#line-scriptable-options) | Y coordinate of end one of the line in units along the y axis. -| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the Y scale to bind onto. +| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the Y scale to bind onto. | z | int | 0 | [Yes](#line-scriptable-options) | All visible elements will be drawn in ascending order of `z` option, with the same `drawTime` option. If one of the axes does not match an axis in the chart, the line will take the entire chart dimension. @@ -971,26 +971,26 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| adjustScaleRange | [AdjustScaleRangeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustScaleRangeCallback.html) | boolean -| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double -| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| controlPoint | [ControlPointCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ControlPointCallback.html) | double - String - [ControlPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/ControlPoint.html) -| curve | [CurveCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/CurveCallback.html) | boolean -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean -| drawTime | [DrawTimeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/DrawTimeCallback.html) | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) -| endValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double -| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| value | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| xMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| xMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| z | [ZCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int +| adjustScaleRange | [AdjustScaleRangeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustScaleRangeCallback.html) | boolean +| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double +| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| controlPoint | [ControlPointCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ControlPointCallback.html) | double - String - [ControlPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/ControlPoint.html) +| curve | [CurveCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/CurveCallback.html) | boolean +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean +| drawTime | [DrawTimeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/DrawTimeCallback.html) | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) +| endValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double +| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| value | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| xMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| xMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| z | [ZCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int ### Line label @@ -1017,32 +1017,32 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- | autoRotation | boolean | `false` | - | If `true`, the rotation option is ignored and the label uses the degrees of the line. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgba(0,0,0,0.8) -          | [Yes](#line-label-scriptable-options) | Background color of the label container. -| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#line-label-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT| [Yes](#line-label-scriptable-options) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.BLACK -          | [Yes](#line-label-scriptable-options) | The color of the line. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgba(0,0,0,0.8) -          | [Yes](#line-label-scriptable-options) | Background color of the label container. +| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#line-label-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT| [Yes](#line-label-scriptable-options) | Cap style of the line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.BLACK -          | [Yes](#line-label-scriptable-options) | The color of the line. | borderDash | int[] | [] | [Yes](#line-label-scriptable-options) | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | 0 | [Yes](#line-label-scriptable-options) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | [Yes](#line-label-scriptable-options) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). -| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) | 6 | [Yes](#line-label-scriptable-options) | The radius of label box in pixels. -| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#line-label-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | [Yes](#line-label-scriptable-options) | Line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderRadius | int - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) | 6 | [Yes](#line-label-scriptable-options) | The radius of label box in pixels. +| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#line-label-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). | borderWidth | int | 0 | [Yes](#line-label-scriptable-options) | The width of the line in pixels. -| [color](#fonts-and-colors) | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)[] | #fff -          | [Yes](#line-label-scriptable-options) | The text color of the label. -| content | String - String[] - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | `null` | [Yes](#line-label-scriptable-options) | The content to show in the label. Provide an array to display values on a new line. +| [color](#fonts-and-colors) | String[] - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)[] | #fff -          | [Yes](#line-label-scriptable-options) | The text color of the label. +| content | String - String[] - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | `null` | [Yes](#line-label-scriptable-options) | The content to show in the label. Provide an array to display values on a new line. | display | boolean | `false` | [Yes](#line-label-scriptable-options) | Whether or not the label is shown. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) | See description | - | Defines when the label is drawn.
Defaults to the line annotation draw time if unset. -| [font](#fonts-and-colors) | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) - List<[FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)> - [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)[] | See description | [Yes](#line-label-scriptable-options) | The text font of the label. The default value is the global font with the style set to FontStyle.BOLD.
See [Font](../defaults/DefaultsCharts#font). +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) | See description | - | Defines when the label is drawn.
Defaults to the line annotation draw time if unset. +| [font](#fonts-and-colors) | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) - List<[FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)> - [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)[] | See description | [Yes](#line-label-scriptable-options) | The text font of the label. The default value is the global font with the style set to FontStyle.BOLD.
See [Font](../defaults/DefaultsCharts#font). | imageHeight | int - String | Undefined.INTEGER - `null` | [Yes](#line-label-scriptable-options) | Overrides the height of the image. Could be set in pixel by a number, or in percentage of current height of image by a string. If uset, uses the height of the image. It is used only when the content is an image. | imageOpacity | double | 0 | [Yes](#line-label-scriptable-options) | Overrides the opacity of the image or canvas element. Could be set a number in the range 0.0 to 1.0, inclusive. It is used only when the content is an image or canvas element. | imageWidth | int - String | Undefined.INTEGER - `null` | [Yes](#line-label-scriptable-options) | Overrides the width of the image. Could be set in pixel by a number, or in percentage of current width of image by a string. If unset, uses the width of the image. It is used only when the content is an image. -| padding | [Padding](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Padding.html) | 6 | [Yes](#line-label-scriptable-options) | Number of pixels to add above and below the title text.
See [padding documentation](../configuration/Commons#padding) for more details. -| position | [LabelPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/LabelPosition.html) - double | LabelPosition.CENTER | [Yes](#line-label-scriptable-options) | Anchor position of label on line. If set by a double, a value between 0 and 1, is representing the percentage on the size where the label will be located. +| padding | [Padding](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Padding.html) | 6 | [Yes](#line-label-scriptable-options) | Number of pixels to add above and below the title text.
See [padding documentation](../configuration/Commons#padding) for more details. +| position | [LabelPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/LabelPosition.html) - double | LabelPosition.CENTER | [Yes](#line-label-scriptable-options) | Anchor position of label on line. If set by a double, a value between 0 and 1, is representing the percentage on the size where the label will be located. | rotation | double | 0 | [Yes](#line-label-scriptable-options) | The rotation of label, in degrees. | shadowBlur | double | 0 | [Yes](#line-label-scriptable-options) | The amount of blur applied to shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur). | shadowOffsetX | int | 0 | [Yes](#line-label-scriptable-options) | The distance that shadows will be offset horizontally. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX). | shadowOffsetY | int | 0 | [Yes](#line-label-scriptable-options) | The distance that shadows will be offset vertically. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY). -| textAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.CENTER | [Yes](#line-label-scriptable-options) | Horizontal alignment on the label content when is set as a multiple lines text. -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#line-label-scriptable-options) | The stroke color of the text. +| textAlign | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.CENTER | [Yes](#line-label-scriptable-options) | Horizontal alignment on the label content when is set as a multiple lines text. +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#line-label-scriptable-options) | The stroke color of the text. | textStrokeWidth | int | 0 | [Yes](#line-label-scriptable-options) | The stroke width of the text. | xAdjust | double | 0 | [Yes](#line-label-scriptable-options) | Adjustment along x-axis (left-right) of label relative to computed position. Negative values move the label left, positive right. | yAdjust | double | 0 | [Yes](#line-label-scriptable-options) | Adjustment along y-axis (top-bottom) of label relative to computed position. Negative values move the label up, positive down. @@ -1074,35 +1074,35 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) -| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<AnnotationContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<AnnotationContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<AnnotationContext> | int - - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/BarBorderRadius.html) -| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| [color](#fonts-and-colors) | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| content | [ContentCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ContentCallback.html) | String - List<String> - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean -| [font](#fonts-and-colors) | [FontsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontsCallback.html)<AnnotationContext> | List<[FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html)> -| imageHeight | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int -| imageOpacity | [ImageOpacityCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ImageOpacityCallback.html) | double -| imageWidth | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int -| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PaddingCallback.html)<AnnotationContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PaddingItem.html) -| position | [LabelPositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/LabelPositionCallback.html) | double - [LabelPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/LabelPosition.html) -| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double**(1)** -| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double -| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| textAlign | [TextAlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/TextAlignCallback.html)<AnnotationContext> | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) -| textStrokeColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| xAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double -| yAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double -| z | [ZCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int +| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) +| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<AnnotationContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<AnnotationContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderRadius | [BorderRadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderRadiusCallback.html)<AnnotationContext> | int - - [BarBorderRadius](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/BarBorderRadius.html) +| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| [color](#fonts-and-colors) | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| content | [ContentCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ContentCallback.html) | String - List<String> - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean +| [font](#fonts-and-colors) | [FontsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontsCallback.html)<AnnotationContext> | List<[FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html)> +| imageHeight | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int +| imageOpacity | [ImageOpacityCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ImageOpacityCallback.html) | double +| imageWidth | [ImageSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ImageSizeCallback.html) | String - int +| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PaddingCallback.html)<AnnotationContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PaddingItem.html) +| position | [LabelPositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/LabelPositionCallback.html) | double - [LabelPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/LabelPosition.html) +| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double**(1)** +| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double +| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| textAlign | [TextAlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/TextAlignCallback.html)<AnnotationContext> | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) +| textStrokeColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| xAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double +| yAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double +| z | [ZCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int **(1)**To enable `autoRotation` by the rotation callback, the value to return must be `Double.NaN`. @@ -1144,15 +1144,15 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT| [Yes](#line-label-callout-scriptable-options) | Cap style of the callout line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)| HtmlColor.BLACK -          | [Yes](#line-label-callout-scriptable-options) | The color of the callout line. +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT| [Yes](#line-label-callout-scriptable-options) | Cap style of the callout line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)| HtmlColor.BLACK -          | [Yes](#line-label-callout-scriptable-options) | The color of the callout line. | borderDash | int[] | [] | [Yes](#line-label-callout-scriptable-options) | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | 0 | [Yes](#line-label-callout-scriptable-options) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | [Yes](#line-label-callout-scriptable-options) | Callout line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | [Yes](#line-label-callout-scriptable-options) | Callout line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin). | borderWidth | int | 1 | [Yes](#line-label-callout-scriptable-options) | The width of the callout line in pixels. | display | boolean | `false` | [Yes](#line-label-callout-scriptable-options) | Whether or not the callout is shown. | margin | int | 5 | [Yes](#line-label-callout-scriptable-options) | Amount of pixels between the label and the callout separator. -| position | [CalloutPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/CalloutPosition.html) | CalloutPosition.AUTO | [Yes](#line-label-callout-scriptable-options) | The position of callout, with respect to the label. +| position | [CalloutPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/CalloutPosition.html) | CalloutPosition.AUTO | [Yes](#line-label-callout-scriptable-options) | The position of callout, with respect to the label. | side | int | 5 | [Yes](#line-label-callout-scriptable-options) | Width of the starter line of callout pointer. | start | double - int | 0.5D | [Yes](#line-label-callout-scriptable-options) | The percentage of the separator dimension to use as starting point for callout pointer. Could be set in pixel by an integer, or in percentage of the separator dimension by a double, a value between 0 and 1. @@ -1188,17 +1188,17 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<AnnotationContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<AnnotationContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean -| margin | [MarginCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/MarginCallback.html) | int -| position | [CalloutPositionCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/CalloutPositionCallback.html) | [CalloutPosition](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/CalloutPosition.html) -| side | [SideCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/SideCallback.html) | int -| start | [StartCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/StartCallback](https.html) | double - int +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<AnnotationContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<AnnotationContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean +| margin | [MarginCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/MarginCallback.html) | int +| position | [CalloutPositionCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/CalloutPositionCallback.html) | [CalloutPosition](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/CalloutPosition.html) +| side | [SideCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/SideCallback.html) | int +| start | [StartCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/StartCallback](https.html) | double - int ### Arrow heads @@ -1224,21 +1224,21 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `lineAnnotation.borderColor` | [Yes](#arrowheads-scriptable-options) | Background color of the arrow head. -| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#arrowheads-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `lineAnnotation.borderColor` | [Yes](#arrowheads-scriptable-options) | The border arrow head color. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `lineAnnotation.borderColor` | [Yes](#arrowheads-scriptable-options) | Background color of the arrow head. +| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#arrowheads-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `lineAnnotation.borderColor` | [Yes](#arrowheads-scriptable-options) | The border arrow head color. | borderDash | int[] | `lineAnnotation.borderDash` | [Yes](#arrowheads-scriptable-options) | Length and spacing of dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/setLineDash). | borderDashOffset | double | `lineAnnotation.borderDashOffset` | [Yes](#arrowheads-scriptable-options) | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset). -| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `lineAnnotation.borderShadowColor` | [Yes](#arrowheads-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `lineAnnotation.borderShadowColor` | [Yes](#arrowheads-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). | borderWidth | int | `lineAnnotation.borderWidth` | [Yes](#arrowheads-scriptable-options) | The width of the line in pixels. | display | boolean | `false` | [Yes](#arrowheads-scriptable-options) | Whether or not the arrow head is shown. -| end | [ArrowHeads](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/ArrowHeads.html) | - | - | To configure the arrow head at the end of the line. +| end | [ArrowHeads](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/ArrowHeads.html) | - | - | To configure the arrow head at the end of the line. | fill | boolean | `false` | [Yes](#arrowheads-scriptable-options) | Whether or not the arrow head is filled. | length | int | `12` | [Yes](#arrowheads-scriptable-options) | The length of the arrow head in pixels. | shadowBlur | double | `lineAnnotation.shadowBlur` | [Yes](#arrowheads-scriptable-options) | The amount of blur applied to shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur). | shadowOffsetX | int | `lineAnnotation.shadowOffsetX` | [Yes](#arrowheads-scriptable-options) | The distance that shadows will be offset horizontally. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetX). | shadowOffsetY | int | `lineAnnotation.shadowOffsetY` | [Yes](#arrowheads-scriptable-options) | The distance that shadows will be offset vertically. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowOffsetY). -| start | [ArrowHeads](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/ArrowHeads.html) | - | - | To configure the arrow head at the start of the line. +| start | [ArrowHeads](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/ArrowHeads.html) | - | - | To configure the arrow head at the start of the line. | width | int | `6` | [Yes](#arrowheads-scriptable-options) | The width of the arrow head in pixels. #### ArrowHeads scriptable options @@ -1267,20 +1267,20 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) -| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double -| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean -| fill | [FillCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/FillCallback.html) | boolean -| length | [LengthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/LengthCallback.html) | int -| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double -| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| width | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) +| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double +| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean +| fill | [FillCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/FillCallback.html) | boolean +| length | [LengthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/LengthCallback.html) | int +| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double +| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| width | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int ## Point @@ -1314,17 +1314,17 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- | adjustScaleRange | boolean | `true` | [Yes](#point-scriptable-options) | If `true`, the scale range should be adjusted if this annotation is out of range. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#point-scriptable-options) | The fill color of the point.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#point-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#point-scriptable-options) | The stroke color of the point. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#point-scriptable-options) | The fill color of the point.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#point-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#point-scriptable-options) | The stroke color of the point. | borderDash | int[] | [] | [Yes](#point-scriptable-options) | The line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern. | borderDashOffset | int | 0 | [Yes](#point-scriptable-options) | Offset for border dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset) -| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#point-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#point-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). | borderWidth | int | 1 | [Yes](#point-scriptable-options) | The stroke width of the point. | display | boolean | `true` | [Yes](#point-scriptable-options) | Whether or not this annotation is visible. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.
AFTER_DATASETS_DRAW | [Yes](#point-scriptable-options) | Defines when the annotation is drawn. This allows positioning of the annotation relative to the other elements of the graph. +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.
AFTER_DATASETS_DRAW | [Yes](#point-scriptable-options) | Defines when the annotation is drawn. This allows positioning of the annotation relative to the other elements of the graph. | [init](#initial-animation) | boolean | false | - | If `true` or customized by [callback](#initial-animation), the annotation element will be animated since the initial phase. -| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) | PointStyle.CIRCLE | [Yes](#point-scriptable-options) | Style of the point. +| pointStyle | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) | PointStyle.CIRCLE | [Yes](#point-scriptable-options) | Style of the point. | radius | double | 10 | [Yes](#point-scriptable-options) | Size of the point in pixels. | rotation | double | 0 | [Yes](#point-scriptable-options) | The rotation of the point, in degrees. | shadowBlur | double | 0 | [Yes](#point-scriptable-options) | The amount of blur applied to shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowBlur). @@ -1333,12 +1333,12 @@ The complete options are described by following table: | xAdjust | double | 0 | [Yes](#point-scriptable-options) | Adjustment along x-axis (left-right) of point relative to computed position. Negative values move the point left, positive right. | xMax | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#point-scriptable-options) | X coordinate of end two of the box, whose center is used as the center of the point, in units along the x axis. | xMin | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#point-scriptable-options) | X coordinate of end one of the box, whose center is used as the center of the point, in units along the x axis. -| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the X scale to bind onto. +| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the X scale to bind onto. | xValue | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#point-scriptable-options) | X coordinate of the center of point in units along the x axis. | yAdjust | double | 0 | [Yes](#point-scriptable-options) | Adjustment along y-axis (top-bottom) of point relative to computed position. Negative values move the point up, positive down. | yMax | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#point-scriptable-options) | Y coordinate of end one of the box, whose center is used as the center of the point, in units along the y axis. | yMin | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#point-scriptable-options) | Y coordinate of end one of the box, whose center is used as the center of the point, in units along the y axis. -| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the Y scale to bind onto. +| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the Y scale to bind onto. | yValue | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#point-scriptable-options) | Y coordinate of the center of point in units along the y axis. | z | int | 0 | [Yes](#point-scriptable-options) | All visible elements will be drawn in ascending order of `z` option, with the same `drawTime` option. @@ -1372,31 +1372,31 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| adjustScaleRange | [AdjustScaleRangeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustScaleRangeCallback.html) | boolean -| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) -| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double -| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean -| drawTime | [DrawTimeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/DrawTimeCallback.html) | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) -| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<AnnotationContext> | [PointStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) -| radius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<AnnotationContext> | double -| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double -| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double -| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| xAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double -| xMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| xMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| xValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double -| yMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| z | [ZCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int +| adjustScaleRange | [AdjustScaleRangeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustScaleRangeCallback.html) | boolean +| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) +| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double +| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean +| drawTime | [DrawTimeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/DrawTimeCallback.html) | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) +| pointStyle | [PointStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PointStyleCallback.html)<AnnotationContext> | [PointStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/PointStyle.html) - [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) - [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) +| radius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<AnnotationContext> | double +| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double +| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double +| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| xAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double +| xMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| xMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| xValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double +| yMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| z | [ZCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int ## Polygon @@ -1432,17 +1432,17 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :- | :- | adjustScaleRange | boolean | `true` | [Yes](#polygon-scriptable-options) | If `true`, the scale range should be adjusted if this annotation is out of range. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#polygon-scriptable-options) | The fill color of the polygon.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). -| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#polygon-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). -| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT | [Yes](#polygon-scriptable-options) | Cap style of the border line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#polygon-scriptable-options) | The stroke color of the polygon. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#polygon-scriptable-options) | The fill color of the polygon.
See [default colors](../defaults/DefaultsCharts#commons-charts-options). +| backgroundShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#polygon-scriptable-options) | The color of shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderCapStyle | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) | CapStyle.BUTT | [Yes](#polygon-scriptable-options) | Cap style of the border line. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineCap). +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `Defaults.get().getGlobal()`
`.getColorAsString()` | [Yes](#polygon-scriptable-options) | The stroke color of the polygon. | borderDash | int[] | [] | [Yes](#polygon-scriptable-options) | The line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern. | borderDashOffset | int | 0 | [Yes](#polygon-scriptable-options) | Offset for border dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset) -| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | [Yes](#polygon-scriptable-options) | Border line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin) -| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#polygon-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). +| borderJoinStyle | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) | JoinStyle.MITER | [Yes](#polygon-scriptable-options) | Border line joint style. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineJoin) +| borderShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | [Yes](#polygon-scriptable-options) | The color of border shadows. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/shadowColor). | borderWidth | int | 1 | [Yes](#polygon-scriptable-options) | The stroke width of the polygon. | display | boolean | `true` | [Yes](#polygon-scriptable-options) | Whether or not this annotation is visible. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.
AFTER_DATASETS_DRAW | [Yes](#polygon-scriptable-options) | Defines when the annotation is drawn. This allows positioning of the annotation relative to the other elements of the graph. +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) | DrawTime.
AFTER_DATASETS_DRAW | [Yes](#polygon-scriptable-options) | Defines when the annotation is drawn. This allows positioning of the annotation relative to the other elements of the graph. | [init](#initial-animation) | boolean | false | - | If `true` or customized by [callback](#initial-animation), the annotation element will be animated since the initial phase. | radius | double | 10 | [Yes](#polygon-scriptable-options) | Size of the polygon in pixels. | rotation | double | 0 | [Yes](#polygon-scriptable-options) | The rotation of the polygon, in degrees. @@ -1453,12 +1453,12 @@ The complete options are described by following table: | xAdjust | double | 0 | [Yes](#polygon-scriptable-options) | Adjustment along x-axis (left-right) of polygon relative to computed position. Negative values move the polygon left, positive right. | xMax | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#polygon-scriptable-options) | X coordinate of end two of the box, whose center is used as the center of the polygon, in units along the x axis. | xMin | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#polygon-scriptable-options) | X coordinate of end one of the box, whose center is used as the center of the polygon, in units along the x axis. -| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the X scale to bind onto. +| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the X scale to bind onto. | xValue | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#polygon-scriptable-options) | X coordinate of the center of polygon in units along the x axis. | yAdjust | double | 0 | [Yes](#polygon-scriptable-options) | Adjustment along y-axis (top-bottom) of polygon relative to computed position. Negative values move the polygon up, positive down. | yMax | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#polygon-scriptable-options) | Y coordinate of end one of the box, whose center is used as the center of the polygon, in units along the y axis. | yMin | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#polygon-scriptable-options) | Y coordinate of end one of the box, whose center is used as the center of the polygon, in units along the y axis. -| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the Y scale to bind onto. +| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | - | The ID of the Y scale to bind onto. | yValue | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) | `null` | [Yes](#polygon-scriptable-options) | Y coordinate of the center of polygon in units along the y axis. | z | int | 0 | [Yes](#polygon-scriptable-options) | All visible elements will be drawn in ascending order of `z` option, with the same `drawTime` option. @@ -1492,39 +1492,39 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| adjustScaleRange | [AdjustScaleRangeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustScaleRangeCallback.html) | boolean -| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) -| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<AnnotationContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/CapStyle.html) -| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> -| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double -| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<AnnotationContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/JoinStyle.html) -| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html)> -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int -| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean -| drawTime | [DrawTimeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/DrawTimeCallback.html) | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/enums/DrawTime.html) -| radius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<AnnotationContext> | double -| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double -| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double -| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int -| sides | [SidesCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/SidesCallback.html) | int -| xAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double -| xMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| xMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| xValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double -| yMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| yValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) -| z | [ZCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int +| adjustScaleRange | [AdjustScaleRangeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustScaleRangeCallback.html) | boolean +| backgroundColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) +| backgroundShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderCapStyle | [CapStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CapStyleCallback.html)<AnnotationContext> | [CapStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/CapStyle.html) +| borderColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderDash | [BorderDashCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashCallback.html)<AnnotationContext> | List<Integer> +| borderDashOffset | [BorderDashOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/BorderDashOffsetCallback.html)<AnnotationContext> | double +| borderJoinStyle | [JoinStyleCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/JoinStyleCallback.html)<AnnotationContext> | [JoinStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/JoinStyle.html) +| borderShadowColor | [ColorsCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorsCallback.html)<AnnotationContext> | List<String> - List<[IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html)> +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<AnnotationContext> | int +| display | [SimpleDisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/SimpleDisplayCallback.html)<AnnotationContext> | boolean +| drawTime | [DrawTimeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/DrawTimeCallback.html) | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/enums/DrawTime.html) +| radius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<AnnotationContext> | double +| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<AnnotationContext> | double +| shadowBlur | [ShadowBlurCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowBlurCallback.html) | double +| shadowOffsetX | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| shadowOffsetY | [ShadowOffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ShadowOffsetCallback.html) | int +| sides | [SidesCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/SidesCallback.html) | int +| xAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double +| xMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| xMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| xValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yAdjust | [AdjustSizeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/AdjustSizeCallback.html) | double +| yMax | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yMin | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| yValue | [ValueCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ValueCallback.html) | String - double - [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) +| z | [ZCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/ZCallback.html) | int ## Events All annotations provide a set of callbacks which can be enabled to catch events on them. -To catch events is enough to set the events which you want to catch at [AnnotationOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AnnotationOptions.html) and set a callback instance in the annotation. +To catch events is enough to set the events which you want to catch at [AnnotationOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AnnotationOptions.html) and set a callback instance in the annotation. ```java // creates a plugin options @@ -1543,7 +1543,7 @@ box.setClickCallback(new ClickCallback(){ }); ``` -You can also catch events with listeners defined for all defined annotations with a single instance, defining it to [AnnotationOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AnnotationOptions.html). +You can also catch events with listeners defined for all defined annotations with a single instance, defining it to [AnnotationOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AnnotationOptions.html). ```java // creates a plugin options @@ -1563,9 +1563,9 @@ These are the table of callbacks to implement: | Event | Callback type | Description | :- | :- | :- -| enter | [EnterCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/listeners/EnterCallback.html) | Called when the mouse enters the annotation. -| leave | [LeaveCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/listeners/LeaveCallback.html) | Called when the mouse leaves the annotation. -| click | [ClickCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/listeners/ClickCallback.html) | Called when a click occurs on the annotation. +| enter | [EnterCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/listeners/EnterCallback.html) | Called when the mouse enters the annotation. +| leave | [LeaveCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/listeners/LeaveCallback.html) | Called when the mouse leaves the annotation. +| click | [ClickCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/listeners/ClickCallback.html) | Called when a click occurs on the annotation. :::info If the event callback returns `true`, the chart will re-render automatically after processing the event completely. This is important when there are the annotations that require re-draws (for instance, after a change of a rendering options). @@ -1603,12 +1603,12 @@ box.setAfterDraw(new ElementHookCallback(){ | Hook | Callback type | Description | ---- | ---- | ---- -| beforeDraw | [ElementHookCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/listeners/ElementHookCallback.html) | Called before that the annotation is being drawn. -| afterDraw | [ElementHookCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/listeners/ElementHookCallback.html) | Called after the annotation has been drawn. +| beforeDraw | [ElementHookCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/listeners/ElementHookCallback.html) | Called before that the annotation is being drawn. +| afterDraw | [ElementHookCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/listeners/ElementHookCallback.html) | Called after the annotation has been drawn. ## Scriptable context -Some options also accept a callback which is called at runtime and that takes the context as single argument, [AnnotationContext](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AnnotationContext.html) representing contextual information and chart instance. +Some options also accept a callback which is called at runtime and that takes the context as single argument, [AnnotationContext](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AnnotationContext.html) representing contextual information and chart instance. ```java // creates a plugin options @@ -1632,12 +1632,12 @@ The context object contains the following properties: | Name | Type | Description | :- | :- | :- -| annotation | [AbstractAnnotation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/AbstractAnnotation.html) | The annotation configuration where the options is defined as scriptable. -| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. -| chart | [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) | Chart instance. -| element | [AnnotationElement](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/elements/AnnotationElement.html) | The element instance related to the annotation. +| annotation | [AbstractAnnotation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/AbstractAnnotation.html) | The annotation configuration where the options is defined as scriptable. +| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. +| chart | [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) | Chart instance. +| element | [AnnotationElement](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/elements/AnnotationElement.html) | The element instance related to the annotation. | shared | Map<String, Object> | A map that can be used to share objects among all contexts for all annotation. -| type | [ContextType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be `ContextType.CHART` or `ContextType.ANNOTATION` +| type | [ContextType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be `ContextType.CHART` or `ContextType.ANNOTATION` #### Fonts and colors @@ -1647,7 +1647,7 @@ When the label to draw has multiple lines, you can use different font and color The `init` option is scriptable but it doesn't get the [annotation context](#scriptable-context) as argument but a specific context because the element has not been initialized yet, when the callback is invoked. -You can implement a [InitCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/annotation/callbacks/InitCallback.html) interface to enable your own initial animation of the annotation. +You can implement a [InitCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/annotation/callbacks/InitCallback.html) interface to enable your own initial animation of the annotation. ```java // creates a plugin options diff --git a/docs/extensions/DataLabels.md b/docs/extensions/DataLabels.md index b670c556..30e7b28f 100644 --- a/docs/extensions/DataLabels.md +++ b/docs/extensions/DataLabels.md @@ -18,7 +18,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; The data labels plugin is injected directly in the document. -The plugin ID is a constant everywhere available, `DataLabelsPlugin.ID`, in [DataLabelsPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/DataLabelsPlugin.html) entry point. +The plugin ID is a constant everywhere available, `DataLabelsPlugin.ID`, in [DataLabelsPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/DataLabelsPlugin.html) entry point. This plugin registers itself globally, meaning that once injected, all charts will display labels. In case you want it enabled only for a few charts, you can enable it as following: @@ -67,7 +67,7 @@ The plugin options can be changed at 3 different levels and are evaluated with t * per chart type by `Defaults.get().getOptions([chartType]).getPlugins().setOptions` method * or globally by `Defaults.get().getGlobal().getPlugins().setOptions` method -The configuration class [DataLabelsOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/DataLabelsOptions.html) contains all properties needed to configure the plugin. +The configuration class [DataLabelsOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/DataLabelsOptions.html) contains all properties needed to configure the plugin. ```java // creates a plugin options @@ -105,7 +105,7 @@ Defaults.get().getGlobal().getPlugin().setOptions(options); options.store(); ``` -If you need to read the plugin options, there is the specific factory, [DataLabelsOptionsFactory](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/DataLabelsOptionsFactory.html) as static reference inside the [DataLabels](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/DataLabels.html) entry point which can be used to retrieve the options from chart as following: +If you need to read the plugin options, there is the specific factory, [DataLabelsOptionsFactory](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/DataLabelsOptionsFactory.html) as static reference inside the [DataLabels](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/DataLabels.html) entry point which can be used to retrieve the options from chart as following: ```java // gets options reference @@ -128,29 +128,29 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | :- | :- | :- | :----- -| [align](DataLabels#alignment-and-offset) | double - [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/enums/Align.html) | Align.CENTER | [Yes](#scriptable) -| [anchor](DataLabels#anchoring) | [Anchor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/enums/Anchor.html) | Anchor.CENTER | [Yes](#scriptable) -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `null` | [Yes](#scriptable) -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | `null` | [Yes](#scriptable) +| [align](DataLabels#alignment-and-offset) | double - [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/enums/Align.html) | Align.CENTER | [Yes](#scriptable) +| [anchor](DataLabels#anchoring) | [Anchor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/enums/Anchor.html) | Anchor.CENTER | [Yes](#scriptable) +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `null` | [Yes](#scriptable) +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | `null` | [Yes](#scriptable) | borderRadius | double | 0 | [Yes](#scriptable) | borderWidth | int | 0 | [Yes](#scriptable) | [clamp](DataLabels#clamping) | boolean | `false` | [Yes](#scriptable) | [clip](DataLabels#clipping) | boolean | `false` | [Yes](#scriptable) -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [default color](../defaults/DefaultsCharts) | [Yes](#scriptable) -| [display](DataLabels#visibility) | [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) | Display.TRUE | [Yes](#scriptable) -| events | [IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)> | `Defaults.get().getGlobal()`
`.getEvents()` | The events option defines the browser events that the plugin should listen to. This overrides the options at chart level. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [default color](../defaults/DefaultsCharts) | [Yes](#scriptable) +| [display](DataLabels#visibility) | [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) | Display.TRUE | [Yes](#scriptable) +| events | [IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)> | `Defaults.get().getGlobal()`
`.getEvents()` | The events option defines the browser events that the plugin should listen to. This overrides the options at chart level. | [offset](DataLabels#alignment-and-offset) | int | 4 | [Yes](#scriptable) | opacity | double | 1 | [Yes](#scriptable) | [rotation](DataLabels#rotation) | double | 0 | [Yes](#scriptable) -| [textAlign](DataLabels#text-alignment) | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.START | [Yes](#scriptable) -| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | the `color` property | [Yes](#scriptable) +| [textAlign](DataLabels#text-alignment) | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) | TextAlign.START | [Yes](#scriptable) +| textStrokeColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | the `color` property | [Yes](#scriptable) | textStrokeWidth | int | 0 | [Yes](#scriptable) | textShadowBlur | double | 0 | [Yes](#scriptable) -| textShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | the `color` property | [Yes](#scriptable) +| textShadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | the `color` property | [Yes](#scriptable) ## Scriptable -All options also accept a callback which is called for each data and that takes the context as single argument, [DataLabelsContext](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/DataLabelsContext.html) representing contextual information and chart instance. +All options also accept a callback which is called for each data and that takes the context as single argument, [DataLabelsContext](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/DataLabelsContext.html) representing contextual information and chart instance. ```java // creates plugin options @@ -173,17 +173,17 @@ The context object contains the following properties: | Name | Type | Description | :- | :- | :- | active | boolean | Whether the associated element is hovered. -| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. -| chart | [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) | Chart instance. +| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. +| chart | [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) | Chart instance. | dataIndex | int | The index of the current data. -| element | [ChartElement](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ChartElement.html) | The element (point, arc, bar, etc.) for this data. +| element | [ChartElement](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ChartElement.html) | The element (point, arc, bar, etc.) for this data. | datasetIndex | int | The index of the current data set. -| datasetItem | [DatasetItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/DatasetItem.html) | The data set information for this data. -| label | [LabelItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/LabelItem.html) | The label configuration where the options is defined as scriptable. -| mode | [TransitionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/TransitionMode.html) | The update mode, brought by conte -| type | [ContextType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.DATALABELS`. +| datasetItem | [DatasetItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/DatasetItem.html) | The data set information for this data. +| label | [LabelItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/LabelItem.html) | The label configuration where the options is defined as scriptable. +| mode | [TransitionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/TransitionMode.html) | The update mode, brought by conte +| type | [ContextType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.DATALABELS`. -The colored properties (backgroundColor, borderColor, color, textStrokeColor and textShadowColor) can be set (by callbacks) also to a [pattern](../coloring/Patterns), [gradient](../coloring/Gradients), [CanvasPatternItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/CanvasPatternItem.html) or [CanvasGradientItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/CanvasGradientItem.html), as following: +The colored properties (backgroundColor, borderColor, color, textStrokeColor and textShadowColor) can be set (by callbacks) also to a [pattern](../coloring/Patterns), [gradient](../coloring/Gradients), [CanvasPatternItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/CanvasPatternItem.html) or [CanvasGradientItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/CanvasGradientItem.html), as following: ```java // creates plugin options @@ -202,7 +202,7 @@ options.setBackgroundColor(new ColorCallback(){ ``` :::info -The gradient coordinates are relative the label coordinates (local), not relative to the canvas coordinates (global), as reported in [this thread](https://github.com/chartjs/chartjs-plugin-datalabels/issues/114), therefore don't use **Charba** [gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) object but directly the [CanvasGradientItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/CanvasGradientItem.html) if you need to use gradients. +The gradient coordinates are relative the label coordinates (local), not relative to the canvas coordinates (global), as reported in [this thread](https://github.com/chartjs/chartjs-plugin-datalabels/issues/114), therefore don't use **Charba** [gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) object but directly the [CanvasGradientItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/CanvasGradientItem.html) if you need to use gradients. ::: See the example here how to use gradients in the meantime: @@ -255,26 +255,26 @@ The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| align | [AlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/callbacks/AlignCallback.html) | double - [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/enums/Align.html) -| anchor | [AnchorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/callbacks/AnchorCallback.html) | [Anchor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/enums/Anchor.html) -| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DataLabelsContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DataLabelsContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| borderRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DataLabelsContext> | double -| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DataLabelsContext> | int -| clamp | [ClampCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/callbacks/ClampCallback.html) | boolean -| clip | [ClipCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/callbacks/ClipCallback.html) | boolean -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DataLabelsContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/DisplayCallback.html)<DataLabelsContext> | [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<DataLabelsContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| offset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DataLabelsContext> | int -| opacity | [OpacityCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/callbacks/OpacityCallback.html) | double -| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PaddingCallback.html)<DataLabelsContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PaddingItem.html) -| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/RotationCallback.html)<DataLabelsContext> | double -| textAlign | [TextAlignCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/callbacks/TextAlignCallback.html)<DataLabelsContext> | [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) -| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DataLabelsContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/WidthCallback.html)<DataLabelsContext> | int -| textShadowBlur | [TextShadowBlurCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/callbacks/TextShadowBlurCallback.html) | double -| textShadowColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<DataLabelsContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) +| align | [AlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/callbacks/AlignCallback.html) | double - [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/enums/Align.html) +| anchor | [AnchorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/callbacks/AnchorCallback.html) | [Anchor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/enums/Anchor.html) +| backgroundColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DataLabelsContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| borderColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DataLabelsContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| borderRadius | [RadiusCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RadiusCallback.html)<DataLabelsContext> | double +| borderWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DataLabelsContext> | int +| clamp | [ClampCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/callbacks/ClampCallback.html) | boolean +| clip | [ClipCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/callbacks/ClipCallback.html) | boolean +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DataLabelsContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| display | [DisplayCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/DisplayCallback.html)<DataLabelsContext> | [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<DataLabelsContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| offset | [OffsetCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/OffsetCallback.html)<DataLabelsContext> | int +| opacity | [OpacityCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/callbacks/OpacityCallback.html) | double +| padding | [PaddingCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PaddingCallback.html)<DataLabelsContext> | [PaddingItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PaddingItem.html) +| rotation | [RotationCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/RotationCallback.html)<DataLabelsContext> | double +| textAlign | [TextAlignCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/callbacks/TextAlignCallback.html)<DataLabelsContext> | [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) +| textStrokeColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DataLabelsContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| textStrokeWidth | [WidthCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/WidthCallback.html)<DataLabelsContext> | int +| textShadowBlur | [TextShadowBlurCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/callbacks/TextShadowBlurCallback.html) | double +| textShadowColor | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<DataLabelsContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) ## Font @@ -294,11 +294,11 @@ The complete options are described by following table: |:- |:- |:- |:- | fontFamily | String | [default font family](../defaults/DefaultsCharts#font) | The font family of label. | fontSize | int | [default font size](../defaults/DefaultsCharts#font) | The font size of label. -| fontStyle | [FontStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/FontStyle.html) | [default font style](../defaults/DefaultsCharts#font) | The font style of label. -| weight | [Weight](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/enums/Weight.html) | [default font weight](../defaults/DefaultsCharts#font) | Font weight (boldness) for text. +| fontStyle | [FontStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/FontStyle.html) | [default font style](../defaults/DefaultsCharts#font) | The font style of label. +| weight | [Weight](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/enums/Weight.html) | [default font weight](../defaults/DefaultsCharts#font) | Font weight (boldness) for text. | [lineHeight](#multiple-lines-of-labels-text) | double - String | 1.2 | Height of an individual line of text. -The font element can be set as [scriptable option](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html), providing a [font item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) instance, as following: +The font element can be set as [scriptable option](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html), providing a [font item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) instance, as following: ```java // creates plugin options @@ -335,7 +335,7 @@ The complete options are described by following table: | bottom | int | 4 | left | int | 4 -The padding element can be set as [scriptable option](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/PaddingCallback.html), providing a [padding item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/PaddingItem.html) instance, as following: +The padding element can be set as [scriptable option](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/PaddingCallback.html), providing a [padding item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/PaddingItem.html) instance, as following: ```java // creates plugin options @@ -387,9 +387,9 @@ Options defined under each labels, always overrides options defined at the chart ## Anchoring -An anchor point is defined by an orientation vector and a position on the data element. The orientation depends on the scale type (vertical, horizontal or radial). The position is calculated based on the [Anchor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/enums/Anchor.html) option and the orientation vector. +An anchor point is defined by an orientation vector and a position on the data element. The orientation depends on the scale type (vertical, horizontal or radial). The position is calculated based on the [Anchor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/enums/Anchor.html) option and the orientation vector. -Supported values for [Anchor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/enums/Anchor.html): +Supported values for [Anchor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/enums/Anchor.html): - `CENTER` (default): element center - `START`: lowest element boundary - `END`: highest element boundary @@ -406,7 +406,7 @@ If the element is fully hidden (i.e. entirely outside the chart area), anchor po ## Alignment and Offset -The [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/enums/Align.html) option defines the position of the label relative to the anchor point position and orientation. Its value can be expressed either by a number representing the clockwise angle (in degree) or by one of the following string presets: +The [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/enums/Align.html) option defines the position of the label relative to the anchor point position and orientation. Its value can be expressed either by a number representing the clockwise angle (in degree) or by one of the following string presets: - `CENTER` (default): the label is centered on the anchor point - `START`: the label is positioned before the anchor point, following the same direction @@ -416,7 +416,7 @@ The [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client - `LEFT`: the label is positioned to the left of the anchor point (180) - `TOP`: the label is positioned to the top of the anchor point (270) -The `offset` represents the distance (in pixels) to pull the label *away* from the anchor point. This option is **not applicable** when [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/enums/Align.html) is `CENTER'`. Also note that if [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/enums/Align.html) is `START`, the label is moved in the opposite direction. The default value is `4`. +The `offset` represents the distance (in pixels) to pull the label *away* from the anchor point. This option is **not applicable** when [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/enums/Align.html) is `CENTER'`. Also note that if [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/enums/Align.html) is `START`, the label is moved in the opposite direction. The default value is `4`. @@ -426,7 +426,7 @@ This option controls the clockwise rotation angle (in degrees) of the label, the ## Visibility -The [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) option controls the visibility of labels and accepts the following values: +The [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) option controls the visibility of labels and accepts the following values: - `TRUE` (default): the label is drawn - `FALSE`: the label is hidden @@ -434,7 +434,7 @@ The [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/clie ## Overlap -The [Display](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Display.html) is the option can be used to prevent overlapping labels, based on the following rules when two labels overlap: +The [Display](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Display.html) is the option can be used to prevent overlapping labels, based on the following rules when two labels overlap: - if both labels are `TRUE`, they will be drawn overlapping - if both labels are `AUTO`, the one with the highest data index will be hidden. If labels are at the same data index, the one with the lowest dataset index will be hidden @@ -471,12 +471,12 @@ option.setFormatter(new FormatterCallback(){ }); ``` -The [DataItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/DataItem.html) argument is a wrapper to the possible values that a dataset can contain: +The [DataItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/DataItem.html) argument is a wrapper to the possible values that a dataset can contain: * doubles. * strings. - * [FloatingData](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/FloatingData.html), available only for [BAR](../charts/ChartBar#floating-bars) dataset instances. - * [DataPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/data/DataPoint.html). + * [FloatingData](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/FloatingData.html), available only for [BAR](../charts/ChartBar#floating-bars) dataset instances. + * [DataPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/data/DataPoint.html). ### Multiple lines of labels text @@ -503,9 +503,9 @@ The space between each line can be adjusted using the font `lineHeight` option. ## Text Alignment -The [textAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html) option only applies to multiple line labels and specifies the text alignment being used when drawing the label text. Note that right-to-left text detection based on the current locale is not currently implemented. +The [textAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html) option only applies to multiple line labels and specifies the text alignment being used when drawing the label text. Note that right-to-left text detection based on the current locale is not currently implemented. -Supported values for [TextAlign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/TextAlign.html): +Supported values for [TextAlign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/TextAlign.html): - `START` (default): the text is left-aligned - `CENTER`: the text is centered @@ -542,9 +542,9 @@ option.getListeners().setLeaveEventHandler(new LeaveEventHandler(){ }); ``` -The [listeners element](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/Listeners.html) allows to register callbacks to be notified when an event is detected on a specific label. This option is an object where the property is the type of the event to listen and the value is a callback with the [context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/DataLabelsContext.html) and [event](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/ChartEventContext.html) arguments. +The [listeners element](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/Listeners.html) allows to register callbacks to be notified when an event is detected on a specific label. This option is an object where the property is the type of the event to listen and the value is a callback with the [context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/DataLabelsContext.html) and [event](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/ChartEventContext.html) arguments. -The [context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/DataLabelsContext.html) contains the same information as for other callbacks, can be modified (e.g. add new options, by `context.setOptions` method) and thus, if the callback explicitly returns `true`, the label is updated with the new context and the chart re-rendered. This allows to implement visual interactions with labels such as highlight, selection, etc. +The [context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/DataLabelsContext.html) contains the same information as for other callbacks, can be modified (e.g. add new options, by `context.setOptions` method) and thus, if the callback explicitly returns `true`, the label is updated with the new context and the chart re-rendered. This allows to implement visual interactions with labels such as highlight, selection, etc. Listeners can be registered for any label at chart level or for labels of a specific dataset. @@ -556,13 +556,13 @@ This plugin currently supports the following label events and interface to be im | **Name** | **Charba events** | **Description** | :- | :- | :- -| enter | `mousemove` | the mouse is moved over a label. See [EnterEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/events/EnterEventHandler.html) -| leave | `mousemove` | the mouse is moved out of a label. See [LeaveEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/events/LeaveEventHandler.html) -| click | `click` | the mouse's primary button is pressed and released on a label. See [ClickEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/events/ClickEventHandler.html) +| enter | `mousemove` | the mouse is moved over a label. See [EnterEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/events/EnterEventHandler.html) +| leave | `mousemove` | the mouse is moved out of a label. See [LeaveEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/events/LeaveEventHandler.html) +| click | `click` | the mouse's primary button is pressed and released on a label. See [ClickEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/events/ClickEventHandler.html) **Charba** event that need to be enabled in order to get the associated label event working. -**Charba** provides an abstract handler implementation with all interfaces ([AbstractEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/datalabels/events/AbstractEventHandler.html)) which can be extended, only with needed methods, and add easily as following: +**Charba** provides an abstract handler implementation with all interfaces ([AbstractEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/datalabels/events/AbstractEventHandler.html)) which can be extended, only with needed methods, and add easily as following: ```java // creates plugin options @@ -619,7 +619,7 @@ DataLabelsPointerHandler handler = new DataLabelsPointerHandler(); options.setListenersHandler(handler); ``` -The handler can be customized at constructor level, setting which [cursor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/CursorType.html) must be used hovering the labels, as following: +The handler can be customized at constructor level, setting which [cursor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/CursorType.html) must be used hovering the labels, as following: ```java // creates the handler instance @@ -632,7 +632,7 @@ DataLabelsPointerHandler handler = new DataLabelsPointerHandler(CursorType.CROSS ### Selection handler -**Charba** provides a common listener handler for [listener](#listeners-element) to invoke data set selection handlers if there were defined. The handler accepts [DatasetSelectionEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/DatasetSelectionEventHandler.html) instances in order to notify which data set has been selected clicking on the label. +**Charba** provides a common listener handler for [listener](#listeners-element) to invoke data set selection handlers if there were defined. The handler accepts [DatasetSelectionEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/DatasetSelectionEventHandler.html) instances in order to notify which data set has been selected clicking on the label. To apply a callback, you can set an instance to the plugin options, as following: @@ -661,7 +661,7 @@ options.setListenersHandler(handler); Against to the [data set selection event handler](../configuration/Interaction#selecting-a-dataset), at chart level, this invocation is synchronous. -The handler can be customized at constructor level, setting which [cursor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/CursorType.html) must be used hovering the labels, as following: +The handler can be customized at constructor level, setting which [cursor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/CursorType.html) must be used hovering the labels, as following: ```java // creates the handler instance diff --git a/docs/extensions/Gradient.md b/docs/extensions/Gradient.md index 0bf4c4cb..2598aaf5 100644 --- a/docs/extensions/Gradient.md +++ b/docs/extensions/Gradient.md @@ -16,7 +16,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; The gradient plugin is injected directly in the document. -The plugin ID is a constant everywhere available, `GradientPlugin.ID`, in [GradientPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gradient/GradientPlugin.html) entry point. +The plugin ID is a constant everywhere available, `GradientPlugin.ID`, in [GradientPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gradient/GradientPlugin.html) entry point. This plugin registers itself globally, meaning that once injected, all charts will enable zooming. In case you want it enabled only for a few charts, you can enable it as following: @@ -65,20 +65,20 @@ dataset.setOptions(options); The plugin options can be changed at only at dataset level by `dataset.setOptions` method. -The configuration class [GradientOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gradient/GradientOptions.html) contains all properties needed to configure the plugin. +The configuration class [GradientOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gradient/GradientOptions.html) contains all properties needed to configure the plugin. The complete options are described by following table: | Name | Type | Description | :- | :- | :----- -| backgroundColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as background color of the dataset. -| borderColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as border color of the dataset. -| hoverBackgroundColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as background color of the dataset, when hovered. -| hoverBorderColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as border color of the dataset, when hovered. -| pointBackgroundColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as background color of the points of the dataset. -| pointBorderColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as border color of the points of the dataset. -| pointHoverBackgroundColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as background color of the points of the dataset, when hovered. -| pointHoverBorderColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as border color of the points of the dataset, when hovered +| backgroundColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as background color of the dataset. +| borderColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as border color of the dataset. +| hoverBackgroundColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as background color of the dataset, when hovered. +| hoverBorderColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as border color of the dataset, when hovered. +| pointBackgroundColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as background color of the points of the dataset. +| pointBorderColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as border color of the points of the dataset. +| pointHoverBackgroundColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as background color of the points of the dataset, when hovered. +| pointHoverBorderColor | [PropertyOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gradient/PropertyOptions.html) | Sets the gradient as border color of the points of the dataset, when hovered ## Property options @@ -97,8 +97,8 @@ The complete options are described by following table: | Name | Type | Description | :- | :- | :- -| axis | [AxisKind](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/AxisKind.html) | The axis to use for applying the gradient to the dataset. -| colors | [Colors](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gradient/Colors.html) | Sets the colors to composed the gradient +| axis | [AxisKind](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/AxisKind.html) | The axis to use for applying the gradient to the dataset. +| colors | [Colors](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gradient/Colors.html) | Sets the colors to composed the gradient diff --git a/docs/extensions/Labels.md b/docs/extensions/Labels.md index 80d048b3..3da2b3fd 100644 --- a/docs/extensions/Labels.md +++ b/docs/extensions/Labels.md @@ -23,7 +23,7 @@ The plugin has been heavily changed in order to be compliant with [Chart.JS](htt The labels plugin is injected directly in the document. -The plugin ID is a constant everywhere available, `LabelsPlugin.ID`, in [LabelsPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/LabelsPlugin.html) entry point. +The plugin ID is a constant everywhere available, `LabelsPlugin.ID`, in [LabelsPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/LabelsPlugin.html) entry point. This plugin registers itself globally, meaning that once injected, all charts will display labels. In case you want it enabled only for a few charts, you can enable it as following: @@ -72,11 +72,11 @@ The plugin options can be changed at 2 different levels and are evaluated with t * per chart by `chart.getOptions().getPlugins().setOptions` method * or globally by `Defaults.get().getGlobal().getPlugins().setOptions` method -The configuration [LabelsOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/LabelsOptions.html) class is the entry point of plugin configuration. +The configuration [LabelsOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/LabelsOptions.html) class is the entry point of plugin configuration. -Every [label](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/Label.html) configuration can be add to the [LabelsOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/LabelsOptions.html), assigning a unique id. +Every [label](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/Label.html) configuration can be add to the [LabelsOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/LabelsOptions.html), assigning a unique id. -The id of a label configuration can be set by a string or by a specific class, [LabelId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/LabelId.html). +The id of a label configuration can be set by a string or by a specific class, [LabelId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/LabelId.html). ```java // ------------------------ @@ -148,7 +148,7 @@ Defaults.get().getGlobal().getPlugin().setOptions(options); options.store(); ``` -If you need to read the plugin options, there is the specific factory, [LabelsOptionsFactory](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/LabelsOptionsFactory.html) as static reference inside the [LabelsPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/LabelsPlugin.html) entry point which can be used to retrieve the options from chart as following: +If you need to read the plugin options, there is the specific factory, [LabelsOptionsFactory](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/LabelsOptionsFactory.html) as static reference inside the [LabelsPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/LabelsPlugin.html) entry point which can be used to retrieve the options from chart as following: ```java // gets options reference @@ -184,7 +184,7 @@ Label label2 = options.getLabel("myLabel2"); ## Options -The following options can configure how the labels will look like and they can be applied to the [label](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/Label.html) object. +The following options can configure how the labels will look like and they can be applied to the [label](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/Label.html) object. ```java // creates a plugin options @@ -202,18 +202,18 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | Description | :- | :- | :- | :----- | :- | arc | boolean | `false` | - | If `true`, draws label in arc. Bar chart ignores this. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | [default color](../defaults/DefaultsCharts) | [Yes](#color) | The font color of the label. -| font | [Font](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/Font.html) | [default font](../defaults/DefaultsCharts#font) | [Yes](#font) | The font of label text. -| images | [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)[] | `null` | - | Set images when the rendering is set to Render.IMAGE. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | [default color](../defaults/DefaultsCharts) | [Yes](#color) | The font color of the label. +| font | [Font](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/Font.html) | [default font](../defaults/DefaultsCharts#font) | [Yes](#font) | The font of label text. +| images | [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)[] | `null` | - | Set images when the rendering is set to Render.IMAGE. | outsidePadding | int | 2 | - | Add padding when the position is Position.OUTSIDE. | overlap | boolean | `true` | - | Draw label even it's overlap. Bar chart ignores this. -| position | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/enums/Position.html) | Position.DEFAULT | - | Position to draw label. Bar chart ignores this. +| position | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/enums/Position.html) | Position.DEFAULT | - | Position to draw label. Bar chart ignores this. | precision | int | 0 | - | Precision for percentage label text. -| render | [Render](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/enums/Render.html) | Render.PERCENTAGE | [Yes](#render) | The value of the label to render. +| render | [Render](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/enums/Render.html) | Render.PERCENTAGE | [Yes](#render) | The value of the label to render. | shadowBlur | int | 6 | - | The label text shadow intensity. | shadowOffsetX | int | 3 | - | The label text shadow X offset. | shadowOffsetY | int | 3 | - | The label text shadow Y offset. -| shadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgba(0,0,0,0.3) -          | - | The label text shadow color. +| shadowColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgba(0,0,0,0.3) -          | - | The label text shadow color. | showActualPercentages | boolean | `false` | - | Show the real calculated percentages from the values and don't apply the additional logic to fit the percentages to 100 in total. | showZero | boolean | `false` | - | Identifies whether or not labels of value 0 are displayed | textMargin | int | 2 | - | The added margin of text when the position is Position.OUTSIDE or Position.BORDER. @@ -229,33 +229,33 @@ There are 3 options which can be defined as scriptable: * `font`, to set the font of the label. * `render`, to set the value of the label to render. -The callbacks are getting the only 1 argument, the [plugin context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/LabelsContext.html) which contains the context of the callback execution. +The callbacks are getting the only 1 argument, the [plugin context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/LabelsContext.html) which contains the context of the callback execution. The context object contains the following properties: | Name | Type | Description | :- | :- | :- | active | boolean | Whether the associated element is hovered. -| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. -| chart | [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) | Chart instance. +| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. +| chart | [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) | Chart instance. | dataIndex | int | The index of the current data. -| dataItem | [DataItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/DataItem.html) | The value of the label. +| dataItem | [DataItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/DataItem.html) | The value of the label. | datasetIndex | int | The index of the current data set. -| datasetItem | [DatasetItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/DatasetItem.html) | The data set information for this data -| element | [ChartElement](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ChartElement.html) | The element (point, arc, bar, etc.) for this data +| datasetItem | [DatasetItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/DatasetItem.html) | The data set information for this data +| element | [ChartElement](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ChartElement.html) | The element (point, arc, bar, etc.) for this data | label | String | The string representation of the value of the label. -| labelOptions | [Label](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/Label.html) | The label configuration where the options is defined as scriptable. -| mode | [TransitionMode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/TransitionMode.html) | The update mode, brought by conte +| labelOptions | [Label](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/Label.html) | The label configuration where the options is defined as scriptable. +| mode | [TransitionMode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/TransitionMode.html) | The update mode, brought by conte | percentage | double | The percentage representation of the value of the label. -| type | [ContextType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.LABELS`. +| type | [ContextType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.LABELS`. The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/ColorCallback.html)<AnnotationContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) -| font | [FontCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html)<AnnotationContext> | [FontItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) -| render | [RenderCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/callbacks/RenderCallback.html) | String +| color | [ColorCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/ColorCallback.html)<AnnotationContext> | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) +| font | [FontCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html)<AnnotationContext> | [FontItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) +| render | [RenderCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/callbacks/RenderCallback.html) | String ### Color @@ -263,7 +263,7 @@ You can set the color of the labels at runtime, providing different colors for d -The color property can be set as [scriptable option](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/callbacks/ColorCallback.html), as following: +The color property can be set as [scriptable option](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/callbacks/ColorCallback.html), as following: ```java // creates a plugin options @@ -296,7 +296,7 @@ You can set the font of the labels at runtime, providing different font for diff -The font property can be set as [scriptable option](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/FontCallback.html), providing a [font item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/FontItem.html) instance, as following: +The font property can be set as [scriptable option](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/FontCallback.html), providing a [font item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/FontItem.html) instance, as following: ```java // creates a plugin options @@ -330,7 +330,7 @@ You can set the value of the labels to show on the chart at runtime, providing d -The render property can be set as [scriptable option](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/labels/callbacks/RenderCallback.html), as following: +The render property can be set as [scriptable option](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/labels/callbacks/RenderCallback.html), as following: ```java // creates a plugin options diff --git a/docs/extensions/Zoom.md b/docs/extensions/Zoom.md index 7f6bd957..f358d5a0 100644 --- a/docs/extensions/Zoom.md +++ b/docs/extensions/Zoom.md @@ -23,7 +23,7 @@ The plugin is providing 2 main actions to apply on a chart: The zoom plugin is injected directly in the document. -The plugin ID is a constant everywhere available, `ZoomPlugin.ID`, in [ZoomPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ZoomPlugin.html) entry point. +The plugin ID is a constant everywhere available, `ZoomPlugin.ID`, in [ZoomPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ZoomPlugin.html) entry point. This plugin registers itself globally, meaning that once injected, all charts will enable zooming. In case you want it enabled only for a few charts, you can enable it as following: @@ -80,7 +80,7 @@ The plugin options can be changed at 2 different levels and are evaluated with t * per chart type by `Defaults.get().getOptions([chartType]).getPlugins().setOptions` method * or globally by `Defaults.get().getGlobal().getPlugins().setOptions` method -The configuration class [ZoomOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ZoomOptions.html) contains all properties needed to configure the plugin. +The configuration class [ZoomOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ZoomOptions.html) contains all properties needed to configure the plugin. You can also change the default for all charts instances, as following: @@ -105,7 +105,7 @@ Defaults.get().getGlobal().getPlugin().setOptions(options); options.store(); ``` -If you need to read the plugin options, there is the specific factory, [ZoomOptionsFactory](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ZoomOptionsFactory.html) as static reference inside the [ZoomPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ZoomPlugin.html) entry point which can be used to retrieve the options from chart as following: +If you need to read the plugin options, there is the specific factory, [ZoomOptionsFactory](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ZoomOptionsFactory.html) as static reference inside the [ZoomPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ZoomPlugin.html) entry point which can be used to retrieve the options from chart as following: ```java // gets options reference @@ -126,7 +126,7 @@ The complete options are described by following table: | Name | Type | Default | Scriptable | :- | :- | :- | :----- -| events | [IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsEvent.html)> | `Defaults.get().getGlobal()`
`.getEvents()` | The events option defines the browser events that the plugin should listen to. This overrides the options at chart level. +| events | [IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)[] - Set<[IsEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsEvent.html)> | `Defaults.get().getGlobal()`
`.getEvents()` | The events option defines the browser events that the plugin should listen to. This overrides the options at chart level. ## Pan @@ -148,17 +148,17 @@ The complete options are described by following table: | Name | Type | Default | Description | :- | :- | :- | :- | enabled | boolean | `false` | If `true` the panning is enabled. -| modifierKey | [ModifierKey](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ModifierKey.html) | `null` | Keyboard modifier key which must be pressed to enable panning, otherwise the rejected callback will be triggered. -| mode | [Mode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/enums/Mode.html) | Mode.XY | Panning directions. Remove the appropriate direction to disable. For instance, Mode.Y would only allow panning in the y direction. -| overScaleMode | [Mode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/enums/Mode.html) | Mode.XY | Enable panning over a scale for that axis (but only if mode is also enabled), and disables panning along that axis otherwise. -| scaleMode | [Mode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/enums/Mode.html) | Mode.XY | Enable panning over a scale for that axis (regardless of mode). +| modifierKey | [ModifierKey](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ModifierKey.html) | `null` | Keyboard modifier key which must be pressed to enable panning, otherwise the rejected callback will be triggered. +| mode | [Mode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/enums/Mode.html) | Mode.XY | Panning directions. Remove the appropriate direction to disable. For instance, Mode.Y would only allow panning in the y direction. +| overScaleMode | [Mode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/enums/Mode.html) | Mode.XY | Enable panning over a scale for that axis (but only if mode is also enabled), and disables panning along that axis otherwise. +| scaleMode | [Mode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/enums/Mode.html) | Mode.XY | Enable panning over a scale for that axis (regardless of mode). | threshold | double | 10 | The minimal pan distance required before actually applying pan. ## Zoom The zooming refers to a way to maintain focus when the chart size changes. -The [zoom options](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/Zoom.html) has got a inner elements in order to configure: +The [zoom options](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/Zoom.html) has got a inner elements in order to configure: * [Wheel](#wheel) element to set the mouse wheel behavior * [Drag](#drag) element to set the drag-to-zoom behavior @@ -179,13 +179,13 @@ The complete common options to all inner elements are described by following tab | Name | Type | Default | Description | :- | :- | :- | :- -| mode | [Mode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/enums/Mode.html) | Mode.XY | Zooming directions. Remove the appropriate direction to disable. For instance, Mode.Y would only allow zooming in the y direction. -| overScaleMode | [Mode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/enums/Mode.html) | Mode.XY | Enable panning over a scale for that axis (but only if mode is also enabled), and disables panning along that axis otherwise. -| scaleMode | [Mode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/enums/Mode.html) | Mode.XY | Enable panning over a scale for that axis (regardless of mode). +| mode | [Mode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/enums/Mode.html) | Mode.XY | Zooming directions. Remove the appropriate direction to disable. For instance, Mode.Y would only allow zooming in the y direction. +| overScaleMode | [Mode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/enums/Mode.html) | Mode.XY | Enable panning over a scale for that axis (but only if mode is also enabled), and disables panning along that axis otherwise. +| scaleMode | [Mode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/enums/Mode.html) | Mode.XY | Enable panning over a scale for that axis (regardless of mode). ### Wheel -The [wheel](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/Wheel.html) options refers to a way to set the mouse wheel behavior. +The [wheel](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/Wheel.html) options refers to a way to set the mouse wheel behavior. ```java // creates a plugin options @@ -202,13 +202,13 @@ The complete options are described by following table: | :- | :- | :- | :- | enabled | boolean | `false` | If `true` the wheel zooming is enabled. | speed | double | 0.1 | The speed of element via mouse wheel (percentage of element on a wheel event). Must be a value between 0 and 1. -| modifierKey | [ModifierKey](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ModifierKey.html) | `null` | Keyboard modifier key which must be pressed to enable zooming, otherwise the rejected callback will be triggered. +| modifierKey | [ModifierKey](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ModifierKey.html) | `null` | Keyboard modifier key which must be pressed to enable zooming, otherwise the rejected callback will be triggered. ### Drag The Drag-to-zoom effect can be customized. -The [drag](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/Drag.html) object provides the methods to customized the area to zoom. +The [drag](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/Drag.html) object provides the methods to customized the area to zoom. ```java // creates a plugin options @@ -224,16 +224,16 @@ The complete options are described by following table: | Name | Type | Default | Description | :- | :- | :- | :- | enabled | boolean | `false` | If `true` the drag zooming is enabled. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgba(225,225,225,0.3) -          | The fill color of drag area. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgb(225,225,225) -          | The stroke color of drag area. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgba(225,225,225,0.3) -          | The fill color of drag area. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgb(225,225,225) -          | The stroke color of drag area. | borderWidth | int | 0 | The stroke width of drag area. -| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/enums/DrawTime.html) | DrawTime.
BEFORE_DATASETS_DRAW | Defines when the rectangle is drawn. -| modifierKey | [ModifierKey](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ModifierKey.html) | `null` | Keyboard modifier key which must be pressed to enable drag-to-zoom. +| drawTime | [DrawTime](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/enums/DrawTime.html) | DrawTime.
BEFORE_DATASETS_DRAW | Defines when the rectangle is drawn. +| modifierKey | [ModifierKey](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ModifierKey.html) | `null` | Keyboard modifier key which must be pressed to enable drag-to-zoom. | threshold | double | 0 | The minimal zoom distance required before actually applying drag-to-zoom. ### Pinch -The [pinch](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/Pinch.html) options refers to a way to enable the behavior of a finger gesture used with a touch screen interface that supports multi-touch. +The [pinch](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/Pinch.html) options refers to a way to enable the behavior of a finger gesture used with a touch screen interface that supports multi-touch. ```java // creates a plugin options @@ -267,12 +267,12 @@ The complete options are described by following table: | Name | Type | Description | :- | :- | :- -| [x](#scale-limit) | [ScaleLimit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ScaleLimit.html) | Sets the minimum and maximum value for X scale. -| [y](#scale-limit) | [ScaleLimit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ScaleLimit.html) | Sets the minimum and maximum value for Y scale. +| [x](#scale-limit) | [ScaleLimit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ScaleLimit.html) | Sets the minimum and maximum value for X scale. +| [y](#scale-limit) | [ScaleLimit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ScaleLimit.html) | Sets the minimum and maximum value for Y scale. ### Scale limit -The [scale limit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ScaleLimit.html) object can set he minimum and maximum values to apply to scales in order to manage pan and zoom inside those boundaries. +The [scale limit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ScaleLimit.html) object can set he minimum and maximum values to apply to scales in order to manage pan and zoom inside those boundaries. The complete options are described by following table: @@ -286,7 +286,7 @@ The complete options are described by following table: ## Scriptable -Scriptable options in the plugin configuration accept a callback which is called during plugin configuration phase. The callbacks are getting the only 1 argument, the [plugin context](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ZoomContext.html) which contains the context of the callback execution. +Scriptable options in the plugin configuration accept a callback which is called during plugin configuration phase. The callbacks are getting the only 1 argument, the [plugin context](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ZoomContext.html) which contains the context of the callback execution. ```java // creates a plugin options @@ -309,23 +309,23 @@ The context object contains the following properties: | Name | Type | Description | :- | :- | :- -| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. -| chart | [IsChart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/IsChart.html) | Chart instance. -| element | [AbstractConfigurationItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/AbstractConfigurationItem.html) | The pan or zoom configuration where the options is defined as scriptable. -| point | [EventPoint](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/EventPoint.html) | The point passed by the native plugin during some events handling. -| type | [ContextType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.ZOOM`. +| attributes | [NativeObjectContainer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/commons/NativeObjectContainer.html) | User object which you can store your options at runtime. +| chart | [IsChart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/IsChart.html) | Chart instance. +| element | [AbstractConfigurationItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/AbstractConfigurationItem.html) | The pan or zoom configuration where the options is defined as scriptable. +| point | [EventPoint](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/EventPoint.html) | The point passed by the native plugin during some events handling. +| type | [ContextType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ContextType.html) | The type of the context. It can be ONLY `ContextType.ZOOM`. The following options can be set by a callback: | Name | Callback | Returned types | :- | :- | :- -| mode | [ModeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/callbacks/ModeCallback.html) | [Mode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/enums/Mode.html) -| overScaleMode | [ModeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/callbacks/ModeCallback.html) | [Mode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/enums/Mode.html) -| scaleMode | [ModeCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/callbacks/ModeCallback.html) | [Mode](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/enums/Mode.html) +| mode | [ModeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/callbacks/ModeCallback.html) | [Mode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/enums/Mode.html) +| overScaleMode | [ModeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/callbacks/ModeCallback.html) | [Mode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/enums/Mode.html) +| scaleMode | [ModeCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/callbacks/ModeCallback.html) | [Mode](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/enums/Mode.html) ### Starting event -The pan and zoom element can catch events during pan and zoom starting which can be consumed by [callback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/callbacks/StartCallback.html), as following: +The pan and zoom element can catch events during pan and zoom starting which can be consumed by [callback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/callbacks/StartCallback.html), as following: ```java // creates a plugin options @@ -349,7 +349,7 @@ options.getPan().setStartCallback(new StartCallback(){ ### Progressing event -The pan and zoom element can catch events during pan and zoom which can be consumed by [callback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/callbacks/ProgressCallback.html), as following: +The pan and zoom element can catch events during pan and zoom which can be consumed by [callback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/callbacks/ProgressCallback.html), as following: ```java // creates a plugin options @@ -371,7 +371,7 @@ options.getPan().setProgressCallback(new ProgressCallback(){ ### Completed event -The pan and zoom element can catch event when pan and zoom are completed which can be consumed by [callback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/callbacks/CompletedCallback.html), as following: +The pan and zoom element can catch event when pan and zoom are completed which can be consumed by [callback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/callbacks/CompletedCallback.html), as following: ```java // creates a plugin options @@ -393,7 +393,7 @@ options.getPan().setCompletedCallback(new CompletedCallback(){ ### Rejected event -The pan and zoom element can catch event when pan and zoom are invoked but it is not enabled due to the [modifier key](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ModifierKey.html) is not pressed and can be consumed by [callback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/callbacks/RejectedCallback.html), as following: +The pan and zoom element can catch event when pan and zoom are invoked but it is not enabled due to the [modifier key](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ModifierKey.html) is not pressed and can be consumed by [callback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/callbacks/RejectedCallback.html), as following: ```java // creates a plugin options @@ -419,7 +419,7 @@ The plugin provides a set of API in order to pan, zoom and reset programmaticall ### Resetting -You can programmatically reset the zoom and pan to the default state by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: +You can programmatically reset the zoom and pan to the default state by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: ```java // resets zoom and pan on chart instance @@ -432,7 +432,7 @@ ZoomPlugin.reset(chart, DefaultTransitionMode.DEFAULT); ### Current level -You can programmatically get the current level of zoom (the default state level is equal to 1) by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: +You can programmatically get the current level of zoom (the default state level is equal to 1) by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: ```java // gets level of zoom @@ -445,7 +445,7 @@ if (level == 1D) { ### Zooming -You can programmatically zoom on a chart instance by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: +You can programmatically zoom on a chart instance by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: ```java // zoom on chart with 110% on both directions @@ -458,7 +458,7 @@ ZoomPlugin.zoom(chart, 0.9); ZoomPlugin.zoom(chart, 0.9, DefaultTransitionMode.DEFAULT); ``` -You can also zoom horizontally or vertically, specifying the percentage of zoom on a specific direction, by [Amount](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/Amount.html) class, as following: +You can also zoom horizontally or vertically, specifying the percentage of zoom on a specific direction, by [Amount](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/Amount.html) class, as following: ```java // zoom on chart with 110% on X direction @@ -475,7 +475,7 @@ ZoomPlugin.zoom(chart, amount, DefaultTransitionMode.DEFAULT); ### Zooming on scale -You can programmatically zoom on a scale instance of the chart by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: +You can programmatically zoom on a scale instance of the chart by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: ```java // creates a scale range to set minimum @@ -495,7 +495,7 @@ ZoomPlugin.zoomScale(chart, DefaultScaleId.X, new ScaleRange(-100, 0), DefaultTr ### Zooming by a rectangle -You can programmatically zoom, by a rectangle, on a instance of the chart by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: +You can programmatically zoom, by a rectangle, on a instance of the chart by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: ```java // creates top-left point @@ -516,7 +516,7 @@ ZoomPlugin.zoomRect(chart, topLeft, bottomRight, DefaultTransitionMode.DEFAULT); ### Panning -You can programmatically pan on a chart instance by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: +You can programmatically pan on a chart instance by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: ```java // pan on chart with 100 pixels on both directions @@ -527,7 +527,7 @@ ZoomPlugin.pan(chart, 100); ZoomPlugin.pan(chart, 100, DefaultTransitionMode.DEFAULT); ``` -You can also pan horizontally or vertically, specifying the amount of pixels of pan on a specific direction, by [Amount](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/Amount.html) class, as following: +You can also pan horizontally or vertically, specifying the amount of pixels of pan on a specific direction, by [Amount](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/Amount.html) class, as following: ```java // zoom on chart with 100 pixels on X direction @@ -544,7 +544,7 @@ ZoomPlugin.pan(chart, amount, DefaultTransitionMode.DEFAULT); ### Is Zoomed or Panned -You can programmatically check is the chart is zoomed or panned by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: +You can programmatically check is the chart is zoomed or panned by [ZoomPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/zoom/ZoomPlugin.html), as following: ```java // gets if zoomed or panned diff --git a/docs/getting-started/GettingStarted.md b/docs/getting-started/GettingStarted.md index 2f5a1022..63143f79 100644 --- a/docs/getting-started/GettingStarted.md +++ b/docs/getting-started/GettingStarted.md @@ -80,7 +80,7 @@ The [javascript utilities](../utilities/Javascript) and the [toast](../utilities The deferred resources can be used ONLY in **GWT Web Toolkit** projects. ::: -A deferred resource contains the javascript code to inject by GWT [ClientBundle](http://www.gwtproject.org/doc/latest/DevGuideClientBundle.html#TextResource) and it will be injected in the DOM tree by [DeferredCharba](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/DeferredCharba.html). +A deferred resource contains the javascript code to inject by GWT [ClientBundle](http://www.gwtproject.org/doc/latest/DevGuideClientBundle.html#TextResource) and it will be injected in the DOM tree by [DeferredCharba](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/DeferredCharba.html). For users who wants to leverage on asynchronously loading of [Chart.JS](http://www.chartjs.org/) module, date time library and adapter or want to leverage on [GWT code splitting](http://www.gwtproject.org/doc/latest/DevGuideCodeSplitting.html), they should use the deferred resources and start using **Charba** inside the callback of successfully load of needed resources. diff --git a/docs/getting-started/Integration.md b/docs/getting-started/Integration.md index dac850c6..009265d1 100644 --- a/docs/getting-started/Integration.md +++ b/docs/getting-started/Integration.md @@ -16,8 +16,8 @@ For this reason, **Charba** provides a set of utilities (casting some own elemen The main provided hooks by **Charba** are: - * a [Div](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Div.html) element which is exposed by `chart.getChartElement()` method. - * a [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html) element which is exposed by `chart.getCanvas()` method. + * a [Div](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Div.html) element which is exposed by `chart.getChartElement()` method. + * a [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html) element which is exposed by `chart.getCanvas()` method. @@ -29,19 +29,19 @@ The following table shows how you can leverage on [Google Elemental2](https://gi | Charba class | Elemental2 class | Charba to Elemental2 | Elemental2 to Charba | :- | :- | :- | :- -| [Div](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Div.html)| HTMLDivElement | `HTMLDivElement element = Div.as()` | `Div element = CastHelper.toDiv(HTMLDivElement)`| -| [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)| HTMLImageElement | `HTMLImageElement element = Img.as()` | `Img element = CastHelper.toImg(HTMLImageElement)`| -| [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html)| HTMLCanvasElement | `HTMLCanvasElement element = Canvas.as()` | `Canvas element = CastHelper.toCanvas(HTMLCanvasElement)` | -| [CanvasPatternItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/CanvasPatternItem.html)| CanvasPattern | `CanvasPattern item = CanvasPatternItem.as()` | `CanvasPatternItem item = CastHelper.toPattern(CanvasPattern)`| -| [CanvasGradientItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/CanvasGradientItem.html)| CanvasGradient | `CanvasGradient item = CanvasGradientItem.as()` | `CanvasGradientItem item = CastHelper.toGradient(CanvasGradient)`| -| [NativeBaseEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/events/NativeBaseEvent.html)| Event | `Event event = NativeBaseEvent.as()` | `NativeBaseEvent event = (NativeBaseEvent) elemental2Event` | -| [NativeMouseEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/events/NativeMouseEvent.html)| MouseEvent | `MouseEvent event = NativeMouseEvent.as()` | `NativeMouseEvent event = (NativeMouseEvent) elemental2Event` | -| [NativeTouchEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/events/NativeTouchEvent.html)| TouchEvent | `TouchEvent event = NativeTouchEvent.as()` | `NativeTouchEvent event = (NativeTouchEvent) elemental2Event` | -| [NativeKeyboardEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/events/NativeKeyboardEvent.html)| KeyboardEvent | `KeyboardEvent event = NativeKeyboardEvent.as()` | `NativeKeyboardEvent event = (NativeKeyboardEvent) elemental2Event` | -| [NativePointerEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/events/NativePointerEvent.html)| MouseEvent| `MouseEvent event = NativePointerEvent.as()` | `NativeMouseEvent event = (NativeMouseEvent) elemental2Event`**(1)** | -| [NativeCustomEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/events/NativeCustomEvent.html)| CustomEvent | `CustomEvent event = NativeCustomEvent.as()` | `NativeCustomEvent event = (NativeCustomEvent) elemental2Event` | - -**(1)** up to date, [Google Elemental2](https://github.com/google/elemental2) doesn't map the [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent) javascript class therefore you can use only the [NativeMouseEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/evets/NativeMouseEvent.html). +| [Div](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Div.html)| HTMLDivElement | `HTMLDivElement element = Div.as()` | `Div element = CastHelper.toDiv(HTMLDivElement)`| +| [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)| HTMLImageElement | `HTMLImageElement element = Img.as()` | `Img element = CastHelper.toImg(HTMLImageElement)`| +| [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html)| HTMLCanvasElement | `HTMLCanvasElement element = Canvas.as()` | `Canvas element = CastHelper.toCanvas(HTMLCanvasElement)` | +| [CanvasPatternItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/CanvasPatternItem.html)| CanvasPattern | `CanvasPattern item = CanvasPatternItem.as()` | `CanvasPatternItem item = CastHelper.toPattern(CanvasPattern)`| +| [CanvasGradientItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/CanvasGradientItem.html)| CanvasGradient | `CanvasGradient item = CanvasGradientItem.as()` | `CanvasGradientItem item = CastHelper.toGradient(CanvasGradient)`| +| [NativeBaseEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/events/NativeBaseEvent.html)| Event | `Event event = NativeBaseEvent.as()` | `NativeBaseEvent event = (NativeBaseEvent) elemental2Event` | +| [NativeMouseEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/events/NativeMouseEvent.html)| MouseEvent | `MouseEvent event = NativeMouseEvent.as()` | `NativeMouseEvent event = (NativeMouseEvent) elemental2Event` | +| [NativeTouchEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/events/NativeTouchEvent.html)| TouchEvent | `TouchEvent event = NativeTouchEvent.as()` | `NativeTouchEvent event = (NativeTouchEvent) elemental2Event` | +| [NativeKeyboardEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/events/NativeKeyboardEvent.html)| KeyboardEvent | `KeyboardEvent event = NativeKeyboardEvent.as()` | `NativeKeyboardEvent event = (NativeKeyboardEvent) elemental2Event` | +| [NativePointerEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/events/NativePointerEvent.html)| MouseEvent| `MouseEvent event = NativePointerEvent.as()` | `NativeMouseEvent event = (NativeMouseEvent) elemental2Event`**(1)** | +| [NativeCustomEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/events/NativeCustomEvent.html)| CustomEvent | `CustomEvent event = NativeCustomEvent.as()` | `NativeCustomEvent event = (NativeCustomEvent) elemental2Event` | + +**(1)** up to date, [Google Elemental2](https://github.com/google/elemental2) doesn't map the [PointerEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent) javascript class therefore you can use only the [NativeMouseEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/evets/NativeMouseEvent.html). Here is a simple sample: @@ -77,22 +77,22 @@ The following table shows how you can leverage on [GWT Web toolkit](http://www.g | Charba class | GWT class | Charba to GWT | GWT to Charba | :- | :- | :- | :- -| [Div](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Div.html)| [DivElement](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/DivElement.html) | `DivElement element = Div.as()` | `Div element = CastHelper.toDiv(DivElement)`| -| [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)| [ImageElement](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/ImageElement.html) | `ImageElement element = Img.as()` | `Img element = CastHelper.toImg(ImageElement)`| -| [Canvas](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Canvas.html)| [CanvasElement](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/CanvasElement.html) | `CanvasElement element = Canvas.as()` | `Canvas element = CastHelper.toCanvas(CanvasElement)` | -| [CanvasPatternItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/CanvasPatternItem.html) | [CanvasPattern](http://www.gwtproject.org/javadoc/latest/com/google/gwt/canvas/dom/client/CanvasPattern.html) | `CanvasPattern item = CanvasPatternItem.as()` | `CanvasPatternItem item = CastHelper.toPattern(CanvasPattern)`| -| [CanvasGradientItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/CanvasGradientItem.html) | [CanvasGradient](http://www.gwtproject.org/javadoc/latest/com/google/gwt/canvas/dom/client/CanvasGradient.html) | `CanvasGradient item = CanvasGradientItem.as()` | `CanvasGradientItem item = CastHelper.toGradient(CanvasGradient)`| -| [NativeBaseEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/events/NativeBaseEvent.html)| [NativeEvent](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/NativeEvent.html) | `NativeEvent event = NativeBaseEvent.as()` | `NativeBaseEvent event = (NativeBaseEvent) gwtEvent` | -| [NativeMouseEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/events/NativeMouseEvent.html)| [NativeEvent](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/NativeEvent.html) | `NativeEvent event = NativeMouseEvent.as()` | `NativeMouseEvent event = (NativeMouseEvent) gwtEvent` | -| [NativeTouchEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/events/NativeTouchEvent.html)| [NativeEvent](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/NativeEvent.html) | `NativeEvent event = NativeTouchEvent.as()` | `NativeTouchEvent event = (NativeTouchEvent) gwtEvent` | -| [NativeKeyboardEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/events/NativeKeyboardEvent.html)| [NativeEvent](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/NativeEvent.html) | `NativeEvent event = NativeTouchEvent.as()` | `NativeKeyboardEvent event = (NativeKeyboardEvent) gwtEvent` | -| [NativePointerEvent](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/events/NativePointerEvent.html)| [NativeEvent](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/NativeEvent.html) | `NativeEvent event = NativePointerEvent.as()` | `NativeMouseEvent event = (NativeMouseEvent) gwtEvent`**(2)** | +| [Div](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Div.html)| [DivElement](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/DivElement.html) | `DivElement element = Div.as()` | `Div element = CastHelper.toDiv(DivElement)`| +| [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)| [ImageElement](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/ImageElement.html) | `ImageElement element = Img.as()` | `Img element = CastHelper.toImg(ImageElement)`| +| [Canvas](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Canvas.html)| [CanvasElement](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/CanvasElement.html) | `CanvasElement element = Canvas.as()` | `Canvas element = CastHelper.toCanvas(CanvasElement)` | +| [CanvasPatternItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/CanvasPatternItem.html) | [CanvasPattern](http://www.gwtproject.org/javadoc/latest/com/google/gwt/canvas/dom/client/CanvasPattern.html) | `CanvasPattern item = CanvasPatternItem.as()` | `CanvasPatternItem item = CastHelper.toPattern(CanvasPattern)`| +| [CanvasGradientItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/CanvasGradientItem.html) | [CanvasGradient](http://www.gwtproject.org/javadoc/latest/com/google/gwt/canvas/dom/client/CanvasGradient.html) | `CanvasGradient item = CanvasGradientItem.as()` | `CanvasGradientItem item = CastHelper.toGradient(CanvasGradient)`| +| [NativeBaseEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/events/NativeBaseEvent.html)| [NativeEvent](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/NativeEvent.html) | `NativeEvent event = NativeBaseEvent.as()` | `NativeBaseEvent event = (NativeBaseEvent) gwtEvent` | +| [NativeMouseEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/events/NativeMouseEvent.html)| [NativeEvent](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/NativeEvent.html) | `NativeEvent event = NativeMouseEvent.as()` | `NativeMouseEvent event = (NativeMouseEvent) gwtEvent` | +| [NativeTouchEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/events/NativeTouchEvent.html)| [NativeEvent](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/NativeEvent.html) | `NativeEvent event = NativeTouchEvent.as()` | `NativeTouchEvent event = (NativeTouchEvent) gwtEvent` | +| [NativeKeyboardEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/events/NativeKeyboardEvent.html)| [NativeEvent](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/NativeEvent.html) | `NativeEvent event = NativeTouchEvent.as()` | `NativeKeyboardEvent event = (NativeKeyboardEvent) gwtEvent` | +| [NativePointerEvent](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/events/NativePointerEvent.html)| [NativeEvent](http://www.gwtproject.org/javadoc/latest/com/google/gwt/dom/client/NativeEvent.html) | `NativeEvent event = NativePointerEvent.as()` | `NativeMouseEvent event = (NativeMouseEvent) gwtEvent`**(2)** | **(2)** up to date, [GWT Web toolkit](http://www.gwtproject.org/) maps only the [MouseEvent](https://developer.mozilla.org/en-US/docs/Web/API/MouseEvent) and [TouchEvent](https://developer.mozilla.org/en-US/docs/Web/API/PointerEvent) javascript classes therefore you can cast them but you cannot use all available event info. -GWT Web Toolkit is also providing other classes related to images and for those **Charba** is providing a dedicated utility, [ImagesHelper](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/gwt/ImagesHelper.html), to transform those GWT classes in a [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html). +GWT Web Toolkit is also providing other classes related to images and for those **Charba** is providing a dedicated utility, [ImagesHelper](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/gwt/ImagesHelper.html), to transform those GWT classes in a [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html). | Charba class | GWT class | GWT to Charba | :- | :- | :- -| [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)| [ImageResource](http://www.gwtproject.org/javadoc/latest/com/google/gwt/resources/client/ImageResource.html) | `Img element = ImagesHelper.toImg(ImageResource)`| -| [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html)| [Image](http://www.gwtproject.org/javadoc/latest/com/google/gwt/user/client/ui/Image.html) | `Img element = ImagesHelper.toImg(Image)`| +| [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)| [ImageResource](http://www.gwtproject.org/javadoc/latest/com/google/gwt/resources/client/ImageResource.html) | `Img element = ImagesHelper.toImg(ImageResource)`| +| [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html)| [Image](http://www.gwtproject.org/javadoc/latest/com/google/gwt/user/client/ui/Image.html) | `Img element = ImagesHelper.toImg(Image)`| diff --git a/docs/intl/DateTimeFormat.md b/docs/intl/DateTimeFormat.md index 29179800..ba5f1798 100644 --- a/docs/intl/DateTimeFormat.md +++ b/docs/intl/DateTimeFormat.md @@ -6,7 +6,7 @@ sidebar_label: Date time formatting --- ## Date time formatting -**Charba** provide a [date time format](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/DateTimeFormat.html) implementation which enables language-sensitive date time formatting, leveraging on [INTL](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat) platform. +**Charba** provide a [date time format](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/DateTimeFormat.html) implementation which enables language-sensitive date time formatting, leveraging on [INTL](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat) platform. ```java // creates a date time format @@ -24,7 +24,7 @@ Console.log(numberFormat.format(new Date())); ## Creating -A [date time format](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/DateTimeFormat.html) can be created and consumed as following: +A [date time format](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/DateTimeFormat.html) can be created and consumed as following: ```java // creates locale @@ -47,7 +47,7 @@ DateTimeFormat dfGermanOptions = new DateTimeFormat(german, options); ## Options -A [date time format](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/DateTimeFormat.html) can be configured, when created, by the set of options which can change the date time formatting, together with the locale. +A [date time format](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/DateTimeFormat.html) can be configured, when created, by the set of options which can change the date time formatting, together with the locale. ```java // creates locale @@ -70,31 +70,31 @@ The complete options are described by following table: | Name | Type | Default | Description | :- | :- | :- | :- -| calendar | [Calendar](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/Calendar.html) | `null` | The calendar to use for formatting. -| dateStyle | [DateTimeStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/DateTimeStyle.html) | `null` | The date style to use when formatting. -| day | [NumberItemStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/NumberItemStyle.html) | NumberItemStyle.NUMERIC | The representation of the day. -| dayPeriod | [StringItemStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/StringItemStyle.html) | `null` | The way day periods should be expressed. -| era | [StringItemStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/StringItemStyle.html) | `null` | The representation of the era. -| formatMatcher | [FormatMatcher](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/FormatMatcher.html) | `null` | The format matching algorithm to use. -| hour | [NumberItemStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/NumberItemStyle.html) | `null` | The representation of the hour. +| calendar | [Calendar](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/Calendar.html) | `null` | The calendar to use for formatting. +| dateStyle | [DateTimeStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/DateTimeStyle.html) | `null` | The date style to use when formatting. +| day | [NumberItemStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/NumberItemStyle.html) | NumberItemStyle.NUMERIC | The representation of the day. +| dayPeriod | [StringItemStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/StringItemStyle.html) | `null` | The way day periods should be expressed. +| era | [StringItemStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/StringItemStyle.html) | `null` | The representation of the era. +| formatMatcher | [FormatMatcher](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/FormatMatcher.html) | `null` | The format matching algorithm to use. +| hour | [NumberItemStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/NumberItemStyle.html) | `null` | The representation of the hour. | hour12 | boolean | `false` | Whether to use 12-hour time (as opposed to 24-hour time).
This option overrides the `hourCycle` option in case both are present. -| hourCycle | [HourCycle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/HourCycle.html) | `null` | The hour cycle to use. -| localeMatcher | [LocaleMatcher](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/LocaleMatcher.html) | LocaleMatcher.BEST_FIT | The locale matching algorithm to use. -| minute | [NumberItemStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/NumberItemStyle.html) | `null` | The representation of the minute. -| month | [MixedItemStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/MixedItemStyle.html) | MixedItemStyle.NUMERIC | The representation of the month. -| numberingSystem | [NumberingSystem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/NumberingSystem.html) | `null` | The numbering system to use for date time formatting. -| second | [NumberItemStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/NumberItemStyle.html) | `null` | The representation of the second. -| timeStyle | [DateTimeStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/DateTimeStyle.html) | `null` | The time style to use when formatting. -| timeZone | [TimeZone](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/TimeZone.html) | `null` | The time zone to use. -| timeZoneName | [TimeZoneName](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/TimeZoneName.html) | `null` | The representation of the time zone name. -| weekDay | [StringItemStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/StringItemStyle.html) | `null` | The representation of the weekday. -| year | [NumberItemStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/NumberItemStyle.html) | NumberItemStyle.NUMERIC | The representation of the year. +| hourCycle | [HourCycle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/HourCycle.html) | `null` | The hour cycle to use. +| localeMatcher | [LocaleMatcher](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/LocaleMatcher.html) | LocaleMatcher.BEST_FIT | The locale matching algorithm to use. +| minute | [NumberItemStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/NumberItemStyle.html) | `null` | The representation of the minute. +| month | [MixedItemStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/MixedItemStyle.html) | MixedItemStyle.NUMERIC | The representation of the month. +| numberingSystem | [NumberingSystem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/NumberingSystem.html) | `null` | The numbering system to use for date time formatting. +| second | [NumberItemStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/NumberItemStyle.html) | `null` | The representation of the second. +| timeStyle | [DateTimeStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/DateTimeStyle.html) | `null` | The time style to use when formatting. +| timeZone | [TimeZone](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/TimeZone.html) | `null` | The time zone to use. +| timeZoneName | [TimeZoneName](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/TimeZoneName.html) | `null` | The representation of the time zone name. +| weekDay | [StringItemStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/StringItemStyle.html) | `null` | The representation of the weekday. +| year | [NumberItemStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/NumberItemStyle.html) | NumberItemStyle.NUMERIC | The representation of the year. See [INTL date time format](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat#parameters) documentation for the details of each option. ## Using -The [date time format](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/DateTimeFormat.html) provides a set of methods to enable the date time formatting. +The [date time format](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/DateTimeFormat.html) provides a set of methods to enable the date time formatting. The most important one is **format**, to format a [Date](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/util/Date.html) as following: @@ -124,7 +124,7 @@ resolvedOptions.getTimeStyle(); ### Formatting to parts -**formatToParts** method is useful for custom formatting of date time strings. It returns a list of [format part objects](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/FormatPart.html) containing the locale-specific tokens from which it possible to build custom strings while preserving the locale-specific parts. +**formatToParts** method is useful for custom formatting of date time strings. It returns a list of [format part objects](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/FormatPart.html) containing the locale-specific tokens from which it possible to build custom strings while preserving the locale-specific parts. ```java // creates a date time format diff --git a/docs/intl/Locale.md b/docs/intl/Locale.md index a14bc713..b0a21055 100644 --- a/docs/intl/Locale.md +++ b/docs/intl/Locale.md @@ -10,9 +10,9 @@ sidebar_label: Locale ## Locale -**Charba** provide a own [locale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) implementation which can be used in the charts or for other several purposes. +**Charba** provide a own [locale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) implementation which can be used in the charts or for other several purposes. -The [locale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) object allows for easier manipulation of Unicode locales. Unicode represents locales with a string, called a _locale identifier_. +The [locale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) object allows for easier manipulation of Unicode locales. Unicode represents locales with a string, called a _locale identifier_. The locale identifier consists of a language identifier and extension tags. Language identifiers are the core of the locale, consisting of language, script, and region subtags. @@ -34,7 +34,7 @@ A Unicode BCP 47 locale identifier consists of with all present components separated by hyphens. -To create own locale, you can use the [locale builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocaleBuilder.html) as following: +To create own locale, you can use the [locale builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocaleBuilder.html) as following: ```java // creates a locale with language @@ -56,19 +56,19 @@ CLocale german = CLocaleBuilder.build("de"); CLocale austrian = CLocaleBuilder.build("de-AT"); ``` -The [locale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) is providing a subset of locales as constants. +The [locale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) is providing a subset of locales as constants. **Charba** provides the enumerations with possible languages, regions or scripts that can be used to create a locale: - * languages codes are enumerated in [Language](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/Language.html) object. - * regions are enumerated in [Region](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/Region.html) object. - * scripts are enumerated in [Script](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/Script.html) object. + * languages codes are enumerated in [Language](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/Language.html) object. + * regions are enumerated in [Region](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/Region.html) object. + * scripts are enumerated in [Script](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/Script.html) object. ## Defaults At runtime, you can determine the user’s locale in different ways, automatically retrieved, or can be set programmatically. -The default [locale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) will set if one of the following items is met and in the order are described: +The default [locale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) will set if one of the following items is met and in the order are described: * Append the client `locale` property value to the query string of the URL. @@ -79,9 +79,9 @@ For instance, `http://www.example.org/myapp.html?locale=de` will set "de" as def For instance, `` will set "de" as default locale. * Reads the default locale from platform - * if all above items don't provide any correct locale, [CLocale.US](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) is set. + * if all above items don't provide any correct locale, [CLocale.US](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) is set. -To access to default locale, you can retrieve it from [locale](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/CLocale.html) object, where is statically stored, as following: +To access to default locale, you can retrieve it from [locale](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/CLocale.html) object, where is statically stored, as following: ```java // gets default locale diff --git a/docs/intl/NumberFormat.md b/docs/intl/NumberFormat.md index 019a99d4..ee362cdc 100644 --- a/docs/intl/NumberFormat.md +++ b/docs/intl/NumberFormat.md @@ -6,7 +6,7 @@ sidebar_label: Number formatting --- ## Number formatting -**Charba** provide a [number format](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/NumberFormat.html) implementation which enables language-sensitive number formatting, leveraging on [INTL](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) platform. +**Charba** provide a [number format](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/NumberFormat.html) implementation which enables language-sensitive number formatting, leveraging on [INTL](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat) platform. ```java // creates a number format @@ -17,7 +17,7 @@ Console.log(numberFormat.format(13576453.865)); ## Creating -A [number format](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/NumberFormat.html) can be created and consumed as following: +A [number format](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/NumberFormat.html) can be created and consumed as following: ```java // creates locale @@ -40,7 +40,7 @@ NumberFormat nfGermanOptions = new NumberFormat(german, options); ## Options -A [number format](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/NumberFormat.html) can be configured, when created, by the set of options which can change the number formatting, together with the locale. +A [number format](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/NumberFormat.html) can be configured, when created, by the set of options which can change the number formatting, together with the locale. ```java // creates locale @@ -63,29 +63,29 @@ The complete options are described by following table: | Name | Type | Default | Description | :- | :- | :- | :- -| compactDisplay | [CompactDisplay](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/CompactDisplay.html) | CompactDisplay.SHORT | Set the compact display when `notation` is set to Notation.COMPACT. -| currency | [Currency](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/Currency.html) | `null` | The currency to use in currency formatting. -| currencyDisplay | [CurrencyDisplay](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/CurrencyDisplay.html) | CurrencyDisplay.SYMBOL | How to display the currency in currency formatting. -| currencySign | [CurrencySign](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/CurrencySign.html) | CurrencySign.STANDARD | In many locales, accounting format means to wrap the number with parentheses instead of appending a minus sign. -| localeMatcher | [LocaleMatcher](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/LocaleMatcher.html) | LocaleMatcher.BEST_FIT | The locale matching algorithm to use. -| maximumFractionDigits | int | The default for plain number formatting is the larger of `minimumFractionDigits` and `3`.
The default for currency formatting is the larger of `minimumFractionDigits` and the number of minor unit digits provided by [Currency](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/Currency.html).
The default for percent formatting is the larger of `minimumFractionDigits` and `0`. | The maximum number of fraction digits to use.
Possible values are from 0 to 20. +| compactDisplay | [CompactDisplay](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/CompactDisplay.html) | CompactDisplay.SHORT | Set the compact display when `notation` is set to Notation.COMPACT. +| currency | [Currency](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/Currency.html) | `null` | The currency to use in currency formatting. +| currencyDisplay | [CurrencyDisplay](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/CurrencyDisplay.html) | CurrencyDisplay.SYMBOL | How to display the currency in currency formatting. +| currencySign | [CurrencySign](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/CurrencySign.html) | CurrencySign.STANDARD | In many locales, accounting format means to wrap the number with parentheses instead of appending a minus sign. +| localeMatcher | [LocaleMatcher](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/LocaleMatcher.html) | LocaleMatcher.BEST_FIT | The locale matching algorithm to use. +| maximumFractionDigits | int | The default for plain number formatting is the larger of `minimumFractionDigits` and `3`.
The default for currency formatting is the larger of `minimumFractionDigits` and the number of minor unit digits provided by [Currency](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/Currency.html).
The default for percent formatting is the larger of `minimumFractionDigits` and `0`. | The maximum number of fraction digits to use.
Possible values are from 0 to 20. | maximumSignificantDigits | int | 21 | The maximum number of significant digits to use.
Possible values are from 1 to 21. -| minimumFractionDigits | int | The default for plain number and percent formatting is `0`.
The default for currency formatting is the number of minor unit digits provided by [Currency](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/Currency.html). | The minimum number of fraction digits to use.
Possible values are from 0 to 20. +| minimumFractionDigits | int | The default for plain number and percent formatting is `0`.
The default for currency formatting is the number of minor unit digits provided by [Currency](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/Currency.html). | The minimum number of fraction digits to use.
Possible values are from 0 to 20. | minimumIntegerDigits | int | 1 | The minimum number of integer digits to use.
Possible values are from 1 to 21. | minimumSignificantDigits | int | 1 | The minimum number of significant digits to use.
Possible values are from 1 to 21. -| notation | [Notation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/Notation.html) | Notation.STANDARD | The formatting that should be displayed for the number. -| numberingSystem | [NumberingSystem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/NumberingSystem.html) | `null` | The numbering system to use for number formatting. -| signDisplay | [SignDisplay](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/SignDisplay.html) | SignDisplay.AUTO | When to display the sign for the number. -| style | [Style](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/Style.html) | Style.DECIMAL | The formatting style to use. -| unitOfMeasureDisplay | [MeasureUnitDisplay](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/MeasureUnitDisplay.html) | MeasureUnitDisplay.SHORT | The unit formatting style to use in unit formatting. -| unitsOfMeasure | [MeasureUnit](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/enums/MeasureUnit[].html)[] | [] | The unit to use in unit formatting. +| notation | [Notation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/Notation.html) | Notation.STANDARD | The formatting that should be displayed for the number. +| numberingSystem | [NumberingSystem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/NumberingSystem.html) | `null` | The numbering system to use for number formatting. +| signDisplay | [SignDisplay](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/SignDisplay.html) | SignDisplay.AUTO | When to display the sign for the number. +| style | [Style](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/Style.html) | Style.DECIMAL | The formatting style to use. +| unitOfMeasureDisplay | [MeasureUnitDisplay](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/MeasureUnitDisplay.html) | MeasureUnitDisplay.SHORT | The unit formatting style to use in unit formatting. +| unitsOfMeasure | [MeasureUnit](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/enums/MeasureUnit[].html)[] | [] | The unit to use in unit formatting. | useGrouping | boolean | `true` | Whether to use grouping separators, such as thousands separators or thousand/lakh/crore separators. See [INTL number format](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat#parameters) documentation for the details of each option. ## Using -The [number format](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/NumberFormat.html) provides a set of methods to enable the number formatting. +The [number format](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/NumberFormat.html) provides a set of methods to enable the number formatting. The most important one is **format**, to format a double as following: @@ -113,7 +113,7 @@ resolvedOptions.getCurrencyDisplay(); ### Formatting to parts -**formatToParts** method is useful for custom formatting of number strings. It returns a list of [format part objects](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/intl/FormatPart.html) containing the locale-specific tokens from which it possible to build custom strings while preserving the locale-specific parts. +**formatToParts** method is useful for custom formatting of number strings. It returns a list of [format part objects](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/intl/FormatPart.html) containing the locale-specific tokens from which it possible to build custom strings while preserving the locale-specific parts. ```java // creates a number format diff --git a/docs/plugins/BackgroundColor.md b/docs/plugins/BackgroundColor.md index ef188551..fa6db526 100644 --- a/docs/plugins/BackgroundColor.md +++ b/docs/plugins/BackgroundColor.md @@ -12,7 +12,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; -The implementation is [ChartBackgroundColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ChartBackgroundColor.html) and can be set as following: +The implementation is [ChartBackgroundColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ChartBackgroundColor.html) and can be set as following: ```java // --------------------------------- @@ -25,7 +25,7 @@ Defaults.get().getPlugins().register(new ChartBackgroundColor()); chart.getPlugins().add(new ChartBackgroundColor()); ``` -The ID of plugin is `charbabackgroundcolor` ([ChartBackgroundColor.ID](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ChartBackgroundColor.html#ID)). +The ID of plugin is `charbabackgroundcolor` ([ChartBackgroundColor.ID](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ChartBackgroundColor.html#ID)). To set the background color or pattern or gradient, you must create the instance passing the color or pattern or gradient in the constructor: @@ -50,7 +50,7 @@ new ChartBackgroundColor(pattern); It could be that you set this plugin as global one for all your charts but you want to change it for only one instance. -In this case you should instantiate a [ChartBackgroundColorOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ChartBackgroundColorOptions.html) and set it to your chart options as following, setting the color or pattern or gradient you want: +In this case you should instantiate a [ChartBackgroundColorOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ChartBackgroundColorOptions.html) and set it to your chart options as following, setting the color or pattern or gradient you want: ```java // creates a plugin options @@ -79,7 +79,7 @@ chart.getOptions().getPlugin().setOptions(options); options.store(chart); ``` -If you need to read the plugin options, there is the specific factory, [ChartBackgroundColorOptionsFactory](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ChartBackgroundColorOptionsFactory.html) as static reference inside the [plugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ChartBackgroundColor.html) which can be used to retrieve the options from the chart as following: +If you need to read the plugin options, there is the specific factory, [ChartBackgroundColorOptionsFactory](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ChartBackgroundColorOptionsFactory.html) as static reference inside the [plugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ChartBackgroundColor.html) which can be used to retrieve the options from the chart as following: ```java // gets options reference @@ -100,10 +100,10 @@ The following are the attributes that you can set to plugin options: | Name | Type | Default | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | HtmlColor.WHITE -          | The fill color of the chart background. -| areaBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) | HtmlColor.WHITE -          | The fill color of the chart area background. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | HtmlColor.WHITE -          | The fill color of the chart background. +| areaBackgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) - [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) - [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) | HtmlColor.WHITE -          | The fill color of the chart area background. | fillArea | boolean | `true` | If `false`, the chart area is not filled with the `backgroundColor` set for the canvas filling. -| globalCompositeOperation | [GlobalCompositeOperation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/GlobalCompositeOperation.html) | GlobalCompositeOperation.SOURCE_OVER | The type of compositing operation to apply when drawing new shapes.

See [here](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation) more details. +| globalCompositeOperation | [GlobalCompositeOperation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/GlobalCompositeOperation.html) | GlobalCompositeOperation.SOURCE_OVER | The type of compositing operation to apply when drawing new shapes.

See [here](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/globalCompositeOperation) more details. The following is showing how a chart area can be filled: diff --git a/docs/plugins/ColorSchemes.md b/docs/plugins/ColorSchemes.md index 95f961a3..7c761493 100644 --- a/docs/plugins/ColorSchemes.md +++ b/docs/plugins/ColorSchemes.md @@ -15,7 +15,7 @@ This plugin, as singleton, can be set both at global and at chart level. -The implementation is [ColorSchemes](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ColorSchemes.html) and can be set as following: +The implementation is [ColorSchemes](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ColorSchemes.html) and can be set as following: ```java // --------------------------------- @@ -28,13 +28,13 @@ Defaults.get().getPlugins().register(ColorSchemes.get()); chart.getPlugins().add(ColorSchemes.get()); ``` -The ID of plugin is `charbacolorschemes` ([ColorSchemes.ID](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ColorSchemes.html#ID)). +The ID of plugin is `charbacolorschemes` ([ColorSchemes.ID](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ColorSchemes.html#ID)). ## Options It could be that you set this plugin as global one for all your charts but you want to change it for only one instance. -In this case you should instantiate a [ColorSchemesOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ColorSchemesOptions.html) and set it to your chart options as following, setting the color scheme you want: +In this case you should instantiate a [ColorSchemesOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ColorSchemesOptions.html) and set it to your chart options as following, setting the color scheme you want: ```java // creates a plugin options @@ -75,7 +75,7 @@ options.store(); ``` -If you need to read the plugin options, there is the specific factory, [ColorSchemesOptionsFactory](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ColorSchemesOptionsFactory.html) as static reference inside the [plugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ColorSchemes.html) which can be used to retrieve the options from chart as following: +If you need to read the plugin options, there is the specific factory, [ColorSchemesOptionsFactory](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ColorSchemesOptionsFactory.html) as static reference inside the [plugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ColorSchemes.html) which can be used to retrieve the options from chart as following: ```java // gets options reference @@ -96,8 +96,8 @@ The following are the attributes that you can set to plugin options: | Name | Type | Default | Description | :- | :- | :- | :- -| schemeScope | [SchemeScope](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/enums/SchemeScope.html) | SchemeScope.DATASET | If set to `data`, the color scheme is applied to the data instead of dataset. This can be set only for [BAR](../charts/ChartBar) or [BUBBLE](../charts/ChartBubble) charts. -| scheme | [ColorScheme](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ColorScheme.html) | BrewerScheme.PAIRED12 - | Defines the color scheme instance to apply +| schemeScope | [SchemeScope](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/enums/SchemeScope.html) | SchemeScope.DATASET | If set to `data`, the color scheme is applied to the data instead of dataset. This can be set only for [BAR](../charts/ChartBar) or [BUBBLE](../charts/ChartBubble) charts. +| scheme | [ColorScheme](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ColorScheme.html) | BrewerScheme.PAIRED12 - | Defines the color scheme instance to apply | backgroundColorAlpha | double | `0.5` | The transparency value for the background color. Must be a number between 0.0 (fully transparent) and 1.0 (no transparency). | reverse | boolean | `false` | If set to `true`, the order of the colors in the selected scheme is reversed. @@ -111,7 +111,7 @@ The following are the attributes that you can set to plugin options: * **GWT material**, with a set of color schemes taken from [GWT Material color table](../coloring/tables/GWTMaterialColors). Here the complete [list](./tables/ColorSchemeGwtMaterial). * **Google Chart**, with a set of color schemes taken from [Google Chart table color](../coloring/tables/GoogleChartColors). -You can also create your own color schemes, implementing the [ColorScheme](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ColorScheme.html) interface. +You can also create your own color schemes, implementing the [ColorScheme](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ColorScheme.html) interface. ## Options builder diff --git a/docs/plugins/Crosshair.md b/docs/plugins/Crosshair.md index 1a3118a4..746954d0 100644 --- a/docs/plugins/Crosshair.md +++ b/docs/plugins/Crosshair.md @@ -16,7 +16,7 @@ Crosshairs are thin vertical and horizontal lines centered on a data point in a This plugin, as singleton, can be set both at global and at chart level. -The implementation is [Crosshair](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/Crosshair.html) and can be set as following: +The implementation is [Crosshair](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/Crosshair.html) and can be set as following: ```java // --------------------------------- @@ -29,13 +29,13 @@ Defaults.get().getPlugins().register(Crosshair.get()); chart.getPlugins().add(Crosshair.get()); ``` -The ID of plugin is `charbacrosshair` ([Crosshair.ID](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/Crosshair.html#ID)). +The ID of plugin is `charbacrosshair` ([Crosshair.ID](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/Crosshair.html#ID)). ## Options It could be that you set this plugin as global one for all your charts but you want to change it for only one instance. -In this case you should instantiate a [CrosshairOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/CrosshairOptions.html) and set it to your chart options as following, setting the color you want: +In this case you should instantiate a [CrosshairOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/CrosshairOptions.html) and set it to your chart options as following, setting the color you want: ```java // creates a plugin options @@ -73,7 +73,7 @@ Defaults.get().getGlobal().getPlugin().setOptions(options); options.store(); ``` -If you need to read the plugin options, there is the specific factory, [CrosshairOptionsFactory](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/CrosshairOptionsFactory.html) as static reference inside the [plugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/Crosshair.html) which can be used to retrieve the options from chart, as following: +If you need to read the plugin options, there is the specific factory, [CrosshairOptionsFactory](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/CrosshairOptionsFactory.html) as static reference inside the [plugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/Crosshair.html) which can be used to retrieve the options from chart, as following: ```java // gets options reference @@ -96,14 +96,14 @@ The following are the attributes that you can set to plugin options: | :- | :- | :- | :- | enabled | boolean | `true` | If `true`, the plugin is enabled. | group | String | `null` | Defines the group which the plugin instance belongs to. It can link the crosshair instances on multiple charts as group and the position is synchronized on all charts. -| lineColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.GRAY -          | The color of the line of the cross hairs. +| lineColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.GRAY -          | The color of the line of the cross hairs. | lineDash | int[] | [2, 2] | The line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern. | lineDashOffset | double | 0 | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset) | lineWidth | int | 1 | The width of the line of the cross hairs. -| mode | [InteractionAxis](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/InteractionAxis.html) | InteractionAxis.XY | Sets the display on horizontal and/or vertical hairs. -| modifierKey | [ModifierKey](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ModifierKey.html) | `null` | Keyboard modifier key which must be pressed to enable the cross hair. -| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | DefaultScaleId.X | The ID of the X axis to use to position the vertical cross hair. -| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | DefaultScaleId.Y | The ID of the Y axis to use to position the horizontal cross hair. +| mode | [InteractionAxis](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/InteractionAxis.html) | InteractionAxis.XY | Sets the display on horizontal and/or vertical hairs. +| modifierKey | [ModifierKey](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ModifierKey.html) | `null` | Keyboard modifier key which must be pressed to enable the cross hair. +| xScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | DefaultScaleId.X | The ID of the X axis to use to position the vertical cross hair. +| yScaleID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | DefaultScaleId.Y | The ID of the Y axis to use to position the horizontal cross hair. ## Labelling @@ -123,15 +123,15 @@ The following are the attributes that you can set to plugin label options: | Name | Type | Default | Description | :- | :- | :- | :- | display | boolean | `true` | If `true`, the label is shown. -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgb(110, 112, 121) -          | The background color of the label. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | The border color of the label. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgb(110, 112, 121) -          | The background color of the label. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | The border color of the label. | borderRadius | int | 6 | The border radius of the label. | borderWidth | int | 0 | The border width of the label. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.WHITE -          | The color of the text of the label. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | See description | Font of the text of the label.

The default value is the global font.
See [Font](../defaults/DefaultsCharts#font). +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.WHITE -          | The color of the text of the label. +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | See description | Font of the text of the label.

The default value is the global font.
See [Font](../defaults/DefaultsCharts#font). | padding | int | 6 | The space around the text of the label. -To set the same value to both labels, without writing twice the same code, [CrosshairOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/CrosshairOptions.html) is providing a objet which enables that: +To set the same value to both labels, without writing twice the same code, [CrosshairOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/CrosshairOptions.html) is providing a objet which enables that: ```java // creates a plugin options @@ -146,7 +146,7 @@ The plugin provides a callback to change the format the value of label text in o -The formatter can be instantiated implementing [CrosshairFormatterCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/CrosshairFormatterCallback.html) interface which is providing 3 parameters: +The formatter can be instantiated implementing [CrosshairFormatterCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/CrosshairFormatterCallback.html) interface which is providing 3 parameters: 1. chart instance 1. the scale instance, where the label is related to. diff --git a/docs/plugins/DatasetsItemsSelector.md b/docs/plugins/DatasetsItemsSelector.md index d2e68527..34303967 100644 --- a/docs/plugins/DatasetsItemsSelector.md +++ b/docs/plugins/DatasetsItemsSelector.md @@ -16,7 +16,7 @@ The goal is to enable selections of a subset of datasets, zooming and drill down This plugin, as singleton, can be set both at global and at chart level. -The implementation is [DatasetsItemsSelector](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/DatasetsItemsSelector.html) and can be set as following: +The implementation is [DatasetsItemsSelector](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/DatasetsItemsSelector.html) and can be set as following: ```java // --------------------------------- @@ -29,7 +29,7 @@ Defaults.get().getPlugins().register(DatasetsItemsSelector.get()); chart.getPlugins().add(DatasetsItemsSelector.get()); ``` -The ID of plugin is `charbadatasetsitemsselector` ([DatasetsItemsSelector.ID](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/DatasetsItemsSelector.html#ID)). +The ID of plugin is `charbadatasetsitemsselector` ([DatasetsItemsSelector.ID](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/DatasetsItemsSelector.html#ID)). :::note It works on all multiple scales chart type, like [line](../charts/ChartLine)**(1)**, [bar](../charts/ChartBar)**(1)**, [scatter](../charts/ChartScatter) or [bubble](../charts/ChartBubble) charts. @@ -41,7 +41,7 @@ It works on all multiple scales chart type, like [line](../charts/ChartLine)**         | The border color of the selected area. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgb(97, 97, 97) -          | The border color of the selected area. | borderDash | int[] | [] | The line dash pattern used when stroking lines, using an array of values which specify alternating lengths of lines and gaps which describe the pattern. | borderDashOffset | double | 0 | Offset for line dashes. See [MDN](https://developer.mozilla.org/en-US/docs/Web/API/CanvasRenderingContext2D/lineDashOffset) | borderWidth | int | 0 | The border width of the selected area. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgba(255, 204, 128, 0.3) -          | The color of selected area on chart. +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgba(255, 204, 128, 0.3) -          | The color of selected area on chart. | enabled | boolean | `true` | If `true`, the plugin is enabled. | enabledClearByEscape | boolean | `true` | If `true`, the selection can be clear pressing `Escape` key. -| modifierKey | [ModifierKey](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ModifierKey.html) | `null` | Keyboard modifier key which must be pressed to enable the selection. -| xAxisID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | DefaultScaleId.X | The ID of the X axis to use to calculate the amount of selectable items. -| yAxisID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/ScaleId.html) | `null` | The ID of the Y axis to use to calculate the area selections. If `null`, the chart area size is used. To use for stacked axes. +| modifierKey | [ModifierKey](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ModifierKey.html) | `null` | Keyboard modifier key which must be pressed to enable the selection. +| xAxisID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | DefaultScaleId.X | The ID of the X axis to use to calculate the amount of selectable items. +| yAxisID | String - [ScaleId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/ScaleId.html) | `null` | The ID of the Y axis to use to calculate the area selections. If `null`, the chart area size is used. To use for stacked axes. ### Selection cleaner -Every options has got a inner element to set selection cleaner options. The [selection cleaner](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/SelectionCleaner.html) element allows to reset the selection directly from the chart. +Every options has got a inner element to set selection cleaner options. The [selection cleaner](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/SelectionCleaner.html) element allows to reset the selection directly from the chart. @@ -137,12 +137,12 @@ The complete options are described by following table: | :- | :- | :- | :- | display | boolean | `false` | If `true` the element will be showed to chart. | label | String | `"Reset selection"` | The label to show in the element. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | See description | Font of selection cleaner label.

The default value is the global font.
See [Font](../defaults/DefaultsCharts#font). -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | rgb(97, 97, 97) -          | The font color of label. -| align | [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/enums/Align.html) | Align.RIGHT | Alignment of element. -| position | [Position](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html) | Position.BOTTOM | Position of the element in the chart. `left` and `right` are ignored and use `bottom`. -| image | [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) | `null` | The image to show in the element. -| render | [Render](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/enums/Render.html) | Render.LABEL | Defines if label or image or both will e showed in the element. +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | See description | Font of selection cleaner label.

The default value is the global font.
See [Font](../defaults/DefaultsCharts#font). +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | rgb(97, 97, 97) -          | The font color of label. +| align | [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/enums/Align.html) | Align.RIGHT | Alignment of element. +| position | [Position](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html) | Position.BOTTOM | Position of the element in the chart. `left` and `right` are ignored and use `bottom`. +| image | [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) | `null` | The image to show in the element. +| render | [Render](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/enums/Render.html) | Render.LABEL | Defines if label or image or both will e showed in the element. | margin | int | `2` | The distance with the canvas borders. | padding | int | `4` | The padding around the render element. | spacing | int | `3` | The distance between image and label in the element. @@ -174,7 +174,7 @@ protected void handleSelect() { } ``` -To catch the event and manage it, you can add a [DatasetRangeSelectionEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/DatasetRangeSelectionEventHandler.html) instance to the chart options, as following: +To catch the event and manage it, you can add a [DatasetRangeSelectionEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/DatasetRangeSelectionEventHandler.html) instance to the chart options, as following: ```java chart.addHandler(new DatasetRangeSelectionEventHandler(){ @@ -192,14 +192,14 @@ chart.addHandler(new DatasetRangeSelectionEventHandler(){ }, DatasetRangeSelectionEvent.TYPE); ``` -The [event](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/DatasetRangeSelectionEvent.html) provides 2 methods to get the range of the selected data sets: +The [event](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/DatasetRangeSelectionEvent.html) provides 2 methods to get the range of the selected data sets: - * `getFrom()` provides the starting value on data sets, by a [scale item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ScaleValueItem.html). - * `getTo()` provides the ending value on data sets, by a [scale item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/items/ScaleValueItem.html). + * `getFrom()` provides the starting value on data sets, by a [scale item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ScaleValueItem.html). + * `getTo()` provides the ending value on data sets, by a [scale item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/items/ScaleValueItem.html). ### Cleaning selection -To reset a selection programmatically, without using [selection cleaner](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/SelectionCleaner.html) element, the plugin provides 2 methods: +To reset a selection programmatically, without using [selection cleaner](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/SelectionCleaner.html) element, the plugin provides 2 methods: * `cleanSelection(IsChart chart)` which resets the selected area on passed chart instance firing event on reset if a clean selection handler has been configured. * `cleanSelection(IsChart chart, boolean fireEvent)` which resets the selected area on passed chart instance, setting if the event must be fired @@ -213,7 +213,7 @@ protected void reset() { } ``` -To catch the event and manage it, you can add a [DatasetRangeCleanSelectionEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/DatasetRangeCleanSelectionEventHandler.html) instance to the chart options, as following: +To catch the event and manage it, you can add a [DatasetRangeCleanSelectionEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/DatasetRangeCleanSelectionEventHandler.html) instance to the chart options, as following: ```java chart.addHandler(new DatasetRangeCleanSelectionEventHandler(){ diff --git a/docs/plugins/HTMLLegend.md b/docs/plugins/HTMLLegend.md index 95871626..d80165e8 100644 --- a/docs/plugins/HTMLLegend.md +++ b/docs/plugins/HTMLLegend.md @@ -22,7 +22,7 @@ The goal is to create a HTML element with all flexibility that HTML elements can This plugin, as singleton, can be set both at global and at chart level. -The implementation is [HtmlLegend](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/HtmlLegend.html) and can be set as following: +The implementation is [HtmlLegend](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/HtmlLegend.html) and can be set as following: ```java // --------------------------------- @@ -35,13 +35,13 @@ Defaults.get().getPlugins().register(HtmlLegend.get()); chart.getPlugins().add(HtmlLegend.get()); ``` -The ID of plugin is `charbahtmllegend` ([HtmlLegend.ID](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/HtmlLegend.html#ID)). +The ID of plugin is `charbahtmllegend` ([HtmlLegend.ID](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/HtmlLegend.html#ID)). ## Options It could be that you set this plugin as global one for all your charts but you want to change it for only one instance. -In this case you should instantiate a [HtmlLegendOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/HtmlLegendOptions.html) and set it to your chart options as following, setting the color you want: +In this case you should instantiate a [HtmlLegendOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/HtmlLegendOptions.html) and set it to your chart options as following, setting the color you want: ```java // creates a plugin options @@ -79,7 +79,7 @@ Defaults.get().getGlobal().getPlugin().setOptions(options); options.store(); ``` -If you need to read the plugin options, there is the specific factory, [HtmlLegendOptionsFactory](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/HtmlLegendOptionsFactory.html) as static reference inside the [plugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/HtmlLegend.html) which can be used to retrieve the options from chart, as following: +If you need to read the plugin options, there is the specific factory, [HtmlLegendOptionsFactory](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/HtmlLegendOptionsFactory.html) as static reference inside the [plugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/HtmlLegend.html) which can be used to retrieve the options from chart, as following: ```java // gets options reference @@ -103,13 +103,13 @@ The following are the attributes that you can set to plugin options: | Name | Type | Default | Description | :- | :- | :- | :- | display | boolean | `true` | if `true`, the HTML legend is showed. -| cursorPointer | [CursorType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/CursorType.html) | CursorType.POINTER | Cursor style when the legend is hovered. +| cursorPointer | [CursorType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/CursorType.html) | CursorType.POINTER | Cursor style when the legend is hovered. | maxLegendColumns | int | Integer.MAX_VALUE | Amount of legend items to show in the same row before creating new row. :::note limitations - * [Position.LEFT](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html#LEFT) is ignored and managed as [Position.TOP](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html#TOP). - * [Position.RIGHT](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html#RIGHT) is ignored and managed as [Position.BOTTOM](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/Position.html#BOTTOM). - * [CanvasGradientItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/CanvasGradientItem.html)s provided by a dataset callback are ignored. + * [Position.LEFT](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html#LEFT) is ignored and managed as [Position.TOP](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html#TOP). + * [Position.RIGHT](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html#RIGHT) is ignored and managed as [Position.BOTTOM](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/Position.html#BOTTOM). + * [CanvasGradientItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/CanvasGradientItem.html)s provided by a dataset callback are ignored. ::: ## Setting HTML text @@ -117,13 +117,13 @@ The following are the attributes that you can set to plugin options: The plugin allows to the user 2 ways to apply own behavior on legend text creation in order to customize the legend text: 1. implements a [LegendLabelsCallback](../configuration/Legend#generatelabels-callback) at chart level. The interface can provide `setText(SafeHtml)` method to set or override the value of legend item as HTML. - 1. implements a [HtmlLegendTextCallback](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/callbacks/HtmlLegendTextCallback.html), see below. + 1. implements a [HtmlLegendTextCallback](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/callbacks/HtmlLegendTextCallback.html), see below. By default, if the legend text (provided by labels or dataset label) contains `\n`, the legend text will be split having a multi-line legend text. ### Item text callback -The plugin provides a callback to change the value of legend text which can return a [SafeHtml](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/safehtml/SafeHtml.html) to apply as legend text. +The plugin provides a callback to change the value of legend text which can return a [SafeHtml](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/safehtml/SafeHtml.html) to apply as legend text. @@ -152,7 +152,7 @@ options.setLegendItemCallback(new HtmlLegendItemCallback(){ ### Title text callback -The plugin provides a callback to change the value of legend title text which can return a [SafeHtml](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/safehtml/SafeHtml.html) to apply as legend title text. +The plugin provides a callback to change the value of legend title text which can return a [SafeHtml](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/safehtml/SafeHtml.html) to apply as legend title text. diff --git a/docs/plugins/Import.md b/docs/plugins/Import.md index 196145b7..727f02ec 100644 --- a/docs/plugins/Import.md +++ b/docs/plugins/Import.md @@ -12,14 +12,14 @@ Some plugins, written in javascript, are already developed and available for [Ch **Charba** provides you the way to import and leverage on these plugins. -The following list of steps is related to GWT projects. For J2CL applications, you must implement an [AbstractInjectableResource](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/resources/AbstractInjectableResource.html) in order to provide the javascript content as strings. +The following list of steps is related to GWT projects. For J2CL applications, you must implement an [AbstractInjectableResource](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/resources/AbstractInjectableResource.html) in order to provide the javascript content as strings. The steps are the following: 1. take the javascript plugin and store in your project in a resource folder 1. create a GWT [ClientBundle](http://www.gwtproject.org/doc/latest/DevGuideClientBundle.html) to get the javascript plugin as GWT [TextResource](http://www.gwtproject.org/doc/latest/DevGuideClientBundle.html#TextResource) - 1. use **Charba** [GlobalPlugins](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/GlobalPlugins.html) to inject and register the plugin. It's **IMPORTANT** to invoke the registration after the [Charba enablement](../getting-started/GettingStarted#javascript-resources). - 1. Create a [plugin options container](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/AbstractPluginOptions.html), with the properties to configure the plugin (see [above](./#options)) + 1. use **Charba** [GlobalPlugins](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/GlobalPlugins.html) to inject and register the plugin. It's **IMPORTANT** to invoke the registration after the [Charba enablement](../getting-started/GettingStarted#javascript-resources). + 1. Create a [plugin options container](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/AbstractPluginOptions.html), with the properties to configure the plugin (see [above](./#options)) 1. Create the view with a chart with the statement to activate the plugin Here is an example, how to include [Stacked100](https://github.com/y-takey/chartjs-plugin-stacked100) plugin, The original code of the plugin is **NOT** adapted to work with [Chart.JS](http://www.chartjs.org/) version 3.x, the changed source of the plugin has been taken from [here](https://raw.githubusercontent.com/pepstock-org/Charba-Showcase/master/src/org/pepstock/charba/showcase/client/resources/js/chartjs-plugin-stacked100.js). diff --git a/docs/plugins/Plugins.md b/docs/plugins/Plugins.md index 3bc5943c..a5ef3e00 100644 --- a/docs/plugins/Plugins.md +++ b/docs/plugins/Plugins.md @@ -14,12 +14,12 @@ Plugins are the most efficient way to customize or change the default behavior o There 2 ways to add plugins to **Charba**: - 1. implementing [Plugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html) interface. - 2. using [SmartPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/SmartPlugin.html) class. + 1. implementing [Plugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html) interface. + 2. using [SmartPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/SmartPlugin.html) class. ### Using Plugin interface -A plugin could be implemented by the [Plugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html) interface. +A plugin could be implemented by the [Plugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html) interface. ```java // creates my plugin @@ -41,7 +41,7 @@ Plugin myPlugin = new Plugin(){ chart.getPlugins().add(myPlugin); ``` -An easy way to implement a plugin is also to extends the [AbstractPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/AbstractPlugin.html) class as following: +An easy way to implement a plugin is also to extends the [AbstractPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/AbstractPlugin.html) class as following: ```java // creates my plugin @@ -64,7 +64,7 @@ Even if the interface implementation is a standard JAVA way to have plugins, thi ### Using SmartPlugin -A [SmartPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/SmartPlugin.html) works as a configuration object where the user can add the hooks needed implementations. +A [SmartPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/SmartPlugin.html) works as a configuration object where the user can add the hooks needed implementations. ```java // creates my plugin @@ -85,7 +85,7 @@ chart.getPlugins().add(myPlugin); In this case, CHART.JS will invoke ONLY the defined hook, ignoring all the others, improving the performance of chart drawing. -All plugin hooks could be implemented by a specific interface in [org.pepstock.charba.client.plugins.hooks](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/package-summary.html) or by a [native hook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/NativeHook.html) where you use JavaScript code. +All plugin hooks could be implemented by a specific interface in [org.pepstock.charba.client.plugins.hooks](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/package-summary.html) or by a [native hook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/NativeHook.html) where you use JavaScript code. ## Registering @@ -181,16 +181,16 @@ SmartPlugin myPlugin = new SmartPlugin("_myPlugin"); // <-- throws IllegalArgume A plugin could need to be configured. Apart the public methods that every plugin can expose to set specific values and to be aligned with [Chart.JS](http://www.chartjs.org/) way to pass configuration to plugins, the chart options can host the configuration of the plugin which could be read at runtime. -The [plugins](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/configuration/Plugins.html) configuration is nested in the configuration using +The [plugins](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/configuration/Plugins.html) configuration is nested in the configuration using ```java // get plugins options container from chart configuration Plugins plugins = chart.getOptions().getPlugins(); ``` -The plugin options must extend [AbstractPluginOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/AbstractPluginOptions.html) and leverage on available methods to store the plugin configuration. +The plugin options must extend [AbstractPluginOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/AbstractPluginOptions.html) and leverage on available methods to store the plugin configuration. -Furthermore, every plugin needs to have a factory which must be an implementation of [AbstractPluginOptionsFactory](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/AbstractPluginOptionsFactory.html)) interface necessary to enable **Charba** to create your options, passing the javascript object which maintain the configuration. +Furthermore, every plugin needs to have a factory which must be an implementation of [AbstractPluginOptionsFactory](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/AbstractPluginOptionsFactory.html)) interface necessary to enable **Charba** to create your options, passing the javascript object which maintain the configuration. A plugin can consume configuration by options from: @@ -377,11 +377,11 @@ chart.getOptions().getPlugins().setEnabled(DefaultPluginId.TOOLTIP, false); chart.getOptions().getPlugins().setEnabled("pluginid", true); ``` -[Chart.JS](http://www.chartjs.org/) provides a set of plugins out-of-the-box. All their ids are mapped to [DefaultPluginId](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/DefaultPluginId.html) enumeration. +[Chart.JS](http://www.chartjs.org/) provides a set of plugins out-of-the-box. All their ids are mapped to [DefaultPluginId](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/DefaultPluginId.html) enumeration. ## Hooks -[Plugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html) interface and [SmartPlugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/SmartPlugin.html) [hooks](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/package-summary.html) provide all possible hooks or methods which will invoked during the life cycle of the chart or when an event or conditions is occurring. +[Plugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html) interface and [SmartPlugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/SmartPlugin.html) [hooks](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/package-summary.html) provide all possible hooks or methods which will invoked during the life cycle of the chart or when an event or conditions is occurring. All hooks are defined with a default therefore you can implement only what you need. The hooks have got different purposes: @@ -404,10 +404,10 @@ The following hooks can be used to setup data needed for the plugin to operate: | `Plugin` method | `SmartPlugin` hook | Description | :- | :- | :- -| onConfigure | [ConfigureHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/ConfigureHook.html) | Called before initializing configuration of 'chart' -| onBeforeInit | [BeforeInitHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeInitHook.html) | Called before initializing 'chart' -| onAfterInit | [AfterInitHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterInitHook.html) | Called after 'chart' has been initialized and before the first update. -| onResize | [ResizeHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/ResizeHook.html) | Called after the chart as been resized. +| onConfigure | [ConfigureHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/ConfigureHook.html) | Called before initializing configuration of 'chart' +| onBeforeInit | [BeforeInitHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeInitHook.html) | Called before initializing 'chart' +| onAfterInit | [AfterInitHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterInitHook.html) | Called after 'chart' has been initialized and before the first update. +| onResize | [ResizeHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/ResizeHook.html) | Called after the chart as been resized. The initialization process is documented in the flowchart below. @@ -429,10 +429,10 @@ flowchart TD style F fill:#D5E8D4,stroke:#82B366 style G fill:#D5E8D4,stroke:#82B366 style H fill:#FFF2CC,stroke:#D6B656 - click B href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onConfigure(org.pepstock.charba.client.IsChart)" "onConfigure" _blank - click D href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onBeforeInit(org.pepstock.charba.client.IsChart)" "onBeforeInit" _blank - click F href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onResize(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginResizeArgument)" "onResize" _blank - click G href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onAfterInit(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.Chart)" "onAfterInit" _blank + click B href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onConfigure(org.pepstock.charba.client.IsChart)" "onConfigure" _blank + click D href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onBeforeInit(org.pepstock.charba.client.IsChart)" "onBeforeInit" _blank + click F href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onResize(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginResizeArgument)" "onResize" _blank + click G href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onAfterInit(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.Chart)" "onAfterInit" _blank ``` ### Registering and activating @@ -443,10 +443,10 @@ The following hooks can be used to interact during the plugin registering or act | `Plugin` method | `SmartPlugin` hook | Description | :- | :- | :- -| onInstall | [InstallHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/InstallHook.html) | Called when plugin is installed for this chart instance; this hook is also invoked for disabled plugins (options equals to false) -| onStart | [StartHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/StartHook.html) | Called when a plugin is starting; this happens when chart is created or plugin is enabled -| onStop | [StopHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/StopHook.html) | Called when a plugin stopping; this happens when chart is destroyed or plugin is disabled -| onUninstall | [UninstallHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/UninstallHook.html) | Called after chart is destroyed on all plugins that were installed for that chart; this hook is also invoked for disabled plugins (options equals to false) +| onInstall | [InstallHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/InstallHook.html) | Called when plugin is installed for this chart instance; this hook is also invoked for disabled plugins (options equals to false) +| onStart | [StartHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/StartHook.html) | Called when a plugin is starting; this happens when chart is created or plugin is enabled +| onStop | [StopHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/StopHook.html) | Called when a plugin stopping; this happens when chart is destroyed or plugin is disabled +| onUninstall | [UninstallHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/UninstallHook.html) | Called after chart is destroyed on all plugins that were installed for that chart; this hook is also invoked for disabled plugins (options equals to false) ### Updating or reconfiguring @@ -465,15 +465,15 @@ The same notification are provided even if the chart is [reconfigured](../charts | `Plugin` method | `SmartPlugin` hook | Description | :- | :- | :- | onBeginDrawing | - | Called before every drawing cycle, coming from initialization, updating or rendering of chart -| onBeforeUpdate | [BeforeUpdateHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeUpdateHook.html) | Called before updating 'chart'. If any plugin returns false, the update is cancelled (and thus subsequent render(s)) until another 'update' is triggered. -| onAfterUpdate | [AfterUpdateHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterUpdateHook.html) | Called after 'chart' has been updated and before rendering. Note that this hook will not be called if the chart update has been previously cancelled. -| onBeforeElementsUpdate | [BeforeElementsUpdateHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeElementsUpdateHook.html) | Called during the update process, before any chart elements have been created. -| onBeforeLayout | [BeforeLayoutHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeLayoutHook.html) | Called before laying out 'chart'. If any plugin returns false, the layout update is cancelled until another 'update' is triggered. -| onAfterLayout | [AfterLayoutHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterLayoutHook.html) | Called after the 'chart' has been layed out. Note that this hook will not be called if the layout update has been previously cancelled. -| onBeforeDatasetsUpdate | [BeforeDatasetsUpdateHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeDatasetsUpdateHook.html) | Called before updating the 'chart' datasets. If any plugin returns false, the datasets update is cancelled until another 'update' is triggered. -| onAfterDatasetsUpdate | [AfterDatasetsUpdateHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterDatasetsUpdateHook.html) | Called after the 'chart' datasets have been updated. Note that this hook will not be called if the datasets update has been previously cancelled. -| onBeforeDatasetUpdate | [BeforeDatasetUpdateHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeDatasetUpdateHook.html) | Called before updating the 'chart' dataset at the given 'args.index'. If any plugin returns false, the datasets update is cancelled until another 'update' is triggered. -| onAfterDatasetUpdate | [AfterDatasetUpdateHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterDatasetUpdateHook.html) | Called after the 'chart' datasets at the given 'args.index' has been updated. Note that this hook will not be called if the datasets update has been previously cancelled. +| onBeforeUpdate | [BeforeUpdateHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeUpdateHook.html) | Called before updating 'chart'. If any plugin returns false, the update is cancelled (and thus subsequent render(s)) until another 'update' is triggered. +| onAfterUpdate | [AfterUpdateHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterUpdateHook.html) | Called after 'chart' has been updated and before rendering. Note that this hook will not be called if the chart update has been previously cancelled. +| onBeforeElementsUpdate | [BeforeElementsUpdateHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeElementsUpdateHook.html) | Called during the update process, before any chart elements have been created. +| onBeforeLayout | [BeforeLayoutHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeLayoutHook.html) | Called before laying out 'chart'. If any plugin returns false, the layout update is cancelled until another 'update' is triggered. +| onAfterLayout | [AfterLayoutHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterLayoutHook.html) | Called after the 'chart' has been layed out. Note that this hook will not be called if the layout update has been previously cancelled. +| onBeforeDatasetsUpdate | [BeforeDatasetsUpdateHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeDatasetsUpdateHook.html) | Called before updating the 'chart' datasets. If any plugin returns false, the datasets update is cancelled until another 'update' is triggered. +| onAfterDatasetsUpdate | [AfterDatasetsUpdateHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterDatasetsUpdateHook.html) | Called after the 'chart' datasets have been updated. Note that this hook will not be called if the datasets update has been previously cancelled. +| onBeforeDatasetUpdate | [BeforeDatasetUpdateHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeDatasetUpdateHook.html) | Called before updating the 'chart' dataset at the given 'args.index'. If any plugin returns false, the datasets update is cancelled until another 'update' is triggered. +| onAfterDatasetUpdate | [AfterDatasetUpdateHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterDatasetUpdateHook.html) | Called after the 'chart' datasets at the given 'args.index' has been updated. Note that this hook will not be called if the datasets update has been previously cancelled. The updating and reconfiguring process is documented in the flowchart below. @@ -529,17 +529,17 @@ flowchart TD style Z fill:#FFFFFF,stroke:#000000 style AA fill:#D5E8D4,stroke:#82B366 style AB fill:#FFF2CC,stroke:#D6B656 - click C "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onConfigure(org.pepstock.charba.client.IsChart)" "onConfigure" _blank - click D "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onBeginDrawing(org.pepstock.charba.client.IsChart,boolean)" "onBeginDrawing" _blank - click E "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onBeforeUpdate(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginUpdateArgument)" "onBeforeUpdate" _blank - click I "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onBeforeElementsUpdate(org.pepstock.charba.client.IsChart)" "onBeforeElementsUpdate" _blank - click M "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onBeforeLayout(org.pepstock.charba.client.IsChart)" "onBeforeLayout" _blank - click Q "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onBeforeDatasetsUpdate(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginUpdateArgument)" "onBeforeDatasetsUpdate" _blank - click P "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onAfterLayout(org.pepstock.charba.client.IsChart)" "onAfterLayout" _blank - click S "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onAfterUpdate(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginUpdateArgument)" "onAfterUpdate" _blank - click T "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onBeforeDatasetUpdate(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginDatasetArgument)" "onBeforeDatasetUpdate" _blank - click V "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onAfterDatasetUpdate(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginDatasetArgument)" "onAfterDatasetUpdate" _blank - click AA "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onAfterDatasetsUpdate(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginUpdateArgument)" "onAfterDatasetsUpdate" _blank + click C "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onConfigure(org.pepstock.charba.client.IsChart)" "onConfigure" _blank + click D "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onBeginDrawing(org.pepstock.charba.client.IsChart,boolean)" "onBeginDrawing" _blank + click E "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onBeforeUpdate(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginUpdateArgument)" "onBeforeUpdate" _blank + click I "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onBeforeElementsUpdate(org.pepstock.charba.client.IsChart)" "onBeforeElementsUpdate" _blank + click M "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onBeforeLayout(org.pepstock.charba.client.IsChart)" "onBeforeLayout" _blank + click Q "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onBeforeDatasetsUpdate(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginUpdateArgument)" "onBeforeDatasetsUpdate" _blank + click P "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onAfterLayout(org.pepstock.charba.client.IsChart)" "onAfterLayout" _blank + click S "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onAfterUpdate(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginUpdateArgument)" "onAfterUpdate" _blank + click T "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onBeforeDatasetUpdate(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginDatasetArgument)" "onBeforeDatasetUpdate" _blank + click V "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onAfterDatasetUpdate(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginDatasetArgument)" "onAfterDatasetUpdate" _blank + click AA "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onAfterDatasetsUpdate(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginUpdateArgument)" "onAfterDatasetsUpdate" _blank ``` ### Rendering @@ -555,14 +555,14 @@ The following hooks can be used to interact during the chart rendering: | `Plugin` method | `SmartPlugin` hook | Description | :- | :- | :- -| onBeforeRender | [BeforeRenderHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeRenderHook.html) | Called before rendering 'chart'. If any plugin returns false, the rendering is cancelled until another 'render' is triggered. -| onAfterRender | [AfterRenderHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterRenderHook.html) | Called after the 'chart' has been fully rendered (and animation completed). Note that this hook will not be called if the rendering has been previously cancelled. -| onBeforeDraw | [BeforeDrawHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeDrawHook.html) | Called before drawing 'chart' at every animation frame. If any plugin returns false, the frame drawing is cancelled until another 'render' is triggered. -| onAfterDraw | [AfterDrawHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterDrawHook.html) | Called after the 'chart' has been drawn. Note that this hook will not be called if the drawing has been previously cancelled. -| onBeforeDatasetsDraw | [BeforeDatasetsDrawHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeDatasetsDrawHook.html) | Called before drawing the 'chart' datasets. If any plugin returns false, the datasets drawing is cancelled until another 'render' is triggered. -| onAfterDatasetsDraw | [AfterDatasetsDrawHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterDatasetsDrawHook.html) | Called after the 'chart' datasets have been drawn. Note that this hook will not be called if the datasets drawing has been previously cancelled. -| onBeforeDatasetDraw | [BeforeDatasetDrawHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeDatasetDrawHook.html) | Called before drawing the 'chart' dataset at the given 'index' (datasets are drawn in the reverse order). If any plugin returns false, the datasets drawing is cancelled until another 'render' is triggered. -| onAfterDatasetDraw | [AfterDatasetDrawHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterDatasetDrawHook.html) | Called after the 'chart' datasets at the given 'args.index' have been drawn (datasets are drawn in the reverse order). Note that this hook will not be called if the datasets drawing has been previously cancelled. +| onBeforeRender | [BeforeRenderHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeRenderHook.html) | Called before rendering 'chart'. If any plugin returns false, the rendering is cancelled until another 'render' is triggered. +| onAfterRender | [AfterRenderHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterRenderHook.html) | Called after the 'chart' has been fully rendered (and animation completed). Note that this hook will not be called if the rendering has been previously cancelled. +| onBeforeDraw | [BeforeDrawHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeDrawHook.html) | Called before drawing 'chart' at every animation frame. If any plugin returns false, the frame drawing is cancelled until another 'render' is triggered. +| onAfterDraw | [AfterDrawHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterDrawHook.html) | Called after the 'chart' has been drawn. Note that this hook will not be called if the drawing has been previously cancelled. +| onBeforeDatasetsDraw | [BeforeDatasetsDrawHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeDatasetsDrawHook.html) | Called before drawing the 'chart' datasets. If any plugin returns false, the datasets drawing is cancelled until another 'render' is triggered. +| onAfterDatasetsDraw | [AfterDatasetsDrawHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterDatasetsDrawHook.html) | Called after the 'chart' datasets have been drawn. Note that this hook will not be called if the datasets drawing has been previously cancelled. +| onBeforeDatasetDraw | [BeforeDatasetDrawHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeDatasetDrawHook.html) | Called before drawing the 'chart' dataset at the given 'index' (datasets are drawn in the reverse order). If any plugin returns false, the datasets drawing is cancelled until another 'render' is triggered. +| onAfterDatasetDraw | [AfterDatasetDrawHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterDatasetDrawHook.html) | Called after the 'chart' datasets at the given 'args.index' have been drawn (datasets are drawn in the reverse order). Note that this hook will not be called if the datasets drawing has been previously cancelled. | onEndDrawing | - | Called after every drawing cycle, coming from initialization, updating or rendering of chart. The rendering process is documented in the flowchart below. @@ -612,15 +612,15 @@ flowchart TD style T fill:#D5E8D4,stroke:#82B366 style U fill:#D5E8D4,stroke:#82B366 style V fill:#FFF2CC,stroke:#D6B656 - click B href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onBeforeRender(org.pepstock.charba.client.IsChart)" "onBeforeRender" _blank - click E href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onBeforeDraw(org.pepstock.charba.client.IsChart)" "onBeforeDraw" _blank - click H href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onBeforeDatasetsDraw(org.pepstock.charba.client.IsChart)" "onBeforeDatasetsDraw" _blank - click L href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onAfterDraw(org.pepstock.charba.client.IsChart)" "onAfterDraw" _blank - click M href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onBeforeDatasetDraw(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginDatasetArgument)" "onBeforeDatasetDraw" _blank - click Q href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onAfterDatasetDraw(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginDatasetArgument)" "onAfterDatasetsDraw" _blank - click S href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onAfterDatasetsDraw(org.pepstock.charba.client.IsChart)" "onAfterDatasetDraw" _blank - click T href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onAfterRender(org.pepstock.charba.client.IsChart)" "onAfterRender" _blank - click U href "https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/Plugin.html#onEndDrawing(org.pepstock.charba.client.IsChart)" "onEndDrawing" _blank + click B href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onBeforeRender(org.pepstock.charba.client.IsChart)" "onBeforeRender" _blank + click E href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onBeforeDraw(org.pepstock.charba.client.IsChart)" "onBeforeDraw" _blank + click H href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onBeforeDatasetsDraw(org.pepstock.charba.client.IsChart)" "onBeforeDatasetsDraw" _blank + click L href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onAfterDraw(org.pepstock.charba.client.IsChart)" "onAfterDraw" _blank + click M href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onBeforeDatasetDraw(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginDatasetArgument)" "onBeforeDatasetDraw" _blank + click Q href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onAfterDatasetDraw(org.pepstock.charba.client.IsChart,org.pepstock.charba.client.items.PluginDatasetArgument)" "onAfterDatasetsDraw" _blank + click S href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onAfterDatasetsDraw(org.pepstock.charba.client.IsChart)" "onAfterDatasetDraw" _blank + click T href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onAfterRender(org.pepstock.charba.client.IsChart)" "onAfterRender" _blank + click U href "https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/Plugin.html#onEndDrawing(org.pepstock.charba.client.IsChart)" "onEndDrawing" _blank ``` ### Building scales @@ -633,10 +633,10 @@ The following hooks can be used to interact during the chart updating or reconfi | `Plugin` method | `SmartPlugin` hook | Description | :- | :- | :- -| onBeforeDataLimits | [BeforeDataLimitsHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeDataLimitsHook.html) | Called before scale data limits are calculated. This hook is called separately for each scale in the chart. -| onAfterDataLimits | [AfterDataLimitsHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterDataLimitsHook.html) | Called after scale data limits are calculated. This hook is called separately for each scale in the chart. -| onBeforeBuildTicks | [BeforeBuildTicksHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeBuildTicksHook.html) | Called before scale builds its ticks. This hook is called separately for each scale in the chart. -| onAfterBuildTicks | [AfterBuildTicksHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterBuildTicksHook.html) | Called after scale has build its ticks. This hook is called separately for each scale in the chart. +| onBeforeDataLimits | [BeforeDataLimitsHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeDataLimitsHook.html) | Called before scale data limits are calculated. This hook is called separately for each scale in the chart. +| onAfterDataLimits | [AfterDataLimitsHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterDataLimitsHook.html) | Called after scale data limits are calculated. This hook is called separately for each scale in the chart. +| onBeforeBuildTicks | [BeforeBuildTicksHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeBuildTicksHook.html) | Called before scale builds its ticks. This hook is called separately for each scale in the chart. +| onAfterBuildTicks | [AfterBuildTicksHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterBuildTicksHook.html) | Called after scale has build its ticks. This hook is called separately for each scale in the chart. ### Tooltip drawing @@ -646,8 +646,8 @@ The following hooks can be used to interact during the tooltip drawing: | `Plugin` method | `SmartPlugin` hook | Description | :- | :- | :- -| onBeforeTooltipDraw | [BeforeTooltipDrawHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeTooltipDrawHook.html) | Called before drawing the 'tooltip'. If any plugin returns false, the tooltip drawing is cancelled until another 'render' is triggered. -| onAfterTooltipDraw | [AfterTooltipDrawHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterTooltipDrawHook.html) | Called after drawing the 'tooltip'. Note that this hook will not be called if the tooltip drawing has been previously cancelled. +| onBeforeTooltipDraw | [BeforeTooltipDrawHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeTooltipDrawHook.html) | Called before drawing the 'tooltip'. If any plugin returns false, the tooltip drawing is cancelled until another 'render' is triggered. +| onAfterTooltipDraw | [AfterTooltipDrawHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterTooltipDrawHook.html) | Called after drawing the 'tooltip'. Note that this hook will not be called if the tooltip drawing has been previously cancelled. ### Events @@ -659,8 +659,8 @@ The following hooks can be used to interact during the canvas event process: | `Plugin` method | `SmartPlugin` hook | Description | :- | :- | :- -| onBeforeEvent | [BeforeEventHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeEventHook.html) | Called before processing the specified 'event'. If any plugin returns false, the event will be discarded. -| onAfterEvent | [AfterEventHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterEventHook.html) | Called after the 'event' has been consumed. Note that this hook will not be called if the 'event' has been previously discarded. +| onBeforeEvent | [BeforeEventHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeEventHook.html) | Called before processing the specified 'event'. If any plugin returns false, the event will be discarded. +| onAfterEvent | [AfterEventHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterEventHook.html) | Called after the 'event' has been consumed. Note that this hook will not be called if the 'event' has been previously discarded. ### Resizing, resetting and destroying @@ -678,7 +678,7 @@ The following hooks can be used to interact during the resize, reset and destroy | `Plugin` method | `SmartPlugin` hook | Description | :- | :- | :- -| onResize | [ResizeHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/ResizeHook.html) | Called after the chart as been resized. -| onReset | [ResetHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/ResetHook.html) | Called during chart reset. -| onBeforeDestroy | [BeforeDestroyHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/BeforeDestroyHook.html) | Called before the chart is being destroyed. -| onAfterDestroy | [AfterDestroyHook](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/plugins/hooks/AfterDestroyHook.html) | Called after the chart has been destroyed. +| onResize | [ResizeHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/ResizeHook.html) | Called after the chart as been resized. +| onReset | [ResetHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/ResetHook.html) | Called during chart reset. +| onBeforeDestroy | [BeforeDestroyHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/BeforeDestroyHook.html) | Called before the chart is being destroyed. +| onAfterDestroy | [AfterDestroyHook](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/plugins/hooks/AfterDestroyHook.html) | Called after the chart has been destroyed. diff --git a/docs/plugins/Pointer.md b/docs/plugins/Pointer.md index 8f1cdec8..e4b3fc75 100644 --- a/docs/plugins/Pointer.md +++ b/docs/plugins/Pointer.md @@ -8,11 +8,11 @@ sidebar_label: Chart cursor **Charba** provides a plugin implementation to set the cursor of the chart when a chart and clickable element is hovered. -The goal is to change the style of [cursor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/CursorType.html) to highlight that the element could be clickable. +The goal is to change the style of [cursor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/CursorType.html) to highlight that the element could be clickable. This plugin, as singleton, can be set both at global and at chart level. -The implementation is [ChartPointer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ChartPointer.html) and can be set as following: +The implementation is [ChartPointer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ChartPointer.html) and can be set as following: ```java // --------------------------------- @@ -25,13 +25,13 @@ Defaults.get().getPlugins().register(ChartPointer.get()); chart.getPlugins().add(ChartPointer.get()); ``` -The ID of plugin is `charbacursorpointer` ([ChartPointer.ID](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ChartPointer.html#ID)). +The ID of plugin is `charbacursorpointer` ([ChartPointer.ID](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ChartPointer.html#ID)). ## Options It could be that you set this plugin as global one for all your charts but you want to change it for only one instance. -In this case you should instantiate a [ChartPointerOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ChartPointerOptions.html) and set it to your chart options as following, setting the color you want: +In this case you should instantiate a [ChartPointerOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ChartPointerOptions.html) and set it to your chart options as following, setting the color you want: ```java // creates a plugin options @@ -69,7 +69,7 @@ Defaults.get().getGlobal().getPlugin().setOptions(options); options.store(); ``` -If you need to read the plugin options, there is the specific factory, [ChartPointerOptionsFactory](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ChartPointerOptionsFactory.html) as static reference inside the [plugin](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/ChartPointer.html) which can be used to retrieve the options from chart, as following: +If you need to read the plugin options, there is the specific factory, [ChartPointerOptionsFactory](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ChartPointerOptionsFactory.html) as static reference inside the [plugin](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/ChartPointer.html) which can be used to retrieve the options from chart, as following: ```java // gets options reference @@ -90,8 +90,8 @@ The following are the attributes that you can set to plugin options: | Name | Type | Default | Description | :- | :- | :- | :- -| cursorPointer | [CursorType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/CursorType.html) | CursorType.POINTER | Cursor style applied to the canvas when is hovering a clickable element. -| elements | [PointerElement](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/enums/PointerElement.html) | PointerElement.DATASET, PointerElement.TITLE, PointerElement.SUBTITLE, PointerElement.AXES, PointerElement.LEGEND | Chart elements where the cursor pointer will be applied if the element is hovered. +| cursorPointer | [CursorType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/CursorType.html) | CursorType.POINTER | Cursor style applied to the canvas when is hovering a clickable element. +| elements | [PointerElement](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/enums/PointerElement.html) | PointerElement.DATASET, PointerElement.TITLE, PointerElement.SUBTITLE, PointerElement.AXES, PointerElement.LEGEND | Chart elements where the cursor pointer will be applied if the element is hovered. By `elements` array property, you can decide on which chart elements the cursor pointer will be applied. @@ -99,10 +99,10 @@ Apart for `PointerElement.LEGEND`, that is always clickable, for all the others | Element | Handler | :- | :- -| PointerElement.DATASET | [DatasetSelectionEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/DatasetSelectionEventHandler.html) -| PointerElement.TITLE | [TitleClickEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/TitleClickEventHandler.html) -| PointerElement.SUBTITLE | [SubtitleClickEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/SubtitleClickEventHandler.html) -| PointerElement.AXES | [AxisClickEventHandler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/events/AxisClickEventHandler.html) +| PointerElement.DATASET | [DatasetSelectionEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/DatasetSelectionEventHandler.html) +| PointerElement.TITLE | [TitleClickEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/TitleClickEventHandler.html) +| PointerElement.SUBTITLE | [SubtitleClickEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/SubtitleClickEventHandler.html) +| PointerElement.AXES | [AxisClickEventHandler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/events/AxisClickEventHandler.html) ## Options builder diff --git a/docs/plugins/tables/ColorSchemeBrewer.md b/docs/plugins/tables/ColorSchemeBrewer.md index d438b1e4..c315c96e 100644 --- a/docs/plugins/tables/ColorSchemeBrewer.md +++ b/docs/plugins/tables/ColorSchemeBrewer.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Brewer color scheme -The BREWER color schemes are stored in [BrewerScheme](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/enums/BrewerScheme.html) enumeration. +The BREWER color schemes are stored in [BrewerScheme](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/enums/BrewerScheme.html) enumeration. | Name | Scheme | | :--- | :--- | diff --git a/docs/plugins/tables/ColorSchemeGwtMaterial.md b/docs/plugins/tables/ColorSchemeGwtMaterial.md index 8acae65e..b4f60594 100644 --- a/docs/plugins/tables/ColorSchemeGwtMaterial.md +++ b/docs/plugins/tables/ColorSchemeGwtMaterial.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## GWT Material color scheme -The GWT Material color schemes are stored in [GwtMaterialScheme](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/enums/GwtMaterialScheme.html) enumeration. +The GWT Material color schemes are stored in [GwtMaterialScheme](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/enums/GwtMaterialScheme.html) enumeration. | Name | Scheme | | :- | :- | diff --git a/docs/plugins/tables/ColorSchemeOffice.md b/docs/plugins/tables/ColorSchemeOffice.md index 406bc4c8..cd233a89 100644 --- a/docs/plugins/tables/ColorSchemeOffice.md +++ b/docs/plugins/tables/ColorSchemeOffice.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Office color scheme -The OFFICE color schemes are stored in [OfficeScheme](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/enums/OfficeScheme.html) enumeration. +The OFFICE color schemes are stored in [OfficeScheme](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/enums/OfficeScheme.html) enumeration. | Name | Scheme | | :- | :- | diff --git a/docs/plugins/tables/ColorSchemeTableau.md b/docs/plugins/tables/ColorSchemeTableau.md index 2066d65a..8c3c4458 100644 --- a/docs/plugins/tables/ColorSchemeTableau.md +++ b/docs/plugins/tables/ColorSchemeTableau.md @@ -8,7 +8,7 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; ## Tableau color scheme -The TABLEAU color schemes are stored in [TableauScheme](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/impl/plugins/enums/TableauScheme.html) enumeration. +The TABLEAU color schemes are stored in [TableauScheme](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/impl/plugins/enums/TableauScheme.html) enumeration. | Name | Scheme | | :- | :- | diff --git a/docs/utilities/AnnotationBuilder.md b/docs/utilities/AnnotationBuilder.md index eb8513df..79a8d4c9 100644 --- a/docs/utilities/AnnotationBuilder.md +++ b/docs/utilities/AnnotationBuilder.md @@ -10,11 +10,11 @@ import useBaseUrl from '@docusaurus/useBaseUrl'; One of most frequent requests is how to add HTML code in the canvas. This enables the user to add easily information in the chart, leveraging on HTML code. -[HTML annotation Builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/AnnotationBuilder.html) provides methods to create images to add to canvas where the chart is drawing. It is leveraging on `SVG+XML` and `` to create an image that you can add to the chart by a plugin, controller or with whatever else method. +[HTML annotation Builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/AnnotationBuilder.html) provides methods to create images to add to canvas where the chart is drawing. It is leveraging on `SVG+XML` and `` to create an image that you can add to the chart by a plugin, controller or with whatever else method. Leveraging on ``, check [here](https://developer.mozilla.org/en-US/docs/Web/SVG/Element/foreignObject#Browser_compatibility) the compatibility matrix on browsers. -You can pass the HTML as string or by an [element](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/BaseHtmlElement.html). If you use a string, the string must be XML well-formed, following the [xHTML specification](http://www.w3.org/1999/xhtml) otherwise an exception will occurs. +You can pass the HTML as string or by an [element](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/BaseHtmlElement.html). If you use a string, the string must be XML well-formed, following the [xHTML specification](http://www.w3.org/1999/xhtml) otherwise an exception will occurs. diff --git a/docs/utilities/Javascript.md b/docs/utilities/Javascript.md index 4a22efa5..f7843060 100644 --- a/docs/utilities/Javascript.md +++ b/docs/utilities/Javascript.md @@ -16,9 +16,9 @@ The javascript utilities can be used even if the [**Charba.enable**](../getting- ## Scheduler -The [scheduler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/CScheduler.html) utility executes a particular block of code once after a specified time has elapsed. +The [scheduler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/CScheduler.html) utility executes a particular block of code once after a specified time has elapsed. -The logic that you pass to the [scheduler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/CScheduler.html) will run at some point in the future. +The logic that you pass to the [scheduler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/CScheduler.html) will run at some point in the future. ```java // creates and submits my task @@ -45,7 +45,7 @@ CScheduler.get().submit(new Runnable(){ ## Timer -The [timer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/CTimer.html) utility executes a particular block of code repeatedly at no less than the number of milliseconds. +The [timer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/CTimer.html) utility executes a particular block of code repeatedly at no less than the number of milliseconds. ```java // creates a timer with user logic @@ -66,14 +66,14 @@ timer.start(); ### Starting -A [timer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/CTimer.html) will execute a particular block of code repeatedly after it has been started. +A [timer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/CTimer.html) will execute a particular block of code repeatedly after it has been started. ```java // starts timer timer.start(); ``` -You can change the interval of an existing [timer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/CTimer.html), restarting it with new interval to use: +You can change the interval of an existing [timer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/CTimer.html), restarting it with new interval to use: ```java // starts timer @@ -84,7 +84,7 @@ timer.start(10000); ### Stopping -A [timer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/CTimer.html) can be stopped when you want to stop temporarily the execution or if it's not needed anymore. +A [timer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/CTimer.html) can be stopped when you want to stop temporarily the execution or if it's not needed anymore. ```java // stops timer @@ -95,9 +95,9 @@ timer.stop(); In order to keep the chart up to date, you sometimes want to perform an update periodically. You might want to run a poll to the server for new data and update the chart. -The [chart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/AbstractChart.html) provides a method to configure the timer for the chart instance. +The [chart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/AbstractChart.html) provides a method to configure the timer for the chart instance. -The [timer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/CTimer.html) will start executing the block of code repeatedly after the chart drawing and will e stopped when chart will be destroyed. +The [timer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/CTimer.html) will start executing the block of code repeatedly after the chart drawing and will e stopped when chart will be destroyed. ```java // creates the chart @@ -122,9 +122,9 @@ chart.createAndSetTimer(new ChartTimerTask(){ }, 10000); ``` -The [chart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/AbstractChart.html) needs a [specific task interface](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/ChartTimerTask.html) to apply the logic. +The [chart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/AbstractChart.html) needs a [specific task interface](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/ChartTimerTask.html) to apply the logic. -The [chart](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/AbstractChart.html) provides the access in order to stop and start the [timer](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/CTimer.html) when you need. +The [chart](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/AbstractChart.html) provides the access in order to stop and start the [timer](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/CTimer.html) when you need. ```java // creates the chart @@ -141,7 +141,7 @@ if (timer != null){ ## Window -**Charba** provides a JavaScript [window wrapper](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/Window.html). +**Charba** provides a JavaScript [window wrapper](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/Window.html). [JavaScript Window](https://developer.mozilla.org/en-US/docs/Web/API/Window) is a global variable, representing the window in which the script is running. @@ -156,7 +156,7 @@ double devicePixelRatio = Window.getDevicePixelRatio(); One of the method of [Window](https://developer.mozilla.org/en-US/docs/Web/API/Window) object, returns the [console](https://developer.mozilla.org/en-US/docs/Web/API/console). -**Charba** provides the [console](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/Console.html) object as shortcut to that window service. +**Charba** provides the [console](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/Console.html) object as shortcut to that window service. The console provides access to the browser's debugging console. The specifics of how it works varies from browser to browser, but there is a de facto set of features that are typically provided. @@ -171,7 +171,7 @@ Console.log(object1, object2, object3); The [JSON](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/JSON) object contains methods for converting objects to JSON and JSON string to objects. -**Charba** provides an [implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/JSON.html) with the methods and capabilities to use in your GWT or J2CL project. +**Charba** provides an [implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/JSON.html) with the methods and capabilities to use in your GWT or J2CL project. ```java // gets and logs the object in JSON format @@ -188,7 +188,7 @@ Console.log(JSON.parse("{ test: 8, doc: true}", 3)); [Regular expressions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/RegExp) are patterns used to match character combinations in strings. -**Charba** provides an [implementation](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/RegExp.html) with a subset of methods and capabilities to use in your GWT or J2CL project. +**Charba** provides an [implementation](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/RegExp.html) with a subset of methods and capabilities to use in your GWT or J2CL project. ```java // gets a string to check diff --git a/docs/utilities/Toast.md b/docs/utilities/Toast.md index f6856565..3316f9fe 100644 --- a/docs/utilities/Toast.md +++ b/docs/utilities/Toast.md @@ -100,7 +100,7 @@ Toaster.get().show(options, "This is my toast title", Both title and label can contain HTML code. -The `show` method is returning a [status](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/enums/Status.html) instance which report if the toast is showing, on queue, invalid or discard. +The `show` method is returning a [status](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/enums/Status.html) instance which report if the toast is showing, on queue, invalid or discard. ```java // shows a toast with default type and without title @@ -146,7 +146,7 @@ chart.addHandler(new DatasetSelectionEventHandler() { ## Options -The toast utility allows to define the properties that a toast could have to render the toast, by a [toast options](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ToastOptions.html). +The toast utility allows to define the properties that a toast could have to render the toast, by a [toast options](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ToastOptions.html). ```java // creates a toast options @@ -171,22 +171,22 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| actions | [ActionItem](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ActionItem.html)[] | [] | Set the custom action to show in the toast.
See [actions section](#actions) for details. -| align | [Align](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/enums/Align.html) | Align.LEFT | Set the alignment of the toast actions. +| actions | [ActionItem](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ActionItem.html)[] | [] | Set the custom action to show in the toast.
See [actions section](#actions) for details. +| align | [Align](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/enums/Align.html) | Align.LEFT | Set the alignment of the toast actions. | autoHide | boolean | `true` | Set to `false` to avoid that the toast will disappear automatically. To close it, you must click on the toast. | borderRadius | int | 8 | The border radius of the toast element. | hideProgressBar | boolean | `false` | Set to `true` to hide the progress bar on the toast element. | hideShadow | boolean | `false` | Set to `true` to hide the shadow on the toast element. -| icon | [Img](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Img.html) | `null` | To add an icon on the toast. -| modifierKey | [ModifierKey](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/enums/ModifierKey.html) | `null` | Keyboard modifier key which must be pressed to enable the closure of the toast clicking on it. +| icon | [Img](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Img.html) | `null` | To add an icon on the toast. +| modifierKey | [ModifierKey](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/enums/ModifierKey.html) | `null` | Keyboard modifier key which must be pressed to enable the closure of the toast clicking on it. | progressBarHeight | int | 3 | The height of progress bar in pixels. -| progressBarType | [IsProgressBarType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/IsProgressBarType.html) | DefaultProgressBarType.DEFAULT | The type of the progress bar to show on the toast element. +| progressBarType | [IsProgressBarType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/IsProgressBarType.html) | DefaultProgressBarType.DEFAULT | The type of the progress bar to show on the toast element. | timeout | int | 4000 | The duration of toast, after that the toast will be hide automatically, according with `autoHide` option. -| type | [IsToastType](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/IsToastType.html) | DefaultToastType.DEFAULT | The type of the toast. +| type | [IsToastType](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/IsToastType.html) | DefaultToastType.DEFAULT | The type of the toast. ### Defaults -You can set default options to use for all toasts you want to show in your application, without replicating the same configuration on several part of the application, by the [default toast options](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/DefaultToastOptions.html), accessible by the [toaster](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/Toaster.html). +You can set default options to use for all toasts you want to show in your application, without replicating the same configuration on several part of the application, by the [default toast options](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/DefaultToastOptions.html), accessible by the [toaster](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/Toaster.html). ```java // gets the default toast options @@ -209,7 +209,7 @@ Based on the toast structure, you can set 3 different kinds of options to render ### Title -The [toast title](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/Title.html) is a text which is located on the top of toast in order to provide a synthetic information about the toast. +The [toast title](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/Title.html) is a text which is located on the top of toast in order to provide a synthetic information about the toast. ```java // creates a toast options @@ -226,12 +226,12 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | #616161 -          | Set the font color of title content. Setting it, you override the color that a [toast type](#type) has been configured to use. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | see description | Font of text of title.
The default font of the title has got the `weight` set to `Weight.BOLD` and the `size` to `15`.
See [Font](../defaults/DefaultsCharts#font). +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | #616161 -          | Set the font color of title content. Setting it, you override the color that a [toast type](#type) has been configured to use. +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | see description | Font of text of title.
The default font of the title has got the `weight` set to `Weight.BOLD` and the `size` to `15`.
See [Font](../defaults/DefaultsCharts#font). ### Label -The [toast label](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/Label.html) is a text which is located on the bottom of toast in order to provide the message to the user. +The [toast label](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/Label.html) is a text which is located on the bottom of toast in order to provide the message to the user. ```java // creates a toast options @@ -248,12 +248,12 @@ The following are the attributes that you can set: | Name | Type | Default | Description | :- | :- | :- | :- -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | #616161 -          | Set the font color of label content. Setting it, you override the color that a [toast type](#type) has been configured to use. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | see description | Font of text of label.
The default font of the title has got the `lineHeight` set to `20px` and the `size` to `14`.
See [Font](../defaults/DefaultsCharts#font). +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | #616161 -          | Set the font color of label content. Setting it, you override the color that a [toast type](#type) has been configured to use. +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | see description | Font of text of label.
The default font of the title has got the `lineHeight` set to `20px` and the `size` to `14`.
See [Font](../defaults/DefaultsCharts#font). ### Action -The [toast action](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/Action.html) is a list of clickable elements which is located on the bottom of toast, below the label, in order to allow the user to perform specific actions from the toast. +The [toast action](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/Action.html) is a list of clickable elements which is located on the bottom of toast, below the label, in order to allow the user to perform specific actions from the toast. ```java // creates a toast options @@ -270,13 +270,13 @@ The following are the attributes that you can set in order to apply the configur | Name | Type | Default | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | Set the background color of the configured actions elements. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | Set the border color of the configured actions elements. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | Set the background color of the configured actions elements. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | Set the border color of the configured actions elements. | borderRadius | int | 0 | Set the border radius of the configured actions elements. -| borderStyle | [BorderStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/BorderStyle.html) | BorderStyle.NONE | Set the border style of the configured actions elements. +| borderStyle | [BorderStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/BorderStyle.html) | BorderStyle.NONE | Set the border style of the configured actions elements. | borderWidth | int | 0 | Set the border width of the configured actions elements. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | #616161 -          | Set the font color of toast action element. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | see description | Font of text of toast action element.
The default font of the actions have got the `lineHeight` set to `20px` and the `size` to `14`.
See [Font](../defaults/DefaultsCharts#font). +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | #616161 -          | Set the font color of toast action element. +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | see description | Font of text of toast action element.
The default font of the actions have got the `lineHeight` set to `20px` and the `size` to `14`.
See [Font](../defaults/DefaultsCharts#font). See [actions section](#actions) how you can set your toast actions and override the above options. @@ -300,7 +300,7 @@ options.setType(DefaultToastType.INFO); Status status = Toaster.get().show(options, "This is my toast title", "This is my toast content"); ``` -There are some types provided out of the box, by the [default type enumeration](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/enums/DefaultToastType.html). +There are some types provided out of the box, by the [default type enumeration](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/enums/DefaultToastType.html). The following table shows the different colors for each default type. @@ -315,7 +315,7 @@ The following table shows the different colors for each default type. ### Custom type -Where the default types are not enough and you want to use own colors for your toast, you can create your own type, by a [toast type builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ToastTypeBuilder.html). +Where the default types are not enough and you want to use own colors for your toast, you can create your own type, by a [toast type builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ToastTypeBuilder.html).

@@ -344,7 +344,7 @@ options.setType(myType); Status status = Toaster.get().show(options, "This is my toast title", "This is my toast content"); ``` -A custom type can be created using [Pattern](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Pattern.html) or [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) as background. +A custom type can be created using [Pattern](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Pattern.html) or [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) as background. :::caution The name of the type must follow the following rule, otherwise an exception will occur: @@ -366,7 +366,7 @@ options.setProgressBarType(DefaultProgressBarType.ERROR); Toaster.get().show(options, "This is my toast title", "This is my toast content"); ``` -There are some progress bar types provided out of the box, by the [default type enumeration](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/enums/DefaultProgressBarType.html). +There are some progress bar types provided out of the box, by the [default type enumeration](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/enums/DefaultProgressBarType.html). The following table shows the different colors for each default type. @@ -381,7 +381,7 @@ The following table shows the different colors for each default type. ### Custom progress bar type -Where the default progress bar types are not enough and you want to use own colors for your bar, you can create your own type, by a [toast progress bar type builder](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ProgressBarTypeBuilder.html). +Where the default progress bar types are not enough and you want to use own colors for your bar, you can create your own type, by a [toast progress bar type builder](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ProgressBarTypeBuilder.html).

@@ -402,7 +402,7 @@ options.setProgressBarType(myType); Toaster.get().show(options, "This is my toast title", "This is my toast content"); ``` -A custom progress bar type can be created using [Gradient](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/Gradient.html) as background. +A custom progress bar type can be created using [Gradient](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/Gradient.html) as background. :::caution The name of the type must follow the following rule, otherwise an exception will occur: @@ -416,11 +416,11 @@ Actions make your toast interactive, letting the user take quick actions on your Actions appear in the expanded portion of your notification. -An [action](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ActionItem.html) can be composed by the following items: +An [action](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ActionItem.html) can be composed by the following items: * **id**, is an optional item, to have a unique name of the instance. If not set, an automatic id is calculated. * **content**, is an optional item, to set the content to show in the toast. If not set, the id is used as content. - * **handler**, is an [mandatory item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/handlers/ActionClickEventHandler.html), to set the callback to use when the action is clicked. + * **handler**, is an [mandatory item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/handlers/ActionClickEventHandler.html), to set the callback to use when the action is clicked. ```java // creates my action with id and content @@ -454,7 +454,7 @@ Toaster.get().show(options, "This is my toast (with an action) content");

-A [action click handler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/handlers/ActionClickEventHandler.html) must return a boolean in order to close the toast when action is clicked (returning `true`) or leave the toast to be close naturally at the end of timeout (returning `false`). +A [action click handler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/handlers/ActionClickEventHandler.html) must return a boolean in order to close the toast when action is clicked (returning `true`) or leave the toast to be close naturally at the end of timeout (returning `false`). :::caution The id of the action must follow the following rule, otherwise an exception will occur: @@ -499,13 +499,13 @@ The following table shows the different colors for each default type. | Name | Type | Default | Description | :- | :- | :- | :- -| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | Set the background color of the configured action element. -| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | Set the border color of the configured action element. +| backgroundColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | Set the background color of the configured action element. +| borderColor | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | HtmlColor.TRANSPARENT | Set the border color of the configured action element. | borderRadius | int | 0 | Set the border radius of the configured action element. -| borderStyle | [BorderStyle](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/enums/BorderStyle.html) | BorderStyle.NONE | Set the border style of the configured action element. +| borderStyle | [BorderStyle](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/enums/BorderStyle.html) | BorderStyle.NONE | Set the border style of the configured action element. | borderWidth | int | 0 | Set the border width of the configured action element. -| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/colors/IsColor.html) | #616161 -          | Set the font color of toast action element. -| font | [IsFont](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/options/IsFont.html) | see description | Font of text of toast action element.
The default font of the actions have got the `lineHeight` set to `20px` and the `size` to `14`.
See [Font](../defaults/DefaultsCharts#font). +| color | String - [IsColor](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/colors/IsColor.html) | #616161 -          | Set the font color of toast action element. +| font | [IsFont](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/options/IsFont.html) | see description | Font of text of toast action element.
The default font of the actions have got the `lineHeight` set to `20px` and the `size` to `14`.
See [Font](../defaults/DefaultsCharts#font). ## Handlers @@ -519,7 +519,7 @@ The status or actions are: ### Open handler -The [open handler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/handlers/OpenHandler.html) is triggered when a toast is open and shown on the user interface. +The [open handler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/handlers/OpenHandler.html) is triggered when a toast is open and shown on the user interface. ```java // creates a toast options @@ -542,11 +542,11 @@ options.setOpenHandler(new OpenHandler(){ Toaster.get().show(options, "This is my toast title", "This is my toast content"); ``` -The handler provides a [toast item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ToastItem.html) which contains all options of the toast and additional information related to the runtime context where the toast is shown. See [here](#toast-item) the [toast item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ToastItem.html) details. +The handler provides a [toast item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ToastItem.html) which contains all options of the toast and additional information related to the runtime context where the toast is shown. See [here](#toast-item) the [toast item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ToastItem.html) details. ### Close handler -The [close handler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/handlers/CloseHandler.html) is triggered when a toast is close and removed from the user interface. +The [close handler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/handlers/CloseHandler.html) is triggered when a toast is close and removed from the user interface. ```java // creates a toast options @@ -570,13 +570,13 @@ options.setCloseHandler(new CloseHandler(){ Toaster.get().show(options, "This is my toast title", "This is my toast content"); ``` -The handler provides a [toast item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ToastItem.html) which contains all options of the toast and additional information related to the runtime context where the toast was shown and the [action item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ActionItem.html), the toast has been closed clicking on a actioin. +The handler provides a [toast item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ToastItem.html) which contains all options of the toast and additional information related to the runtime context where the toast was shown and the [action item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ActionItem.html), the toast has been closed clicking on a actioin. -See [here](#toast-item) the [toast item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ToastItem.html) details.
See [here](#actions) the [action item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ActionItem.html) details. +See [here](#toast-item) the [toast item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ToastItem.html) details.
See [here](#actions) the [action item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ActionItem.html) details. ### Click event handler -The [click event handler](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/handlers/ClickEventHandler.html) is triggered when a click event is fired on the shown toast in the user interface. +The [click event handler](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/handlers/ClickEventHandler.html) is triggered when a click event is fired on the shown toast in the user interface. ```java // creates a toast options @@ -600,7 +600,7 @@ options.setClickEventHandler(new ClickEventHandler(){ Toaster.get().show(options, "This is my toast title", "This is my toast content"); ``` -The handler provides a [toast item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ToastItem.html) which contains all options of the toast and additional information related to the runtime context where the toast was shown and the event fired on the toast. See [here](#toast-item) the [toast item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ToastItem.html) details. +The handler provides a [toast item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ToastItem.html) which contains all options of the toast and additional information related to the runtime context where the toast was shown and the event fired on the toast. See [here](#toast-item) the [toast item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ToastItem.html) details. ## Maximum shown notifications @@ -608,7 +608,7 @@ The toast utility provides the capability to limit the amount of toast you want This is because many toasts could waste the user interface making it chaotic. -You can decide how to manage new message to show when the maximum amount of open toasts is already reached, by the 2 policies, enumerated by [maximum open items policy](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/enums/MaximumOpenItemsPolicy.html). +You can decide how to manage new message to show when the maximum amount of open toasts is already reached, by the 2 policies, enumerated by [maximum open items policy](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/enums/MaximumOpenItemsPolicy.html). * `MaximumOpenItemsPolicy.QUEUE`, as **default**, when new message is requested to be shown, the message is put in a queue and when the open items will be close, it will show. * `MaximumOpenItemsPolicy.DISCARD`, when new message is requested to be shown, the message is discard and never shown. @@ -621,7 +621,7 @@ Toaster.get().setMaxOpenItemsPolicy(MaximumOpenItemsPolicy.QUEUE); Toaster.get().setMaxOpenItemsPolicy(MaximumOpenItemsPolicy.DISCARD); ``` -By default, the maximum amount of open toast is **`100`** and you can not increment it. But you can decrease this value, by the [toaster](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/Toaster.html). And the minimum amount is **`1`** because at least 1 toast must be shown. +By default, the maximum amount of open toast is **`100`** and you can not increment it. But you can decrease this value, by the [toaster](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/Toaster.html). And the minimum amount is **`1`** because at least 1 toast must be shown. ```java // reduces the amount of open toasts @@ -636,7 +636,7 @@ When new message is requested to be shown but there are already the maximum amou ## History The toast utility can store in a local history a certain amount of toast (in FIFO approach), shown during the application utilization, in order to provide to the user visibility on all notifications you received. -By default, the history is not enabled but it can, setting the amount of messages you want to maintain, by the [toaster](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/Toaster.html). +By default, the history is not enabled but it can, setting the amount of messages you want to maintain, by the [toaster](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/Toaster.html). ```java // ------------------------- @@ -652,7 +652,7 @@ Toaster.get().setMaxHistoryItems(20); Toaster.get().setMaxHistoryItems(0); ``` -The [toaster](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/Toaster.html) provides the list of toast items in the history in order to enable to create an own panel where to show all the toast items. +The [toaster](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/Toaster.html) provides the list of toast items in the history in order to enable to create an own panel where to show all the toast items. ```java // gets the toast history @@ -661,19 +661,19 @@ List history = Toaster.get().getHistoryItems(); ### Toast item -The history provides a unmodifiable list of a [toast item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ToastItem.html). +The history provides a unmodifiable list of a [toast item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ToastItem.html). -A [toast item](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ToastItem.html) contains all the options of a [toast options](#options) and in addition the following ones, result of the context where the toast has been shows. +A [toast item](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ToastItem.html) contains all the options of a [toast options](#options) and in addition the following ones, result of the context where the toast has been shows. | Name | Type | Description | :- | :- | :- | context | Map | The context of the toast invocation, containing the meta data to consume by the configured handlers. | dateTime | java.util.Date | Every change status and action invocation is recorded with the date time when occurs. If the toast haven't recorded the passed status or the passed action, returns `null` -| element | [Div](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/dom/elements/Div.html) | The DOM element of the shown toast.
Returns a consistent HTML element only when the toast is closed. +| element | [Div](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/dom/elements/Div.html) | The DOM element of the shown toast.
Returns a consistent HTML element only when the toast is closed. | id | int | The unique id of the toast. | label | String | `null` | The text of the toast label. Can contain HTML code. -| options | [ToastItemOptions](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ToastItemOptions.html) | The immutable options used to emit the toast. -| status | [Status](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/enums/Status.html) | The last status of the toast. +| options | [ToastItemOptions](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ToastItemOptions.html) | The immutable options used to emit the toast. +| status | [Status](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/enums/Status.html) | The last status of the toast. | title | String | `null` | The text of the toast title. Can contain HTML code. The toast records when the status is changed and when an action has been invoked, clicking on that. @@ -708,7 +708,7 @@ Toaster.get().hideOpenItems(false); ## Options builder -**Charba** provides a builder to create options using the **set** methods in sequence and get the [toast options](https://pepstock-org.github.io/Charba/6.4/org/pepstock/charba/client/utils/toast/ToastOptions.html) at the end of configuration, by `build` method. +**Charba** provides a builder to create options using the **set** methods in sequence and get the [toast options](https://pepstock-org.github.io/Charba/6.5/org/pepstock/charba/client/utils/toast/ToastOptions.html) at the end of configuration, by `build` method. ```java // creates a simple toast options and shows it diff --git a/docusaurus.config.js b/docusaurus.config.js index 5710e036..4a8a91db 100644 --- a/docusaurus.config.js +++ b/docusaurus.config.js @@ -91,7 +91,7 @@ module.exports = { lastVersion: 'current', versions: { current: { - label: 'Next 6.5 🚧', + label: '6.5', }, }, }, diff --git a/sidebars.js b/sidebars.js index ebe78776..fb0587a3 100644 --- a/sidebars.js +++ b/sidebars.js @@ -96,12 +96,12 @@ module.exports = { }, { "type": "link", - "href": "https://github.com/pepstock-org/Charba/releases/tag/6.4", + "href": "https://github.com/pepstock-org/Charba/releases/tag/6.5", "label": "Release note" }, { "type": "link", - "href": "https://pepstock-org.github.io/Charba/6.4/index.html", + "href": "https://pepstock-org.github.io/Charba/6.5/index.html", "label": "Javadoc API" } ], diff --git a/static/img/charba_jar_trend_65.png b/static/img/charba_jar_trend_65.png new file mode 100644 index 00000000..fd7d62e6 Binary files /dev/null and b/static/img/charba_jar_trend_65.png differ