File : core/mapIcon/NoteDataForMapIcon.js

1
/*
2
Copyright - 2017 2023 - wwwouaiebe - Contact: https://www.ouaie.be/
3
4
This  program is free software;
5
you can redistribute it and/or modify it under the terms of the
6
GNU General Public License as published by the Free Software Foundation;
7
either version 3 of the License, or any later version.
8
9
This program is distributed in the hope that it will be useful,
10
but WITHOUT ANY WARRANTY; without even the implied warranty of
11
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
12
GNU General Public License for more details.
13
14
You should have received a copy of the GNU General Public License
15
along with this program; if not, write to the Free Software
16
Foundation, Inc., 51 Franklin St, Fifth Floor, Boston, MA  02110-1301  USA
17
*/
18
/*
19
Changes:
20
    - v4.0.0:
21
        - created from v3.6.0
22
Doc reviewed 202208
23
 */
24
25
import { LAT_LNG } from '../../main/Constants.js';
26
27
/* ------------------------------------------------------------------------------------------------------------------------- */
28
/**
29
An object with data used to build the Note
30
*/
31
/* ------------------------------------------------------------------------------------------------------------------------- */
32
33
class NoteDataForMapIcon {
34
35
    /**
36
    The constructor
37
    */
38
39
    constructor ( ) {
40
        Object.seal ( this );
41
    }
42
43
    /**
44
    The icon content ( = the outerHTML of the SVG with streets itinerary and rcnRef number )
45
    @type {String}
46
    */
47
48
    iconContent = '';
49
50
    /**
51
    The tooltip ( = the direction to follow + indications on roundabout, rcnRef and start point or end point )
52
    @type {String}
53
    */
54
55
    tooltipContent = '';
56
57
    /**
58
    The address ( = streets names at the note position and city and hamlet )
59
    @type {String}
60
    */
61
62
    address = '';
63
64
    /**
65
    The lat and lng of the note
66
    @type {Array.<Number>}
67
    */
68
69
    latLng = [ LAT_LNG.defaultValue, LAT_LNG.defaultValue ];
70
}
71
72
export default NoteDataForMapIcon;
73
74
/* --- End of file --------------------------------------------------------------------------------------------------------- */
75