@arcgis/common-components 5.1.0-next.17 → 5.1.0-next.18
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/components/arcgis-histogram/customElement.d.ts +10 -10
- package/dist/components/arcgis-slider/customElement.d.ts +1 -1
- package/dist/docs/api.json +1 -1
- package/dist/docs/docs.json +1 -1
- package/dist/docs/vscode.html-custom-data.json +1 -1
- package/dist/docs/web-types.json +1 -1
- package/package.json +3 -3
|
@@ -5,7 +5,7 @@ import type { PublicLitElement as LitElement } from "@arcgis/lumina";
|
|
|
5
5
|
import type { T9nMeta } from "@arcgis/lumina/controllers";
|
|
6
6
|
|
|
7
7
|
/**
|
|
8
|
-
* Renders a histogram to visualize the spread of a dataset based on [bins](
|
|
8
|
+
* Renders a histogram to visualize the spread of a dataset based on [bins](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#bins) representing buckets, or sub-ranges, of
|
|
9
9
|
* data. Each [bin](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/types/#HistogramBin) is defined by a minimum and maximum value and a total count.
|
|
10
10
|
*
|
|
11
11
|
* You can generate the underlying histogram's bins with the [histogram](https://developers.arcgis.com/javascript/latest/references/core/smartMapping/statistics/histogram/)
|
|
@@ -27,19 +27,19 @@ import type { T9nMeta } from "@arcgis/lumina/controllers";
|
|
|
27
27
|
* histogramElement.max = results.maxValue;
|
|
28
28
|
* ```
|
|
29
29
|
*
|
|
30
|
-
* Other properties of this component allow you to display meaningful values on the histogram, such as the [average](
|
|
31
|
-
* [
|
|
30
|
+
* Other properties of this component allow you to display meaningful values on the histogram, such as the [average](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#average),
|
|
31
|
+
* [standardDeviation](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#standardDeviation), and the [dataLines](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#dataLines) properties.
|
|
32
32
|
*
|
|
33
|
-
* The [layout](
|
|
33
|
+
* The [layout](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#layout) property allows you to set the orientation of the histogram, and the [colorStops](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#colorStops)
|
|
34
34
|
* property allows you to set a gradient or color scheme for the histogram bars.
|
|
35
35
|
*
|
|
36
36
|
* See the image below for a summary of the configurable options available on the histogram.
|
|
37
37
|
*
|
|
38
|
-
* 
|
|
39
39
|
*
|
|
40
|
-
* The [colorStops](
|
|
40
|
+
* The [colorStops](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#colorStops) property may be used to define a color scheme for the histogram bars.
|
|
41
41
|
*
|
|
42
|
-
* 
|
|
43
43
|
*
|
|
44
44
|
* @cssproperty [--arcgis-histogram-bar-color] - Specifies the color of the histogram bars when the bin doesn't have a corresponding color stop.
|
|
45
45
|
* @cssproperty [--arcgis-histogram-stop-color] - Specifies the default color for color stops.
|
|
@@ -107,7 +107,7 @@ export abstract class ArcgisHistogram extends LitElement {
|
|
|
107
107
|
* When set to `true`, overlapping classed color stops will be blended together to create the color of the bar.
|
|
108
108
|
* This allows to show a if a bar representing a bin overlaps with multiple classed color stops.
|
|
109
109
|
*
|
|
110
|
-
* This property is only applicable when the [colorStops](
|
|
110
|
+
* This property is only applicable when the [colorStops](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#colorStops) property is set to classed color stops.
|
|
111
111
|
*
|
|
112
112
|
* @default false
|
|
113
113
|
*/
|
|
@@ -200,7 +200,7 @@ export abstract class ArcgisHistogram extends LitElement {
|
|
|
200
200
|
accessor layout: HistogramLayout;
|
|
201
201
|
/**
|
|
202
202
|
* The maximum value or bound of the entire histogram. This
|
|
203
|
-
* should match the maximum bound of the last [
|
|
203
|
+
* should match the maximum bound of the last [bins](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#bins).
|
|
204
204
|
*
|
|
205
205
|
* @example
|
|
206
206
|
* ```js
|
|
@@ -224,7 +224,7 @@ export abstract class ArcgisHistogram extends LitElement {
|
|
|
224
224
|
};
|
|
225
225
|
/**
|
|
226
226
|
* The minimum value or bound of the entire histogram. This
|
|
227
|
-
* should match the minimum bound of the first [
|
|
227
|
+
* should match the minimum bound of the first [bins](https://developers.arcgis.com/javascript/latest/references/common-components/components/arcgis-histogram/#bins).
|
|
228
228
|
*
|
|
229
229
|
* @example
|
|
230
230
|
* ```js
|
|
@@ -354,7 +354,7 @@ export abstract class ArcgisSlider extends LitElement {
|
|
|
354
354
|
* when the user clicks a thumb value label. This allows the user to move the slider
|
|
355
355
|
* thumb to precise values without sliding the thumbs.
|
|
356
356
|
*
|
|
357
|
-
* 
|
|
358
358
|
*
|
|
359
359
|
* @default false
|
|
360
360
|
*/
|