vector-map.d.ts 19 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620
  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 DxVectorMap from 'devextreme/viz/vector_map';
  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 { DxiLayerComponent } from './nested/layer-dxi';
  23. import { DxiLegendComponent } from './nested/legend-dxi';
  24. /**
  25. * The VectorMap is a widget that visualizes geographical locations. This widget represents a geographical map that contains areas and markers. Areas embody continents and countries. Markers flag specific points on the map, for example, towns, cities or capitals.
  26. */
  27. export declare class DxVectorMapComponent extends DxComponent implements OnDestroy, OnChanges, DoCheck {
  28. private _watcherHelper;
  29. private _idh;
  30. instance: DxVectorMap;
  31. /**
  32. * Specifies the options for the map background.
  33. */
  34. background: {
  35. borderColor?: string;
  36. color?: string;
  37. };
  38. /**
  39. * Specifies the positioning of a map in geographical coordinates.
  40. */
  41. bounds: Array<number>;
  42. /**
  43. * Specifies the geographical coordinates of the center for a map.
  44. */
  45. center: Array<number>;
  46. /**
  47. * Configures the control bar.
  48. */
  49. controlBar: {
  50. borderColor?: string;
  51. color?: string;
  52. enabled?: boolean;
  53. horizontalAlignment?: string;
  54. margin?: number;
  55. opacity?: number;
  56. verticalAlignment?: string;
  57. };
  58. /**
  59. * Specifies whether the widget responds to the user interaction.
  60. */
  61. disabled: boolean;
  62. /**
  63. * Specifies the attributes to be attached to the widget's root element.
  64. */
  65. elementAttr: any;
  66. /**
  67. * Configures the exporting and printing features.
  68. */
  69. export: {
  70. backgroundColor?: string;
  71. enabled?: boolean;
  72. fileName?: string;
  73. formats?: Array<string>;
  74. margin?: number;
  75. printingEnabled?: boolean;
  76. proxyUrl?: string;
  77. };
  78. /**
  79. * Specifies options for VectorMap widget layers.
  80. */
  81. layers: Array<any | {
  82. borderColor?: string;
  83. borderWidth?: number;
  84. color?: string;
  85. colorGroupingField?: string;
  86. colorGroups?: Array<number>;
  87. customize?: Function;
  88. dataField?: string;
  89. dataSource?: any | DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string;
  90. elementType?: string;
  91. hoveredBorderColor?: string;
  92. hoveredBorderWidth?: number;
  93. hoveredColor?: string;
  94. hoverEnabled?: boolean;
  95. label?: {
  96. dataField?: string;
  97. enabled?: boolean;
  98. font?: DevExpress.viz.Font;
  99. };
  100. maxSize?: number;
  101. minSize?: number;
  102. name?: string;
  103. opacity?: number;
  104. palette?: string | Array<string>;
  105. paletteSize?: number;
  106. selectedBorderColor?: string;
  107. selectedBorderWidth?: number;
  108. selectedColor?: string;
  109. selectionMode?: string;
  110. size?: number;
  111. sizeGroupingField?: string;
  112. sizeGroups?: Array<number>;
  113. type?: string;
  114. }>;
  115. /**
  116. * Configures map legends.
  117. */
  118. legends: Array<any | {
  119. backgroundColor?: string;
  120. border?: {
  121. color?: string;
  122. cornerRadius?: number;
  123. dashStyle?: string;
  124. opacity?: number;
  125. visible?: boolean;
  126. width?: number;
  127. };
  128. columnCount?: number;
  129. columnItemSpacing?: number;
  130. customizeHint?: Function;
  131. customizeItems?: Function;
  132. customizeText?: Function;
  133. font?: DevExpress.viz.Font;
  134. horizontalAlignment?: string;
  135. itemsAlignment?: string;
  136. itemTextPosition?: string;
  137. margin?: number | {
  138. bottom?: number;
  139. left?: number;
  140. right?: number;
  141. top?: number;
  142. };
  143. markerColor?: string;
  144. markerShape?: string;
  145. markerSize?: number;
  146. orientation?: string;
  147. paddingLeftRight?: number;
  148. paddingTopBottom?: number;
  149. rowCount?: number;
  150. rowItemSpacing?: number;
  151. source?: {
  152. grouping?: string;
  153. layer?: string;
  154. };
  155. title?: string | {
  156. font?: DevExpress.viz.Font;
  157. horizontalAlignment?: string;
  158. margin?: {
  159. bottom?: number;
  160. left?: number;
  161. right?: number;
  162. top?: number;
  163. };
  164. placeholderSize?: number;
  165. subtitle?: string | {
  166. font?: DevExpress.viz.Font;
  167. offset?: number;
  168. text?: string;
  169. };
  170. text?: string;
  171. verticalAlignment?: string;
  172. };
  173. verticalAlignment?: string;
  174. visible?: boolean;
  175. }>;
  176. /**
  177. * Configures the loading indicator.
  178. */
  179. loadingIndicator: {
  180. backgroundColor?: string;
  181. enabled?: boolean;
  182. font?: DevExpress.viz.Font;
  183. show?: boolean;
  184. text?: string;
  185. };
  186. /**
  187. * Specifies a map's maximum zoom factor.
  188. */
  189. maxZoomFactor: number;
  190. /**
  191. * Disables the panning capability.
  192. */
  193. panningEnabled: boolean;
  194. /**
  195. * Notifies the widget that it is embedded into an HTML page that uses a tag modifying the path.
  196. */
  197. pathModified: boolean;
  198. /**
  199. * Specifies the map projection.
  200. */
  201. projection: any;
  202. /**
  203. * Specifies whether to redraw the widget when the size of the parent browser window changes or a mobile device rotates.
  204. */
  205. redrawOnResize: boolean;
  206. /**
  207. * Switches the widget to a right-to-left representation.
  208. */
  209. rtlEnabled: boolean;
  210. /**
  211. * Specifies the widget's size in pixels.
  212. */
  213. size: {
  214. height?: number;
  215. width?: number;
  216. };
  217. /**
  218. * Sets the name of the theme the widget uses.
  219. */
  220. theme: string;
  221. /**
  222. * Configures the widget's title.
  223. */
  224. title: string | {
  225. font?: DevExpress.viz.Font;
  226. horizontalAlignment?: string;
  227. margin?: number | {
  228. bottom?: number;
  229. left?: number;
  230. right?: number;
  231. top?: number;
  232. };
  233. placeholderSize?: number;
  234. subtitle?: string | {
  235. font?: DevExpress.viz.Font;
  236. offset?: number;
  237. text?: string;
  238. textOverflow?: string;
  239. wordWrap?: string;
  240. };
  241. text?: string;
  242. textOverflow?: string;
  243. verticalAlignment?: string;
  244. wordWrap?: string;
  245. };
  246. /**
  247. * Configures tooltips.
  248. */
  249. tooltip: {
  250. arrowLength?: number;
  251. border?: {
  252. color?: string;
  253. dashStyle?: string;
  254. opacity?: number;
  255. visible?: boolean;
  256. width?: number;
  257. };
  258. color?: string;
  259. container?: Element | JQuery;
  260. cornerRadius?: number;
  261. customizeTooltip?: Function;
  262. enabled?: boolean;
  263. font?: DevExpress.viz.Font;
  264. opacity?: number;
  265. paddingLeftRight?: number;
  266. paddingTopBottom?: number;
  267. shadow?: {
  268. blur?: number;
  269. color?: string;
  270. offsetX?: number;
  271. offsetY?: number;
  272. opacity?: number;
  273. };
  274. zIndex?: number;
  275. };
  276. /**
  277. * Specifies whether the map should respond to touch gestures.
  278. */
  279. touchEnabled: boolean;
  280. /**
  281. * Specifies whether or not the map should respond when a user rolls the mouse wheel.
  282. */
  283. wheelEnabled: boolean;
  284. /**
  285. * Specifies a number that is used to zoom a map initially.
  286. */
  287. zoomFactor: number;
  288. /**
  289. * Disables the zooming capability.
  290. */
  291. zoomingEnabled: boolean;
  292. /**
  293. * A function that is executed each time the center coordinates are changed.
  294. */
  295. onCenterChanged: EventEmitter<any>;
  296. /**
  297. * A function that is executed when any location on the map is clicked or tapped.
  298. */
  299. onClick: EventEmitter<any>;
  300. /**
  301. * A function that is executed before the widget is disposed of.
  302. */
  303. onDisposing: EventEmitter<any>;
  304. /**
  305. * A function that is executed when the widget's rendering has finished.
  306. */
  307. onDrawn: EventEmitter<any>;
  308. /**
  309. * A function that is executed after the widget is exported.
  310. */
  311. onExported: EventEmitter<any>;
  312. /**
  313. * A function that is executed before the widget is exported.
  314. */
  315. onExporting: EventEmitter<any>;
  316. /**
  317. * A function that is executed before a file with exported widget is saved to the user's local storage.
  318. */
  319. onFileSaving: EventEmitter<any>;
  320. /**
  321. * A function that is executed when an error or warning occurs.
  322. */
  323. onIncidentOccurred: EventEmitter<any>;
  324. /**
  325. * A function used in JavaScript frameworks to save the widget instance.
  326. */
  327. onInitialized: EventEmitter<any>;
  328. /**
  329. * A function that is executed after a widget option is changed.
  330. */
  331. onOptionChanged: EventEmitter<any>;
  332. /**
  333. * A function that is executed when a layer element is selected or selection is canceled.
  334. */
  335. onSelectionChanged: EventEmitter<any>;
  336. /**
  337. * A function that is executed when a tooltip becomes hidden.
  338. */
  339. onTooltipHidden: EventEmitter<any>;
  340. /**
  341. * A function that is executed when a tooltip appears.
  342. */
  343. onTooltipShown: EventEmitter<any>;
  344. /**
  345. * A function that is executed each time the zoom factor is changed.
  346. */
  347. onZoomFactorChanged: EventEmitter<any>;
  348. /**
  349. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  350. */
  351. backgroundChange: EventEmitter<{
  352. borderColor?: string;
  353. color?: string;
  354. }>;
  355. /**
  356. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  357. */
  358. boundsChange: EventEmitter<Array<number>>;
  359. /**
  360. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  361. */
  362. centerChange: EventEmitter<Array<number>>;
  363. /**
  364. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  365. */
  366. controlBarChange: EventEmitter<{
  367. borderColor?: string;
  368. color?: string;
  369. enabled?: boolean;
  370. horizontalAlignment?: string;
  371. margin?: number;
  372. opacity?: number;
  373. verticalAlignment?: string;
  374. }>;
  375. /**
  376. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  377. */
  378. disabledChange: EventEmitter<boolean>;
  379. /**
  380. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  381. */
  382. elementAttrChange: EventEmitter<any>;
  383. /**
  384. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  385. */
  386. exportChange: EventEmitter<{
  387. backgroundColor?: string;
  388. enabled?: boolean;
  389. fileName?: string;
  390. formats?: Array<string>;
  391. margin?: number;
  392. printingEnabled?: boolean;
  393. proxyUrl?: string;
  394. }>;
  395. /**
  396. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  397. */
  398. layersChange: EventEmitter<Array<any | {
  399. borderColor?: string;
  400. borderWidth?: number;
  401. color?: string;
  402. colorGroupingField?: string;
  403. colorGroups?: Array<number>;
  404. customize?: Function;
  405. dataField?: string;
  406. dataSource?: any | DevExpress.data.DataSource | DevExpress.data.DataSourceOptions | string;
  407. elementType?: string;
  408. hoveredBorderColor?: string;
  409. hoveredBorderWidth?: number;
  410. hoveredColor?: string;
  411. hoverEnabled?: boolean;
  412. label?: {
  413. dataField?: string;
  414. enabled?: boolean;
  415. font?: DevExpress.viz.Font;
  416. };
  417. maxSize?: number;
  418. minSize?: number;
  419. name?: string;
  420. opacity?: number;
  421. palette?: string | Array<string>;
  422. paletteSize?: number;
  423. selectedBorderColor?: string;
  424. selectedBorderWidth?: number;
  425. selectedColor?: string;
  426. selectionMode?: string;
  427. size?: number;
  428. sizeGroupingField?: string;
  429. sizeGroups?: Array<number>;
  430. type?: string;
  431. }>>;
  432. /**
  433. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  434. */
  435. legendsChange: EventEmitter<Array<any | {
  436. backgroundColor?: string;
  437. border?: {
  438. color?: string;
  439. cornerRadius?: number;
  440. dashStyle?: string;
  441. opacity?: number;
  442. visible?: boolean;
  443. width?: number;
  444. };
  445. columnCount?: number;
  446. columnItemSpacing?: number;
  447. customizeHint?: Function;
  448. customizeItems?: Function;
  449. customizeText?: Function;
  450. font?: DevExpress.viz.Font;
  451. horizontalAlignment?: string;
  452. itemsAlignment?: string;
  453. itemTextPosition?: string;
  454. margin?: number | {
  455. bottom?: number;
  456. left?: number;
  457. right?: number;
  458. top?: number;
  459. };
  460. markerColor?: string;
  461. markerShape?: string;
  462. markerSize?: number;
  463. orientation?: string;
  464. paddingLeftRight?: number;
  465. paddingTopBottom?: number;
  466. rowCount?: number;
  467. rowItemSpacing?: number;
  468. source?: {
  469. grouping?: string;
  470. layer?: string;
  471. };
  472. title?: string | {
  473. font?: DevExpress.viz.Font;
  474. horizontalAlignment?: string;
  475. margin?: {
  476. bottom?: number;
  477. left?: number;
  478. right?: number;
  479. top?: number;
  480. };
  481. placeholderSize?: number;
  482. subtitle?: string | {
  483. font?: DevExpress.viz.Font;
  484. offset?: number;
  485. text?: string;
  486. };
  487. text?: string;
  488. verticalAlignment?: string;
  489. };
  490. verticalAlignment?: string;
  491. visible?: boolean;
  492. }>>;
  493. /**
  494. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  495. */
  496. loadingIndicatorChange: EventEmitter<{
  497. backgroundColor?: string;
  498. enabled?: boolean;
  499. font?: DevExpress.viz.Font;
  500. show?: boolean;
  501. text?: string;
  502. }>;
  503. /**
  504. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  505. */
  506. maxZoomFactorChange: EventEmitter<number>;
  507. /**
  508. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  509. */
  510. panningEnabledChange: EventEmitter<boolean>;
  511. /**
  512. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  513. */
  514. pathModifiedChange: EventEmitter<boolean>;
  515. /**
  516. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  517. */
  518. projectionChange: EventEmitter<any>;
  519. /**
  520. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  521. */
  522. redrawOnResizeChange: EventEmitter<boolean>;
  523. /**
  524. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  525. */
  526. rtlEnabledChange: EventEmitter<boolean>;
  527. /**
  528. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  529. */
  530. sizeChange: EventEmitter<{
  531. height?: number;
  532. width?: number;
  533. }>;
  534. /**
  535. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  536. */
  537. themeChange: EventEmitter<string>;
  538. /**
  539. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  540. */
  541. titleChange: EventEmitter<string | {
  542. font?: DevExpress.viz.Font;
  543. horizontalAlignment?: string;
  544. margin?: number | {
  545. bottom?: number;
  546. left?: number;
  547. right?: number;
  548. top?: number;
  549. };
  550. placeholderSize?: number;
  551. subtitle?: string | {
  552. font?: DevExpress.viz.Font;
  553. offset?: number;
  554. text?: string;
  555. textOverflow?: string;
  556. wordWrap?: string;
  557. };
  558. text?: string;
  559. textOverflow?: string;
  560. verticalAlignment?: string;
  561. wordWrap?: string;
  562. }>;
  563. /**
  564. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  565. */
  566. tooltipChange: EventEmitter<{
  567. arrowLength?: number;
  568. border?: {
  569. color?: string;
  570. dashStyle?: string;
  571. opacity?: number;
  572. visible?: boolean;
  573. width?: number;
  574. };
  575. color?: string;
  576. container?: Element | JQuery;
  577. cornerRadius?: number;
  578. customizeTooltip?: Function;
  579. enabled?: boolean;
  580. font?: DevExpress.viz.Font;
  581. opacity?: number;
  582. paddingLeftRight?: number;
  583. paddingTopBottom?: number;
  584. shadow?: {
  585. blur?: number;
  586. color?: string;
  587. offsetX?: number;
  588. offsetY?: number;
  589. opacity?: number;
  590. };
  591. zIndex?: number;
  592. }>;
  593. /**
  594. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  595. */
  596. touchEnabledChange: EventEmitter<boolean>;
  597. /**
  598. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  599. */
  600. wheelEnabledChange: EventEmitter<boolean>;
  601. /**
  602. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  603. */
  604. zoomFactorChange: EventEmitter<number>;
  605. /**
  606. * This member supports the internal infrastructure and is not intended to be used directly from your code.
  607. */
  608. zoomingEnabledChange: EventEmitter<boolean>;
  609. layersChildren: QueryList<DxiLayerComponent>;
  610. legendsChildren: QueryList<DxiLegendComponent>;
  611. constructor(elementRef: ElementRef, ngZone: NgZone, templateHost: DxTemplateHost, _watcherHelper: WatcherHelper, _idh: IterableDifferHelper, optionHost: NestedOptionHost, transferState: TransferState, platformId: any);
  612. protected _createInstance(element: any, options: any): DxVectorMap;
  613. ngOnDestroy(): void;
  614. ngOnChanges(changes: SimpleChanges): void;
  615. setupChanges(prop: string, changes: SimpleChanges): void;
  616. ngDoCheck(): void;
  617. _setOption(name: string, value: any): void;
  618. }
  619. export declare class DxVectorMapModule {
  620. }