0
# Global API
1

2
Static methods and constants available on the `$.datetimepicker` namespace for global configuration and utilities.
3

4
## Capabilities
5

6
### Locale Management
7

8
Set global locale configuration that applies to all datetimepicker instances.
9

10
```javascript { .api }
11
/**
12
 * Set global locale for all datetimepicker instances
13
 * @param locale - Locale code (e.g., 'en', 'de', 'fr')
14
 */
15
$.datetimepicker.setLocale(locale: string): void;
16
```
17

18
**Usage Examples:**
19

20
```javascript
21
// Set German locale globally
22
$.datetimepicker.setLocale('de');
23

24
// All subsequent datetimepicker instances will use German locale
25
$('#date1').datetimepicker(); // Uses German
26
$('#date2').datetimepicker(); // Uses German
27

28
// Switch to French
29
$.datetimepicker.setLocale('fr');
30
$('#date3').datetimepicker(); // Uses French
31
```
32

33
**Supported Locales:**
34

35
- `'ar'` - Arabic
36
- `'az'` - Azerbaijanian (Azeri)
37
- `'bg'` - Bulgarian
38
- `'bs'` - Bosnian
39
- `'ca'` - Catalan
40
- `'ch'` - Simplified Chinese
41
- `'cs'` - Czech (Čeština)
42
- `'da'` - Danish (Dansk)
43
- `'de'` - German
44
- `'el'` - Greek (Ελληνικά)
45
- `'en'` - English (default)
46
- `'es'` - Spanish
47
- `'et'` - Estonian (Eesti)
48
- `'eu'` - Basque (Euskara)
49
- `'fa'` - Persian/Farsi
50
- `'fi'` - Finnish (Suomi)
51
- `'fr'` - French
52
- `'gl'` - Galician (Galego)
53
- `'he'` - Hebrew (עברית)
54
- `'hr'` - Croatian (Hrvatski)
55
- `'hu'` - Hungarian
56
- `'id'` - Indonesian
57
- `'is'` - Icelandic
58
- `'it'` - Italian
59
- `'ja'` - Japanese
60
- `'km'` - Khmer (ភាសាខ្មែរ)
61
- `'ko'` - Korean (한국어)
62
- `'kr'` - Korean
63
- `'lt'` - Lithuanian (lietuvių)
64
- `'lv'` - Latvian (Latviešu)
65
- `'mk'` - Macedonian (Македонски)
66
- `'mn'` - Mongolian (Монгол)
67
- `'nl'` - Dutch
68
- `'no'` - Norwegian
69
- `'pl'` - Polish
70
- `'pt'` - Portuguese
71
- `'ro'` - Romanian
72
- `'ru'` - Russian
73
- `'se'` - Swedish
74
- `'sk'` - Slovak (Slovenčina)
75
- `'sl'` - Slovenian (Slovenščina)
76
- `'sq'` - Albanian (Shqip)
77
- `'sr'` - Serbian Cyrillic (Српски)
78
- `'sv'` - Swedish (Svenska)
79
- `'th'` - Thai
80
- `'tr'` - Turkish
81
- `'ug'` - Uyghur (ئۇيغۇرچە)
82
- `'uk'` - Ukrainian
83
- `'vi'` - Vietnamese
84
- `'zh'` - Simplified Chinese (简体中文)
85

86
### Date Formatter Management
87

88
Configure custom date formatting and parsing.
89

90
```javascript { .api }
91
/**
92
 * Set custom date formatter for parsing and formatting dates
93
 * @param dateFormatter - Formatter name or custom formatter object
94
 */
95
$.datetimepicker.setDateFormatter(dateFormatter: string | DateFormatter): void;
96

97
interface DateFormatter {
98
    parseDate(dateString: string, format: string): Date;
99
    formatDate(date: Date, format: string): string;
100
}
101
```
102

103
### Default Options Access
104

105
Access and modify the global default options for all datetimepicker instances.
106

107
```javascript { .api }
108
/**
109
 * Global default options object that can be modified to change defaults for all instances
110
 */
111
$.fn.datetimepicker.defaults: DateTimePickerOptions;
112
```
113

114
**Usage Examples:**
115

116
```javascript
117
// Modify global default format
118
$.fn.datetimepicker.defaults.format = 'Y-m-d H:i';
119

120
// Change global default step size
121
$.fn.datetimepicker.defaults.step = 30;
122

123
// Set global defaults for behavior
124
$.fn.datetimepicker.defaults.closeOnDateSelect = true;
125
$.fn.datetimepicker.defaults.timepicker = false;
126

127
// All subsequent datetimepicker instances will use these defaults
128
$('#date1').datetimepicker(); // Uses Y-m-d H:i format, 30 min steps, date-only
129
$('#date2').datetimepicker(); // Same defaults applied
130
```
131

