|
7 | 7 | <div class="description"><div class="ui-grid-i18n-service-page ui-grid-i18n-service-i18nservice-page"><p>Services for i18n</p> |
8 | 8 | </div></div> |
9 | 9 | <div class="member method"><h2 id="methods">Methods</h2> |
10 | | -<ul class="methods"><li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L125" class="view-source icon-eye-open"> </a><h3 id="methods_add">add(langs, stringMaps)</h3> |
| 10 | +<ul class="methods"><li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L130" class="view-source icon-eye-open"> </a><h3 id="methods_add">add(langs, stringMaps)</h3> |
11 | 11 | <div class="add"><div class="add-page"><p>Adds the languages and strings to the cache. Decorate this service to |
12 | 12 | add more translation strings</p> |
13 | 13 | </div><h5 id="methods_add_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>langs</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="add-page"><p>languages to add</p> |
|
28 | 28 | </div></div> |
29 | 29 | </div> |
30 | 30 | </li> |
31 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L156" class="view-source icon-eye-open"> </a><h3 id="methods_get">get(lang)</h3> |
| 31 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L161" class="view-source icon-eye-open"> </a><h3 id="methods_get">get(lang)</h3> |
32 | 32 | <div class="get"><div class="get-page"><p>return all currently loaded languages</p> |
33 | 33 | </div><h5 id="methods_get_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>lang</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="get-page"><p>to return. If not specified, returns current language</p> |
34 | 34 | </div></td></tr></tbody></table><h5 id="methods_get_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-object">object</a></td><td><div class="get-page"><p>the translation string maps for the language</p> |
35 | 35 | </div></td></tr></table></div> |
36 | 36 | </li> |
37 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L144" class="view-source icon-eye-open"> </a><h3 id="methods_getalllangs">getAllLangs()</h3> |
| 37 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L149" class="view-source icon-eye-open"> </a><h3 id="methods_getalllangs">getAllLangs()</h3> |
38 | 38 | <div class="getalllangs"><div class="getalllangs-page"><p>return all currently loaded languages</p> |
39 | 39 | </div><h5 id="methods_getalllangs_returns">Returns</h5><table class="variables-matrix"><tr><td><a href="" class="label type-hint type-hint-array">array</a></td><td><div class="getalllangs-page"><p>string</p> |
40 | 40 | </div></td></tr></table></div> |
41 | 41 | </li> |
42 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L230" class="view-source icon-eye-open"> </a><h3 id="methods_getcurrentlang">getCurrentLang()</h3> |
| 42 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L234" class="view-source icon-eye-open"> </a><h3 id="methods_getcurrentlang">getCurrentLang()</h3> |
43 | 43 | <div class="getcurrentlang"><div class="getcurrentlang-page"><p>returns the current language used in the application</p> |
44 | 44 | </div></div> |
45 | 45 | </li> |
46 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L245" class="view-source icon-eye-open"> </a><h3 id="methods_getfallbacklang">getFallbackLang()</h3> |
| 46 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L249" class="view-source icon-eye-open"> </a><h3 id="methods_getfallbacklang">getFallbackLang()</h3> |
47 | 47 | <div class="getfallbacklang"><div class="getfallbacklang-page"><p>returns the fallback language used in the application</p> |
48 | 48 | </div></div> |
49 | 49 | </li> |
50 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L174" class="view-source icon-eye-open"> </a><h3 id="methods_getsafetext">getSafeText(path, [lang])</h3> |
| 50 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L179" class="view-source icon-eye-open"> </a><h3 id="methods_getsafetext">getSafeText(path, [lang])</h3> |
51 | 51 | <div class="getsafetext"><div class="getsafetext-page"><p>returns the text specified in the path or a Missing text if text is not found</p> |
52 | 52 | </div><h5 id="methods_getsafetext_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>path</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="getsafetext-page"><p>property path to use for retrieving text from string map</p> |
53 | 53 | </div></td></tr><tr><td>[lang]</td><td><a href="" class="label type-hint type-hint-string">String</a></td><td><div class="getsafetext-page"><p>to return. If not specified, returns current language</p> |
|
59 | 59 | </div></div> |
60 | 60 | </div> |
61 | 61 | </li> |
62 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L199" class="view-source icon-eye-open"> </a><h3 id="methods_setcurrentlang">setCurrentLang(lang)</h3> |
| 62 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L203" class="view-source icon-eye-open"> </a><h3 id="methods_setcurrentlang">setCurrentLang(lang)</h3> |
63 | 63 | <div class="setcurrentlang"><div class="setcurrentlang-page"><p>sets the current language to use in the application |
64 | 64 | $broadcasts the i18nConstants.UPDATE_EVENT on the $rootScope</p> |
65 | 65 | </div><h5 id="methods_setcurrentlang_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>lang</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="setcurrentlang-page"><p>to set</p> |
|
70 | 70 | </div></div> |
71 | 71 | </div> |
72 | 72 | </li> |
73 | | -<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L218" class="view-source icon-eye-open"> </a><h3 id="methods_setfallbacklang">setFallbackLang(lang)</h3> |
| 73 | +<li><a href="https://github.com/angular-ui/ui-grid/blob/master/packages/core/src/js/services/ui-i18n.js#L222" class="view-source icon-eye-open"> </a><h3 id="methods_setfallbacklang">setFallbackLang(lang)</h3> |
74 | 74 | <div class="setfallbacklang"><div class="setfallbacklang-page"><p>sets the fallback language to use in the application. |
75 | 75 | The default fallback language is english.</p> |
76 | 76 | </div><h5 id="methods_setfallbacklang_parameters">Parameters</h5><table class="variables-matrix table table-bordered table-striped"><thead><tr><th>Param</th><th>Type</th><th>Details</th></tr></thead><tbody><tr><td>lang</td><td><a href="" class="label type-hint type-hint-string">string</a></td><td><div class="setfallbacklang-page"><p>to set</p> |
|
0 commit comments