linear-gauge.d.ts 15 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496
  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 } from '@angular/core';
  15. import DevExpress from 'devextreme/bundles/dx.all';
  16. import DxLinearGauge from 'devextreme/viz/linear_gauge';
  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. /**
  23. * The LinearGauge is a widget that indicates values on a linear numeric scale.
  24. */
  25. export declare class DxLinearGaugeComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
  26. private _watcherHelper;
  27. private _idh;
  28. instance: DxLinearGauge;
  29. /**
  30. * Specifies animation options.
  31. */
  32. animation: {
  33. duration?: number;
  34. easing?: string;
  35. enabled?: boolean;
  36. };
  37. /**
  38. * Specifies the color of the parent page element.
  39. */
  40. containerBackgroundColor: string;
  41. /**
  42. * Specifies whether the widget responds to the user interaction.
  43. */
  44. disabled: boolean;
  45. /**
  46. * Specifies the attributes to be attached to the widget's root element.
  47. */
  48. elementAttr: any;
  49. /**
  50. * Configures the exporting and printing features.
  51. */
  52. export: {
  53. backgroundColor?: string;
  54. enabled?: boolean;
  55. fileName?: string;
  56. formats?: Array<string>;
  57. margin?: number;
  58. printingEnabled?: boolean;
  59. proxyUrl?: string;
  60. };
  61. /**
  62. * Specifies the options required to set the geometry of the LinearGauge widget.
  63. */
  64. geometry: {
  65. orientation?: string;
  66. };
  67. /**
  68. * Configures the loading indicator.
  69. */
  70. loadingIndicator: {
  71. backgroundColor?: string;
  72. font?: DevExpress.viz.Font;
  73. show?: boolean;
  74. text?: string;
  75. };
  76. /**
  77. * Generates space around the widget.
  78. */
  79. margin: {
  80. bottom?: number;
  81. left?: number;
  82. right?: number;
  83. top?: number;
  84. };
  85. /**
  86. * Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path.
  87. */
  88. pathModified: boolean;
  89. /**
  90. * Specifies gauge range container options.
  91. */
  92. rangeContainer: {
  93. backgroundColor?: string;
  94. horizontalOrientation?: string;
  95. offset?: number;
  96. palette?: string | Array<string>;
  97. paletteExtensionMode?: string;
  98. ranges?: Array<any | {
  99. color?: string;
  100. endValue?: number;
  101. startValue?: number;
  102. }>;
  103. verticalOrientation?: string;
  104. width?: number | {
  105. end?: number;
  106. start?: number;
  107. };
  108. };
  109. /**
  110. * Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates.
  111. */
  112. redrawOnResize: boolean;
  113. /**
  114. * Switches the widget to a right-to-left representation.
  115. */
  116. rtlEnabled: boolean;
  117. /**
  118. * Specifies the gauge's scale options.
  119. */
  120. scale: {
  121. allowDecimals?: boolean;
  122. customMinorTicks?: Array<number>;
  123. customTicks?: Array<number>;
  124. endValue?: number;
  125. horizontalOrientation?: string;
  126. label?: {
  127. customizeText?: Function;
  128. font?: DevExpress.viz.Font;
  129. format?: DevExpress.ui.format | string;
  130. indentFromTick?: number;
  131. overlappingBehavior?: string;
  132. useRangeColors?: boolean;
  133. visible?: boolean;
  134. };
  135. minorTick?: {
  136. color?: string;
  137. length?: number;
  138. opacity?: number;
  139. visible?: boolean;
  140. width?: number;
  141. };
  142. minorTickInterval?: number;
  143. scaleDivisionFactor?: number;
  144. startValue?: number;
  145. tick?: {
  146. color?: string;
  147. length?: number;
  148. opacity?: number;
  149. visible?: boolean;
  150. width?: number;
  151. };
  152. tickInterval?: number;
  153. verticalOrientation?: string;
  154. };
  155. /**
  156. * Specifies the widget's size in pixels.
  157. */
  158. size: {
  159. height?: number;
  160. width?: number;
  161. };
  162. /**
  163. * Specifies the appearance options of subvalue indicators.
  164. */
  165. subvalueIndicator: any;
  166. /**
  167. * Specifies a set of subvalues to be designated by the subvalue indicators.
  168. */
  169. subvalues: Array<number>;
  170. /**
  171. * Sets the name of the theme the widget uses.
  172. */
  173. theme: string;
  174. /**
  175. * Configures the widget's title.
  176. */
  177. title: string | {
  178. font?: DevExpress.viz.Font;
  179. horizontalAlignment?: string;
  180. margin?: number | {
  181. bottom?: number;
  182. left?: number;
  183. right?: number;
  184. top?: number;
  185. };
  186. placeholderSize?: number;
  187. subtitle?: string | {
  188. font?: DevExpress.viz.Font;
  189. offset?: number;
  190. text?: string;
  191. textOverflow?: string;
  192. wordWrap?: string;
  193. };
  194. text?: string;
  195. textOverflow?: string;
  196. verticalAlignment?: string;
  197. wordWrap?: string;
  198. };
  199. /**
  200. * Configures tooltips.
  201. */
  202. tooltip: {
  203. arrowLength?: number;
  204. border?: {
  205. color?: string;
  206. dashStyle?: string;
  207. opacity?: number;
  208. visible?: boolean;
  209. width?: number;
  210. };
  211. color?: string;
  212. container?: Element | JQuery;
  213. cornerRadius?: number;
  214. customizeTooltip?: Function;
  215. enabled?: boolean;
  216. font?: DevExpress.viz.Font;
  217. format?: DevExpress.ui.format | string;
  218. opacity?: number;
  219. paddingLeftRight?: number;
  220. paddingTopBottom?: number;
  221. shadow?: {
  222. blur?: number;
  223. color?: string;
  224. offsetX?: number;
  225. offsetY?: number;
  226. opacity?: number;
  227. };
  228. zIndex?: number;
  229. };
  230. /**
  231. * Specifies the main value on a gauge.
  232. */
  233. value: number;
  234. /**
  235. * Specifies the appearance options of the value indicator.
  236. */
  237. valueIndicator: any;
  238. /**
  239. * A function that is executed before the widget is disposed of.
  240. */
  241. onDisposing: EventEmitter<any>;
  242. /**
  243. * A function that is executed when the widget's rendering has finished.
  244. */
  245. onDrawn: EventEmitter<any>;
  246. /**
  247. * A function that is executed after the widget is exported.
  248. */
  249. onExported: EventEmitter<any>;
  250. /**
  251. * A function that is executed before the widget is exported.
  252. */
  253. onExporting: EventEmitter<any>;
  254. /**
  255. * A function that is executed before a file with exported widget is saved to the user's local storage.
  256. */
  257. onFileSaving: EventEmitter<any>;
  258. /**
  259. * A function that is executed when an error or warning occurs.
  260. */
  261. onIncidentOccurred: EventEmitter<any>;
  262. /**
  263. * A function used in JavaScript frameworks to save the widget instance.
  264. */
  265. onInitialized: EventEmitter<any>;
  266. /**
  267. * A function that is executed after a widget option is changed.
  268. */
  269. onOptionChanged: EventEmitter<any>;
  270. /**
  271. * A function that is executed when a tooltip becomes hidden.
  272. */
  273. onTooltipHidden: EventEmitter<any>;
  274. /**
  275. * A function that is executed when a tooltip appears.
  276. */
  277. onTooltipShown: EventEmitter<any>;
  278. /**
  279. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  280. */
  281. animationChange: EventEmitter<{
  282. duration?: number;
  283. easing?: string;
  284. enabled?: boolean;
  285. }>;
  286. /**
  287. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  288. */
  289. containerBackgroundColorChange: EventEmitter<string>;
  290. /**
  291. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  292. */
  293. disabledChange: EventEmitter<boolean>;
  294. /**
  295. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  296. */
  297. elementAttrChange: EventEmitter<any>;
  298. /**
  299. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  300. */
  301. exportChange: EventEmitter<{
  302. backgroundColor?: string;
  303. enabled?: boolean;
  304. fileName?: string;
  305. formats?: Array<string>;
  306. margin?: number;
  307. printingEnabled?: boolean;
  308. proxyUrl?: string;
  309. }>;
  310. /**
  311. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  312. */
  313. geometryChange: EventEmitter<{
  314. orientation?: string;
  315. }>;
  316. /**
  317. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  318. */
  319. loadingIndicatorChange: EventEmitter<{
  320. backgroundColor?: string;
  321. font?: DevExpress.viz.Font;
  322. show?: boolean;
  323. text?: string;
  324. }>;
  325. /**
  326. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  327. */
  328. marginChange: EventEmitter<{
  329. bottom?: number;
  330. left?: number;
  331. right?: number;
  332. top?: number;
  333. }>;
  334. /**
  335. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  336. */
  337. pathModifiedChange: EventEmitter<boolean>;
  338. /**
  339. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  340. */
  341. rangeContainerChange: EventEmitter<{
  342. backgroundColor?: string;
  343. horizontalOrientation?: string;
  344. offset?: number;
  345. palette?: string | Array<string>;
  346. paletteExtensionMode?: string;
  347. ranges?: Array<any | {
  348. color?: string;
  349. endValue?: number;
  350. startValue?: number;
  351. }>;
  352. verticalOrientation?: string;
  353. width?: number | {
  354. end?: number;
  355. start?: number;
  356. };
  357. }>;
  358. /**
  359. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  360. */
  361. redrawOnResizeChange: EventEmitter<boolean>;
  362. /**
  363. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  364. */
  365. rtlEnabledChange: EventEmitter<boolean>;
  366. /**
  367. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  368. */
  369. scaleChange: EventEmitter<{
  370. allowDecimals?: boolean;
  371. customMinorTicks?: Array<number>;
  372. customTicks?: Array<number>;
  373. endValue?: number;
  374. horizontalOrientation?: string;
  375. label?: {
  376. customizeText?: Function;
  377. font?: DevExpress.viz.Font;
  378. format?: DevExpress.ui.format | string;
  379. indentFromTick?: number;
  380. overlappingBehavior?: string;
  381. useRangeColors?: boolean;
  382. visible?: boolean;
  383. };
  384. minorTick?: {
  385. color?: string;
  386. length?: number;
  387. opacity?: number;
  388. visible?: boolean;
  389. width?: number;
  390. };
  391. minorTickInterval?: number;
  392. scaleDivisionFactor?: number;
  393. startValue?: number;
  394. tick?: {
  395. color?: string;
  396. length?: number;
  397. opacity?: number;
  398. visible?: boolean;
  399. width?: number;
  400. };
  401. tickInterval?: number;
  402. verticalOrientation?: string;
  403. }>;
  404. /**
  405. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  406. */
  407. sizeChange: EventEmitter<{
  408. height?: number;
  409. width?: number;
  410. }>;
  411. /**
  412. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  413. */
  414. subvalueIndicatorChange: EventEmitter<any>;
  415. /**
  416. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  417. */
  418. subvaluesChange: EventEmitter<Array<number>>;
  419. /**
  420. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  421. */
  422. themeChange: EventEmitter<string>;
  423. /**
  424. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  425. */
  426. titleChange: EventEmitter<string | {
  427. font?: DevExpress.viz.Font;
  428. horizontalAlignment?: string;
  429. margin?: number | {
  430. bottom?: number;
  431. left?: number;
  432. right?: number;
  433. top?: number;
  434. };
  435. placeholderSize?: number;
  436. subtitle?: string | {
  437. font?: DevExpress.viz.Font;
  438. offset?: number;
  439. text?: string;
  440. textOverflow?: string;
  441. wordWrap?: string;
  442. };
  443. text?: string;
  444. textOverflow?: string;
  445. verticalAlignment?: string;
  446. wordWrap?: string;
  447. }>;
  448. /**
  449. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  450. */
  451. tooltipChange: EventEmitter<{
  452. arrowLength?: number;
  453. border?: {
  454. color?: string;
  455. dashStyle?: string;
  456. opacity?: number;
  457. visible?: boolean;
  458. width?: number;
  459. };
  460. color?: string;
  461. container?: Element | JQuery;
  462. cornerRadius?: number;
  463. customizeTooltip?: Function;
  464. enabled?: boolean;
  465. font?: DevExpress.viz.Font;
  466. format?: DevExpress.ui.format | string;
  467. opacity?: number;
  468. paddingLeftRight?: number;
  469. paddingTopBottom?: number;
  470. shadow?: {
  471. blur?: number;
  472. color?: string;
  473. offsetX?: number;
  474. offsetY?: number;
  475. opacity?: number;
  476. };
  477. zIndex?: number;
  478. }>;
  479. /**
  480. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  481. */
  482. valueChange: EventEmitter<number>;
  483. /**
  484. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  485. */
  486. valueIndicatorChange: EventEmitter<any>;
  487. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  488. protected _createInstance(element: any, options: any): DxLinearGauge;
  489. ngOnDestroy(): void;
  490. ngOnChanges(changes: SimpleChanges): void;
  491. setupChanges(prop: string, changes: SimpleChanges): void;
  492. ngDoCheck(): void;
  493. _setOption(name: string, value: any): void;
  494. }
  495. export declare class DxLinearGaugeModule {
  496. }