Commit e962932a authored by Philippe Bardou's avatar Philippe Bardou

Search doc done !

parent 9ce567db
......@@ -51,6 +51,7 @@
<li><a href="#disableClick"><i class="icon-chevron-right"></i> disableClick</a></li>
<li><a href="#useValues"><i class="icon-chevron-right"></i> useValues</a></li>
<li><a href="#exporting"><i class="icon-chevron-right"></i> exporting</a></li>
<li><a href="#search"><i class="icon-chevron-right"></i> search...</a></li>
</ul>
</div>
......@@ -287,7 +288,34 @@ $(document).ready(function(){
});
});
</pre>
</section>
</section>
<section id="search">
<div class="page-header">
<h1>search...</h1>
</div>
<p>Three parameters to manage a search field:
<ul>
<li>searchInput: a jquery object (an html input element), default value is null for no search feature</li>
<li>searchStatus: a jquery object (a span type element) to display the search status</li>
<li>searchMinSize: the minimum size of the input string to start the search.</li>
</ul>
</p>
<pre class="prettyprint linenums">
$(document).ready(function(){
$('#example').jvenn({
series: [{
name: 'sample1',
data: ["Otu1", "Otu2", "Otu3", "Otu4", "Otu5", "Otu6", "Otu7"],
values: [5, 15, 250, 20, 23, 58, 89]
}],
searchInput: $("#search-field"),
searchStatus: $("#search-status"),
searchMinSize: 1
});
});
</pre>
</section>
</div>
</div>
......
......@@ -42,6 +42,7 @@
<ul class="nav nav-list bs-docs-sidenav affix">
<li class="active"><a href="#quickStart"><i class="icon-chevron-right"></i> Quick start</a></li>
<li><a href="#export"><i class="icon-chevron-right"></i> Export to ...</a></li>
<li><a href="#search"><i class="icon-chevron-right"></i> Search</a></li>
<li><a href="#legend"><i class="icon-chevron-right"></i> Switch button panel</a></li>
<li><a href="#extraCharts"><i class="icon-chevron-right"></i> Extra chats</a></li>
</ul>
......@@ -97,7 +98,23 @@
<img width="50%" src="img/jvenn-export.png" class="img-rounded">
</div>
</section>
<section id="search">
<div class="page-header">
<h1>Search for an element</h1>
</div>
<p>Fill the input field on the top of the page to search for an element (case sensitive). Three different status are possible:
<ul>
<li><b>found</b> only one element matched, the corresponding intersection is then highlighted</li>
<li><b>not found</b> no element matched, all intersections are faded out</li>
<li><b>ambiguous</b> two or more elements matched, keep on searching...</li>
</ul>
</p>
<div class="bs-docs-example" style="text-align: center;">
<img width="48%" src="img/jvenn-search1.png" class="img-rounded img-polaroid"> <img width="48%" src="img/jvenn-search2.png" class="img-rounded img-polaroid">
</div>
</section>
<section id="legend">
<div class="page-header">
<h1>Switch button panel</h1>
......
Markdown is supported
0%
or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment