more documentation for doEmit flag - resolves #105

CHANGELOG.md

@@ -6,6 +6,7 @@ This document lists the changes introduced by this fork.
 
 * Revert commit baffdd5591761e967957ad71cbe22a4196b32615 because of
   an incorrect implementation of `count()` in the `ServerDataSource` 
+* Adds more documentation for the `doEmit` flag of various methods.
 
 ## Version 2.6.0
 

projects/angular2-smart-table/CHANGELOG.md

@@ -6,6 +6,7 @@ This document lists the changes introduced by this fork.
 
 * Revert commit baffdd5591761e967957ad71cbe22a4196b32615 because of
   an incorrect implementation of `count()` in the `ServerDataSource`
+* Adds more documentation for the `doEmit` flag of various methods.
 
 ## Version 2.6.0
 

projects/demo/src/app/pages/documentation/documentation.component.html

@@ -1091,7 +1091,9 @@ <h3>Data Source Methods</h3>
             </ul>
           </li>
           <li>
-            doEmit: <span class="highlight">boolean</span> - emit event (to refresh the table) or not, default = true
+            doEmit: <span class="highlight">boolean</span> - emit event (to refresh the table) or not, default = true.
+            Set this to false if you want to prepare a configuration without refreshing the table
+            (e.g. to avoid a HTTP request from a ServerDataSource).
           </li>
         </ul>
       </td>
@@ -1115,7 +1117,9 @@ <h3>Data Source Methods</h3>
             </ul>
           </li>
           <li>
-            doEmit: <span class="highlight">boolean</span> - emit event (to refresh the table) or not, default = true
+            doEmit: <span class="highlight">boolean</span> - emit event (to refresh the table) or not, default = true.
+            Set this to false if you want to prepare a configuration without refreshing the table
+            (e.g. to avoid a HTTP request from a ServerDataSource).
           </li>
         </ul>
       </td>
@@ -1149,7 +1153,9 @@ <h3>Data Source Methods</h3>
             andOperator: <span class="highlight">boolean</span> - how to process multiple filters (as AND or as OR), default = true (AND)
           </li>
           <li>
-            doEmit: <span class="highlight">boolean</span> - emit event (to refresh the table) or not, default = true
+            doEmit: <span class="highlight">boolean</span> - emit event (to refresh the table) or not, default = true.
+            Set this to false if you want to prepare a configuration without refreshing the table
+            (e.g. to avoid a HTTP request from a ServerDataSource).
           </li>
         </ul>
       </td>
@@ -1174,7 +1180,9 @@ <h3>Data Source Methods</h3>
             andOperator: <span class="highlight">boolean</span> - how to process multiple filters (as AND or as OR), default = true (AND)
           </li>
           <li>
-            doEmit: <span class="highlight">boolean</span> - emit event (to refresh the table) or not, default = true
+            doEmit: <span class="highlight">boolean</span> - emit event (to refresh the table) or not, default = true.
+            Set this to false if you want to prepare a configuration without refreshing the table
+            (e.g. to avoid a HTTP request from a ServerDataSource).
           </li>
         </ul>
       </td>
@@ -1207,7 +1215,9 @@ <h3>Data Source Methods</h3>
             perPage: <span class="highlight">number</span> - about per page
           </li>
           <li>
-            doEmit: <span class="highlight">boolean</span> - emit event (to refresh the table) or not, default = true
+            doEmit: <span class="highlight">boolean</span> - emit event (to refresh the table) or not, default = true.
+            Set this to false if you want to prepare a configuration without refreshing the table
+            (e.g. to avoid a HTTP request from a ServerDataSource).
           </li>
         </ul>
       </td>
@@ -1223,7 +1233,9 @@ <h3>Data Source Methods</h3>
             page: <span class="highlight">number</span> - page number
           </li>
           <li>
-            doEmit: <span class="highlight">boolean</span> - emit event (to refresh the table) or not, default = true
+            doEmit: <span class="highlight">boolean</span> - emit event (to refresh the table) or not, default = true.
+            Set this to false if you want to prepare a configuration without refreshing the table
+            (e.g. to avoid a HTTP request from a ServerDataSource).
           </li>
         </ul>
       </td>