Explorar el Código

sort panel documentation

Rashid Khan hace 12 años
padre
commit
db524af6b2
Se han modificado 2 ficheros con 44 adiciones y 0 borrados
  1. 22 0
      panels/sort/module.js
  2. 22 0
      panels/stringquery/module.js

+ 22 - 0
panels/sort/module.js

@@ -1,3 +1,25 @@
+/*
+
+  ## Sort
+
+  This will probably be removed in the near future since it only interacts with 
+  the table panel and the table panel already implements all of its functionality.
+  It only interacts with the table panel in any case
+
+  ### Parameters
+  * label ::  The label to stick over the drop down
+  * sort :: An array where the first elemetn is the field to sort on an the second
+            is the direction ('asc' or 'desc')
+  ### Group Events
+  #### Sends
+  * sort :: An array where the first elemetn is the field to sort on an the second
+            is the direction ('asc' or 'desc')
+  #### Receives
+  * fields :: An array containing the fields in a table. This will be concat'd + 
+              uniqued with the curent list. 
+
+*/
+
 angular.module('kibana.sort', [])
 .controller('sort', function($scope, eventBus) {
 

+ 22 - 0
panels/stringquery/module.js

@@ -1,3 +1,25 @@
+/*
+
+  ## Sort
+
+  This will probably be removed in the near future since it only interacts with 
+  the table panel and the table panel already implements all of its functionality.
+  It only interacts with the table panel in any case
+
+  ### Parameters
+  * label ::  The label to stick over the drop down
+  * sort :: An array where the first elemetn is the field to sort on an the second
+            is the direction ('asc' or 'desc')
+  ### Group Events
+  #### Sends
+  * sort :: An array where the first elemetn is the field to sort on an the second
+            is the direction ('asc' or 'desc')
+  #### Receives
+  * fields :: An array containing the fields in a table. This will be concat'd + 
+              uniqued with the curent list. 
+
+*/
+
 angular.module('kibana.stringquery', [])
 .controller('stringquery', function($scope, eventBus) {