forked from DefinitelyTyped/DefinitelyTyped
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenlayers.d.ts
5403 lines (4548 loc) · 198 KB
/
openlayers.d.ts
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
// Type definitions for OpenLayers v3.18.2
// Project: http://openlayers.org/
// Definitions by: Wouter Goedhart <https://github.com/woutergd>
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
declare namespace olx {
interface StaticImageOptions {
/** Attributions */
attributions?: Array<ol.Attribution>
/*** The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. */
crossOrigin?: string
/*** Extent of the image in map coordinates. This is the [left, bottom, right, top] map coordinates of your image.*/
imageExtent: ol.Extent;
/*** Size of the image in pixels.*/
imageSize?: ol.Size;
/*** experimental Optional function to load an image given a URL.*/
imageLoadFunction?: ol.TileLoadFunctionType;
/*** Optional logo.*/
logo?: olx.LogoOptions;
/*** experimental Projection.*/
projection: ol.proj.Projection;
/*** Image URL.*/
url: string;
}
interface ZoomToExtentOptions {
/*** Class name. Default is ol-zoom-extent.*/
className?: string;
/*** Target.*/
target?: Element;
/*** Text label to use for the button. Default is E. Instead of text, also a Node (e.g. a span element) can be used.*/
label?: string | Node;
/*** Text label to use for the button tip. Default is Zoom to extent.*/
tipLabel?: string;
/*** The extent to zoom to. If undefined the validity extent of the view projection is used.*/
extent: ol.Extent;
}
interface OverviewMapOptions {
/*** Whether the control should start collapsed or not (expanded). Default to true.*/
collapsed?: boolean;
/*** Text label to use for the expanded overviewmap button. Default is «. Instead of text, also a Node (e.g. a span element) can be used.*/
collapseLabel? :string | Node;
/*** Whether the control can be collapsed or not. Default to true.*/
collapsible?: boolean;
/*** Text label to use for the collapsed overviewmap button. Default is ». Instead of text, also a Node (e.g. a span element) can be used.*/
label?: string | Node;
/*** Layers for the overview map. If not set, then all main map layers are used instead.*/
layers?: ol.layer.Layer[] | ol.Collection<ol.layer.Layer>;
/*** Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.*/
render?: Function;
/*** Specify a target if you want the control to be rendered outside of the map's viewport.*/
target?: Element;
/*** Text label to use for the button tip. Default is Overview map*/
tipLabel?: string;
/*** Custom view for the overview map. If not provided, a default view with an EPSG:3857 projection will be used.*/
view?: ol.View;
}
interface RotateOptions {
/*** CSS class name. Default is ol-rotate.*/
className?: string;
/*** Text label to use for the rotate button. Default is ⇧. Instead of text, also a Node (e.g. a span element) can be used.*/
label?: string | Element;
/*** Text label to use for the rotate tip. Default is Reset rotation.*/
tipLabel?: string;
/*** Animation duration in milliseconds. Default is 250.*/
duration?: number;
/*** Hide the control when rotation is 0. Default is true.*/
autoHide?: boolean;
/*** Function called when the control should be re-rendered. This is called in a requestAnimationFrame callback.*/
render?: Function;
/*** Function called when the control is clicked. This will override the default resetNorth.*/
resetNorth?: Function;
/*** Target.*/
target?: Element;
}
interface AttributionOptions {
/** HTML markup for this attribution. */
html: string;
}
interface DeviceOrientationOptions {
/**
* Start tracking. Default is false.
*/
tracking?: boolean;
}
interface FrameState {
/**
*
*/
pixelRatio: number;
/**
*
*/
time: number;
/**
*
*/
viewState: olx.ViewState;
}
interface FeatureOverlayOptions {
/**
* Features
*/
features?: Array<ol.Feature> | ol.Collection<ol.Feature> | ol.style.StyleFunction;
/**
* Map
*/
map: ol.Map;
/**
* Style
*/
style: ol.style.Style | Array<ol.style.Style>;
}
interface GeolocationOptions {
/**
* Start Tracking. Default is false.
*/
tracking?: boolean;
/**
* Tracking options. See http://www.w3.org/TR/geolocation-API/#position_options_interface.
*/
trackingOptions?: PositionOptions;
/**
* The projection the position is reported in.
*/
projection?: ol.proj.ProjectionLike | ol.proj.Projection;
}
interface GraticuleOptions {
/** Reference to an ol.Map object. */
map?: ol.Map;
/** The maximum number of meridians and parallels from the center of the map. The default value is 100, which means that at most 200 meridians and 200 parallels will be displayed. The default value is appropriate for conformal projections like Spherical Mercator. If you increase the value more lines will be drawn and the drawing performance will decrease. */
maxLines?: number;
/** The stroke style to use for drawing the graticule. If not provided, the lines will be drawn with rgba(0,0,0,0.2), a not fully opaque black. */
strokeStyle?: ol.style.Stroke;
/** The target size of the graticule cells, in pixels. Default value is 100 pixels. */
targetSize?: number;
}
interface BaseWMSOptions {
/** Attributions. */
attributions?: Array<ol.Attribution>;
/** WMS request parameters. At least a LAYERS param is required. STYLES is '' by default. VERSION is 1.3.0 by default. WIDTH, HEIGHT, BBOX and CRS (SRS for WMS version < 1.3.0) will be set dynamically. */
params?: any;
/** The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. */
crossOrigin?: string;
/** experimental Use the ol.Map#pixelRatio value when requesting the image from the remote server. Default is true. */
hidpi?: boolean;
/** experimental The type of the remote WMS server: mapserver, geoserver or qgis. Only needed if hidpi is true. Default is undefined. */
serverType?: ol.source.wms.ServerType;
/** WMS service URL. */
url?: string;
/** Logo. */
logo?: olx.LogoOptions;
/** experimental Projection. */
projection?: ol.proj.ProjectionLike;
}
interface ImageWMSOptions extends BaseWMSOptions {
/** experimental Optional function to load an image given a URL. */
imageLoadFunction?: ol.ImageLoadFunctionType;
/** Ratio. 1 means image requests are the size of the map viewport, 2 means twice the width and height of the map viewport, and so on. Must be 1 or higher. Default is 1.5. */
ratio?: number;
/** Resolutions. If specified, requests will be made for these resolutions only. */
resolutions?: Array<number>;
}
interface TileWMSOptions {
attributions?: Array<ol.Attribution>;
/**WMS request parameters. At least a LAYERS param is required. STYLES is '' by default. VERSION is 1.3.0 by default. WIDTH, HEIGHT, BBOX and CRS (SRS for WMS version < 1.3.0) will be set dynamically. Required.*/
params: Object;
/**The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you are using the WebGL renderer or if you want to access pixel data with the Canvas renderer. See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail.*/
crossOrigin?: string;
/** The size in pixels of the gutter around image tiles to ignore. By setting this property to a non-zero value, images will be requested that are wider and taller than the tile size by a value of 2 x gutter. Defaults to zero. Using a non-zero value allows artifacts of rendering at tile edges to be ignored. If you control the WMS service it is recommended to address "artifacts at tile edges" issues by properly configuring the WMS service. For example, MapServer has a tile_map_edge_buffer configuration parameter for this. See http://mapserver.org/output/tile_mode.html. */
gutter?: number;
/** Use the ol.Map#pixelRatio value when requesting the image from the remote server. Default is true.*/
hidpi?: boolean;
logo?: string | olx.LogoOptions;
/** Tile grid. Base this on the resolutions, tilesize and extent supported by the server. If this is not defined, a default grid will be used: if there is a projection extent, the grid will be based on that; if not, a grid based on a global extent with origin at 0,0 will be used. */
tileGrid?: ol.tilegrid.TileGrid;
/** experimental Maximum zoom. */
maxZoom?: number;
projection?: ol.proj.ProjectionLike;
reprojectionErrorThreshold?: number;
/** experimental Optional function to load a tile given a URL. */
tileLoadFunction?: ol.TileLoadFunctionType;
/** WMS service URL. */
url?: string;
/** WMS service urls. Use this instead of url when the WMS supports multiple urls for GetMap requests. */
urls?: Array<string>;
/** experimental The type of the remote WMS server. Currently only used when hidpi is true. Default is undefined. */
serverType?: ol.source.wms.ServerType;
/** experimental Whether to wrap the world horizontally. When set to false, only one world will be rendered. When true, tiles will be requested for one world only, but they will be wrapped horizontally to render multiple worlds. The default is true. */
wrapX?: boolean;
}
interface OSMOptions {
/** Attributions */
attributions?: ol.AttributionLike;
/** Cache size. Default is 2048. */
cacheSize?: number;
/**
* The crossOrigin attribute for loaded images. Note that you must provide a crossOrigin value if you are using the WebGL
* renderer or if you want to access pixel data with the Canvas renderer.
* See https://developer.mozilla.org/en-US/docs/Web/HTML/CORS_enabled_image for more detail. Default is anonymous.
*/
crossOrigin?: string;
/** Max zoom. Default is 19. */
maxZoom?: number;
/** Whether the layer is opaque. Default is true. */
opaque?: boolean;
/** Maximum allowed reprojection error (in pixels). Default is 0.5. Higher values can increase reprojection performance, but decrease precision. */
reprojectionErrorThreshold?: number;
/** Optional function to load a tile given a URL. */
tileLoadFunction?: ol.TileLoadFunctionType;
/** URL template. Must include {x}, {y} or {-y}, and {z} placeholders. Default is https://{a-c}.tile.openstreetmap.org/{z}/{x}/{y}.png. */
url?: string;
/** Whether to wrap the world horizontally. Default is true. */
wrapX?: boolean;
}
/**
* Object literal with config options for the map logo.
*/
interface LogoOptions {
/**
* Link url for the logo. Will be followed when the logo is clicked.
*/
href: string;
/**
* Image src for the logo
*/
src: string;
}
interface MapOptions {
/** Controls initially added to the map. If not specified, ol.control.defaults() is used. */
controls?: any;
/** The ratio between physical pixels and device-independent pixels (dips) on the device. If undefined then it gets set by using window.devicePixelRatio. */
pixelRatio?: number;
/** Interactions that are initially added to the map. If not specified, ol.interaction.defaults() is used. */
interactions?: any;
/** The element to listen to keyboard events on. This determines when the KeyboardPan and KeyboardZoom interactions trigger. For example, if this option is set to document the keyboard interactions will always trigger. If this option is not specified, the element the library listens to keyboard events on is the map target (i.e. the user-provided div for the map). If this is not document the target element needs to be focused for key events to be emitted, requiring that the target element has a tabindex attribute. */
keyboardEventTarget?: any;
/** Layers. If this is not defined, a map with no layers will be rendered. Note that layers are rendered in the order supplied, so if you want, for example, a vector layer to appear on top of a tile layer, it must come after the tile layer. */
layers?: Array<any>
/** When set to true, tiles will be loaded during animations. This may improve the user experience, but can also make animations stutter on devices with slow memory. Default is false. */
loadTilesWhileAnimating?: boolean;
/** When set to true, tiles will be loaded while interacting with the map. This may improve the user experience, but can also make map panning and zooming choppy on devices with slow memory. Default is false. */
loadTilesWhileInteracting?: boolean;
/** The map logo. A logo to be displayed on the map at all times. If a string is provided, it will be set as the image source of the logo. If an object is provided, the src property should be the URL for an image and the href property should be a URL for creating a link. To disable the map logo, set the option to false. By default, the OpenLayers 3 logo is shown. */
logo?: any;
/** Overlays initially added to the map. By default, no overlays are added. */
overlays?: any;
/** Renderer. By default, Canvas, DOM and WebGL renderers are tested for support in that order, and the first supported used. Specify a ol.RendererType here to use a specific renderer. Note that at present only the Canvas renderer supports vector data. */
renderer?: any;
/** The container for the map, either the element itself or the id of the element. If not specified at construction time, ol.Map#setTarget must be called for the map to be rendered. */
target?: any;
/** The map's view. No layer sources will be fetched unless this is specified at construction time or through ol.Map#setView. */
view?: ViewOptions;
}
interface OverlayOptions {
/**
* The overlay element.
*/
element?: Element;
/**
* Offsets in pixels used when positioning the overlay. The fist element in the array is the horizontal offset. A positive value shifts the overlay right. The second element in the array is the vertical offset. A positive value shifts the overlay down. Default is [0, 0].
*/
offset?: Array<number>;
/**
* The overlay position in map projection.
*/
position?: ol.Coordinate;
/**
* Defines how the overlay is actually positioned with respect to its position property. Possible values are 'bottom-left', 'bottom-center', 'bottom-right', 'center-left', 'center-center', 'center-right', 'top-left', 'top-center', and 'top-right'. Default is 'top-left'.
*/
positioning?: ol.OverlayPositioning;
/**
* Whether event propagation to the map viewport should be stopped. Default is true. If true the overlay is placed in the same container as that of the controls (CSS class name ol-overlaycontainer-stopevent); if false it is placed in the container with CSS class name ol-overlaycontainer.
*/
stopEvent?: boolean;
/**
* Whether the overlay is inserted first in the overlay container, or appended. Default is true. If the overlay is placed in the same container as that of the controls (see the stopEvent option) you will probably set insertFirst to true so the overlay is displayed below the controls.
*/
insertFirst?: boolean;
/**
* If set to true the map is panned when calling setPosition, so that the overlay is entirely visible in the current viewport. The default is false.
*/
autoPan?: boolean;
/**
* The options used to create a ol.animation.pan animation. This animation is only used when autoPan is enabled. By default the default options for ol.animation.pan are used. If set to null the panning is not animated.
*/
autoPanAnimation?: olx.animation.PanOptions;
/**
* The margin (in pixels) between the overlay and the borders of the map when autopanning. The default is 20.
*/
autoPanMargin?: number;
}
interface ViewOptions {
/** The initial center for the view. The coordinate system for the center is specified with the projection option. Default is undefined, and layer sources will not be fetched if this is not set. */
center?: ol.Coordinate;
/** Rotation constraint. false means no constraint. true means no constraint, but snap to zero near zero. A number constrains the rotation to that number of values. For example, 4 will constrain the rotation to 0, 90, 180, and 270 degrees. The default is true. */
constrainRotation?: boolean;
/** Enable rotation. Default is true. If false a rotation constraint that always sets the rotation to zero is used. The constrainRotation option has no effect if enableRotation is false. */
enableRotation?: boolean;
/**The extent that constrains the center, in other words, center cannot be set outside this extent. Default is undefined. */
extent?: ol.Extent;
/** The maximum resolution used to determine the resolution constraint. It is used together with minResolution (or maxZoom) and zoomFactor. If unspecified it is calculated in such a way that the projection's validity extent fits in a 256x256 px tile. If the projection is Spherical Mercator (the default) then maxResolution defaults to 40075016.68557849 / 256 = 156543.03392804097. */
maxResolution?: number;
/** The minimum resolution used to determine the resolution constraint. It is used together with maxResolution (or minZoom) and zoomFactor. If unspecified it is calculated assuming 29 zoom levels (with a factor of 2). If the projection is Spherical Mercator (the default) then minResolution defaults to 40075016.68557849 / 256 / Math.pow(2, 28) = 0.0005831682455839253. */
minResolution?: number;
/** The maximum zoom level used to determine the resolution constraint. It is used together with minZoom (or maxResolution) and zoomFactor. Default is 28. Note that if minResolution is also provided, it is given precedence over maxZoom. */
maxZoom?: number;
/** The minimum zoom level used to determine the resolution constraint. It is used together with maxZoom (or minResolution) and zoomFactor. Default is 0. Note that if maxResolution is also provided, it is given precedence over minZoom. */
minZoom?: number;
/** The projection. Default is EPSG:3857 (Spherical Mercator). */
projection?: ol.proj.ProjectionLike | ol.proj.Projection;
/** The initial resolution for the view. The units are projection units per pixel (e.g. meters per pixel). An alternative to setting this is to set zoom. Default is undefined, and layer sources will not be fetched if neither this nor zoom are defined. */
resolution?: number;
/** Resolutions to determine the resolution constraint. If set the maxResolution, minResolution, minZoom, maxZoom, and zoomFactor options are ignored. */
resolutions?: Array<number>;
/** The initial rotation for the view in radians (positive rotation clockwise). Default is 0. */
rotation?: number;
/** Only used if resolution is not defined. Zoom level used to calculate the initial resolution for the view. The initial resolution is determined using the ol.View#constrainResolution method. */
zoom?: number;
/** The zoom factor used to determine the resolution constraint. Default is 2. */
zoomFactor?: number;
}
interface ViewState {
/**
*
*/
center: ol.Coordinate;
/**
*
*/
projection: ol.proj.Projection;
/**
*
*/
resolution: number;
/**
*
*/
rotation: number;
}
interface Projection {
/**
* The SRS identifier code, e.g. EPSG:4326.
*/
code: string;
/**
* Units. Required unless a proj4 projection is defined for code.
*/
units?: ol.proj.Units;
/**
* The validity extent for the SRS.
*/
extent?: Array<number>;
/**
* The axis orientation as specified in Proj4. The default is enu.
*/
axisOrientation?: string;
/**
* Whether the projection is valid for the whole globe. Default is false.
*/
global?: boolean;
/**
* experimental The world extent for the SRS.
*/
worldExtent?: ol.Extent;
/**
* experimental Function to determine resolution at a point. The function is called with
* a {number} view resolution and an {ol.Coordinate} as arguments, and returns the {number}
* resolution at the passed coordinate.
*/
getPointResolution?: (resolution: number, coordinate: ol.Coordinate) => number;
}
namespace animation {
interface BounceOptions {
/**
* The resolution to start the bounce from, typically map.getView().getResolution().
*/
resolution: number;
/**
* The start time of the animation. Default is immediately.
*/
start?: number;
/**
* The duration of the animation in milliseconds. Default is 1000.
*/
duration?: number;
/**
* The easing function to use. Can be an ol.easing or a custom function. Default is ol.easing.upAndDown.
*/
easing?: (t: number) => number;
}
interface PanOptions {
/**
* The resolution to start the bounce from, typically map.getView().getResolution().
*/
source: ol.Coordinate;
/**
* The start time of the animation. Default is immediately.
*/
start?: number;
/**
* The duration of the animation in milliseconds. Default is 1000.
*/
duration?: number;
/**
* The easing function to use. Can be an ol.easing or a custom function. Default is ol.easing.upAndDown.
*/
easing?: (t: number) => number;
}
interface RotateOptions {
/**
* The rotation value (in radians) to begin rotating from, typically map.getView().getRotation(). If undefined then 0 is assumed.
*/
rotation?: number;
/**
* The rotation center/anchor. The map rotates around the center of the view if unspecified.
*/
anchor?: ol.Coordinate;
/**
* The start time of the animation. Default is immediately.
*/
start?: number;
/**
* The duration of the animation in milliseconds. Default is 1000.
*/
duration?: number;
/**
* The easing function to use. Can be an ol.easing or a custom function. Default is ol.easing.upAndDown.
*/
easing?: (t: number) => number
}
interface ZoomOptions {
/**
* The resolution to begin zooming from, typically map.getView().getResolution().
*/
resolution: number;
/**
* The start time of the animation. Default is immediately.
*/
start?: number;
/**
* The duration of the animation in milliseconds. Default is 1000.
*/
duration?: number;
/**
* The easing function to use. Can be an ol.easing or a custom function. Default is ol.easing.upAndDown.
*/
easing?: (t: number) => number
}
}
namespace control {
interface DefaultsOptions {
/**
* Attribution. Default is true.
*/
attribution?: boolean;
/**
* Attribution options.
*/
//TODO: Replace with olx.control.AttributionOptions
attributionOptions?: any;
/**
* Rotate. Default is true;
*/
rotate?: boolean;
/**
* Rotate options
*/
//TODO: Replace with olx.control.RotateOptions
rotateOptions?: any;
/**
* Zoom. Default is true
*/
zoom?: boolean;
/**
*
*/
//TODO: Replace with olx.control.ZoomOptions
zoomOptions?: any;
}
}
namespace interaction {
interface DefaultsOptions {
/*** Whether Alt-Shift-drag rotate is desired. Default is true.*/
altShiftDragRotate?: boolean;
/*** Whether double click zoom is desired. Default is true.*/
doubleClickZoom?: boolean;
/*** Whether keyboard interaction is desired. Default is true.*/
keyboard?: boolean;
/*** Whether mousewheel zoom is desired. Default is true.*/
mouseWheelZoom?: boolean;
/*** Whether Shift-drag zoom is desired. Default is true.*/
shiftDragZoom?: boolean;
/*** Whether drag pan is desired. Default is true.*/
dragPan?: boolean;
/*** Whether pinch rotate is desired. Default is true.*/
pinchRotate?: boolean;
/*** Whether pinch zoom is desired. Default is true.*/
pinchZoom?: boolean;
/*** Zoom delta*/
zoomDelta?: number;
/*** Zoom duration*/
zoomDuration?: number;
}
interface InteractionOptions {
/**
* Method called by the map to notify the interaction that a browser event was dispatched to the map.
* The function may return false to prevent the propagation of the event to other interactions in
* the map's interactions chain. Required.
*/
handleEvent: Function;
}
interface ModifyOptions {
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event will
* be considered to add or move a vertex to the sketch. Default is ol.events.condition.primaryAction.
*/
condition?: ol.events.ConditionType;
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should
* be handled. By default, ol.events.condition.singleClick with ol.events.condition.noModifierKeys results
* in a vertex deletion.
*/
deleteCondition?: ol.events.ConditionType;
/*** Pixel tolerance for considering the pointer close enough to a segment or vertex for editing. Default is 10.*/
pixelTolerance?: number;
/*** Style used for the features being modified. By default the default edit style is used (see ol.style).*/
style?: ol.style.Style | Array<ol.style.Style> | ol.style.StyleFunction;
/*** The features the interaction works on. Required.*/
features: ol.Collection<ol.Feature>;
/*** Wrap the world horizontally on the sketch overlay. Default is false.*/
wrapX?: boolean;
}
interface DragBoxOptions {
/*** CSS class name for styling the box. The default is ol-dragbox.*/
className?: string;
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled.
* Default is ol.events.condition.always.
*/
condition?: ol.events.ConditionType;
/*** A function that takes a ol.MapBrowserEvent and two ol.Pixels to indicate whether a boxend event should be fired.*/
boxEndCondition?: ol.interaction.DragBoxEndConditionType;
}
interface DrawOptions {
/**
* The maximum distance in pixels between "down" and "up" for a "up" event to be considered a "click" event and actually
* add a point/vertex to the geometry being drawn. Default is 6 pixels. That value was chosen for the draw interaction
* to behave correctly on mouse as well as on touch devices.
*/
clickTolerance?: number;
/**
* Destination collection for the drawn features.
*/
features?: ol.Collection<ol.Feature>;
/**
* Destination source for the drawn features.
*/
source?: ol.source.Vector;
/**
* Pixel distance for snapping to the drawing finish. Default is 12.
*/
snapTolerance?: number;
/**
* Drawing type ('Point', 'LineString', 'Polygon', 'MultiPoint', 'MultiLineString', 'MultiPolygon' or 'Circle'). Required.
*/
type: ol.geom.GeometryType;
/**
* The number of points that can be drawn before a polygon ring or line string is finished. The default is no restriction.
*/
maxPoints?: number;
/**
* The number of points that must be drawn before a polygon ring or line string can be finished. Default is 3 for polygon
* rings and 2 for line strings.
*/
minPoints?: number;
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether the drawing can be finished.
*/
finishCondition?: ol.events.ConditionType;
/**
* Style for sketch features.
*/
style?: ol.style.Style | Array<ol.style.Style> | ol.style.StyleFunction;
/**
* Function that is called when a geometry's coordinates are updated.
*/
geometryFunction?: ol.interaction.DrawGeometryFunctionType;
/**
* Geometry name to use for features created by the draw interaction.
*/
geometryName?: string;
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled.
* By default ol.events.condition.noModifierKeys, i.e. a click, adds a vertex or deactivates freehand drawing.
*/
condition?: ol.events.ConditionType;
/**
* Condition that activates freehand drawing for lines and polygons. This function takes an ol.MapBrowserEvent and returns
* a boolean to indicate whether that event should be handled. The default is ol.events.condition.shiftKeyOnly, meaning that
* the Shift key activates freehand drawing.
*/
freehandCondition?: ol.events.ConditionType;
/**
* Wrap the world horizontally on the sketch overlay. Default is false.
*/
wrapX?: boolean;
}
interface DoubleClickZoomOptions {
/**
* Animation duration in milliseconds. Default is 250.
*/
duration?: number;
/**
* The zoom delta applied on each double click, default is 1.
*/
delta?: number;
}
interface DragAndDropOptions {
/**
* Format constructors.
*/
formatConstructors?: Array<ol.format.Feature>;
/**
* Target projection. By default, the map's view's projection is used.
*/
projection: ol.proj.ProjectionLike;
/**
* The element that is used as the drop target, default is the viewport element.
*/
target?: Element;
}
interface DragPanOptions {
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled.
* Default is ol.events.condition.noModifierKeys.
*/
condition?: ol.events.ConditionType;
/**
* Kinetic inertia to apply to the pan.
*/
kinetic?: ol.Kinetic;
}
interface DragRotateOptions {
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled.
* Default is ol.events.condition.altShiftKeysOnly.
*/
condition?: ol.events.ConditionType;
/**
* Animation duration in milliseconds. Default is 250.
*/
duration?: number;
}
interface DragRotateAndZoomOptions {
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled.
* Default is ol.events.condition.shiftKeyOnly.
*/
condition?: ol.events.ConditionType;
/**
* Animation duration in milliseconds. Default is 400.
*/
duration?: number;
}
interface DragZoomOptions {
/**
* CSS class name for styling the box. The default is ol-dragzoom.
*/
className?: string;
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled.
* Default is ol.events.condition.shiftKeyOnly.
*/
condition?: ol.events.ConditionType;
/**
* Animation duration in milliseconds. Default is 200.
*/
duration?: number;
/**
* Use interaction for zooming out. Default is false.
*/
out?: boolean;
}
interface KeyboardPanOptions {
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled.
* Default is ol.events.condition.noModifierKeys and ol.events.condition.targetNotEditable.
*/
condition?: ol.events.ConditionType;
/**
* Animation duration in milliseconds. Default is 100.
*/
duration?: number;
/**
* Pixel The amount to pan on each key press. Default is 128 pixels.
*/
pixelDelta?: number;
}
interface KeyboardZoomOptions {
/**
* Animation duration in milliseconds. Default is 100.
*/
duration?: number;
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled.
* Default is ol.events.condition.targetNotEditable.
*/
condition?: ol.events.ConditionType;
/**
* The amount to zoom on each key press. Default is 1.
*/
delta?: number;
}
interface MouseWheelZoomOptions {
/**
* Animation duration in milliseconds. Default is 250.
*/
duration?: number;
/**
* Enable zooming using the mouse's location as the anchor. Default is true.
* When set to false, zooming in and out will zoom to the center of the screen instead of zooming on the mouse's location.
*/
useAnchor?: boolean;
}
interface PinchRotateOptions {
/**
* The duration of the animation in milliseconds. Default is 250.
*/
duration?: number;
/**
* Minimal angle in radians to start a rotation. Default is 0.3.
*/
threshold?: number;
}
interface PinchZoomOptions {
/**
* Animation duration in milliseconds. Default is 400.
*/
duration?: number;
}
interface PointerOptions {
/**
* Function handling "down" events. If the function returns true then a drag sequence is started.
*/
handleDownEvent?: Function;
/**
* Function handling "drag" events. This function is called on "move" events during a drag sequence.
*/
handleDragEvent?: Function;
/**
* Method called by the map to notify the interaction that a browser event was dispatched to the map.
* The function may return false to prevent the propagation of the event to other interactions in the map's interactions chain.
*/
handleEvent?: Function;
/**
* Function handling "move" events. This function is called on "move" events, also during a drag sequence
* (so during a drag sequence both the handleDragEvent function and this function are called).
*/
handleMoveEvent?: Function;
/**
* Function handling "up" events. If the function returns false then the current drag sequence is stopped.
*/
handleUpEvent?: Function;
}
interface SnapOptions {
/**
* Snap to these features. Either this option or source should be provided.
*/
features?: ol.Collection<ol.Feature>;
/**
* Snap to edges. Default is true.
*/
edge?: boolean;
/**
* Snap to vertices. Default is true.
*/
vertex?: boolean;
/**
* Pixel tolerance for considering the pointer close enough to a segment or vertex for snapping. Default is 10 pixels.
*/
pixelTolerance?: number;
/**
* Snap to features from this source. Either this option or features should be provided.
*/
source?: ol.source.Vector;
}
interface SelectOptions {
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled.
* By default, this is ol.events.condition.never.
* Use this if you want to use different events for add and remove instead of toggle.
*/
addCondition?: ol.events.ConditionType;
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled.
* This is the event for the selected features as a whole. By default, this is ol.events.condition.singleClick.
* Clicking on a feature selects that feature and removes any that were in the selection.
* Clicking outside any feature removes all from the selection.
* See toggle, add, remove options for adding/removing extra features to/ from the selection.
*/
condition?: ol.events.ConditionType;
/**
* A list of layers from which features should be selected. Alternatively, a filter function can be provided.
* The function will be called for each layer in the map and should return true for layers that you want to be selectable.
* If the option is absent, all visible layers will be considered selectable.
*/
layers?: Array<ol.layer.Layer> | ((layer: ol.layer.Layer) => boolean);
/**
* Style for the selected features. By default the default edit style is used (see ol.style).
*/
style?: ol.style.Style | Array<ol.style.Style> | ol.style.StyleFunction;
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled.
* By default, this is ol.events.condition.never.
* Use this if you want to use different events for add and remove instead of toggle.
*/
removeCondition?: ol.events.ConditionType;
/**
* A function that takes an ol.MapBrowserEvent and returns a boolean to indicate whether that event should be handled.
* This is in addition to the condition event. By default, ol.events.condition.shiftKeyOnly,
* i.e. pressing shift as well as the condition event, adds that feature to the current selection if it is not currently
* selected, and removes it if it is. See add and remove if you want to use different events instead of a toggle.
*/
toggleCondition?: ol.events.ConditionType;
/**
* A boolean that determines if the default behaviour should select only single features or all (overlapping)
* features at the clicked map position. Default is false i.e single select
*/
multi?: boolean;
/**
* Collection where the interaction will place selected features. Optional. If not set the interaction will create a collection.
* In any case the collection used by the interaction is returned by ol.interaction.Select#getFeatures.
*/
features?: ol.Collection<ol.Feature>;
/**
* A function that takes an ol.Feature and an ol.layer.Layer and returns true if the feature may be selected or false otherwise.
*/
filter?: ol.interaction.SelectFilterFunction;
/**
* Wrap the world horizontally on the selection overlay. Default is true.
*/
wrapX?: boolean;
}
}
namespace layer {
interface BaseOptions {
/**
* Opacity (0, 1). Default is 1.
*/
opacity?: number;
/**