@arcgis/charts-components 5.1.0-next.8 → 5.1.0-next.80
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/README.md +2 -2
- package/dist/cdn/2EFFPZSB.js +2 -0
- package/dist/cdn/{SM4LQF5M.js → 2NN5AE5D.js} +1 -1
- package/dist/cdn/3AIE3FUA.js +2 -0
- package/dist/cdn/3LYW7DPP.js +2 -0
- package/dist/cdn/3MHB5VAM.js +37 -0
- package/dist/cdn/3VEQ7HMG.js +2 -0
- package/dist/cdn/{VFP7AKUR.js → 45P5JEKC.js} +1 -1
- package/dist/cdn/{Q5N6IPFC.js → 47WDNO2P.js} +1 -1
- package/dist/cdn/4GCUO37L.js +2 -0
- package/dist/cdn/4IYPGSMC.js +2 -0
- package/dist/cdn/{6WQPKBUS.js → 4LH6RELA.js} +1 -1
- package/dist/cdn/4YZHTVL7.js +2 -0
- package/dist/cdn/52XNA2DH.js +2 -0
- package/dist/cdn/57CR5SOU.js +2 -0
- package/dist/cdn/5ZYCFKFX.js +2 -0
- package/dist/cdn/66KEM4LG.js +2 -0
- package/dist/cdn/6DGQQ4V4.js +2 -0
- package/dist/cdn/6FB455E4.js +2 -0
- package/dist/cdn/6P6HFKV2.js +2 -0
- package/dist/cdn/7BDNLABD.js +2 -0
- package/dist/cdn/7GWVJEAI.js +2 -0
- package/dist/cdn/7I2D5SVD.js +2 -0
- package/dist/cdn/7ICRLJ5R.js +2 -0
- package/dist/cdn/7K2V6YNA.js +2 -0
- package/dist/cdn/7X23S5SF.js +2 -0
- package/dist/cdn/A4FCRGKH.js +2 -0
- package/dist/cdn/ALMGT4ZN.js +2 -0
- package/dist/cdn/BBBLK7RI.js +2 -0
- package/dist/cdn/BCPVUKSF.js +2 -0
- package/dist/cdn/CXSNVG3M.js +2 -0
- package/dist/cdn/DYQRIA4G.js +2 -0
- package/dist/cdn/E5P3LY6E.js +2 -0
- package/dist/cdn/E6S67HXA.js +2 -0
- package/dist/cdn/{HAJ2VWEU.js → EEBD6KKN.js} +1 -1
- package/dist/cdn/{KACPA2Q3.js → EEBFNI6X.js} +1 -1
- package/dist/cdn/{6DSWJCEU.js → FOYNQPWL.js} +1 -1
- package/dist/cdn/G2EWR4OS.js +2 -0
- package/dist/cdn/GDTHQBCP.js +2 -0
- package/dist/cdn/GPXGV2W3.js +2 -0
- package/dist/cdn/H32MCV7J.js +2 -0
- package/dist/cdn/HESIIJTB.js +2 -0
- package/dist/cdn/HNRWEWFM.js +2 -0
- package/dist/cdn/HWJIFGRR.js +2 -0
- package/dist/cdn/ICCNKIGD.js +2 -0
- package/dist/cdn/IKRCUXIB.js +2 -0
- package/dist/cdn/IO7TJZDW.js +2 -0
- package/dist/cdn/{BHWSEWHV.js → IVWZLS7W.js} +1 -1
- package/dist/cdn/IXGXDRYR.js +2 -0
- package/dist/cdn/{EVWSDR7F.js → IZCUAYGW.js} +1 -1
- package/dist/cdn/JB527BEY.js +2 -0
- package/dist/cdn/JLFVNF5U.js +2 -0
- package/dist/cdn/JM6E3U5J.js +2 -0
- package/dist/cdn/JZPDA4LD.js +2 -0
- package/dist/cdn/{INXFZ3KK.js → KBDOBMB5.js} +7 -7
- package/dist/cdn/KC5H5WGK.js +2 -0
- package/dist/cdn/KFBMPA6U.js +2 -0
- package/dist/cdn/KFIYYH54.js +2 -0
- package/dist/cdn/KQD5PSPV.js +2 -0
- package/dist/cdn/KRGZLJM5.js +2 -0
- package/dist/cdn/KUO2EPUE.js +2 -0
- package/dist/cdn/LD2K2FUM.js +2 -0
- package/dist/cdn/LHNPAXRS.js +2 -0
- package/dist/cdn/LNTDBU7W.js +2 -0
- package/dist/cdn/LPGL66XP.js +2 -0
- package/dist/cdn/LT4HKSXR.js +2 -0
- package/dist/cdn/LX5QI6J3.js +2 -0
- package/dist/cdn/{KZ37E2J3.js → LZNL4CV3.js} +7 -7
- package/dist/cdn/{SBHIJW76.js → MBC2KQUK.js} +1 -1
- package/dist/cdn/MFIKF7RC.js +2 -0
- package/dist/cdn/{K4VD72SG.js → MGIPPTHG.js} +1 -1
- package/dist/cdn/NFBNUOS2.js +2 -0
- package/dist/cdn/NHN6CQRE.js +2 -0
- package/dist/cdn/OQLV6YYT.js +2 -0
- package/dist/cdn/P2MVLEZ7.js +2 -0
- package/dist/cdn/{VPTDXGKU.js → PDXLVDA2.js} +1 -1
- package/dist/cdn/PV4ROV2W.js +2 -0
- package/dist/cdn/Q3YDW4V6.js +2 -0
- package/dist/cdn/QGLWCPMB.js +2 -0
- package/dist/cdn/QJKJNE7A.js +2 -0
- package/dist/cdn/QVD6LHQ2.js +2 -0
- package/dist/cdn/RI65IJRW.js +2 -0
- package/dist/cdn/SJWEUS4D.js +2 -0
- package/dist/cdn/SLB3Y7Q2.js +2 -0
- package/dist/cdn/SUUMGHCO.js +2 -0
- package/dist/cdn/SYV4I4MD.js +4 -0
- package/dist/cdn/T47JP5N6.js +2 -0
- package/dist/cdn/T5RPAQYI.js +2 -0
- package/dist/cdn/TJ3ALCTV.js +2 -0
- package/dist/cdn/TWLIURYH.js +2 -0
- package/dist/cdn/TZG37HE4.js +2 -0
- package/dist/cdn/U7L3L6IV.js +2 -0
- package/dist/cdn/UM7JZ2DY.js +2 -0
- package/dist/cdn/V45SCYTC.js +2 -0
- package/dist/cdn/{TS3WIN62.js → VOR2H3D7.js} +1 -1
- package/dist/cdn/VPLVBL2P.js +2 -0
- package/dist/cdn/WTQDFRE7.js +2 -0
- package/dist/cdn/X234G7PD.js +2 -0
- package/dist/cdn/X7FQPP5T.js +2 -0
- package/dist/cdn/XJFKEIB4.js +2 -0
- package/dist/cdn/XLHQQCTU.js +2 -0
- package/dist/cdn/XSH2YEV4.js +2 -0
- package/dist/cdn/Y3E4HJZ6.js +2 -0
- package/dist/cdn/Y5KIJ6GX.js +120 -0
- package/dist/cdn/Y7IQV44J.js +2 -0
- package/dist/cdn/{ZXIRDWJW.js → YAVQSNZ6.js} +1 -1
- package/dist/cdn/YKJO6KSB.js +2 -0
- package/dist/cdn/YSZU65DU.js +2 -0
- package/dist/cdn/{PKWXSPJL.js → ZEQ6Q5SM.js} +1 -1
- package/dist/cdn/ZMVYIIG4.js +2 -0
- package/dist/cdn/ZRULG7VV.js +4 -0
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.ar.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.bg.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.bs.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.ca.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.cs.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.da.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.de.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.el.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.es.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.et.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.fi.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.fr.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.he.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.hr.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.hu.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.id.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.it.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.ja.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.ko.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.lt.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.lv.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.nl.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.no.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.pl.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.pt-BR.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.pt-PT.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.ro.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.ru.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.sk.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.sl.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.sr.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.sv.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.th.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.tr.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.uk.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.vi.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.zh-CN.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.zh-HK.json +1 -1
- package/dist/cdn/assets/charts-config-heat-chart-data/t9n/messages.zh-TW.json +1 -1
- package/dist/cdn/assets/charts-config-pie-chart-slices/t9n/messages.ja.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.ar.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.bg.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.bs.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.ca.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.cs.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.da.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.de.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.el.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.es.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.et.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.fi.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.fr.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.he.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.hr.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.hu.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.id.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.it.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.ja.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.ko.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.lt.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.lv.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.nl.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.no.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.pl.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.pt-BR.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.pt-PT.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.ro.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.ru.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.sk.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.sl.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.sr.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.sv.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.th.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.tr.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.uk.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.vi.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.zh-CN.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.zh-HK.json +1 -1
- package/dist/cdn/assets/charts-config-select-chart-type-popover/t9n/messages.zh-TW.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.ar.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.bg.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.bs.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.ca.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.cs.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.da.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.de.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.el.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.en.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.es.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.et.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.fi.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.fr.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.he.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.hr.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.hu.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.id.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.it.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.ja.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.ko.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.lt.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.lv.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.nl.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.no.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.pl.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.pt-BR.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.pt-PT.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.ro.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.ru.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.sk.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.sl.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.sr.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.sv.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.th.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.tr.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.uk.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.vi.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.zh-CN.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.zh-HK.json +1 -1
- package/dist/cdn/assets/common/t9n/messages.zh-TW.json +1 -1
- package/dist/cdn/index.js +1 -1
- package/dist/chart-rendering/common/data/utils/summarize-data/interfaces.d.ts +8 -0
- package/dist/chart-rendering/common/interfaces.d.ts +76 -79
- package/dist/chunks/action-bar-utils.js +60 -43
- package/dist/chunks/axis-lines-symbol.js +7 -7
- package/dist/chunks/bar-chart-model.js +35 -25
- package/dist/chunks/bar-chart-series.js +22 -13
- package/dist/chunks/box-plot-data.js +166 -163
- package/dist/chunks/box-plot-model.js +35 -36
- package/dist/chunks/chart-model.js +92 -54
- package/dist/chunks/chart-ui-utils.js +1 -1
- package/dist/chunks/chart-ui-utils2.js +66 -57
- package/dist/chunks/class-breaks.js +250 -132
- package/dist/chunks/combo-bar-line-chart-model.js +39 -32
- package/dist/chunks/common.js +2 -2
- package/dist/chunks/data-labels-symbol.js +1 -1
- package/dist/chunks/data.js +98 -74
- package/dist/chunks/default.js +4 -4
- package/dist/chunks/gauge-model.js +63 -37
- package/dist/chunks/generate-x-axis-title.js +41 -33
- package/dist/chunks/heat-chart-model.js +168 -101
- package/dist/chunks/histogram-data.js +58 -50
- package/dist/chunks/histogram-model.js +39 -28
- package/dist/chunks/index.js +9918 -8233
- package/dist/chunks/index2.js +149 -156
- package/dist/chunks/index3.js +12 -13
- package/dist/chunks/index4.js +63 -95
- package/dist/chunks/interfaces.js +1 -1
- package/dist/chunks/line-chart-model.js +3 -3
- package/dist/chunks/model-setter.js +37 -28
- package/dist/chunks/model-with-guides.js +61 -42
- package/dist/chunks/model-with-tooltips.js +64 -66
- package/dist/chunks/model-with-y-guides.js +33 -25
- package/dist/chunks/negative-values-stacked-to-baseline.js +64 -57
- package/dist/chunks/pie-chart-data.js +83 -75
- package/dist/chunks/pie-chart-model.js +67 -52
- package/dist/chunks/radar-chart-model.js +23 -15
- package/dist/chunks/resources.js +15 -0
- package/dist/chunks/rest-js-object-literals.js +11 -10
- package/dist/chunks/rotated-state.js +22 -14
- package/dist/chunks/scatterplot-model.js +52 -44
- package/dist/chunks/serial-chart-data.js +636 -527
- package/dist/chunks/serial-chart-model.js +243 -225
- package/dist/chunks/series-length.js +33 -25
- package/dist/chunks/series-types.js +32 -23
- package/dist/chunks/series.js +19 -11
- package/dist/chunks/setup-utils.js +1 -1
- package/dist/chunks/store.js +25 -16
- package/dist/chunks/type-guards.js +87 -83
- package/dist/chunks/utils.js +151 -144
- package/dist/chunks/utils2.js +36 -28
- package/dist/chunks/web-component-utils.js +201 -206
- package/dist/components/arcgis-chart/customElement.d.ts +84 -45
- package/dist/components/arcgis-chart/customElement.js +16419 -17087
- package/dist/components/arcgis-charts-action-bar/customElement.d.ts +6 -0
- package/dist/components/arcgis-charts-action-bar/customElement.js +24 -24
- package/dist/components/arcgis-charts-config-axis/customElement.js +5 -5
- package/dist/components/arcgis-charts-config-bar-chart/customElement.js +35 -28
- package/dist/components/arcgis-charts-config-bar-chart-data/customElement.js +40 -24
- package/dist/components/arcgis-charts-config-bar-chart-popover/customElement.js +45 -37
- package/dist/components/arcgis-charts-config-bar-chart-series/customElement.js +18 -10
- package/dist/components/arcgis-charts-config-bar-chart-series-popover/customElement.js +22 -14
- package/dist/components/arcgis-charts-config-box-plot/customElement.js +21 -14
- package/dist/components/arcgis-charts-config-box-plot-data/customElement.js +14 -6
- package/dist/components/arcgis-charts-config-box-plot-popover/customElement.js +37 -29
- package/dist/components/arcgis-charts-config-box-plot-series/customElement.js +13 -5
- package/dist/components/arcgis-charts-config-box-plot-series-popover/customElement.js +25 -17
- package/dist/components/arcgis-charts-config-category-format/customElement.js +4 -4
- package/dist/components/arcgis-charts-config-chart-rename-popover/customElement.js +22 -14
- package/dist/components/arcgis-charts-config-color-style/customElement.js +1 -1
- package/dist/components/arcgis-charts-config-create-flow/customElement.js +133 -126
- package/dist/components/arcgis-charts-config-font-style/customElement.js +25 -17
- package/dist/components/arcgis-charts-config-format/customElement.js +55 -45
- package/dist/components/arcgis-charts-config-format-popover/customElement.js +16 -8
- package/dist/components/arcgis-charts-config-general/customElement.js +16 -8
- package/dist/components/arcgis-charts-config-guide/customElement.js +43 -29
- package/dist/components/arcgis-charts-config-guide-popover/customElement.js +22 -14
- package/dist/components/arcgis-charts-config-guides-type-popover/customElement.js +15 -7
- package/dist/components/arcgis-charts-config-heat-chart/customElement.js +32 -25
- package/dist/components/arcgis-charts-config-heat-chart-data/customElement.js +210 -238
- package/dist/components/arcgis-charts-config-heat-chart-popover/customElement.js +18 -10
- package/dist/components/arcgis-charts-config-histogram/customElement.js +40 -33
- package/dist/components/arcgis-charts-config-histogram-data/customElement.js +38 -30
- package/dist/components/arcgis-charts-config-histogram-popover/customElement.js +30 -22
- package/dist/components/arcgis-charts-config-line-chart/customElement.js +31 -24
- package/dist/components/arcgis-charts-config-line-chart-data/customElement.js +17 -9
- package/dist/components/arcgis-charts-config-line-chart-popover/customElement.js +35 -27
- package/dist/components/arcgis-charts-config-line-chart-series/customElement.js +13 -5
- package/dist/components/arcgis-charts-config-line-chart-series-popover/customElement.js +15 -7
- package/dist/components/arcgis-charts-config-line-style/customElement.js +8 -8
- package/dist/components/arcgis-charts-config-number-format/customElement.js +10 -10
- package/dist/components/arcgis-charts-config-pie-chart/customElement.js +19 -12
- package/dist/components/arcgis-charts-config-pie-chart-data/customElement.js +19 -11
- package/dist/components/arcgis-charts-config-pie-chart-popover/customElement.js +30 -22
- package/dist/components/arcgis-charts-config-pie-chart-slices/customElement.js +17 -9
- package/dist/components/arcgis-charts-config-pie-chart-slices-popover/customElement.js +18 -10
- package/dist/components/arcgis-charts-config-scatter-plot/customElement.js +29 -21
- package/dist/components/arcgis-charts-config-scatter-plot-data/customElement.js +15 -7
- package/dist/components/arcgis-charts-config-scatter-plot-popover/customElement.js +22 -14
- package/dist/components/arcgis-charts-config-select-chart-type-popover/customElement.js +37 -25
- package/dist/components/arcgis-charts-config-view-charts/customElement.js +23 -14
- package/dist/components/arcgis-charts-info-modal/customElement.js +35 -20
- 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/dist/index.js +440 -393
- package/dist/interfaces.d.ts +11 -5
- package/dist/json-schema/index.d.ts +220 -219
- package/dist/loader.js +7 -7
- package/dist/model/bar-chart-model/bar-chart-model.d.ts +6 -5
- package/dist/model/box-plot-model/box-plot-model.d.ts +19 -10
- package/dist/model/chart-model/chart-model-base.d.ts +0 -1
- package/dist/model/combo-bar-line-chart-model/combo-bar-line-chart-model.d.ts +18 -11
- package/dist/model/gauge-model/gauge-model.d.ts +29 -8
- package/dist/model/heat-chart-model/heat-chart-model.d.ts +109 -38
- package/dist/model/histogram-model/histogram-model.d.ts +18 -4
- package/dist/model/interfaces/chart-interfaces.d.ts +4 -4
- package/dist/model/interfaces/common.d.ts +5 -2
- package/dist/model/line-chart-model/line-chart-model.d.ts +0 -1
- package/dist/model/mixins/model-with-guides.d.ts +11 -0
- package/dist/model/mixins/model-with-legend.d.ts +3 -15
- package/dist/model/mixins/model-with-temporal-binning.d.ts +7 -7
- package/dist/model/mixins/model-with-tooltips.d.ts +5 -5
- package/dist/model/pie-chart-model/pie-chart-legend-model.d.ts +6 -6
- package/dist/model/pie-chart-model/pie-chart-model.d.ts +13 -5
- package/dist/model/properties/axes/x-axis/max-x-bound.d.ts +5 -1
- package/dist/model/properties/axes/x-axis/min-x-bound.d.ts +5 -1
- package/dist/model/properties/axes/x-axis/x-axis-title-visibility.d.ts +2 -2
- package/dist/model/properties/chart-renderer.d.ts +44 -1
- package/dist/model/properties/color-match.d.ts +0 -1
- package/dist/model/properties/data-labels/data-labels-visibility.d.ts +1 -4
- package/dist/model/properties/description/description-visibility.d.ts +0 -4
- package/dist/model/properties/layer.d.ts +2 -2
- package/dist/model/properties/subtitle/subtitle-visibility.d.ts +0 -4
- package/dist/model/properties/title/title-visibility.d.ts +0 -4
- package/dist/model/radar-chart-model/radar-chart-model.d.ts +0 -1
- package/dist/model/scatterplot-model/scatterplot-model.d.ts +3 -4
- package/dist/model/serial-chart-model/serial-chart-model.d.ts +9 -13
- package/dist/model/shared/setup-utils.d.ts +13 -6
- package/dist/model/shared/type-guards.d.ts +8 -0
- package/dist/model.js +9 -8
- package/dist/spec/data-source.d.ts +26 -18
- package/dist/spec/events.d.ts +2 -5
- package/dist/spec/rest-js-object-literals.d.ts +1 -0
- package/dist/spec/rest-js-types.d.ts +44 -11
- package/dist/spec/web-chart.d.ts +281 -245
- package/dist/types/lumina.d.ts +1 -1
- package/dist/types/preact.d.ts +1 -1
- package/dist/types/react.d.ts +1 -1
- package/dist/types/stencil.d.ts +1 -1
- package/dist/utils/chart-config/converter/index.d.ts +9 -9
- package/dist/utils/chart-config/utils/index.d.ts +41 -8
- package/dist/utils/chart-config/validator/index.d.ts +8 -6
- package/dist/utils/components/event-payloads.d.ts +3 -3
- package/dist/utils/data/categorical-data/index.d.ts +1 -1
- package/dist/utils/data/index.d.ts +126 -5
- package/dist/utils/data/interfaces.d.ts +0 -1
- package/dist/utils/data/pie-chart/index.d.ts +31 -0
- package/dist/utils/defaults/index.d.ts +23 -1
- package/dist/utils/defaults/interfaces.d.ts +2 -0
- package/dist/utils/errors/index.d.ts +5 -5
- package/dist/utils/errors/interfaces.d.ts +1 -0
- package/dist/utils/layer/index.d.ts +84 -49
- package/dist/utils/layer/inline-conversion/index.d.ts +7 -8
- package/dist/utils/layer/interfaces.d.ts +10 -45
- package/dist/utils/layer/query-features/index.d.ts +6 -4
- package/dist/utils/layer/query-features/interfaces.d.ts +1 -1
- package/dist/utils/layer/query-parser/index.d.ts +17 -12
- package/dist/utils/layer/utils/index.d.ts +89 -21
- package/dist/utils/localization/index.d.ts +3 -19
- package/dist/utils/localization/interfaces.d.ts +7 -0
- package/dist/utils/misc/index.d.ts +30 -9
- package/dist/utils/misc/interfaces.d.ts +9 -6
- package/dist/utils/type-guards/index.d.ts +17 -10
- package/dist/utils/types/index.d.ts +17 -17
- package/dist/utils/ui/popover-ui-utils.d.ts +1 -1
- package/package.json +8 -9
- package/dist/cdn/2LIJ6LL6.js +0 -2
- package/dist/cdn/2OGUU3CF.js +0 -2
- package/dist/cdn/2XUJZES7.js +0 -2
- package/dist/cdn/3FSLSUSK.js +0 -2
- package/dist/cdn/3IKX7JF5.js +0 -2
- package/dist/cdn/3LSZZLGN.js +0 -2
- package/dist/cdn/3RGDIFXM.js +0 -2
- package/dist/cdn/3XL7ZAYC.js +0 -2
- package/dist/cdn/4JKSKAIM.js +0 -2
- package/dist/cdn/4XC2ZKSZ.js +0 -2
- package/dist/cdn/5AGSNJFG.js +0 -2
- package/dist/cdn/5J43WZSR.js +0 -2
- package/dist/cdn/5JLPD2NR.js +0 -2
- package/dist/cdn/5SE3ZDX2.js +0 -2
- package/dist/cdn/6HU6FAC6.js +0 -2
- package/dist/cdn/6JS63XSI.js +0 -2
- package/dist/cdn/7BFETEN2.js +0 -2
- package/dist/cdn/7EP32GQJ.js +0 -2
- package/dist/cdn/7WH6VBY6.js +0 -2
- package/dist/cdn/A6FLP7SG.js +0 -2
- package/dist/cdn/ACHYJXNP.js +0 -2
- package/dist/cdn/ANOLEK36.js +0 -2
- package/dist/cdn/ATIYLNFB.js +0 -2
- package/dist/cdn/ATYJIBQA.js +0 -2
- package/dist/cdn/B33AB3RQ.js +0 -2
- package/dist/cdn/BJPCRXMJ.js +0 -2
- package/dist/cdn/BTMNCXKX.js +0 -2
- package/dist/cdn/BTOKHA76.js +0 -2
- package/dist/cdn/CTXREB7E.js +0 -2
- package/dist/cdn/D5XDNKEV.js +0 -2
- package/dist/cdn/DAQJEXZA.js +0 -2
- package/dist/cdn/DGTF5KBL.js +0 -2
- package/dist/cdn/DSRT3QGU.js +0 -2
- package/dist/cdn/E3KNK2QL.js +0 -2
- package/dist/cdn/EAMOK76F.js +0 -2
- package/dist/cdn/ENHEXARD.js +0 -2
- package/dist/cdn/ERWSXC2D.js +0 -2
- package/dist/cdn/FYJRJVSR.js +0 -2
- package/dist/cdn/GUD54AQJ.js +0 -2
- package/dist/cdn/H7ZDNA7W.js +0 -2
- package/dist/cdn/HOVLVPQH.js +0 -2
- package/dist/cdn/HYAXYKZG.js +0 -2
- package/dist/cdn/I7WRC44V.js +0 -2
- package/dist/cdn/IASONEII.js +0 -2
- package/dist/cdn/IEY3ZHXM.js +0 -2
- package/dist/cdn/JAKJRZFS.js +0 -2
- package/dist/cdn/JCW7HW3E.js +0 -58
- package/dist/cdn/JGB4OLU5.js +0 -2
- package/dist/cdn/JTA6HTV5.js +0 -2
- package/dist/cdn/KFJXMRC6.js +0 -2
- package/dist/cdn/KIMKCXB6.js +0 -2
- package/dist/cdn/KKGG37KV.js +0 -2
- package/dist/cdn/KPYFZSB5.js +0 -2
- package/dist/cdn/KSYKVAYS.js +0 -2
- package/dist/cdn/KZ7WEJMS.js +0 -2
- package/dist/cdn/LRRTUMQS.js +0 -2
- package/dist/cdn/M7ZR4HR7.js +0 -2
- package/dist/cdn/MDLYTSBA.js +0 -2
- package/dist/cdn/MIH3XFE3.js +0 -2
- package/dist/cdn/MLDP5OXE.js +0 -2
- package/dist/cdn/MMZFC2VM.js +0 -2
- package/dist/cdn/N2UJIZEU.js +0 -2
- package/dist/cdn/OEJ6ZA3E.js +0 -2
- package/dist/cdn/OFRMMDZQ.js +0 -2
- package/dist/cdn/OJGWQ3IH.js +0 -2
- package/dist/cdn/PUCPVH4M.js +0 -2
- package/dist/cdn/QCF56OBO.js +0 -2
- package/dist/cdn/R5CKMPU7.js +0 -2
- package/dist/cdn/RF7C6WVN.js +0 -2
- package/dist/cdn/RFHASMHJ.js +0 -2
- package/dist/cdn/RUUYSZO3.js +0 -2
- package/dist/cdn/SPAXIJWK.js +0 -2
- package/dist/cdn/TGNJ76AH.js +0 -32
- package/dist/cdn/THBEEC5Q.js +0 -2
- package/dist/cdn/TLSTPQNA.js +0 -2
- package/dist/cdn/U2TWW4FY.js +0 -2
- package/dist/cdn/UJ2JV7FV.js +0 -2
- package/dist/cdn/VBOUUUVO.js +0 -2
- package/dist/cdn/VDXJP4RT.js +0 -2
- package/dist/cdn/VKLPG37D.js +0 -2
- package/dist/cdn/W7KYGPSP.js +0 -2
- package/dist/cdn/WYPEKQH6.js +0 -4
- package/dist/cdn/XHXTKPL6.js +0 -2
- package/dist/cdn/XJSBB5KR.js +0 -2
- package/dist/cdn/XPM5OZBN.js +0 -2
- package/dist/cdn/XQ26L3RE.js +0 -4
- package/dist/cdn/YFEYEBAA.js +0 -2
- package/dist/cdn/YUFKLXMQ.js +0 -2
- package/dist/cdn/YXWXHEUY.js +0 -2
- package/dist/cdn/Z3EGNO5M.js +0 -2
- package/dist/cdn/ZVVQECSL.js +0 -2
- package/dist/cdn/ZYEUKPGT.js +0 -2
- package/dist/cdn/ZYMJEZKL.js +0 -2
- package/dist/chunks/index5.js +0 -66
- /package/dist/cdn/{T73O5OD5.js → 3OGKV4KZ.js} +0 -0
- /package/dist/cdn/{DB6PUP7Y.js → 3VMIFF7C.js} +0 -0
- /package/dist/cdn/{PHPEGJKB.js → 47EOUNYO.js} +0 -0
- /package/dist/cdn/{WNLCIQAX.js → 5TOYNVTW.js} +0 -0
- /package/dist/cdn/{5IAOT56I.js → 6HUDF5Q2.js} +0 -0
- /package/dist/cdn/{QBFKFCAR.js → ALRIN5E5.js} +0 -0
- /package/dist/cdn/{RBFLURN4.js → AVU2CHAB.js} +0 -0
- /package/dist/cdn/{J3EUXZ6G.js → B4ULOSFG.js} +0 -0
- /package/dist/cdn/{V3OHZN3J.js → BQOMKKBK.js} +0 -0
- /package/dist/cdn/{W236VLPQ.js → BUCYRXMT.js} +0 -0
- /package/dist/cdn/{QXCTWH2Z.js → BY77PBZ2.js} +0 -0
- /package/dist/cdn/{VWM7AVM6.js → COQ55XOW.js} +0 -0
- /package/dist/cdn/{MUUD74AD.js → DNSUOJXJ.js} +0 -0
- /package/dist/cdn/{JXQXA2KV.js → EIIQ2CSC.js} +0 -0
- /package/dist/cdn/{CAFCD23J.js → EVHJVY4I.js} +0 -0
- /package/dist/cdn/{HBUMNQ3P.js → F57IRWBF.js} +0 -0
- /package/dist/cdn/{NLCFSYMX.js → FLSUJTUZ.js} +0 -0
- /package/dist/cdn/{7XPFSBJR.js → FSNQ3YXX.js} +0 -0
- /package/dist/cdn/{4OQCJUCA.js → G2L5FYWK.js} +0 -0
- /package/dist/cdn/{HGLFNVUQ.js → GR4BZF3L.js} +0 -0
- /package/dist/cdn/{TW4GANOP.js → GWPFABGL.js} +0 -0
- /package/dist/cdn/{NWX4MEZT.js → HJW6UNEH.js} +0 -0
- /package/dist/cdn/{MRPQHHAR.js → I3BNBZ4D.js} +0 -0
- /package/dist/cdn/{S5OM65RV.js → J6TUXYMO.js} +0 -0
- /package/dist/cdn/{YB66QEEP.js → LOX7MXL4.js} +0 -0
- /package/dist/cdn/{UBAJJGZQ.js → MS6EYP4R.js} +0 -0
- /package/dist/cdn/{UAAZT4XK.js → NGLXQHZ2.js} +0 -0
- /package/dist/cdn/{4KKFIMTJ.js → NPVXLEZW.js} +0 -0
- /package/dist/cdn/{OAX6BSTV.js → NSRIVIOH.js} +0 -0
- /package/dist/cdn/{NRAJ4BK2.js → RHGKKMJG.js} +0 -0
- /package/dist/cdn/{GPLZLU72.js → S5EI7T2D.js} +0 -0
- /package/dist/cdn/{GRDFMG2M.js → SOIF6AMX.js} +0 -0
- /package/dist/cdn/{DO4HZTZB.js → THJTENN5.js} +0 -0
- /package/dist/cdn/{7BO3HV6A.js → TX2SYGTH.js} +0 -0
- /package/dist/cdn/{L2OPHSDM.js → YQJLA77R.js} +0 -0
- /package/dist/cdn/{FOOU5K3C.js → ZL5EGDOW.js} +0 -0
package/dist/spec/web-chart.d.ts
CHANGED
|
@@ -1,34 +1,34 @@
|
|
|
1
1
|
import type { GaugeChartSubTypes, SizePolicyScaleTypes, WebChartCalendarDatePartsUnits, WebChartClassBreakTypes, WebChartDataTransformations, WebChartDirectionalDataOrder, WebChartHeatChartHeatRulesTypes, WebChartHeatChartViewTypes, WebChartLabelBehavior, WebChartLegendPositions, WebChartMultiAxesDataOrder, WebChartNullPolicyTypes, WebChartOrderSeriesBy, WebChartPredefinedLabelsDataOrder, WebChartRadarChartAxisLabelsOrientation, WebChartStackedKinds, WebChartTemporalBinningUnits, WebChartTimeAggregationTypes, WebChartTypes } from "./chart-object-literals.js";
|
|
2
2
|
import type { TimeIntervalInfo } from "./data-source.js";
|
|
3
3
|
import type { RESTUnits } from "./rest-js-object-literals.js";
|
|
4
|
-
import type { Color, IDrawingInfo, IEnvelope, IExtent, IFeatureLayer, IPoint, IPolygon, IPolygonWithCurves, IPolyline, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, IStatisticDefinition, ITextSymbol } from "./rest-js-types.js";
|
|
4
|
+
import type { Color, IDrawingInfo, IEnvelope, IExtent, IFeatureLayer, IImageServiceLayer, IPoint, IPolygon, IPolygonWithCurves, IPolyline, ISimpleFillSymbol, ISimpleLineSymbol, ISimpleMarkerSymbol, IStatisticDefinition, ITextSymbol, ITiledImageServiceLayer } from "./rest-js-types.js";
|
|
5
5
|
|
|
6
6
|
/** Version of the current specification. */
|
|
7
7
|
export const WebChartCurrentVersion: "25.0.0";
|
|
8
8
|
|
|
9
9
|
/** Stores information regarding a numeric conversion. */
|
|
10
10
|
export interface ValueConversion {
|
|
11
|
-
/** A numeric value multiplying the value to convert */
|
|
11
|
+
/** A numeric value multiplying the value to convert. */
|
|
12
12
|
factor?: number;
|
|
13
|
-
/** A numeric offset to apply to the value to convert */
|
|
13
|
+
/** A numeric offset to apply to the value to convert. */
|
|
14
14
|
offset?: number;
|
|
15
15
|
}
|
|
16
16
|
|
|
17
|
-
/** Describes the properties of an axis scrollbar */
|
|
17
|
+
/** Describes the properties of an axis scrollbar. */
|
|
18
18
|
export interface WebChartAxisScrollBar {
|
|
19
19
|
/**
|
|
20
|
-
* Scrollbar visibility
|
|
20
|
+
* Scrollbar visibility.
|
|
21
21
|
*
|
|
22
22
|
* @default false
|
|
23
23
|
*/
|
|
24
24
|
visible?: boolean;
|
|
25
|
-
/** Scrollbar width in pixels */
|
|
25
|
+
/** Scrollbar width in pixels. */
|
|
26
26
|
width?: number;
|
|
27
|
-
/** Scrollbar color */
|
|
27
|
+
/** Scrollbar color. */
|
|
28
28
|
color?: Color;
|
|
29
|
-
/** Grip size in pixels */
|
|
29
|
+
/** Grip size in pixels. */
|
|
30
30
|
gripSize?: number;
|
|
31
|
-
/** Margin between the scrollbar and the series container in pixels */
|
|
31
|
+
/** Margin between the scrollbar and the series container in pixels. */
|
|
32
32
|
margin?: number;
|
|
33
33
|
}
|
|
34
34
|
|
|
@@ -36,24 +36,24 @@ export interface WebChartAxisScrollBar {
|
|
|
36
36
|
export type WebChartTextSymbol = Omit<ITextSymbol, "angle" | "style" | "xoffset" | "yoffset">
|
|
37
37
|
& {
|
|
38
38
|
/**
|
|
39
|
-
* Horizontal offset. Can be a number for a fixed value in pixels, or a string as
|
|
39
|
+
* Horizontal offset. Can be a number for a fixed value in pixels, or a string such as `25%` for a value
|
|
40
40
|
* relative to the label's container width.
|
|
41
41
|
*/
|
|
42
42
|
xoffset?: number | string;
|
|
43
43
|
/**
|
|
44
|
-
*
|
|
44
|
+
* Vertical offset. Can be a number for a fixed value in pixels, or a string such as `25%` for a value
|
|
45
45
|
* relative to the label's container height.
|
|
46
46
|
*/
|
|
47
47
|
yoffset?: number | string;
|
|
48
|
-
/** Rotation of the label */
|
|
48
|
+
/** Rotation angle of the label. */
|
|
49
49
|
angle?: number;
|
|
50
|
-
/** Label style */
|
|
50
|
+
/** Label style. */
|
|
51
51
|
style?: string;
|
|
52
52
|
};
|
|
53
53
|
|
|
54
|
-
/** Stores
|
|
54
|
+
/** Stores information on how some text is rendered on the chart and whether it is visible or not. */
|
|
55
55
|
export interface WebChartText {
|
|
56
|
-
/**
|
|
56
|
+
/** A unique string identifier for the `ChartText` object. This value is `chartText`. */
|
|
57
57
|
type: typeof WebChartTypes.Text;
|
|
58
58
|
/**
|
|
59
59
|
* Determines the visibility of the content.
|
|
@@ -61,7 +61,7 @@ export interface WebChartText {
|
|
|
61
61
|
* @default true
|
|
62
62
|
*/
|
|
63
63
|
visible?: boolean;
|
|
64
|
-
/** Contains the styling
|
|
64
|
+
/** Contains the styling information and text content. */
|
|
65
65
|
content: WebChartTextSymbol;
|
|
66
66
|
}
|
|
67
67
|
|
|
@@ -69,25 +69,25 @@ export interface WebChartText {
|
|
|
69
69
|
export interface WebChartCursorCrosshair {
|
|
70
70
|
/** Represents a unique string identifier for the chart cursor's crosshair. */
|
|
71
71
|
type: typeof WebChartTypes.CursorCrosshair;
|
|
72
|
-
/** Contains styling
|
|
72
|
+
/** Contains styling information on how the chart cursor's crosshair should be rendered. */
|
|
73
73
|
style?: ISimpleLineSymbol;
|
|
74
74
|
/**
|
|
75
|
-
* Indicates whether the vertical crosshair line should be displayed
|
|
75
|
+
* Indicates whether the vertical crosshair line should be displayed.
|
|
76
76
|
*
|
|
77
77
|
* @default false
|
|
78
78
|
*/
|
|
79
79
|
verticalLineVisible?: boolean;
|
|
80
80
|
/**
|
|
81
|
-
* Indicates whether the horizontal crosshair line should be displayed
|
|
81
|
+
* Indicates whether the horizontal crosshair line should be displayed.
|
|
82
82
|
*
|
|
83
83
|
* @default false
|
|
84
84
|
*/
|
|
85
85
|
horizontalLineVisible?: boolean;
|
|
86
86
|
}
|
|
87
87
|
|
|
88
|
-
/** JSON representation of the
|
|
88
|
+
/** JSON representation of the chart's legend. */
|
|
89
89
|
export interface WebChartLegend {
|
|
90
|
-
/**
|
|
90
|
+
/** A unique string identifier for the `ChartLegend` object. This value is `chartLegend`. */
|
|
91
91
|
type: typeof WebChartTypes.Legend;
|
|
92
92
|
/**
|
|
93
93
|
* Determines the visibility of the content.
|
|
@@ -95,29 +95,29 @@ export interface WebChartLegend {
|
|
|
95
95
|
* @default true
|
|
96
96
|
*/
|
|
97
97
|
visible?: boolean;
|
|
98
|
-
/** Contains styling
|
|
98
|
+
/** Contains styling information on how the title of the legend box should be rendered. */
|
|
99
99
|
title?: WebChartText;
|
|
100
100
|
/**
|
|
101
|
-
* Contains styling
|
|
101
|
+
* Contains styling information on how legend body (excluding the `title`) should be rendered.
|
|
102
102
|
* Will use default styling if not provided.
|
|
103
103
|
*/
|
|
104
104
|
body?: WebChartTextSymbol;
|
|
105
105
|
/**
|
|
106
106
|
* Positions the legends at `"right"`, `"left"`, `"top"`, or `"bottom"` of the chart.
|
|
107
107
|
*
|
|
108
|
-
* @default
|
|
108
|
+
* @default `right`
|
|
109
109
|
*/
|
|
110
110
|
position?: WebChartLegendPositions;
|
|
111
111
|
/**
|
|
112
|
-
* Legend's maximum height. If not set the legend will occupy the same height as the series container
|
|
112
|
+
* Legend's maximum height. If not set the legend will occupy the same height as the series container.
|
|
113
113
|
*
|
|
114
114
|
* @default null
|
|
115
115
|
*/
|
|
116
116
|
maxHeight?: number | null;
|
|
117
117
|
/**
|
|
118
|
-
* Allows the legend markers to be displayed as circles.
|
|
119
|
-
* - `false` or `undefined
|
|
120
|
-
* - `true
|
|
118
|
+
* Allows the legend markers to be displayed as circles.
|
|
119
|
+
* - `false` or `undefined`: rounded rectangles
|
|
120
|
+
* - `true`: circles
|
|
121
121
|
*
|
|
122
122
|
* @default false
|
|
123
123
|
*/
|
|
@@ -131,7 +131,7 @@ export interface WebChartNullCategory {
|
|
|
131
131
|
*/
|
|
132
132
|
text?: string;
|
|
133
133
|
/**
|
|
134
|
-
* Contains styling
|
|
134
|
+
* Contains styling information on how the overlay should be rendered.
|
|
135
135
|
* If not provided a default style is applied.
|
|
136
136
|
*
|
|
137
137
|
* @default 1 - symbol.outline.width
|
|
@@ -139,7 +139,7 @@ export interface WebChartNullCategory {
|
|
|
139
139
|
symbol?: ISimpleFillSymbol;
|
|
140
140
|
}
|
|
141
141
|
|
|
142
|
-
/** Specific legend for
|
|
142
|
+
/** Specific legend for pie charts */
|
|
143
143
|
export interface WebChartPieChartLegend extends WebChartLegend {
|
|
144
144
|
/**
|
|
145
145
|
* Indicates whether the category associated to a slice is to be displayed in the legend.
|
|
@@ -149,14 +149,14 @@ export interface WebChartPieChartLegend extends WebChartLegend {
|
|
|
149
149
|
displayCategory?: boolean;
|
|
150
150
|
/**
|
|
151
151
|
* Indicates whether the numeric value associated to a slice is to be displayed in the legend.
|
|
152
|
-
* If both displayNumericValue
|
|
152
|
+
* If both `displayNumericValue` and `displayPercentage` are true on a same label, they will be displayed as `percentage (value)`
|
|
153
153
|
*
|
|
154
154
|
* @default false
|
|
155
155
|
*/
|
|
156
156
|
displayNumericValue?: boolean;
|
|
157
157
|
/**
|
|
158
158
|
* Indicates whether the percentage to a slice is to be displayed in the legend.
|
|
159
|
-
* If both displayNumericValue
|
|
159
|
+
* If both `displayNumericValue` and `displayPercentage` are true on a same label, they will be displayed as `percentage (value)`
|
|
160
160
|
*
|
|
161
161
|
* @default false
|
|
162
162
|
*/
|
|
@@ -168,16 +168,16 @@ export interface WebChartPieChartLegend extends WebChartLegend {
|
|
|
168
168
|
*/
|
|
169
169
|
labelMaxWidth?: number;
|
|
170
170
|
/**
|
|
171
|
-
* Maximum width in pixels of the label displaying the slice
|
|
171
|
+
* Maximum width in pixels of the value label displaying the slice value. If the label is larger than the maximum width, it will automatically wrap.
|
|
172
172
|
*
|
|
173
173
|
* @default 200
|
|
174
174
|
*/
|
|
175
175
|
valueLabelMaxWidth?: number;
|
|
176
176
|
}
|
|
177
177
|
|
|
178
|
-
/** JSON representation of the chart's overlays
|
|
178
|
+
/** JSON representation of the chart's overlays such as the trendline in scatterplot, and the median overlay in histogram. */
|
|
179
179
|
export interface WebChartOverlay {
|
|
180
|
-
/**
|
|
180
|
+
/** A unique string identifier for the `ChartOverlay` object. This value is `chartOverlay`. */
|
|
181
181
|
type: typeof WebChartTypes.Overlay;
|
|
182
182
|
/**
|
|
183
183
|
* Determines whether the overlay is created under the hood. It may or may not be visible.
|
|
@@ -192,7 +192,7 @@ export interface WebChartOverlay {
|
|
|
192
192
|
*/
|
|
193
193
|
visible?: boolean;
|
|
194
194
|
/**
|
|
195
|
-
* Contains styling
|
|
195
|
+
* Contains styling information on how the overlay should be rendered.
|
|
196
196
|
* If not provided a default style is applied.
|
|
197
197
|
*/
|
|
198
198
|
symbol?: ISimpleLineSymbol;
|
|
@@ -200,7 +200,7 @@ export interface WebChartOverlay {
|
|
|
200
200
|
|
|
201
201
|
/** Defines how the numerical(value) axis data should be formatted. */
|
|
202
202
|
export interface NumberFormatOptions {
|
|
203
|
-
/** Represents a unique string identifier for the NumberFormatOptions object. For NumberFormatOptions object, it is
|
|
203
|
+
/** Represents a unique string identifier for the `NumberFormatOptions` object. For the `NumberFormatOptions` object, it is `number`. It can help to differentiate numerical (value) axis from other types of axes such as date-time axis and category axis. */
|
|
204
204
|
type: typeof WebChartTypes.NumberAxisFormat;
|
|
205
205
|
/** Represents the JS native [Intl.NumberFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/NumberFormat/NumberFormat), which is based on [CLDR](http://cldr.unicode.org/translation/numbers-currency/number-patterns) specifications. */
|
|
206
206
|
intlOptions: Intl.NumberFormatOptions;
|
|
@@ -208,14 +208,16 @@ export interface NumberFormatOptions {
|
|
|
208
208
|
|
|
209
209
|
/**
|
|
210
210
|
* Interface used by the axis `valueFormat` property to describe how to format specific date and time units when displayed on the axis.
|
|
211
|
-
*
|
|
211
|
+
*
|
|
212
|
+
* @example
|
|
213
|
+
* ```json
|
|
212
214
|
* "year": { year: "numeric" }
|
|
213
215
|
* "month": { month: "numeric" }
|
|
214
216
|
* "day": { day: "2-digit" }
|
|
215
217
|
* "hour": { day: "numeric" }
|
|
216
218
|
* "minute": { minute: "numeric" }
|
|
217
219
|
* "second": { second: "numeric" }
|
|
218
|
-
*
|
|
220
|
+
* ```
|
|
219
221
|
*/
|
|
220
222
|
export interface WebChartDateTimeUnitFormatOptions {
|
|
221
223
|
year?: Intl.DateTimeFormatOptions;
|
|
@@ -226,9 +228,9 @@ export interface WebChartDateTimeUnitFormatOptions {
|
|
|
226
228
|
second?: Intl.DateTimeFormatOptions;
|
|
227
229
|
}
|
|
228
230
|
|
|
229
|
-
/** Defines how the DateTime axis data should be formatted. */
|
|
231
|
+
/** Defines how the `DateTime` axis data should be formatted. */
|
|
230
232
|
export interface DateTimeFormatOptions {
|
|
231
|
-
/** Represents a unique string identifier for the NumberFormatOptions object. For NumberFormatOptions object, it is
|
|
233
|
+
/** Represents a unique string identifier for the `NumberFormatOptions` object. For the `NumberFormatOptions` object, it is `date`. It can help to differentiate date-time axis from other types of axes such as numeric (value) axis and category axis. */
|
|
232
234
|
type: typeof WebChartTypes.DateAxisFormat;
|
|
233
235
|
/** Represent the JS native [Intl.DateTimeFormatOptions](https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Intl/DateTimeFormat/DateTimeFormat), which is based on [CLDR](http://cldr.unicode.org/translation/date-time-1/date-time-patterns) specifications. */
|
|
234
236
|
intlOptions: Intl.DateTimeFormatOptions;
|
|
@@ -236,30 +238,25 @@ export interface DateTimeFormatOptions {
|
|
|
236
238
|
formatPerDateTimeUnit?: WebChartDateTimeUnitFormatOptions;
|
|
237
239
|
}
|
|
238
240
|
|
|
239
|
-
/** Defines how the category axis data (
|
|
241
|
+
/** Defines how the category axis data (categories) should be formatted. */
|
|
240
242
|
export interface CategoryFormatOptions {
|
|
241
|
-
/** Represents a unique string identifier for the CategoryFormatOptions object. For CategoryFormatOptions object, it is
|
|
243
|
+
/** Represents a unique string identifier for the `CategoryFormatOptions` object. For the `CategoryFormatOptions` object, it is `category`. It can help to differentiate category axis from other types of axes such as date-time axis and numeric (value) axis. */
|
|
242
244
|
type: typeof WebChartTypes.CategoryAxisFormat;
|
|
243
|
-
/**
|
|
244
|
-
* Represents a positive integer which represents the limit on the number of characters to be displayed for all the category strings. The truncated string are appended with `...`. If property is not present or `null`, no truncation is done.
|
|
245
|
-
*
|
|
246
|
-
* @minimum 1
|
|
247
|
-
* @multipleOf 1
|
|
248
|
-
*/
|
|
245
|
+
/** Represents a positive integer which represents the limit on the number of characters to be displayed for all the category strings. The truncated string are appended with `...`. If property is not present or `null`, no truncation is done. */
|
|
249
246
|
characterLimit?: number | null;
|
|
250
247
|
}
|
|
251
248
|
|
|
252
249
|
/** JSON representation of the chart's guide object. Can be used to represent both line and fill guides. */
|
|
253
250
|
export interface WebChartGuide {
|
|
254
|
-
/** Represents a unique string identifier for the Guide object. For Guide class, it is
|
|
251
|
+
/** Represents a unique string identifier for the `Guide` object. For the `Guide` class, it is `chartGuide`. */
|
|
255
252
|
type: typeof WebChartTypes.Guide;
|
|
256
253
|
/** Determines the value where the guide should begin. */
|
|
257
254
|
start: Date | number | string | null;
|
|
258
|
-
/** Determines the value where the guide should end. If it is not specified,
|
|
255
|
+
/** Determines the value where the guide should end. If it is not specified, a line guide is used, otherwise a fill/rectangular guide is used. */
|
|
259
256
|
end?: Date | number | string | null;
|
|
260
|
-
/** Determines how the guide should be rendered.
|
|
257
|
+
/** Determines how the guide should be rendered. */
|
|
261
258
|
style: ISimpleFillSymbol | ISimpleLineSymbol;
|
|
262
|
-
/** A unique string identifier which is used to refer to a particular guide. It is displayed in the
|
|
259
|
+
/** A unique string identifier which is used to refer to a particular guide. It is displayed in the charts config UI to differentiate between different guides. */
|
|
263
260
|
name: string;
|
|
264
261
|
/** Defines a text label for the given guide. It is displayed on the chart next to the concerned guide and is styled using **esriTS** format. */
|
|
265
262
|
label?: WebChartTextSymbol;
|
|
@@ -285,7 +282,7 @@ export interface WebChartGuide {
|
|
|
285
282
|
|
|
286
283
|
/** JSON representation of the chart's axis object */
|
|
287
284
|
export interface WebChartAxis {
|
|
288
|
-
/** Represents a unique string identifier for the WebChartAxis object. For ChartAxis object, it is
|
|
285
|
+
/** Represents a unique string identifier for the `WebChartAxis` object. For `ChartAxis` object, it is `chartAxis`. */
|
|
289
286
|
type: typeof WebChartTypes.Axis;
|
|
290
287
|
/**
|
|
291
288
|
* Determines the visibility of the content.
|
|
@@ -299,7 +296,7 @@ export interface WebChartAxis {
|
|
|
299
296
|
* @default false
|
|
300
297
|
*/
|
|
301
298
|
isLogarithmic?: boolean;
|
|
302
|
-
/** Contains styling
|
|
299
|
+
/** Contains styling information on how the title of the axis should be rendered */
|
|
303
300
|
title?: WebChartText;
|
|
304
301
|
/** Specifies how numerical/categorical/date-time values should be formatted. */
|
|
305
302
|
valueFormat: CategoryFormatOptions | DateTimeFormatOptions | NumberFormatOptions;
|
|
@@ -312,16 +309,16 @@ export interface WebChartAxis {
|
|
|
312
309
|
/** Represent an array of guides that should be rendered onto the axis. */
|
|
313
310
|
guides?: WebChartGuide[];
|
|
314
311
|
/**
|
|
315
|
-
* Contains styling
|
|
312
|
+
* Contains styling information on how the axis line should be rendered.
|
|
316
313
|
* If not provided a default style is applied.
|
|
317
314
|
*/
|
|
318
315
|
lineSymbol?: ISimpleLineSymbol;
|
|
319
|
-
/** Contains styling
|
|
316
|
+
/** Contains styling information on how the axis labels should be rendered. */
|
|
320
317
|
labels: WebChartText;
|
|
321
|
-
/** Represents the axis scrollbar style and visibility */
|
|
318
|
+
/** Represents the axis scrollbar style and visibility. */
|
|
322
319
|
scrollbar?: WebChartAxisScrollBar;
|
|
323
320
|
/**
|
|
324
|
-
* Represents an option to hide/un-hide the zero line on value axis
|
|
321
|
+
* Represents an option to hide/un-hide the zero line on value axis.
|
|
325
322
|
*
|
|
326
323
|
* @default false
|
|
327
324
|
*/
|
|
@@ -348,7 +345,7 @@ export interface WebChartAxis {
|
|
|
348
345
|
* The desired minimum distance between two adjacent axis ticks. The actual distance may fluctuate depending on the chart's size.
|
|
349
346
|
* When not provided a default value is assigned according to the axis type and axis labels behavior.
|
|
350
347
|
*
|
|
351
|
-
* **Note**: This property
|
|
348
|
+
* **Note**: This property is not applicable to gauge charts.
|
|
352
349
|
*
|
|
353
350
|
* @minimum 1
|
|
354
351
|
*/
|
|
@@ -360,9 +357,9 @@ export interface WebChartAxis {
|
|
|
360
357
|
dateBaseInterval?: TimeIntervalInfo;
|
|
361
358
|
}
|
|
362
359
|
|
|
363
|
-
/** JSON representation of the gauge axis ticks. Currently only used by WebChartGaugeAxis
|
|
360
|
+
/** JSON representation of the gauge axis ticks. Currently only used by `WebChartGaugeAxis`. */
|
|
364
361
|
export interface WebChartGaugeAxisTick {
|
|
365
|
-
/** Represents a unique string identifier for the GaugeAxisTick object. For WebChartGaugeAxisTick object, it is
|
|
362
|
+
/** Represents a unique string identifier for the `GaugeAxisTick` object. For `WebChartGaugeAxisTick` object, it is `gaugeAxisTick`. */
|
|
366
363
|
type: typeof WebChartTypes.GaugeAxisTick;
|
|
367
364
|
/**
|
|
368
365
|
* Determines the visibility of the axis ticks.
|
|
@@ -374,7 +371,7 @@ export interface WebChartGaugeAxisTick {
|
|
|
374
371
|
|
|
375
372
|
/** JSON representation of a gauge needle. */
|
|
376
373
|
export interface WebChartNeedle {
|
|
377
|
-
/** Represents a unique string identifier for the ChartNeedle object. For WebChartNeedle object, it is
|
|
374
|
+
/** Represents a unique string identifier for the `ChartNeedle` object. For `WebChartNeedle` object, it is `gaugeNeedle`. */
|
|
378
375
|
type: typeof WebChartTypes.GaugeNeedle;
|
|
379
376
|
/**
|
|
380
377
|
* Hides or shows the needle.
|
|
@@ -382,17 +379,17 @@ export interface WebChartNeedle {
|
|
|
382
379
|
* @default true
|
|
383
380
|
*/
|
|
384
381
|
visible?: boolean;
|
|
385
|
-
/** Contains styling
|
|
382
|
+
/** Contains styling information on how the needle should be rendered. */
|
|
386
383
|
symbol?: ISimpleFillSymbol;
|
|
387
384
|
/**
|
|
388
|
-
* Represents the needle's thickness at the bottom (chart's center)
|
|
385
|
+
* Represents the needle's thickness at the bottom (chart's center) in pixels.
|
|
389
386
|
*
|
|
390
387
|
* @default 10
|
|
391
388
|
* @minimum 1
|
|
392
389
|
*/
|
|
393
390
|
startWidth?: number | null;
|
|
394
391
|
/**
|
|
395
|
-
* Represents the needle's thickness at the top
|
|
392
|
+
* Represents the needle's thickness at the top in pixels.
|
|
396
393
|
*
|
|
397
394
|
* @default 1
|
|
398
395
|
* @minimum 1
|
|
@@ -407,28 +404,27 @@ export interface WebChartNeedle {
|
|
|
407
404
|
*/
|
|
408
405
|
innerRadius?: number | null;
|
|
409
406
|
/**
|
|
410
|
-
* Hides or shows the needle's pin (centroid circle)
|
|
407
|
+
* Hides or shows the needle's pin (centroid circle).
|
|
411
408
|
*
|
|
412
409
|
* @default false
|
|
413
410
|
*/
|
|
414
411
|
displayPin?: boolean;
|
|
415
412
|
}
|
|
416
413
|
|
|
417
|
-
/** JSON representation of the gauge chart's axis object. Inherits from the WebChartAxis properties. */
|
|
414
|
+
/** JSON representation of the gauge chart's axis object. Inherits from the `WebChartAxis` properties. */
|
|
418
415
|
export interface WebChartGaugeAxis extends WebChartAxis {
|
|
419
|
-
/** Specifies how the axis' inner label needs to be displayed */
|
|
416
|
+
/** Specifies how the axis' inner label needs to be displayed. */
|
|
420
417
|
innerLabel?: WebChartText;
|
|
421
|
-
/** Specifies how the axis' needle needs to be displayed */
|
|
418
|
+
/** Specifies how the axis' needle needs to be displayed. */
|
|
422
419
|
needle?: WebChartNeedle;
|
|
423
|
-
/** Specifies how the axis' ticks need to be displayed */
|
|
420
|
+
/** Specifies how the axis' ticks need to be displayed. */
|
|
424
421
|
ticks?: WebChartGaugeAxisTick;
|
|
425
422
|
/**
|
|
426
423
|
* If a label has a value being a multiple of that property, it will be displayed. Otherwise it will be hidden.
|
|
427
424
|
*
|
|
428
|
-
* If the property is `undefined` or 0
|
|
429
|
-
* the axis min and max.
|
|
425
|
+
* If the property is `undefined` or `0`, the chart will be displayed with 6 axis labels distributed evenly along the axis min and max.
|
|
430
426
|
*
|
|
431
|
-
* If the property has a value that results in more than a set limit of axis labels (25 as defined in `ChartDefaults.gauge.maximumNumberOfLabelIntervals`)
|
|
427
|
+
* If the property has a value that results in more than a set limit of axis labels (`25` as defined in `ChartDefaults.gauge.maximumNumberOfLabelIntervals`)
|
|
432
428
|
* this property value will be ignored and the chart will be displayed with only axis min/max with 4 ticks in between.
|
|
433
429
|
*
|
|
434
430
|
* @default undefined
|
|
@@ -436,35 +432,36 @@ export interface WebChartGaugeAxis extends WebChartAxis {
|
|
|
436
432
|
*/
|
|
437
433
|
labelsIncrement?: number;
|
|
438
434
|
/**
|
|
439
|
-
* Specifies if only the first and last labels need to be displayed. If set to `true` all the other labels
|
|
440
|
-
*
|
|
441
|
-
* Their visibility still depends on the axis labels visibility (WebChartAxis.labels.visible).
|
|
435
|
+
* Specifies if only the first and last labels need to be displayed. If set to `true` all the other labels will be hidden.
|
|
436
|
+
* Their visibility still depends on the axis labels visibility (`WebChartAxis.labels.visible`).
|
|
442
437
|
*
|
|
443
438
|
* @default false
|
|
444
439
|
*/
|
|
445
440
|
onlyShowFirstAndLastLabels?: boolean;
|
|
446
|
-
/** Defines how to convert the axis minimum */
|
|
441
|
+
/** Defines how to convert the axis minimum. */
|
|
447
442
|
minimumValueConversion?: ValueConversion;
|
|
448
|
-
/** Defines how to convert the axis maximum */
|
|
443
|
+
/** Defines how to convert the axis maximum. */
|
|
449
444
|
maximumValueConversion?: ValueConversion;
|
|
450
445
|
/**
|
|
451
|
-
*
|
|
452
|
-
* - `minimumFromField` is expected to be a field name. The value from that field for the given feature is mapped to the axis minimum value
|
|
453
|
-
*
|
|
454
|
-
*
|
|
455
|
-
* - If
|
|
456
|
-
*
|
|
457
|
-
*
|
|
446
|
+
* With a gauge by feature:
|
|
447
|
+
* - `minimumFromField` is expected to be a field name. The value from that field for the given feature is mapped to the axis minimum value.
|
|
448
|
+
*
|
|
449
|
+
* With a statistic gauge:
|
|
450
|
+
* - If `minimumFromField` is set to a field name (string), the minimum from that field is mapped to the axis minimum value.
|
|
451
|
+
* - If it is set to an `IStatisticDefinition` the statistic (min, max, avg...) from the given field is mapped to the axis minimum value.
|
|
452
|
+
*
|
|
453
|
+
* When `minimumFromField` is not provided or when it leads to an invalid value, the `minimum` value from the axis config, if provided, or the default value of 0, in that order, will be used.
|
|
458
454
|
*/
|
|
459
455
|
minimumFromField?: IStatisticDefinition | string;
|
|
460
456
|
/**
|
|
461
|
-
*
|
|
462
|
-
* - `maximumFromField` is expected to be a field name. The value from that field for the given feature is mapped to the axis maximum value
|
|
463
|
-
*
|
|
464
|
-
*
|
|
465
|
-
* - If
|
|
466
|
-
*
|
|
467
|
-
*
|
|
457
|
+
* With a gauge by feature:
|
|
458
|
+
* - `maximumFromField` is expected to be a field name. The value from that field for the given feature is mapped to the axis maximum value.
|
|
459
|
+
*
|
|
460
|
+
* With a statistic gauge:
|
|
461
|
+
* - If `maximumFromField` is set to a field name (string), the maximum from that field is mapped to the axis maximum value.
|
|
462
|
+
* - If it is set to an `IStatisticDefinition` the statistic (min, max, avg...) from the given field is mapped to the axis maximum value.
|
|
463
|
+
*
|
|
464
|
+
* When `maximumFromField` is not provided or when it leads to an invalid value, the `maximum` value from the axis config, if provided, or the default value of 0, in that order, will be used.
|
|
468
465
|
*/
|
|
469
466
|
maximumFromField?: IStatisticDefinition | string;
|
|
470
467
|
}
|
|
@@ -472,36 +469,39 @@ export interface WebChartGaugeAxis extends WebChartAxis {
|
|
|
472
469
|
/** JSON representation of the radar chart's axis object. */
|
|
473
470
|
export interface WebChartRadarChartAxis extends WebChartAxis {
|
|
474
471
|
/**
|
|
475
|
-
* Defines the labels orientation
|
|
472
|
+
* Defines the labels orientation.
|
|
476
473
|
*
|
|
477
474
|
* @default WebChartRadarChartAxisLabelsOrientation.Circular
|
|
478
475
|
*/
|
|
479
476
|
labelsOrientation?: WebChartRadarChartAxisLabelsOrientation;
|
|
480
477
|
}
|
|
481
478
|
|
|
482
|
-
/** Chart query object
|
|
479
|
+
/** Chart's query object. */
|
|
483
480
|
export interface WebChartQuery {
|
|
484
|
-
/** Attribute fields to include in the FeatureSet
|
|
481
|
+
/** Attribute fields to include in the `FeatureSet`. Will have an effect on chart with no aggregation. */
|
|
485
482
|
outFields?: string[];
|
|
486
483
|
/** Acts as a filter on the base data for attribute-based filtering, expect for bar/line charts for which is is used to handle the split-by field values. */
|
|
487
484
|
where?: string;
|
|
488
485
|
/**
|
|
489
|
-
* An array of fields which determine how the base data is grouped. Only one **groupBy**
|
|
486
|
+
* An array of fields which determine how the base data is grouped. Only one **groupBy** field is supported,
|
|
490
487
|
*
|
|
491
488
|
* @maxItems 1
|
|
492
489
|
*/
|
|
493
490
|
groupByFieldsForStatistics?: string[];
|
|
494
|
-
/** Represents an array of statistics definitions which dictate how a particular field should be aggregated.
|
|
491
|
+
/** Represents an array of statistics definitions which dictate how a particular field should be aggregated. */
|
|
495
492
|
outStatistics?: IStatisticDefinition[];
|
|
496
493
|
/**
|
|
497
|
-
* Represents the sorting order of the output result.
|
|
494
|
+
* Represents the sorting order of the output result.
|
|
495
|
+
*
|
|
496
|
+
* It's recommended to use the `orderByFields` property of the chart's `orderOptions` object instead of this one.
|
|
497
|
+
* If both are used, the `orderByFields` property of the chart's `orderOptions` object will take precedence.
|
|
498
|
+
*
|
|
498
499
|
* The format of any entry in this array is `field_name sorting_order`. When `sorting_order` is not defined, it is assumed to be ascending.
|
|
499
500
|
*
|
|
500
501
|
* @example
|
|
502
|
+
* ```
|
|
501
503
|
* ["STATE_NAME DESC", "CITY_NAME ASC", "CITY_NAME"]
|
|
502
|
-
*
|
|
503
|
-
* It's recommended to use the `orderByFields` property of the chart's `orderOptions` object instead of this one.
|
|
504
|
-
* If both are used, the `orderByFields` property of the chart's `orderOptions` object will take precedence.
|
|
504
|
+
* ```
|
|
505
505
|
*/
|
|
506
506
|
orderByFields?: string[];
|
|
507
507
|
/** Specifies the geodatabase version to display for feature service queries. */
|
|
@@ -517,7 +517,7 @@ export interface WebChartQuery {
|
|
|
517
517
|
* If not specified, the unit is derived from the geometry spatial reference.
|
|
518
518
|
*/
|
|
519
519
|
units?: RESTUnits;
|
|
520
|
-
/** A time extent
|
|
520
|
+
/** A time extent `[timestamp, timestamp]` for a temporal query against time-aware layers. */
|
|
521
521
|
timeExtent?: [number, number];
|
|
522
522
|
/** The zero-based index indicating where to begin retrieving features. */
|
|
523
523
|
start?: number;
|
|
@@ -546,7 +546,7 @@ export interface WebChartQuery {
|
|
|
546
546
|
*/
|
|
547
547
|
export type WebChartSeriesQuery = Omit<WebChartQuery, "distance" | "gdbVersion" | "geometry" | "num" | "objectIds" | "orderByFields" | "spatialRelationship" | "start" | "timeExtent" | "units">;
|
|
548
548
|
|
|
549
|
-
/** JSON representation of filters applied to the data */
|
|
549
|
+
/** JSON representation of filters applied to the data. */
|
|
550
550
|
export type WebChartDataFilters = Pick<WebChartQuery, "distance" | "gdbVersion" | "geometry" | "objectIds" | "spatialRelationship" | "timeExtent" | "units" | "where">;
|
|
551
551
|
|
|
552
552
|
/** JSON representation of the chart's series object. All other series extends this interface. */
|
|
@@ -562,14 +562,14 @@ export interface WebChartSeries {
|
|
|
562
562
|
visible?: boolean;
|
|
563
563
|
/**
|
|
564
564
|
* Hides or shows data tooltips.
|
|
565
|
-
*
|
|
565
|
+
* **Note**: Not applicable to gauge.
|
|
566
566
|
*
|
|
567
567
|
* @default true
|
|
568
568
|
*/
|
|
569
569
|
dataTooltipVisible?: boolean;
|
|
570
570
|
/**
|
|
571
|
-
* Indicates whether to apply the hovered element's color to the background (false) or the outline (true).
|
|
572
|
-
*
|
|
571
|
+
* Indicates whether to apply the hovered element's color to the background (`false`) or the outline (`true`).
|
|
572
|
+
* **Note**: Not applicable to gauge.
|
|
573
573
|
*
|
|
574
574
|
* @default false
|
|
575
575
|
*/
|
|
@@ -578,20 +578,20 @@ export interface WebChartSeries {
|
|
|
578
578
|
dataTooltipValueFormat?: NumberFormatOptions;
|
|
579
579
|
/**
|
|
580
580
|
* Defines how to render percent values in tooltips.
|
|
581
|
-
*
|
|
581
|
+
* Used for stacked 100% bar and line charts, as well as pie charts.
|
|
582
582
|
*/
|
|
583
583
|
dataTooltipPercentFormat?: NumberFormatOptions;
|
|
584
584
|
/**
|
|
585
585
|
* Defines how to render dates in tooltips.
|
|
586
|
-
*
|
|
586
|
+
* Used for bar and line charts using a date x-axis with no time binning.
|
|
587
587
|
*/
|
|
588
588
|
dataTooltipDateFormat?: DateTimeFormatOptions;
|
|
589
|
-
/** Specifies the name of the series. It would be reflected in the chart
|
|
589
|
+
/** Specifies the name of the series. It would be reflected in the chart's legend. */
|
|
590
590
|
name: string;
|
|
591
|
-
/** Specifies a query object associated with a particular series containing
|
|
591
|
+
/** Specifies a query object associated with a particular series containing information on what data to fetch for that series. */
|
|
592
592
|
query?: WebChartSeriesQuery;
|
|
593
593
|
/**
|
|
594
|
-
* Specifies which field represents the x-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _)
|
|
594
|
+
* Specifies which field represents the x-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) is needed.
|
|
595
595
|
*
|
|
596
596
|
* @minLength 1
|
|
597
597
|
*/
|
|
@@ -608,19 +608,17 @@ export interface WebChartSeries {
|
|
|
608
608
|
}
|
|
609
609
|
|
|
610
610
|
export interface WebChartCalendarDatePartsBinning extends WebChartTemporalBinningBase {
|
|
611
|
-
/**
|
|
612
|
-
* Represents a unique string identifier for the CalendarDatePartsBinning object.
|
|
613
|
-
* For CalendarDatePartsBinning object, it is "calendarDateParts".
|
|
614
|
-
*/
|
|
611
|
+
/** Represents a unique string identifier for the `CalendarDatePartsBinning` object. `For CalendarDatePartsBinning` object, it is `calendarDateParts`. */
|
|
615
612
|
type: typeof WebChartTypes.CalendarDateParts;
|
|
616
613
|
/** Represents the unit to use to bin the data. */
|
|
617
614
|
unit: WebChartCalendarDatePartsUnits;
|
|
618
615
|
}
|
|
619
616
|
|
|
620
|
-
/** Describes the properties available for a temporal binning for
|
|
617
|
+
/** Describes the properties available for a temporal binning for bar charts and line charts. */
|
|
621
618
|
export interface WebChartTemporalBinning extends WebChartTemporalBinningBase, WebChartTemporalBinningExtras {
|
|
622
619
|
/**
|
|
623
620
|
* The unit of time to use to bin the temporal data.
|
|
621
|
+
*
|
|
624
622
|
* Current limitation: the "quarters" unit is only supported if the provided layer supports the `queryBins` operation.
|
|
625
623
|
*/
|
|
626
624
|
unit?: WebChartTemporalBinningUnits;
|
|
@@ -628,6 +626,7 @@ export interface WebChartTemporalBinning extends WebChartTemporalBinningBase, We
|
|
|
628
626
|
size?: number;
|
|
629
627
|
/**
|
|
630
628
|
* The time interval alignment type. Valid options include `equalIntervalsFromStartTime` and `equalIntervalsFromEndTime`.
|
|
629
|
+
*
|
|
631
630
|
* When specific the binning will start at the first or last date of the dataset.
|
|
632
631
|
*
|
|
633
632
|
* @default "equalIntervalsFromStartTime"
|
|
@@ -635,11 +634,12 @@ export interface WebChartTemporalBinning extends WebChartTemporalBinningBase, We
|
|
|
635
634
|
timeAggregationType?: WebChartTimeAggregationTypes;
|
|
636
635
|
}
|
|
637
636
|
|
|
638
|
-
/** Describes the properties related to a temporal series */
|
|
637
|
+
/** Describes the properties related to a temporal series. */
|
|
639
638
|
export interface WebChartTemporalSeries {
|
|
640
639
|
/**
|
|
641
640
|
* Whether to use the time properties to bin the temporal data.
|
|
642
|
-
*
|
|
641
|
+
*
|
|
642
|
+
* `false` - the `binCount` and `unit` properties can be used to set the date axis base interval.
|
|
643
643
|
*
|
|
644
644
|
* @default true
|
|
645
645
|
*/
|
|
@@ -648,9 +648,9 @@ export interface WebChartTemporalSeries {
|
|
|
648
648
|
temporalBinning?: WebChartTemporalBinning;
|
|
649
649
|
}
|
|
650
650
|
|
|
651
|
-
/**
|
|
651
|
+
/** Bar chart shows the categorical distribution of `String` or `DateTime` data. */
|
|
652
652
|
export interface WebChartBarChartSeries extends WebChartSeries, WebChartTemporalSeries {
|
|
653
|
-
/** Represents a unique string identifier for the BarChartSeries object. For BarSeries object, it is
|
|
653
|
+
/** Represents a unique string identifier for the `BarChartSeries` object. For `BarSeries` object, it is `barSeries`. */
|
|
654
654
|
type: typeof WebChartTypes.BarSeries;
|
|
655
655
|
/**
|
|
656
656
|
* Specifies which field represents the y-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.
|
|
@@ -658,58 +658,62 @@ export interface WebChartBarChartSeries extends WebChartSeries, WebChartTemporal
|
|
|
658
658
|
* @minLength 1
|
|
659
659
|
*/
|
|
660
660
|
y: string;
|
|
661
|
-
/** Contains styling
|
|
661
|
+
/** Contains styling information on how the columns/bars should be rendered. */
|
|
662
662
|
fillSymbol?: ISimpleFillSymbol;
|
|
663
663
|
/**
|
|
664
|
-
*
|
|
665
|
-
*
|
|
664
|
+
* `true` or `undefined` - the labels displayed within a small stacked column are hidden to avoid cluttering.
|
|
665
|
+
* `false` - all the data labels are displayed.
|
|
666
666
|
*
|
|
667
667
|
* @default true
|
|
668
668
|
*/
|
|
669
669
|
hideOversizedStackedLabels?: boolean;
|
|
670
670
|
/**
|
|
671
|
-
* When true
|
|
672
|
-
* When false or undefined (default), all the data labels are displayed.
|
|
671
|
+
* When `true`, the labels displayed within a small column for sideBySide bar series are hidden to avoid cluttering.
|
|
672
|
+
* When `false` or `undefined` (default), all the data labels are displayed.
|
|
673
673
|
*
|
|
674
674
|
* @default false
|
|
675
675
|
*/
|
|
676
676
|
hideOversizedSideBySideLabels?: boolean;
|
|
677
677
|
/**
|
|
678
|
-
* Specifies how to display the category with null value
|
|
678
|
+
* Specifies how to display the category with null value.
|
|
679
679
|
* Setting this property will ensure that the item with no data is displayed on the chart with the specified text and color.
|
|
680
680
|
*/
|
|
681
681
|
nullCategory?: WebChartNullCategory;
|
|
682
682
|
}
|
|
683
683
|
|
|
684
|
-
/** Object containing
|
|
684
|
+
/** Object containing histogram overlays. */
|
|
685
685
|
export interface HistogramOverlays {
|
|
686
|
-
/** Represents a unique string identifier for the HistogramOverlays object. For HistogramOverlays object, it is
|
|
686
|
+
/** Represents a unique string identifier for the `HistogramOverlays` object. For `HistogramOverlays` object, it is `chartOverlays`. */
|
|
687
687
|
type: typeof WebChartTypes.Overlays;
|
|
688
688
|
/**
|
|
689
689
|
* Specifies the mean overlay for histogram.
|
|
690
|
+
*
|
|
690
691
|
* If not provided, the mean overlay is not displayed.
|
|
691
692
|
*/
|
|
692
693
|
mean?: WebChartOverlay;
|
|
693
694
|
/**
|
|
694
695
|
* Specifies the median overlay for histogram.
|
|
696
|
+
*
|
|
695
697
|
* If not provided, the median overlay is not displayed.
|
|
696
698
|
*/
|
|
697
699
|
median?: WebChartOverlay;
|
|
698
700
|
/**
|
|
699
701
|
* Specifies the standard deviation overlay for histogram.
|
|
702
|
+
*
|
|
700
703
|
* If not provided, the standard deviation overlay is not displayed.
|
|
701
704
|
*/
|
|
702
705
|
standardDeviation?: WebChartOverlay;
|
|
703
706
|
/**
|
|
704
707
|
* Specifies the comparison distribution overlay for histogram.
|
|
708
|
+
*
|
|
705
709
|
* If not provided, the comparison distribution overlay is not displayed.
|
|
706
710
|
*/
|
|
707
711
|
comparisonDistribution?: WebChartOverlay;
|
|
708
712
|
}
|
|
709
713
|
|
|
710
|
-
/**
|
|
714
|
+
/** Histogram shows the frequency distribution of a numerical field. */
|
|
711
715
|
export interface WebChartHistogramSeries extends WebChartSeries {
|
|
712
|
-
/** Represents a unique string identifier for the HistogramSeries object. For
|
|
716
|
+
/** Represents a unique string identifier for the `HistogramSeries` object. For `HistogramSeries` object, it is `histogramSeries`. */
|
|
713
717
|
type: typeof WebChartTypes.HistogramSeries;
|
|
714
718
|
/**
|
|
715
719
|
* Bin count must be a positive integer.
|
|
@@ -726,34 +730,35 @@ export interface WebChartHistogramSeries extends WebChartSeries {
|
|
|
726
730
|
overlays?: HistogramOverlays;
|
|
727
731
|
/** Specifies how the data should be transformed (e.g. square root, log, etc.) before binning. */
|
|
728
732
|
dataTransformationType?: WebChartDataTransformations;
|
|
729
|
-
/** Contains styling
|
|
733
|
+
/** Contains styling information on how the columns should be rendered. */
|
|
730
734
|
fillSymbol?: ISimpleFillSymbol;
|
|
731
735
|
}
|
|
732
736
|
|
|
733
|
-
/** Object containing
|
|
737
|
+
/** Object containing scatterplot overlays. */
|
|
734
738
|
export interface ScatterplotOverlays {
|
|
735
|
-
/** Represents a unique string identifier for the ScatterplotOverlays object. For ScatterplotOverlays object, it is
|
|
739
|
+
/** Represents a unique string identifier for the `ScatterplotOverlays` object. For the `ScatterplotOverlays` object, it is `chartOverlays`. */
|
|
736
740
|
type: typeof WebChartTypes.Overlays;
|
|
737
741
|
/**
|
|
738
|
-
* Specifies the
|
|
739
|
-
*
|
|
742
|
+
* Specifies the trend line overlay for scatterplot.
|
|
743
|
+
*
|
|
744
|
+
* The trend line won't show if the property is not defined.
|
|
740
745
|
*/
|
|
741
746
|
trendLine?: WebChartOverlay;
|
|
742
747
|
}
|
|
743
748
|
|
|
744
749
|
export interface SizePolicy {
|
|
745
|
-
/** Represents a unique string identifier for the sizePolicy object. For sizePolicy object, it is
|
|
750
|
+
/** Represents a unique string identifier for the `sizePolicy` object. For the `sizePolicy` object, it is `sizeScale`. */
|
|
746
751
|
type: typeof WebChartTypes.SizePolicy;
|
|
747
752
|
/**
|
|
748
|
-
* The type of scale to apply to the markers (
|
|
753
|
+
* The type of scale to apply to the markers (`logarithmic` or `linear`).
|
|
749
754
|
*
|
|
750
755
|
* @default SizePolicyScaleTypes.Linear
|
|
751
756
|
*/
|
|
752
757
|
scaleType?: SizePolicyScaleTypes;
|
|
753
|
-
/** The field which determines the markers size */
|
|
758
|
+
/** The field which determines the markers size. */
|
|
754
759
|
field: string;
|
|
755
760
|
/**
|
|
756
|
-
* The minimum marker size
|
|
761
|
+
* The minimum marker size.
|
|
757
762
|
*
|
|
758
763
|
* @default 5
|
|
759
764
|
* @min 1
|
|
@@ -761,7 +766,7 @@ export interface SizePolicy {
|
|
|
761
766
|
*/
|
|
762
767
|
minSize?: number;
|
|
763
768
|
/**
|
|
764
|
-
* The maximum marker size
|
|
769
|
+
* The maximum marker size.
|
|
765
770
|
*
|
|
766
771
|
* @default 30
|
|
767
772
|
* @min 1
|
|
@@ -770,9 +775,9 @@ export interface SizePolicy {
|
|
|
770
775
|
maxSize?: number;
|
|
771
776
|
}
|
|
772
777
|
|
|
773
|
-
/**
|
|
778
|
+
/** Scatterplot shows the relationship between two numerical fields. */
|
|
774
779
|
export interface WebChartScatterplotSeries extends WebChartSeries {
|
|
775
|
-
/** Represents a unique string identifier for the ScatterSeries object. For ScatterSeries object, it is
|
|
780
|
+
/** Represents a unique string identifier for the `ScatterSeries` object. For the `ScatterSeries` object, it is `scatterSeries`. */
|
|
776
781
|
type: typeof WebChartTypes.ScatterSeries;
|
|
777
782
|
/**
|
|
778
783
|
* Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.
|
|
@@ -780,14 +785,14 @@ export interface WebChartScatterplotSeries extends WebChartSeries {
|
|
|
780
785
|
* @minLength 1
|
|
781
786
|
*/
|
|
782
787
|
y: string;
|
|
783
|
-
/** Specifies how each data point in the
|
|
788
|
+
/** Specifies how each data point in the scatterplot should be rendered. */
|
|
784
789
|
markerSymbol?: ISimpleMarkerSymbol;
|
|
785
790
|
/**
|
|
786
|
-
* Specifies all the chart overlays. The
|
|
791
|
+
* Specifies all the chart overlays. The scatterplot implements only 1 overlay, **trendLine**.
|
|
787
792
|
* The overlays won't show if the property is not defined.
|
|
788
793
|
*/
|
|
789
794
|
overlays?: ScatterplotOverlays;
|
|
790
|
-
/** Specifies rules to use the
|
|
795
|
+
/** Specifies rules to use the scatterplot as bubble plot, by changing dynamically the markers size according to a specific field value. */
|
|
791
796
|
sizePolicy?: SizePolicy;
|
|
792
797
|
/** Specifies the additional numeric fields in the tooltip. */
|
|
793
798
|
additionalTooltipFields?: string[];
|
|
@@ -795,15 +800,16 @@ export interface WebChartScatterplotSeries extends WebChartSeries {
|
|
|
795
800
|
|
|
796
801
|
/** JSON representation of the pie ticks. */
|
|
797
802
|
export interface WebChartPieChartTick {
|
|
798
|
-
/** Represents a unique string identifier for the WebChartPieChartTick object. For
|
|
803
|
+
/** Represents a unique string identifier for the `WebChartPieChartTick` object. For the `WebChartPieChartTick` object, it is `pieTick`. */
|
|
799
804
|
type: typeof WebChartTypes.PieTick;
|
|
800
805
|
/**
|
|
801
806
|
* Determines the visibility of the tick.
|
|
807
|
+
*
|
|
802
808
|
* Assigning the `true` value will only be considered when the data labels are visible (`series.dataLabels.visible`) and
|
|
803
809
|
* when the data label associated to the tick is outside of the chart (`series.dataLabelsOffset` > 0).
|
|
804
810
|
*/
|
|
805
811
|
visible?: boolean;
|
|
806
|
-
/** Contains styling
|
|
812
|
+
/** Contains styling information on how the pie chart ticks should be rendered. */
|
|
807
813
|
lineSymbol?: ISimpleLineSymbol;
|
|
808
814
|
}
|
|
809
815
|
|
|
@@ -815,21 +821,19 @@ export interface WebChartPieChartSlice {
|
|
|
815
821
|
readonly originalLabel?: Date | number | string | null;
|
|
816
822
|
/**
|
|
817
823
|
* Custom label for the slice.
|
|
824
|
+
*
|
|
818
825
|
* For grouped slice, the default value is `Other`.
|
|
819
826
|
* For regular slice, it will be either the category or field name.
|
|
820
827
|
*/
|
|
821
828
|
label?: string;
|
|
822
|
-
/**
|
|
823
|
-
* Contains styling info on how the slice should be rendered. If not provided, the slice will
|
|
824
|
-
* be styled with default values.
|
|
825
|
-
*/
|
|
829
|
+
/** Contains styling information on how the slice should be rendered. If not provided, the slice will be styled with default values. */
|
|
826
830
|
fillSymbol?: ISimpleFillSymbol;
|
|
827
831
|
}
|
|
828
832
|
|
|
829
|
-
/** JSON representation of the pie grouped slice */
|
|
833
|
+
/** JSON representation of the pie grouped slice. */
|
|
830
834
|
export interface WebChartPieChartGroupSlice extends WebChartPieChartSlice {
|
|
831
835
|
/**
|
|
832
|
-
* Slices that have a percent value equal or lesser to this threshold are grouped into a unique slice
|
|
836
|
+
* Slices that have a percent value equal or lesser to this threshold are grouped into a unique slice.
|
|
833
837
|
*
|
|
834
838
|
* @min 0
|
|
835
839
|
* @max 100
|
|
@@ -837,14 +841,15 @@ export interface WebChartPieChartGroupSlice extends WebChartPieChartSlice {
|
|
|
837
841
|
percentageThreshold: number;
|
|
838
842
|
/**
|
|
839
843
|
* Specifies how the grouped slice data labels should be rendered.
|
|
844
|
+
*
|
|
840
845
|
* If the property is not set the `series.dataLabels` will be used instead.
|
|
841
846
|
*/
|
|
842
847
|
dataLabels?: WebChartText;
|
|
843
848
|
}
|
|
844
849
|
|
|
845
|
-
/** JSON representation of the
|
|
850
|
+
/** JSON representation of the pie chart series */
|
|
846
851
|
export interface WebChartPieChartSeries extends WebChartSeries {
|
|
847
|
-
/** Represents a unique string identifier for the
|
|
852
|
+
/** Represents a unique string identifier for the `WebChartPieChartSeries` object. For the `WebChartPieChartSeries` object, it is `pieSeries`. */
|
|
848
853
|
type: typeof WebChartTypes.PieSeries;
|
|
849
854
|
/**
|
|
850
855
|
* Specifies which field represents the y-coordinates of this series. Empty string or one with just white spaces is not allowed. At least 1 or more word characters (a-z, A-Z, _) are needed.
|
|
@@ -864,7 +869,7 @@ export interface WebChartPieChartSeries extends WebChartSeries {
|
|
|
864
869
|
startAngle?: number | null;
|
|
865
870
|
/** @default 270 */
|
|
866
871
|
endAngle?: number | null;
|
|
867
|
-
/** Contains styling
|
|
872
|
+
/** Contains styling information on how the slices should be rendered. */
|
|
868
873
|
fillSymbol?: ISimpleFillSymbol;
|
|
869
874
|
/**
|
|
870
875
|
* Indicates whether the category associated to a slice is to be displayed on its data label.
|
|
@@ -875,7 +880,9 @@ export interface WebChartPieChartSeries extends WebChartSeries {
|
|
|
875
880
|
displayCategoryOnDataLabel?: boolean;
|
|
876
881
|
/**
|
|
877
882
|
* Indicates whether the numeric value associated to a slice is to be displayed on its data label.
|
|
883
|
+
*
|
|
878
884
|
* If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as `percentage (value)`.
|
|
885
|
+
*
|
|
879
886
|
* This property will be ignored if the chart options `dataLabelFormatter` is provided.
|
|
880
887
|
*
|
|
881
888
|
* @default true
|
|
@@ -883,7 +890,9 @@ export interface WebChartPieChartSeries extends WebChartSeries {
|
|
|
883
890
|
displayNumericValueOnDataLabel?: boolean;
|
|
884
891
|
/**
|
|
885
892
|
* Indicates whether the percentage associated to a slice is to be displayed on its data label.
|
|
893
|
+
*
|
|
886
894
|
* If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as `percentage (value)`
|
|
895
|
+
*
|
|
887
896
|
* This property will be ignored if the chart options `dataLabelFormatter` is provided.
|
|
888
897
|
*
|
|
889
898
|
* @default false
|
|
@@ -891,6 +900,7 @@ export interface WebChartPieChartSeries extends WebChartSeries {
|
|
|
891
900
|
displayPercentageOnDataLabel?: boolean;
|
|
892
901
|
/**
|
|
893
902
|
* Indicates whether the category associated to a slice is to be displayed on its tooltip.
|
|
903
|
+
*
|
|
894
904
|
* This property will be ignored if the chart options `tooltipFormatter` is provided.
|
|
895
905
|
*
|
|
896
906
|
* @default true
|
|
@@ -898,7 +908,9 @@ export interface WebChartPieChartSeries extends WebChartSeries {
|
|
|
898
908
|
displayCategoryOnTooltip?: boolean;
|
|
899
909
|
/**
|
|
900
910
|
* Indicates whether the numeric value associated to a slice is to be displayed on its tooltip.
|
|
911
|
+
*
|
|
901
912
|
* If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as `percentage (value)`
|
|
913
|
+
*
|
|
902
914
|
* This property will be ignored if the chart options `tooltipFormatter` is provided.
|
|
903
915
|
*
|
|
904
916
|
* @default true
|
|
@@ -906,7 +918,9 @@ export interface WebChartPieChartSeries extends WebChartSeries {
|
|
|
906
918
|
displayNumericValueOnTooltip?: boolean;
|
|
907
919
|
/**
|
|
908
920
|
* Indicates whether the percentage associated to a slice is to be displayed on its tooltip.
|
|
921
|
+
*
|
|
909
922
|
* If both displayNumericValue & displayPercentage are true on a same label, they will be displayed as `percentage (value)`
|
|
923
|
+
*
|
|
910
924
|
* This property will be ignored if the chart options `tooltipFormatter` is provided.
|
|
911
925
|
*
|
|
912
926
|
* @default true
|
|
@@ -914,27 +928,28 @@ export interface WebChartPieChartSeries extends WebChartSeries {
|
|
|
914
928
|
displayPercentageOnTooltip?: boolean;
|
|
915
929
|
/**
|
|
916
930
|
* Specifies how the numerical values should be formatted (applied to label, tooltip and legend).
|
|
917
|
-
*
|
|
931
|
+
*
|
|
932
|
+
* Can be overridden for the tooltips by `series.dataTooltipValueFormat`.
|
|
918
933
|
*/
|
|
919
934
|
numericValueFormat?: NumberFormatOptions;
|
|
920
935
|
/**
|
|
921
|
-
* Specifies how the percent values should be formatted (applied to label, tooltip and legend)
|
|
922
|
-
*
|
|
936
|
+
* Specifies how the percent values should be formatted (applied to label, tooltip and legend).
|
|
937
|
+
*
|
|
938
|
+
* Can be overridden for the tooltips by `series.dataTooltipPercentFormat`.
|
|
923
939
|
*/
|
|
924
940
|
percentValueFormat?: NumberFormatOptions;
|
|
925
|
-
/** Adds a prefix to all the values displayed on the pie chart: data labels, tooltips and legend */
|
|
941
|
+
/** Adds a prefix to all the values displayed on the pie chart: data labels, tooltips and legend. */
|
|
926
942
|
valuePrefix?: string;
|
|
927
|
-
/** Adds a suffix to all the values displayed on the pie chart: data labels, tooltips and legend */
|
|
943
|
+
/** Adds a suffix to all the values displayed on the pie chart: data labels, tooltips and legend. */
|
|
928
944
|
valueSuffix?: string;
|
|
929
|
-
/** Adds a prefix to all the percentages displayed on the pie chart: data labels, tooltips and legend */
|
|
945
|
+
/** Adds a prefix to all the percentages displayed on the pie chart: data labels, tooltips and legend. */
|
|
930
946
|
percentagePrefix?: string;
|
|
931
|
-
/** Adds a suffix to all the percentages displayed on the pie chart: data labels, tooltips and legend */
|
|
947
|
+
/** Adds a suffix to all the percentages displayed on the pie chart: data labels, tooltips and legend. */
|
|
932
948
|
percentageSuffix?: string;
|
|
933
949
|
/**
|
|
934
|
-
* If set, the category on the data label is truncated to display only `characterLimit` characters, and an ellipsis ("...")
|
|
935
|
-
*
|
|
936
|
-
*
|
|
937
|
-
* Does not apply to tooltips and legend labels.
|
|
950
|
+
* If set, the category on the data label is truncated to display only `characterLimit` characters, and an ellipsis ("...") is added to the end of the label.
|
|
951
|
+
*
|
|
952
|
+
* Does not affect the value or percentage displayed in labels. Not applicable to tooltips or legend labels.
|
|
938
953
|
*
|
|
939
954
|
* @default undefined
|
|
940
955
|
* @minimum 1
|
|
@@ -948,10 +963,11 @@ export interface WebChartPieChartSeries extends WebChartSeries {
|
|
|
948
963
|
ticks?: WebChartPieChartTick;
|
|
949
964
|
/**
|
|
950
965
|
* Whether to place the data labels inside the pie slices.
|
|
966
|
+
*
|
|
951
967
|
* When set to `true` the following properties will be ignored:
|
|
952
|
-
* - dataLabelsOffset
|
|
953
|
-
* - alignDataLabels
|
|
954
|
-
* - optimizeDataLabelsOverlapping
|
|
968
|
+
* - `dataLabelsOffset`
|
|
969
|
+
* - `alignDataLabels`
|
|
970
|
+
* - `optimizeDataLabelsOverlapping`
|
|
955
971
|
*
|
|
956
972
|
* @default false
|
|
957
973
|
*/
|
|
@@ -959,6 +975,7 @@ export interface WebChartPieChartSeries extends WebChartSeries {
|
|
|
959
975
|
/**
|
|
960
976
|
* Determines in pixel how far the data labels should be placed from their slice.
|
|
961
977
|
* If a negative value is provided the label will be placed inside of the chart.
|
|
978
|
+
*
|
|
962
979
|
* Ignored when `dataLabelsInside` is set to `true`.
|
|
963
980
|
*
|
|
964
981
|
* @default 10
|
|
@@ -966,6 +983,7 @@ export interface WebChartPieChartSeries extends WebChartSeries {
|
|
|
966
983
|
dataLabelsOffset?: number;
|
|
967
984
|
/**
|
|
968
985
|
* Aligns labels into columns to make them more readable and avoid them to overlap each other.
|
|
986
|
+
*
|
|
969
987
|
* Ignored when `dataLabelsInside` is set to `true`.
|
|
970
988
|
*
|
|
971
989
|
* @default false
|
|
@@ -973,44 +991,46 @@ export interface WebChartPieChartSeries extends WebChartSeries {
|
|
|
973
991
|
alignDataLabels?: boolean;
|
|
974
992
|
/**
|
|
975
993
|
* Optimizes the data labels rendering to avoid them to be cut off on the edges or to overlap the legend by wrapping them and adding padding to the chart.
|
|
994
|
+
*
|
|
976
995
|
* Ignored when `dataLabelsInside` is set to `true`.
|
|
977
996
|
*
|
|
978
997
|
* @default false
|
|
979
998
|
*/
|
|
980
999
|
optimizeDataLabelsOverlapping?: boolean;
|
|
981
|
-
/** Specifies if and how the slices under a given percentage threshold are grouped into a unique slice */
|
|
1000
|
+
/** Specifies if and how the slices under a given percentage threshold are grouped into a unique slice. */
|
|
982
1001
|
sliceGrouping?: WebChartPieChartGroupSlice;
|
|
983
1002
|
/**
|
|
984
|
-
* An array of WebChartPieChartSlice representing the ids, labels and styles of the pie slices.
|
|
1003
|
+
* An array of `WebChartPieChartSlice` representing the ids, labels and styles of the pie slices.
|
|
985
1004
|
*
|
|
986
1005
|
* When this property is not defined, or when a pie slice does not have a matching slice in this array,
|
|
987
|
-
* the series' fillSymbol will be used. If the series' fillSymbol does not contain color information, colors from the
|
|
988
|
-
* color ramps will be utilized.
|
|
1006
|
+
* the series' fillSymbol will be used. If the series' fillSymbol does not contain color information, colors from the color ramps will be utilized.
|
|
989
1007
|
*/
|
|
990
1008
|
slices?: WebChartPieChartSlice[];
|
|
991
1009
|
}
|
|
992
1010
|
|
|
993
|
-
/** JSON representation of the
|
|
1011
|
+
/** JSON representation of the gauge series */
|
|
994
1012
|
export interface WebChartGaugeSeries extends WebChartSeries {
|
|
995
|
-
/** Represents a unique string identifier for the
|
|
1013
|
+
/** Represents a unique string identifier for the `WebChartGaugeSeries` object. For the `WebChartGaugeSeries` object, it is `gaugeSeries`. */
|
|
996
1014
|
type: typeof WebChartTypes.GaugeSeries;
|
|
997
|
-
/** Defines the conversion to apply to the gauge value */
|
|
1015
|
+
/** Defines the conversion to apply to the gauge value. */
|
|
998
1016
|
valueConversion?: ValueConversion;
|
|
999
1017
|
/**
|
|
1000
1018
|
* Specifies the index of the feature to be rendered.
|
|
1019
|
+
*
|
|
1001
1020
|
* This property will be ignored for a statistic gauge (indicated via `WebGaugeChart.subType` property).
|
|
1021
|
+
*
|
|
1002
1022
|
* For feature-based gauge, if this property is not present, the first feature will be used (featureIndex = 0)
|
|
1003
1023
|
*/
|
|
1004
1024
|
featureIndex?: number;
|
|
1005
1025
|
}
|
|
1006
1026
|
|
|
1007
|
-
/** JSON representation of the
|
|
1027
|
+
/** JSON representation of the line chart series. */
|
|
1008
1028
|
export interface WebChartLineChartSeries<SeriesType extends "lineSeries" | "radarSeries" = "lineSeries"> extends WebChartSeries, WebChartTemporalSeries {
|
|
1009
|
-
/** Represents a unique string identifier for the
|
|
1029
|
+
/** Represents a unique string identifier for the `WebChartLineChartSeries` object. For the `WebChartLineChartSeries` object, it is `lineSeries`. */
|
|
1010
1030
|
type: SeriesType;
|
|
1011
|
-
/** Specifies the numeric field(s) used by the series.
|
|
1031
|
+
/** Specifies the numeric field(s) used by the series. */
|
|
1012
1032
|
y: string[] | string;
|
|
1013
|
-
/** Contains styling
|
|
1033
|
+
/** Contains styling information on how the line or line segments should be rendered. */
|
|
1014
1034
|
lineSymbol?: ISimpleLineSymbol;
|
|
1015
1035
|
/**
|
|
1016
1036
|
* Specifies whether line segments should be smoothed.
|
|
@@ -1030,17 +1050,18 @@ export interface WebChartLineChartSeries<SeriesType extends "lineSeries" | "rada
|
|
|
1030
1050
|
* @default true
|
|
1031
1051
|
*/
|
|
1032
1052
|
markerVisible?: boolean;
|
|
1033
|
-
/** Contains styling
|
|
1053
|
+
/** Contains styling information on how the marker should be rendered. */
|
|
1034
1054
|
markerSymbol?: ISimpleMarkerSymbol;
|
|
1035
1055
|
/**
|
|
1036
1056
|
* Specifies the color of the filled area for line chart.
|
|
1037
|
-
*
|
|
1057
|
+
*
|
|
1058
|
+
* `areaColor` will be applied only if `showArea` is true, and is defaulted to the line color if not provided.
|
|
1038
1059
|
*/
|
|
1039
1060
|
areaColor?: Color;
|
|
1040
1061
|
/**
|
|
1041
1062
|
* Specifies how negative values are treated in stacked series.
|
|
1042
|
-
*
|
|
1043
|
-
*
|
|
1063
|
+
* `true` - negative values will be stacked on the base line.
|
|
1064
|
+
* `false` - negative values will be stacked in relation to their previous values in the stack.
|
|
1044
1065
|
*
|
|
1045
1066
|
* @default true
|
|
1046
1067
|
*/
|
|
@@ -1053,13 +1074,14 @@ export interface WebChartLineChartSeries<SeriesType extends "lineSeries" | "rada
|
|
|
1053
1074
|
*/
|
|
1054
1075
|
connectLines?: boolean;
|
|
1055
1076
|
/**
|
|
1056
|
-
* Specifies how to display the category with null value
|
|
1077
|
+
* Specifies how to display the category with null value.
|
|
1078
|
+
*
|
|
1057
1079
|
* Setting this property will ensure that the item with no data is displayed on the chart with the specified text and color.
|
|
1058
1080
|
*/
|
|
1059
1081
|
nullCategory?: WebChartNullCategory;
|
|
1060
1082
|
}
|
|
1061
1083
|
|
|
1062
|
-
/** JSON representation of the
|
|
1084
|
+
/** JSON representation of the box plot series */
|
|
1063
1085
|
export interface WebChartBoxPlotSeries extends WebChartSeries {
|
|
1064
1086
|
type: typeof WebChartTypes.BoxPlotSeries;
|
|
1065
1087
|
/**
|
|
@@ -1069,11 +1091,11 @@ export interface WebChartBoxPlotSeries extends WebChartSeries {
|
|
|
1069
1091
|
* @minItems 1
|
|
1070
1092
|
*/
|
|
1071
1093
|
y: string[] | string;
|
|
1072
|
-
/** Contains styling
|
|
1094
|
+
/** Contains styling information on how the box and whiskers should be rendered. The whiskers use the `fillSymbol.outline`. */
|
|
1073
1095
|
fillSymbol?: ISimpleFillSymbol;
|
|
1074
1096
|
}
|
|
1075
1097
|
|
|
1076
|
-
/** JSON representation of the Heat chart
|
|
1098
|
+
/** JSON representation of the Heat chart with gradient heat rules. */
|
|
1077
1099
|
export interface WebChartHeatChartGradient {
|
|
1078
1100
|
/** An array of 2 colors to use for the gradient. The first color represents the minimum value, the second color represents the maximum value. */
|
|
1079
1101
|
colorList?: [Color, Color];
|
|
@@ -1082,34 +1104,40 @@ export interface WebChartHeatChartGradient {
|
|
|
1082
1104
|
/** Specifies the custom maximum value for the heat chart. If none is provided, the maximum value from the dataset will be used. */
|
|
1083
1105
|
maxValue?: number;
|
|
1084
1106
|
/**
|
|
1085
|
-
* Specifies the color to use for the items outside the lower range specified by minValue
|
|
1107
|
+
* Specifies the color to use for the items outside the lower range specified by `minValue`. If none is provided,
|
|
1086
1108
|
* the default color will be used.
|
|
1087
1109
|
*
|
|
1088
|
-
* @default [250, 250, 250, 255] - white
|
|
1110
|
+
* @default `[250, 250, 250, 255] - white`
|
|
1089
1111
|
*/
|
|
1090
1112
|
outsideRangeLowerColor?: Color;
|
|
1091
1113
|
/**
|
|
1092
|
-
* Specifies the color to use for the items outside the upper range specified by maxValue
|
|
1114
|
+
* Specifies the color to use for the items outside the upper range specified by `maxValue`. If none is provided,
|
|
1093
1115
|
* the default color will be used.
|
|
1094
1116
|
*
|
|
1095
|
-
* @default [0, 0, 255, 255] - blue
|
|
1117
|
+
* @default `[0, 0, 255, 255] - blue`
|
|
1096
1118
|
*/
|
|
1097
1119
|
outsideRangeUpperColor?: Color;
|
|
1098
1120
|
}
|
|
1099
1121
|
|
|
1100
|
-
/** JSON representation of the Heat chart
|
|
1122
|
+
/** JSON representation of the Heat chart with class breaks heat rules. */
|
|
1101
1123
|
export interface WebChartHeatChartHeatClassBreaks {
|
|
1102
1124
|
/**
|
|
1103
|
-
* The number of
|
|
1125
|
+
* The number of class breaks to be used for the heat chart.
|
|
1104
1126
|
*
|
|
1105
1127
|
* @default 5
|
|
1106
1128
|
*/
|
|
1107
1129
|
breaksCount?: number;
|
|
1108
|
-
/**
|
|
1130
|
+
/**
|
|
1131
|
+
* The classification method to be used for the heat chart.
|
|
1132
|
+
* `equal-interval` - divides the range of values into equal-sized intervals.
|
|
1133
|
+
* `quantile` - divides the range of values into intervals that contain an equal number of features.
|
|
1134
|
+
* `natural-breaks` - identifies natural groupings of values in the data by minimizing the variance within classes and maximizing the variance between classes.
|
|
1135
|
+
* `manual` - allows you to manually specify the class breaks.
|
|
1136
|
+
*/
|
|
1109
1137
|
classificationMethod?: WebChartClassBreakTypes;
|
|
1110
1138
|
}
|
|
1111
1139
|
|
|
1112
|
-
/** JSON representation of the
|
|
1140
|
+
/** JSON representation of the heat chart empty cell configuration. */
|
|
1113
1141
|
export interface WebChartHeatChartEmptyCell {
|
|
1114
1142
|
/**
|
|
1115
1143
|
* Specifies the text to use by the empty cells.
|
|
@@ -1125,7 +1153,7 @@ export interface WebChartHeatChartEmptyCell {
|
|
|
1125
1153
|
symbol?: ISimpleFillSymbol;
|
|
1126
1154
|
}
|
|
1127
1155
|
|
|
1128
|
-
/** JSON representation of the
|
|
1156
|
+
/** JSON representation of the heat chart series. */
|
|
1129
1157
|
export interface WebChartHeatChartSeries extends WebChartSeries {
|
|
1130
1158
|
type: typeof WebChartTypes.HeatSeries;
|
|
1131
1159
|
/**
|
|
@@ -1159,28 +1187,28 @@ export type WebChartRadarChartSeries = WebChartLineChartSeries<"radarSeries">;
|
|
|
1159
1187
|
/** Type containing all the series types available */
|
|
1160
1188
|
export type WebChartSeriesType = WebChartBarChartSeries | WebChartBoxPlotSeries | WebChartGaugeSeries | WebChartHeatChartSeries | WebChartHistogramSeries | WebChartLineChartSeries | WebChartPieChartSeries | WebChartRadarChartSeries | WebChartScatterplotSeries;
|
|
1161
1189
|
|
|
1162
|
-
/**
|
|
1190
|
+
/** JSON representation of the web chart object. */
|
|
1163
1191
|
export interface WebChart {
|
|
1164
1192
|
/** Version of the specification. Used to identify when a saved config was created. */
|
|
1165
1193
|
version: typeof WebChartCurrentVersion;
|
|
1166
|
-
/** Represents a unique string identifier for the
|
|
1194
|
+
/** Represents a unique string identifier for the `WebChart` object. For the `WebChart` object, it is `chart`. */
|
|
1167
1195
|
type: typeof WebChartTypes.Chart;
|
|
1168
|
-
/** Can be used to uniquely identify a chart.
|
|
1196
|
+
/** Can be used to uniquely identify a chart. */
|
|
1169
1197
|
id?: string;
|
|
1170
1198
|
/** Property representing the layer to be used by the chart. If not provided we expect a layer object to be set on the component. */
|
|
1171
|
-
iLayer?: IFeatureLayer;
|
|
1172
|
-
/** Used to filter the chart's data while in
|
|
1199
|
+
iLayer?: IFeatureLayer | IImageServiceLayer | ITiledImageServiceLayer;
|
|
1200
|
+
/** Used to filter the chart's data while in layer mode. */
|
|
1173
1201
|
dataFilters?: WebChartDataFilters;
|
|
1174
|
-
/** Specifies
|
|
1202
|
+
/** Specifies title of the chart. */
|
|
1175
1203
|
title?: WebChartText;
|
|
1176
|
-
/** Specifies
|
|
1204
|
+
/** Specifies subtitle of the chart. */
|
|
1177
1205
|
subtitle?: WebChartText;
|
|
1178
|
-
/** Specifies footer of the chart */
|
|
1206
|
+
/** Specifies footer of the chart. */
|
|
1179
1207
|
footer?: WebChartText;
|
|
1180
1208
|
/**
|
|
1181
1209
|
* Specifies the background color of the chart.
|
|
1182
1210
|
*
|
|
1183
|
-
* @default [255, 255, 255, 255]
|
|
1211
|
+
* @default `[255, 255, 255, 255]`
|
|
1184
1212
|
*/
|
|
1185
1213
|
background?: Color;
|
|
1186
1214
|
/** Specifies cursor's crosshair information for the chart. Only for XY charts. */
|
|
@@ -1188,46 +1216,45 @@ export interface WebChart {
|
|
|
1188
1216
|
/** Specifies the Legend information for the chart. */
|
|
1189
1217
|
legend?: WebChartLegend | WebChartPieChartLegend;
|
|
1190
1218
|
/**
|
|
1191
|
-
* Represents an array of **at least 1 or at most 3**
|
|
1219
|
+
* Represents an array of **at least 1 or at most 3** chart axes accompanying the chart.
|
|
1192
1220
|
* The third axis config is used when a series `assignToSecondValueAxis` is set to `true`.
|
|
1193
1221
|
* Some of the axis features won't apply to the third axis (e.g. labels behaviors).
|
|
1194
1222
|
*/
|
|
1195
1223
|
axes?: [WebChartAxis, WebChartAxis?, WebChartAxis?];
|
|
1196
1224
|
/**
|
|
1197
1225
|
* Represents the way the labels should behave when the horizontal axis can't display them all.
|
|
1198
|
-
*
|
|
1199
|
-
*
|
|
1200
|
-
* The default value for the horizontal axis is "rotate" except for Histogram, where the default is none.
|
|
1226
|
+
*
|
|
1227
|
+
* Applicable to XY charts only. Histograms support `none` and `rotate` only. The default horizontal axis value is `rotate`, except for histograms, where it is `none`.
|
|
1201
1228
|
*
|
|
1202
1229
|
* @default "rotate"
|
|
1203
1230
|
*/
|
|
1204
1231
|
horizontalAxisLabelsBehavior?: WebChartLabelBehavior;
|
|
1205
1232
|
/**
|
|
1206
|
-
* Represents the way the labels should behave when the vertical axis can't display them all.
|
|
1207
|
-
*
|
|
1208
|
-
*
|
|
1233
|
+
* Represents the way the labels should behave when the vertical axis can't display them all.
|
|
1234
|
+
*
|
|
1235
|
+
* For XY Chart only.
|
|
1209
1236
|
*
|
|
1210
1237
|
* @default "wrap"
|
|
1211
1238
|
*/
|
|
1212
1239
|
verticalAxisLabelsBehavior?: WebChartLabelBehavior;
|
|
1213
1240
|
/**
|
|
1214
1241
|
* Represents an array of various chart series to be plot inside the chart.
|
|
1242
|
+
*
|
|
1215
1243
|
* Empty array is not allowed.
|
|
1216
1244
|
*
|
|
1217
1245
|
* @minItems 1
|
|
1218
1246
|
*/
|
|
1219
1247
|
series: WebChartSeriesType[];
|
|
1220
1248
|
/**
|
|
1221
|
-
* Specifies whether or not the chart is rotated.
|
|
1249
|
+
* Specifies whether or not the chart is rotated.
|
|
1222
1250
|
*
|
|
1223
1251
|
* @default false
|
|
1224
1252
|
*/
|
|
1225
1253
|
rotated?: boolean;
|
|
1226
1254
|
/**
|
|
1227
|
-
* Specifies how the bars/lines should be placed when multiple series are rendered in the same chart
|
|
1228
|
-
* when multiple attributes/fields corresponding to the same set of classes are to be visualized.
|
|
1255
|
+
* Specifies how the bars/lines should be placed when multiple series are rendered in the same chart.
|
|
1229
1256
|
*
|
|
1230
|
-
*
|
|
1257
|
+
* Only applicable to bar and line series.
|
|
1231
1258
|
*
|
|
1232
1259
|
* @default sideBySide
|
|
1233
1260
|
*/
|
|
@@ -1246,10 +1273,11 @@ export interface WebChart {
|
|
|
1246
1273
|
colorMatch?: boolean;
|
|
1247
1274
|
/**
|
|
1248
1275
|
* Renderer to use to style the series when the chart uses the color match mode.
|
|
1276
|
+
*
|
|
1249
1277
|
* Considered before the layer's renderer.
|
|
1250
1278
|
*/
|
|
1251
1279
|
chartRenderer?: IDrawingInfo["renderer"];
|
|
1252
|
-
/** Chart order options
|
|
1280
|
+
/** Chart order options for data and series. */
|
|
1253
1281
|
orderOptions?: {
|
|
1254
1282
|
series?: WebChartOrderSeriesBy;
|
|
1255
1283
|
data?: WebChartDirectionalDataOrder | WebChartMultiAxesDataOrder | WebChartPredefinedLabelsDataOrder;
|
|
@@ -1257,7 +1285,7 @@ export interface WebChart {
|
|
|
1257
1285
|
};
|
|
1258
1286
|
}
|
|
1259
1287
|
|
|
1260
|
-
/** JSON representation of
|
|
1288
|
+
/** JSON representation of the gauge chart. */
|
|
1261
1289
|
export interface WebGaugeChart extends WebChart {
|
|
1262
1290
|
/**
|
|
1263
1291
|
* Represents the size of the hole in middle of the chart. The number is used as a percentage rather than a fixed value.
|
|
@@ -1272,55 +1300,55 @@ export interface WebGaugeChart extends WebChart {
|
|
|
1272
1300
|
*/
|
|
1273
1301
|
startAngle?: number | null;
|
|
1274
1302
|
/**
|
|
1275
|
-
* Represents where is the chart's ending point. To be related with startAngle
|
|
1303
|
+
* Represents where is the chart's ending point. To be related with `startAngle`. If `endAngle-startAngle` is 360 the chart will render as a full circle.
|
|
1276
1304
|
*
|
|
1277
1305
|
* @default 180
|
|
1278
1306
|
*/
|
|
1279
1307
|
endAngle?: number | null;
|
|
1280
|
-
/** Array of one WebChartGaugeAxis */
|
|
1308
|
+
/** Array of one `WebChartGaugeAxis`. */
|
|
1281
1309
|
axes: [WebChartGaugeAxis];
|
|
1282
1310
|
/**
|
|
1283
|
-
* The type of
|
|
1311
|
+
* The type of gauge, like `FeatureGauge` or `StatisticGauge`.
|
|
1284
1312
|
*
|
|
1285
1313
|
* When this property is not specified, it will be defaulted to `GaugeChartSubTypes.StatisticGauge`.
|
|
1286
1314
|
*/
|
|
1287
1315
|
subType?: GaugeChartSubTypes;
|
|
1288
1316
|
}
|
|
1289
1317
|
|
|
1290
|
-
/** JSON representation of
|
|
1318
|
+
/** JSON representation of the box plot. */
|
|
1291
1319
|
export interface WebBoxPlot extends WebChart {
|
|
1292
|
-
/** Whether to show the outliers on the chart */
|
|
1320
|
+
/** Whether to show the outliers on the chart. */
|
|
1293
1321
|
showOutliers?: boolean;
|
|
1294
|
-
/** Whether to standardize the values by calculating the series z-score */
|
|
1322
|
+
/** Whether to standardize the values by calculating the series z-score. */
|
|
1295
1323
|
standardizeValues?: boolean;
|
|
1296
1324
|
/**
|
|
1297
1325
|
* Whether to show the mean lines on the chart. Applies only if a split-by field is set.
|
|
1298
|
-
*
|
|
1299
|
-
* contains one box plot series and N lines series.
|
|
1326
|
+
*
|
|
1327
|
+
* Additionally the chart will render with that option enabled only if the the series array contains one box plot series and N lines series.
|
|
1300
1328
|
*
|
|
1301
1329
|
* @default false
|
|
1302
1330
|
*/
|
|
1303
1331
|
showMean?: boolean;
|
|
1304
|
-
/** The box plot series can be of type
|
|
1332
|
+
/** The box plot series can be of type `boxPlotSeries` or `lineSeries`. */
|
|
1305
1333
|
series: (WebChartBoxPlotSeries | WebChartLineChartSeries)[];
|
|
1306
1334
|
}
|
|
1307
1335
|
|
|
1308
|
-
/** Gives a JSON representation of the
|
|
1336
|
+
/** Gives a JSON representation of the radar chart object. */
|
|
1309
1337
|
export interface WebRadarChart extends WebChart {
|
|
1310
1338
|
/**
|
|
1311
|
-
* The radar chart series
|
|
1339
|
+
* The radar chart series.
|
|
1312
1340
|
*
|
|
1313
1341
|
* @minItems 1
|
|
1314
1342
|
*/
|
|
1315
1343
|
series: WebChartRadarChartSeries[];
|
|
1316
|
-
/** Array of two axes, one specific to the radar chart and the other one common to all charts */
|
|
1344
|
+
/** Array of two axes, one specific to the radar chart and the other one common to all charts. */
|
|
1317
1345
|
axes: [WebChartRadarChartAxis, WebChartAxis];
|
|
1318
1346
|
}
|
|
1319
1347
|
|
|
1320
|
-
/** Gives a JSON representation of the
|
|
1348
|
+
/** Gives a JSON representation of the heat chart object. */
|
|
1321
1349
|
export interface WebHeatChart extends WebChart, WebChartTemporalBinningExtras {
|
|
1322
1350
|
/**
|
|
1323
|
-
* The heat chart series
|
|
1351
|
+
* The heat chart series.
|
|
1324
1352
|
*
|
|
1325
1353
|
* @minItems 1
|
|
1326
1354
|
*/
|
|
@@ -1335,11 +1363,11 @@ export interface WebHeatChart extends WebChart, WebChartTemporalBinningExtras {
|
|
|
1335
1363
|
/**
|
|
1336
1364
|
* The calendar view type for the heat chart.
|
|
1337
1365
|
*
|
|
1338
|
-
* **NOTE**: This property is only applicable to the
|
|
1366
|
+
* **NOTE**: This property is only applicable to the calendar heat chart.
|
|
1339
1367
|
*/
|
|
1340
1368
|
viewType?: WebChartHeatChartViewTypes;
|
|
1341
1369
|
/**
|
|
1342
|
-
* Whether to include leap day (Feb. 29th) in queries
|
|
1370
|
+
* Whether to include leap day (Feb. 29th) in queries.
|
|
1343
1371
|
*
|
|
1344
1372
|
* @default false
|
|
1345
1373
|
*/
|
|
@@ -1350,24 +1378,30 @@ export interface WebHeatChart extends WebChart, WebChartTemporalBinningExtras {
|
|
|
1350
1378
|
export interface WebChartTemporalBinningBase {
|
|
1351
1379
|
/**
|
|
1352
1380
|
* Determines whether incomplete time intervals at the start or end of the data span (depending on the `timeAggregationType`) will be removed from the chart.
|
|
1381
|
+
*
|
|
1353
1382
|
* Incomplete intervals on a chart can cause misleading results in which the period in question is under- or over reported due to a different amount of time in the interval.
|
|
1354
|
-
*
|
|
1383
|
+
*
|
|
1384
|
+
* `true` - trim the incomplete intervals.
|
|
1385
|
+
* `false` - does not trim the incomplete intervals.
|
|
1355
1386
|
*
|
|
1356
1387
|
* @default true
|
|
1357
1388
|
*/
|
|
1358
1389
|
trimIncompleteTimeInterval?: boolean;
|
|
1359
1390
|
/**
|
|
1360
1391
|
* The binning start date.
|
|
1392
|
+
*
|
|
1361
1393
|
* Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
|
|
1362
1394
|
*/
|
|
1363
1395
|
start?: number;
|
|
1364
1396
|
/**
|
|
1365
|
-
* The binning end date
|
|
1397
|
+
* The binning end date.
|
|
1398
|
+
*
|
|
1366
1399
|
* Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
|
|
1367
1400
|
*/
|
|
1368
1401
|
end?: number;
|
|
1369
1402
|
/**
|
|
1370
|
-
* Offset to apply to the results
|
|
1403
|
+
* Offset to apply to the results.
|
|
1404
|
+
*
|
|
1371
1405
|
* Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
|
|
1372
1406
|
*/
|
|
1373
1407
|
offset?: {
|
|
@@ -1376,15 +1410,17 @@ export interface WebChartTemporalBinningBase {
|
|
|
1376
1410
|
};
|
|
1377
1411
|
}
|
|
1378
1412
|
|
|
1379
|
-
/** Describes the extra properties available for a temporal series and for the heat chart */
|
|
1413
|
+
/** Describes the extra properties available for a temporal series and for the heat chart. */
|
|
1380
1414
|
export interface WebChartTemporalBinningExtras {
|
|
1381
1415
|
/**
|
|
1382
|
-
* Defines the [IANA time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used for temporal bin calculations
|
|
1416
|
+
* Defines the [IANA time zone](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) used for temporal bin calculations.
|
|
1417
|
+
*
|
|
1383
1418
|
* Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
|
|
1384
1419
|
*/
|
|
1385
1420
|
outTimeZone?: string;
|
|
1386
1421
|
/**
|
|
1387
|
-
* The first day of the week. This property is used to determine the start of the week for date-based bins. The default value depends on the user locale (e.g. 7 as Sunday for
|
|
1422
|
+
* The first day of the week. This property is used to determine the start of the week for date-based bins. The default value depends on the user locale (e.g. `7` as Sunday for US, `1` as Monday for France).
|
|
1423
|
+
*
|
|
1388
1424
|
* Current limitation: this is applied only when the provided layer supports the `queryBins` operation.
|
|
1389
1425
|
*
|
|
1390
1426
|
* @minimum 1
|
|
@@ -1394,8 +1430,8 @@ export interface WebChartTemporalBinningExtras {
|
|
|
1394
1430
|
firstDayOfWeek?: number;
|
|
1395
1431
|
/**
|
|
1396
1432
|
* How summarized bins returning a null value are displayed. Supported options are:
|
|
1397
|
-
* - `null`, `zero`, and `interpolate` for line series
|
|
1398
|
-
* - `null` and `zero` for bar series
|
|
1433
|
+
* - `null`, `zero`, and `interpolate` for line series.
|
|
1434
|
+
* - `null` and `zero` for bar series.
|
|
1399
1435
|
*
|
|
1400
1436
|
* @default "null"
|
|
1401
1437
|
*/
|