-
Notifications
You must be signed in to change notification settings - Fork 38
Expand file tree
/
Copy pathCollator.html
More file actions
29 lines (27 loc) · 11.8 KB
/
Copy pathCollator.html
File metadata and controls
29 lines (27 loc) · 11.8 KB
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
<!DOCTYPE html><html><head><meta charset="utf-8"><title>Collator JavaScript API</title><meta name="description" content="Interactive API reference for the JavaScript Collator Object. Collator provides language aware comparison of Strings for sorting and searching. Available through Intl.Collator."><link rel="stylesheet" type="text/css" href="styles.css"><script type="text/javascript">var _gaq = _gaq || [];
_gaq.push(['_setAccount', 'UA-23450559-1']);
_gaq.push(['_trackPageview']);
(function() {
var ga = document.createElement('script'); ga.type = 'text/javascript'; ga.async = true;
ga.src = ('https:' == document.location.protocol ? 'https://ssl' : 'http://www') + '.google-analytics.com/ga.js';
var s = document.getElementsByTagName('script')[0]; s.parentNode.insertBefore(ga, s);
})();</script></head><body><script>if (sessionStorage.collapsed === 'true') {
document.body.classList.add('members-collapsed');
}
if (localStorage.theme) {
document.body.parentElement.classList.add(localStorage.theme);
}</script><div class="topnav"><a href="/">JavaScripture</a><div class="bookmarks"><a class="bookmark contribute" href="https://github.com/nkronlage/JavaScripture">Contribute via GitHub</a> <a class="bookmark" href="/feedback">Feedback</a></div></div><div class="container"><nav class="leftnav"><div id="searchContainer"><input id="searchBox" type="text" placeholder="Search (Ctrl + S)" autocomplete="false"><div id="resultsBox" style="display:none;"></div></div><div id="apichooser"><a href="#" onclick="openApiChooser(); return false;"><div class="arrow"></div><span id="selectedsets"></span></a><div id="obscure"></div><div id="apisets"><ul></ul></div></div><div class="toc"><h2>Collator</h2><div class="navgroup"><div class="group"><a href="#Constructors">Constructors</a></div><div class="group collapsed"><a href="#InstanceMethods" onclick="expandoClicked(this.parentNode); return false;"><div class="arrow"></div>Instance Methods</a><div class="subgroup"><a href="#compare_String_String">compare</a><a href="#resolvedOptions_">resolvedOptions</a></div></div><div class="group collapsed"><a href="#CollatorMethods" onclick="expandoClicked(this.parentNode); return false;"><div class="arrow"></div>Collator Methods</a><div class="subgroup"><a href="#supportedLocalesOf_Array_Object" title="supportedLocalesOf">supportedLocalesOf</a></div></div></div><h2>JavaScript API</h2><div id="related-apis" class="navgroup"></div><h2>All API</h2><div id="rootObjs" class="navgroup"><span class="empty">No API set selected.</span></div></div></nav><div class="content"><h1 class="declaration"><span class="object">Collator</span> <span class="type">: <a href="/Object">Object</a></span></h1><div class="metadata"><span>constructor</span></div><div class="objectdescription">Collator provides language aware comparison of <a href="/String">Strings</a> for sorting and searching. Available through <a href="/Intl#Collator">Intl.Collator</a>.<div class="membermetadata"><a href="http://www.ecma-international.org/ecma-402/1.0/#sec-10" class="spec">Spec</a></div></div><div><a name=""></a><h2></h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="Collator"></a> <a name="Collator_Array_Object"></a><div class="declaration"><span class="membername primary">Collator</span>(<span class="optional">[<span class="membername">locales</span> : <a class="membertype" href="/Array">Array</a><<a class="membertype" href="/String">String</a>>, <span class="optional">[<span class="membername">options</span> : <a class="membertype" href="/Object">Object</a>]</span>]</span>) : <a class="membertype" href="/Collator">Collator</a></div><div class="member-body"><p class="description">Same as <a href="#new_Collator"><code>new Intl.Collator(locales, options)</code></a>.</p></div></div></div><div><a name="Constructors"></a><h2>Constructors</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="Collator"></a> <a name="new_Collator_Array_Object"></a><div class="declaration">new <span class="membername primary">Collator</span>(<span class="optional">[<span class="membername">locales</span> : <a class="membertype" href="/Array">Array</a><<a class="membertype" href="/String">String</a>>, <span class="optional">[<span class="membername">options</span> : <a class="membertype" href="/Object">Object</a>]</span>]</span>) : <a class="membertype" href="/Collator">Collator</a><div class="subfunction"><span class="membername">options</span> : {<table><tr><td><span class="membername">caseFirst</span> :</td><td><a class="membertype" href="/Boolean">Boolean</a></td><td></td></tr><tr><td><span class="membername">ignorePunctuation</span> :</td><td><a class="membertype" href="/Boolean">Boolean</a></td><td></td></tr><tr><td><span class="membername">localeMatcher</span> :</td><td><a class="membertype" href="/String">String</a></td><td>One of <code>'basic'</code> or <code>'best fit'</code>.</td></tr><tr><td><span class="membername">numeric</span> :</td><td><a class="membertype" href="/Boolean">Boolean</a></td><td></td></tr><tr><td><span class="membername">sensitivity</span> :</td><td><a class="membertype" href="/String">String</a></td><td>One of <code>'base'</code>, <code>'accent'</code>, <code>'case'</code>, or <code>'variant'</code>.</td></tr><tr><td><span class="membername">usage</span> :</td><td><a class="membertype" href="/String">String</a></td><td>One of <code>'sort'</code> or <code>'search'</code></td></tr></table><span class="subfunctionclose">}</span></div></div><div class="member-body"><p class="description"></p><div class="example"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="12" cols="60" wrap="off">
</textarea><a onclick='executeExample(this.parentNode.parentNode, "Collator.Collator"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="errormessage" style="display: none"></div><pre class="results"> </pre></div></div></div><p></p></div></div></div><div><a name="InstanceMethods"></a><h2>Instance Methods</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="compare"></a> <a name="compare_String_String"></a><div class="declaration"><span class="membername primary">compare</span>(<span class="membername">value1</span> : <a class="membertype" href="/String">String</a>, <span class="membername">value2</span> : <a class="membertype" href="/String">String</a>) : <a class="membertype" href="/Number">Number</a></div><div class="member-body"><p class="description">Compares two string values to determine which should come first if they were sorted alphabetically according to the locales of the Collator. Returns <code>0</code> if <code>value1</code> is the same as <code>value2</code>, a negative value if <code>value1</code> should come before <code>value2</code>, and a positive value if <code>value1</code> should come after <code>value2</code>. Can be passed to <a href="/Array#sort">Array.sort()</a> to sort a list of strings.</p><div class="example"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="12" cols="60" wrap="off">
var collator = Intl.Collator();
console.log(collator.compare('a', 'a'));
console.log(collator.compare('a', 'b'));
console.log(collator.compare('b', 'a'));
var letters = ['c', 'a', 'd', 'b'];
console.log(letters.sort(collator.compare));
</textarea><a onclick='executeExample(this.parentNode.parentNode, "Collator.compare"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="errormessage" style="display: none"></div><pre class="results"> </pre></div></div></div><p></p></div></div><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="resolvedOptions"></a> <a name="resolvedOptions_"></a><div class="declaration"><span class="membername primary">resolvedOptions</span>() : <a class="membertype" href="/Object">Object</a><div class="subfunction"><span class="membername">return</span> : {<table><tr><td><span class="membername">caseFirst</span> :</td><td><a class="membertype" href="/Boolean">Boolean</a></td><td></td></tr><tr><td><span class="membername">collation</span> :</td><td><a class="membertype" href="/String">String</a></td><td></td></tr><tr><td><span class="membername">ignorePunctuation</span> :</td><td><a class="membertype" href="/Boolean">Boolean</a></td><td></td></tr><tr><td><span class="membername">locale</span> :</td><td><a class="membertype" href="/String">String</a></td><td></td></tr><tr><td><span class="membername">numeric</span> :</td><td><a class="membertype" href="/Boolean">Boolean</a></td><td></td></tr><tr><td><span class="membername">sensitivity</span> :</td><td><a class="membertype" href="/String">String</a></td><td></td></tr><tr><td><span class="membername">usage</span> :</td><td><a class="membertype" href="/String">String</a></td><td></td></tr></table><span class="subfunctionclose">}</span></div></div><div class="member-body"><p class="description"></p><div class="example"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="12" cols="60" wrap="off">
var options = Intl.Collator().resolvedOptions();
for (var property in options) {
console.log(property + ': ' + options[property]);
}
</textarea><a onclick='executeExample(this.parentNode.parentNode, "Collator.resolvedOptions"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="errormessage" style="display: none"></div><pre class="results"> </pre></div></div></div><p></p></div></div></div><div><a name="CollatorMethods"></a><h2>Collator Methods</h2><div class="member"><div class="expand-members" title="Toggle showing all descriptions and examples"></div><a name="supportedLocalesOf"></a> <a name="supportedLocalesOf_Array_Object"></a><div class="declaration"><span class="membername primary">supportedLocalesOf</span>(<span class="membername">locales</span> : <a class="membertype" href="/Array">Array</a><<a class="membertype" href="/String">String</a>>, <span class="optional">[<span class="membername">options</span> : <a class="membertype" href="/Object">Object</a>]</span>) : <a class="membertype" href="/Array">Array</a><<a class="membertype" href="/String">String</a>><div class="subfunction"><span class="membername">options</span> : {<table><tr><td><span class="membername">localeMatcher</span> :</td><td><a class="membertype" href="/String">String</a></td><td>One of <code>'basic'</code> or <code>'best fit'</code>.</td></tr></table><span class="subfunctionclose">}</span></div></div><div class="member-body"><p class="description"></p><div class="example"><div class="codePanel"><h4>Example:</h4><textarea class="code" rows="12" cols="60" wrap="off">
</textarea><a onclick='executeExample(this.parentNode.parentNode, "Collator.supportedLocalesOf"); return false' href="#" class="run">Run</a></div><div class="resultsPanel"><h4>Results:</h4><div style="position: relative"><div class="errormessage" style="display: none"></div><pre class="results"> </pre></div></div></div><p></p></div></div></div><div class="bottomnav"><a href="/">home</a> <a href="/license">license</a> <a href="https://github.com/nkronlage/JavaScripture">contribute</a> <a href="/feedback">feedback</a> <a id="toggle-theme" href="#">toggle light/dark mode</a></div><div class="copyright">Copyright © JavaScripture Contributors</div></div></div></body><script src="javascripture.js"></script></html>