pie-chart.d.ts 20 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626
  1. /*!
  2. * devextreme-angular
  3. * Version: 19.1.16
  4. * Build date: Tue Oct 18 2022
  5. *
  6. * Copyright (c) 2012 - 2022 Developer Express Inc. ALL RIGHTS RESERVED
  7. *
  8. * This software may be modified and distributed under the terms
  9. * of the MIT license. See the LICENSE file in the root of the project for details.
  10. *
  11. * https://github.com/DevExpress/devextreme-angular
  12. */
  13. import { TransferState } from '@angular/platform-browser';
  14. import { ElementRef, NgZone, OnDestroy, EventEmitter, OnChanges, DoCheck, SimpleChanges, QueryList } from '@angular/core';
  15. import DevExpress from 'devextreme/bundles/dx.all';
  16. import DxPieChart from 'devextreme/viz/pie_chart';
  17. import { DxComponent } from '../core/component';
  18. import { DxTemplateHost } from '../core/template-host';
  19. import { NestedOptionHost } from '../core/nested-option';
  20. import { WatcherHelper } from '../core/watcher-helper';
  21. import { IterableDifferHelper } from '../core/iterable-differ-helper';
  22. import { DxiSeriesComponent } from './nested/series-dxi';
  23. /**
  24. * The PieChart is a widget that visualizes data as a circle divided into sectors that each represents a portion of the whole.
  25. */
  26. export declare class DxPieChartComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
  27. private _watcherHelper;
  28. private _idh;
  29. instance: DxPieChart;
  30. /**
  31. * Specifies adaptive layout options.
  32. */
  33. adaptiveLayout: {
  34. height?: number;
  35. keepLabels?: boolean;
  36. width?: number;
  37. };
  38. /**
  39. * Specifies animation options.
  40. */
  41. animation: boolean | {
  42. duration?: number;
  43. easing?: string;
  44. enabled?: boolean;
  45. maxPointCountSupported?: number;
  46. };
  47. /**
  48. * An object defining the configuration options that are common for all series of the PieChart widget.
  49. */
  50. commonSeriesSettings: any;
  51. /**
  52. * Customizes the appearance of an individual point label.
  53. */
  54. customizeLabel: Function;
  55. /**
  56. * Customizes the appearance of an individual series point.
  57. */
  58. customizePoint: Function;
  59. /**
  60. * Binds the widget to data.
  61. */
  62. dataSource: DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<any>;
  63. /**
  64. * Specifies the diameter of the pie.
  65. */
  66. diameter: number;
  67. /**
  68. * Specifies whether the widget responds to the user interaction.
  69. */
  70. disabled: boolean;
  71. /**
  72. * Specifies the attributes to be attached to the widget's root element.
  73. */
  74. elementAttr: any;
  75. /**
  76. * Configures the exporting and printing features.
  77. */
  78. export: {
  79. backgroundColor?: string;
  80. enabled?: boolean;
  81. fileName?: string;
  82. formats?: Array<string>;
  83. margin?: number;
  84. printingEnabled?: boolean;
  85. proxyUrl?: string;
  86. };
  87. /**
  88. * Specifies the fraction of the inner radius relative to the total radius in the series of the 'doughnut' type. The value should be between 0 and 1.
  89. */
  90. innerRadius: number;
  91. /**
  92. * Specifies PieChart legend options.
  93. */
  94. legend: {
  95. backgroundColor?: string;
  96. border?: {
  97. color?: string;
  98. cornerRadius?: number;
  99. dashStyle?: string;
  100. opacity?: number;
  101. visible?: boolean;
  102. width?: number;
  103. };
  104. columnCount?: number;
  105. columnItemSpacing?: number;
  106. customizeHint?: Function;
  107. customizeItems?: Function;
  108. customizeText?: Function;
  109. font?: DevExpress.viz.Font;
  110. horizontalAlignment?: string;
  111. hoverMode?: string;
  112. itemsAlignment?: string;
  113. itemTextPosition?: string;
  114. margin?: number | {
  115. bottom?: number;
  116. left?: number;
  117. right?: number;
  118. top?: number;
  119. };
  120. markerSize?: number;
  121. orientation?: string;
  122. paddingLeftRight?: number;
  123. paddingTopBottom?: number;
  124. rowCount?: number;
  125. rowItemSpacing?: number;
  126. title?: string | {
  127. font?: DevExpress.viz.Font;
  128. horizontalAlignment?: string;
  129. margin?: {
  130. bottom?: number;
  131. left?: number;
  132. right?: number;
  133. top?: number;
  134. };
  135. placeholderSize?: number;
  136. subtitle?: string | {
  137. font?: DevExpress.viz.Font;
  138. offset?: number;
  139. text?: string;
  140. };
  141. text?: string;
  142. verticalAlignment?: string;
  143. };
  144. verticalAlignment?: string;
  145. visible?: boolean;
  146. };
  147. /**
  148. * Configures the loading indicator.
  149. */
  150. loadingIndicator: {
  151. backgroundColor?: string;
  152. enabled?: boolean;
  153. font?: DevExpress.viz.Font;
  154. show?: boolean;
  155. text?: string;
  156. };
  157. /**
  158. * Generates space around the widget.
  159. */
  160. margin: {
  161. bottom?: number;
  162. left?: number;
  163. right?: number;
  164. top?: number;
  165. };
  166. /**
  167. * Specifies the minimum diameter of the pie.
  168. */
  169. minDiameter: number;
  170. /**
  171. * Sets the palette to be used to colorize series and their elements.
  172. */
  173. palette: string | Array<string>;
  174. /**
  175. * Specifies what to do with colors in the palette when their number is less than the number of series (in the Chart widget) or points in a series (in the PieChart widget).
  176. */
  177. paletteExtensionMode: string;
  178. /**
  179. * Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path.
  180. */
  181. pathModified: boolean;
  182. /**
  183. * Specifies whether a single point or multiple points can be selected in the chart.
  184. */
  185. pointSelectionMode: string;
  186. /**
  187. * Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates.
  188. */
  189. redrawOnResize: boolean;
  190. /**
  191. * Specifies how a chart must behave when point labels overlap.
  192. */
  193. resolveLabelOverlapping: string;
  194. /**
  195. * Switches the widget to a right-to-left representation.
  196. */
  197. rtlEnabled: boolean;
  198. /**
  199. * Specifies the direction that the pie chart segments will occupy.
  200. */
  201. segmentsDirection: string;
  202. /**
  203. * Specifies options for the series of the PieChart widget.
  204. */
  205. series: any | Array<any>;
  206. /**
  207. * Defines options for the series template.
  208. */
  209. seriesTemplate: {
  210. customizeSeries?: Function;
  211. nameField?: string;
  212. };
  213. /**
  214. * Specifies the widget's size in pixels.
  215. */
  216. size: {
  217. height?: number;
  218. width?: number;
  219. };
  220. /**
  221. * Allows you to display several adjoining pies in the same size.
  222. */
  223. sizeGroup: string;
  224. /**
  225. * Specifies the angle in arc degrees from which the first segment of a pie chart should start.
  226. */
  227. startAngle: number;
  228. /**
  229. * Sets the name of the theme the widget uses.
  230. */
  231. theme: string;
  232. /**
  233. * Configures the widget's title.
  234. */
  235. title: string | {
  236. font?: DevExpress.viz.Font;
  237. horizontalAlignment?: string;
  238. margin?: number | {
  239. bottom?: number;
  240. left?: number;
  241. right?: number;
  242. top?: number;
  243. };
  244. placeholderSize?: number;
  245. subtitle?: string | {
  246. font?: DevExpress.viz.Font;
  247. offset?: number;
  248. text?: string;
  249. textOverflow?: string;
  250. wordWrap?: string;
  251. };
  252. text?: string;
  253. textOverflow?: string;
  254. verticalAlignment?: string;
  255. wordWrap?: string;
  256. };
  257. /**
  258. * Configures tooltips.
  259. */
  260. tooltip: {
  261. argumentFormat?: DevExpress.ui.format | string;
  262. arrowLength?: number;
  263. border?: {
  264. color?: string;
  265. dashStyle?: string;
  266. opacity?: number;
  267. visible?: boolean;
  268. width?: number;
  269. };
  270. color?: string;
  271. container?: Element | JQuery;
  272. cornerRadius?: number;
  273. customizeTooltip?: Function;
  274. enabled?: boolean;
  275. font?: DevExpress.viz.Font;
  276. format?: DevExpress.ui.format | string;
  277. opacity?: number;
  278. paddingLeftRight?: number;
  279. paddingTopBottom?: number;
  280. shadow?: {
  281. blur?: number;
  282. color?: string;
  283. offsetX?: number;
  284. offsetY?: number;
  285. opacity?: number;
  286. };
  287. zIndex?: number;
  288. };
  289. /**
  290. * Specifies the type of the pie chart series.
  291. */
  292. type: string;
  293. /**
  294. * A function that is executed before the widget is disposed of.
  295. */
  296. onDisposing: EventEmitter<any>;
  297. /**
  298. * A function that is executed when all series are ready.
  299. */
  300. onDone: EventEmitter<any>;
  301. /**
  302. * A function that is executed when the widget's rendering has finished.
  303. */
  304. onDrawn: EventEmitter<any>;
  305. /**
  306. * A function that is executed after the widget is exported.
  307. */
  308. onExported: EventEmitter<any>;
  309. /**
  310. * A function that is executed before the widget is exported.
  311. */
  312. onExporting: EventEmitter<any>;
  313. /**
  314. * A function that is executed before a file with exported widget is saved to the user's local storage.
  315. */
  316. onFileSaving: EventEmitter<any>;
  317. /**
  318. * A function that is executed when an error or warning occurs.
  319. */
  320. onIncidentOccurred: EventEmitter<any>;
  321. /**
  322. * A function used in JavaScript frameworks to save the widget instance.
  323. */
  324. onInitialized: EventEmitter<any>;
  325. /**
  326. * A function that is executed when a legend item is clicked or tapped.
  327. */
  328. onLegendClick: EventEmitter<any>;
  329. /**
  330. * A function that is executed after a widget option is changed.
  331. */
  332. onOptionChanged: EventEmitter<any>;
  333. /**
  334. * A function that is executed when a series point is clicked or tapped.
  335. */
  336. onPointClick: EventEmitter<any>;
  337. /**
  338. * A function that is executed after the pointer enters or leaves a series point.
  339. */
  340. onPointHoverChanged: EventEmitter<any>;
  341. /**
  342. * A function that is executed when a series point is selected or selection is canceled.
  343. */
  344. onPointSelectionChanged: EventEmitter<any>;
  345. /**
  346. * A function that is executed when a tooltip becomes hidden.
  347. */
  348. onTooltipHidden: EventEmitter<any>;
  349. /**
  350. * A function that is executed when a tooltip appears.
  351. */
  352. onTooltipShown: EventEmitter<any>;
  353. /**
  354. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  355. */
  356. adaptiveLayoutChange: EventEmitter<{
  357. height?: number;
  358. keepLabels?: boolean;
  359. width?: number;
  360. }>;
  361. /**
  362. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  363. */
  364. animationChange: EventEmitter<boolean | {
  365. duration?: number;
  366. easing?: string;
  367. enabled?: boolean;
  368. maxPointCountSupported?: number;
  369. }>;
  370. /**
  371. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  372. */
  373. commonSeriesSettingsChange: EventEmitter<any>;
  374. /**
  375. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  376. */
  377. customizeLabelChange: EventEmitter<Function>;
  378. /**
  379. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  380. */
  381. customizePointChange: EventEmitter<Function>;
  382. /**
  383. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  384. */
  385. dataSourceChange: EventEmitter<DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string | Array<any>>;
  386. /**
  387. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  388. */
  389. diameterChange: EventEmitter<number>;
  390. /**
  391. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  392. */
  393. disabledChange: EventEmitter<boolean>;
  394. /**
  395. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  396. */
  397. elementAttrChange: EventEmitter<any>;
  398. /**
  399. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  400. */
  401. exportChange: EventEmitter<{
  402. backgroundColor?: string;
  403. enabled?: boolean;
  404. fileName?: string;
  405. formats?: Array<string>;
  406. margin?: number;
  407. printingEnabled?: boolean;
  408. proxyUrl?: string;
  409. }>;
  410. /**
  411. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  412. */
  413. innerRadiusChange: EventEmitter<number>;
  414. /**
  415. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  416. */
  417. legendChange: EventEmitter<{
  418. backgroundColor?: string;
  419. border?: {
  420. color?: string;
  421. cornerRadius?: number;
  422. dashStyle?: string;
  423. opacity?: number;
  424. visible?: boolean;
  425. width?: number;
  426. };
  427. columnCount?: number;
  428. columnItemSpacing?: number;
  429. customizeHint?: Function;
  430. customizeItems?: Function;
  431. customizeText?: Function;
  432. font?: DevExpress.viz.Font;
  433. horizontalAlignment?: string;
  434. hoverMode?: string;
  435. itemsAlignment?: string;
  436. itemTextPosition?: string;
  437. margin?: number | {
  438. bottom?: number;
  439. left?: number;
  440. right?: number;
  441. top?: number;
  442. };
  443. markerSize?: number;
  444. orientation?: string;
  445. paddingLeftRight?: number;
  446. paddingTopBottom?: number;
  447. rowCount?: number;
  448. rowItemSpacing?: number;
  449. title?: string | {
  450. font?: DevExpress.viz.Font;
  451. horizontalAlignment?: string;
  452. margin?: {
  453. bottom?: number;
  454. left?: number;
  455. right?: number;
  456. top?: number;
  457. };
  458. placeholderSize?: number;
  459. subtitle?: string | {
  460. font?: DevExpress.viz.Font;
  461. offset?: number;
  462. text?: string;
  463. };
  464. text?: string;
  465. verticalAlignment?: string;
  466. };
  467. verticalAlignment?: string;
  468. visible?: boolean;
  469. }>;
  470. /**
  471. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  472. */
  473. loadingIndicatorChange: EventEmitter<{
  474. backgroundColor?: string;
  475. enabled?: boolean;
  476. font?: DevExpress.viz.Font;
  477. show?: boolean;
  478. text?: string;
  479. }>;
  480. /**
  481. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  482. */
  483. marginChange: EventEmitter<{
  484. bottom?: number;
  485. left?: number;
  486. right?: number;
  487. top?: number;
  488. }>;
  489. /**
  490. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  491. */
  492. minDiameterChange: EventEmitter<number>;
  493. /**
  494. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  495. */
  496. paletteChange: EventEmitter<string | Array<string>>;
  497. /**
  498. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  499. */
  500. paletteExtensionModeChange: EventEmitter<string>;
  501. /**
  502. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  503. */
  504. pathModifiedChange: EventEmitter<boolean>;
  505. /**
  506. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  507. */
  508. pointSelectionModeChange: EventEmitter<string>;
  509. /**
  510. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  511. */
  512. redrawOnResizeChange: EventEmitter<boolean>;
  513. /**
  514. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  515. */
  516. resolveLabelOverlappingChange: EventEmitter<string>;
  517. /**
  518. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  519. */
  520. rtlEnabledChange: EventEmitter<boolean>;
  521. /**
  522. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  523. */
  524. segmentsDirectionChange: EventEmitter<string>;
  525. /**
  526. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  527. */
  528. seriesChange: EventEmitter<any | Array<any>>;
  529. /**
  530. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  531. */
  532. seriesTemplateChange: EventEmitter<{
  533. customizeSeries?: Function;
  534. nameField?: string;
  535. }>;
  536. /**
  537. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  538. */
  539. sizeChange: EventEmitter<{
  540. height?: number;
  541. width?: number;
  542. }>;
  543. /**
  544. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  545. */
  546. sizeGroupChange: EventEmitter<string>;
  547. /**
  548. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  549. */
  550. startAngleChange: EventEmitter<number>;
  551. /**
  552. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  553. */
  554. themeChange: EventEmitter<string>;
  555. /**
  556. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  557. */
  558. titleChange: EventEmitter<string | {
  559. font?: DevExpress.viz.Font;
  560. horizontalAlignment?: string;
  561. margin?: number | {
  562. bottom?: number;
  563. left?: number;
  564. right?: number;
  565. top?: number;
  566. };
  567. placeholderSize?: number;
  568. subtitle?: string | {
  569. font?: DevExpress.viz.Font;
  570. offset?: number;
  571. text?: string;
  572. textOverflow?: string;
  573. wordWrap?: string;
  574. };
  575. text?: string;
  576. textOverflow?: string;
  577. verticalAlignment?: string;
  578. wordWrap?: string;
  579. }>;
  580. /**
  581. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  582. */
  583. tooltipChange: EventEmitter<{
  584. argumentFormat?: DevExpress.ui.format | string;
  585. arrowLength?: number;
  586. border?: {
  587. color?: string;
  588. dashStyle?: string;
  589. opacity?: number;
  590. visible?: boolean;
  591. width?: number;
  592. };
  593. color?: string;
  594. container?: Element | JQuery;
  595. cornerRadius?: number;
  596. customizeTooltip?: Function;
  597. enabled?: boolean;
  598. font?: DevExpress.viz.Font;
  599. format?: DevExpress.ui.format | string;
  600. opacity?: number;
  601. paddingLeftRight?: number;
  602. paddingTopBottom?: number;
  603. shadow?: {
  604. blur?: number;
  605. color?: string;
  606. offsetX?: number;
  607. offsetY?: number;
  608. opacity?: number;
  609. };
  610. zIndex?: number;
  611. }>;
  612. /**
  613. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  614. */
  615. typeChange: EventEmitter<string>;
  616. seriesChildren: QueryList<DxiSeriesComponent>;
  617. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  618. protected _createInstance(element: any, options: any): DxPieChart;
  619. ngOnDestroy(): void;
  620. ngOnChanges(changes: SimpleChanges): void;
  621. setupChanges(prop: string, changes: SimpleChanges): void;
  622. ngDoCheck(): void;
  623. _setOption(name: string, value: any): void;
  624. }
  625. export declare class DxPieChartModule {
  626. }