UNPKG

6.29 kBTypeScriptView Raw
1import { EventsKey } from '../events';
2import BaseEvent from '../events/Event';
3import { Extent } from '../extent';
4import LineString from '../geom/LineString';
5import Point from '../geom/Point';
6import { ObjectEvent } from '../Object';
7import Projection from '../proj/Projection';
8import RenderEvent from '../render/Event';
9import Stroke from '../style/Stroke';
10import Text from '../style/Text';
11import VectorLayer from './Vector';
12
13export interface GraticuleLabelDataType {
14 geom: Point;
15 text: string;
16}
17export interface Options {
18 className?: string | undefined;
19 opacity?: number | undefined;
20 visible?: boolean | undefined;
21 extent?: Extent | undefined;
22 zIndex?: number | undefined;
23 minResolution?: number | undefined;
24 maxResolution?: number | undefined;
25 minZoom?: number | undefined;
26 maxZoom?: number | undefined;
27 maxLines?: number | undefined;
28 strokeStyle?: Stroke | undefined;
29 targetSize?: number | undefined;
30 showLabels?: boolean | undefined;
31 lonLabelFormatter?: ((p0: number) => string) | undefined;
32 latLabelFormatter?: ((p0: number) => string) | undefined;
33 lonLabelPosition?: number | undefined;
34 latLabelPosition?: number | undefined;
35 lonLabelStyle?: Text | undefined;
36 latLabelStyle?: Text | undefined;
37 intervals?: number[] | undefined;
38 wrapX?: boolean | undefined;
39}
40export default class Graticule extends VectorLayer {
41 constructor(opt_options?: Options);
42 /**
43 * Get the list of meridians. Meridians are lines of equal longitude.
44 */
45 getMeridians(): LineString[];
46 /**
47 * Get the list of parallels. Parallels are lines of equal latitude.
48 */
49 getParallels(): LineString[];
50 /**
51 * Update geometries in the source based on current view
52 */
53 loaderFunction(extent: Extent, resolution: number, projection: Projection): void;
54 /**
55 * Strategy function for loading features based on the view's extent and
56 * resolution.
57 */
58 strategyFunction(extent: Extent, resolution: number): Extent[];
59 on(type: string | string[], listener: (p0: any) => any): EventsKey | EventsKey[];
60 once(type: string | string[], listener: (p0: any) => any): EventsKey | EventsKey[];
61 un(type: string | string[], listener: (p0: any) => any): void;
62 on(type: 'change', listener: (evt: BaseEvent) => void): EventsKey;
63 once(type: 'change', listener: (evt: BaseEvent) => void): EventsKey;
64 un(type: 'change', listener: (evt: BaseEvent) => void): void;
65 on(type: 'change:extent', listener: (evt: ObjectEvent) => void): EventsKey;
66 once(type: 'change:extent', listener: (evt: ObjectEvent) => void): EventsKey;
67 un(type: 'change:extent', listener: (evt: ObjectEvent) => void): void;
68 on(type: 'change:maxResolution', listener: (evt: ObjectEvent) => void): EventsKey;
69 once(type: 'change:maxResolution', listener: (evt: ObjectEvent) => void): EventsKey;
70 un(type: 'change:maxResolution', listener: (evt: ObjectEvent) => void): void;
71 on(type: 'change:maxZoom', listener: (evt: ObjectEvent) => void): EventsKey;
72 once(type: 'change:maxZoom', listener: (evt: ObjectEvent) => void): EventsKey;
73 un(type: 'change:maxZoom', listener: (evt: ObjectEvent) => void): void;
74 on(type: 'change:minResolution', listener: (evt: ObjectEvent) => void): EventsKey;
75 once(type: 'change:minResolution', listener: (evt: ObjectEvent) => void): EventsKey;
76 un(type: 'change:minResolution', listener: (evt: ObjectEvent) => void): void;
77 on(type: 'change:minZoom', listener: (evt: ObjectEvent) => void): EventsKey;
78 once(type: 'change:minZoom', listener: (evt: ObjectEvent) => void): EventsKey;
79 un(type: 'change:minZoom', listener: (evt: ObjectEvent) => void): void;
80 on(type: 'change:opacity', listener: (evt: ObjectEvent) => void): EventsKey;
81 once(type: 'change:opacity', listener: (evt: ObjectEvent) => void): EventsKey;
82 un(type: 'change:opacity', listener: (evt: ObjectEvent) => void): void;
83 on(type: 'change:source', listener: (evt: ObjectEvent) => void): EventsKey;
84 once(type: 'change:source', listener: (evt: ObjectEvent) => void): EventsKey;
85 un(type: 'change:source', listener: (evt: ObjectEvent) => void): void;
86 on(type: 'change:visible', listener: (evt: ObjectEvent) => void): EventsKey;
87 once(type: 'change:visible', listener: (evt: ObjectEvent) => void): EventsKey;
88 un(type: 'change:visible', listener: (evt: ObjectEvent) => void): void;
89 on(type: 'change:zIndex', listener: (evt: ObjectEvent) => void): EventsKey;
90 once(type: 'change:zIndex', listener: (evt: ObjectEvent) => void): EventsKey;
91 un(type: 'change:zIndex', listener: (evt: ObjectEvent) => void): void;
92 on(type: 'error', listener: (evt: BaseEvent) => void): EventsKey;
93 once(type: 'error', listener: (evt: BaseEvent) => void): EventsKey;
94 un(type: 'error', listener: (evt: BaseEvent) => void): void;
95 on(type: 'postcompose', listener: (evt: RenderEvent) => void): EventsKey;
96 once(type: 'postcompose', listener: (evt: RenderEvent) => void): EventsKey;
97 un(type: 'postcompose', listener: (evt: RenderEvent) => void): void;
98 on(type: 'postrender', listener: (evt: RenderEvent) => void): EventsKey;
99 once(type: 'postrender', listener: (evt: RenderEvent) => void): EventsKey;
100 un(type: 'postrender', listener: (evt: RenderEvent) => void): void;
101 on(type: 'precompose', listener: (evt: RenderEvent) => void): EventsKey;
102 once(type: 'precompose', listener: (evt: RenderEvent) => void): EventsKey;
103 un(type: 'precompose', listener: (evt: RenderEvent) => void): void;
104 on(type: 'prerender', listener: (evt: RenderEvent) => void): EventsKey;
105 once(type: 'prerender', listener: (evt: RenderEvent) => void): EventsKey;
106 un(type: 'prerender', listener: (evt: RenderEvent) => void): void;
107 on(type: 'propertychange', listener: (evt: ObjectEvent) => void): EventsKey;
108 once(type: 'propertychange', listener: (evt: ObjectEvent) => void): EventsKey;
109 un(type: 'propertychange', listener: (evt: ObjectEvent) => void): void;
110 on(type: 'rendercomplete', listener: (evt: RenderEvent) => void): EventsKey;
111 once(type: 'rendercomplete', listener: (evt: RenderEvent) => void): EventsKey;
112 un(type: 'rendercomplete', listener: (evt: RenderEvent) => void): void;
113}
114
\No newline at end of file