132
```javascript
133
// Use a named formatter (if available)
134
$.datetimepicker.setDateFormatter('moment');
135

136
// Use custom formatter
137
$.datetimepicker.setDateFormatter({
138
    parseDate: function(dateString, format) {
139
        // Custom parsing logic
140
        return new Date(dateString);
141
    },
142
    formatDate: function(date, format) {
143
        // Custom formatting logic  
144
        return date.toISOString().split('T')[0];
145
    }
146
});
147
```
148

149
### Standard Date Format Constants
150

151
Pre-defined date format constants for common standards.
152

153
```javascript { .api }
154
interface StandardFormats {
155
    /** RFC 2822 format: 'D, d M Y H:i:s O' */
156
    readonly RFC_2822: string;
157
    /** ATOM format: 'Y-m-d\TH:i:sP' */
158
    readonly ATOM: string;
159
    /** ISO 8601 format: 'Y-m-d\TH:i:sO' */
160
    readonly ISO_8601: string;
161
    /** RFC 822 format: 'D, d M y H:i:s O' */
162
    readonly RFC_822: string;
163
    /** RFC 850 format: 'l, d-M-y H:i:s T' */
164
    readonly RFC_850: string;
165
    /** RFC 1036 format: 'D, d M y H:i:s O' */
166
    readonly RFC_1036: string;
167
    /** RFC 1123 format: 'D, d M Y H:i:s O' */
168
    readonly RFC_1123: string;
169
    /** RSS format: 'D, d M Y H:i:s O' */
170
    readonly RSS: string;
171
    /** W3C format: 'Y-m-d\TH:i:sP' */
172
    readonly W3C: string;
173
}
174
```
175

176
**Usage Examples:**
177

178
```javascript
179
// Use ISO 8601 format
180
$('#iso-date').datetimepicker({
181
    format: $.datetimepicker.ISO_8601
182
});
183

184
// Use RFC 2822 format
185
$('#rfc-date').datetimepicker({
186
    format: $.datetimepicker.RFC_2822
187
});
188

189
// Use ATOM format for feeds
190
$('#atom-date').datetimepicker({
191
    format: $.datetimepicker.ATOM
192
});
193

194
// List all available formats
195
console.log('Available formats:');
196
console.log('RFC_2822:', $.datetimepicker.RFC_2822);
197
console.log('ATOM:', $.datetimepicker.ATOM);
198
console.log('ISO_8601:', $.datetimepicker.ISO_8601);
199
console.log('W3C:', $.datetimepicker.W3C);
200
```
201

202
### Format Constants Values
203

204
```javascript { .api }
205
// Actual format string values
206
$.datetimepicker.RFC_2822  // 'D, d M Y H:i:s O'
207
$.datetimepicker.ATOM      // 'Y-m-d\TH:i:sP' 
208
$.datetimepicker.ISO_8601  // 'Y-m-d\TH:i:sO'
209
$.datetimepicker.RFC_822   // 'D, d M y H:i:s O'
210
$.datetimepicker.RFC_850   // 'l, d-M-y H:i:s T'
211
$.datetimepicker.RFC_1036  // 'D, d M y H:i:s O'
212
$.datetimepicker.RFC_1123  // 'D, d M Y H:i:s O'
213
$.datetimepicker.RSS       // 'D, d M Y H:i:s O'
214
$.datetimepicker.W3C       // 'Y-m-d\TH:i:sP'
215
```
216

217
### Global Configuration Patterns
218

219
Common patterns for global configuration.
220

221
**Usage Examples:**
222

223
```javascript
224
// Set global defaults for all instances
225
$.fn.datetimepicker.defaults.format = 'Y-m-d H:i';
226
$.fn.datetimepicker.defaults.step = 30;
227
$.datetimepicker.setLocale('en');
228

229
// Initialize multiple pickers with consistent settings
230
$('.datetime-picker').datetimepicker(); // All use global defaults
231

232
// Temporary locale change
233
var originalLocale = 'en';
234
$.datetimepicker.setLocale('de');
235
$('#german-date').datetimepicker();
236
$.datetimepicker.setLocale(originalLocale); // Restore
237

238
// Application-wide date format
239
$.datetimepicker.setLocale('en');
240
$.fn.datetimepicker.defaults.format = $.datetimepicker.ISO_8601;
241
$.fn.datetimepicker.defaults.formatDate = 'Y-m-d';
242
$.fn.datetimepicker.defaults.formatTime = 'H:i:s';
243
```