fields panel documentation

This commit is contained in:
Rashid Khan 2013-04-19 20:36:03 -07:00
parent af89762021
commit 76f4788f72
2 changed files with 42 additions and 21 deletions

View File

@ -1,3 +1,22 @@
/*
## Fields
Allows for enabling and disabling of fields in the table panel as well as a
micro anaylsis panel for analyzing the events in the table panel
### Parameters
* style :: a hash containing css styles
* arrange :: the layout pf the panel 'horizontal' or 'vertical'
* micropanel_position :: where to place the micropanel in relation to the field
### Group Events
#### Recieves
* table_documents :: An object containing the documents in the table panel
*** Sends
* fields :: an object containing the sort order, existing fields and selected fields
*/
angular.module('kibana.fields', []) angular.module('kibana.fields', [])
.controller('fields', function($scope, eventBus, $timeout) { .controller('fields', function($scope, eventBus, $timeout) {

View File

@ -1,30 +1,32 @@
/* /*
## Timepicker
The timepicker panel is used to select time ranges and inform other panel of ## Timepicker
them. It also handles searching for indices that match the given time range and
a pattern
### Parameters The timepicker panel is used to select time ranges and inform other panel of
* mode :: The default mode of the panel. Options: 'relative', 'absolute' 'since' Default: 'relative' them. It also handles searching for indices that match the given time range and
* time_options :: An array of possible time options. Default: ['5m','15m','1h','6h','12h','24h','2d','7d','30d'] a pattern
* timespan :: The default options selected for the relative view. Default: '15m'
* timefield :: The field in which time is stored in the document.
* index :: Index pattern to match. Literals should be double quoted. Default: '_all'
* defaultindex :: Index to failover to if index not found
* index_interval :: Time between timestamped indices (can be 'none') for static index
* refresh: Object containing refresh parameters
* enable :: true/false, enable auto refresh by default. Default: false
* interval :: Seconds between auto refresh. Default: 30
* min :: The lowest interval a user may set
### Group Events ### Parameters
#### Sends * mode :: The default mode of the panel. Options: 'relative', 'absolute' 'since' Default: 'relative'
* time :: Object Includes from, to and index * time_options :: An array of possible time options. Default: ['5m','15m','1h','6h','12h','24h','2d','7d','30d']
#### Receives * timespan :: The default options selected for the relative view. Default: '15m'
* get_time :: Receives an object containing a $id, broadcasts back to it. * timefield :: The field in which time is stored in the document.
* index :: Index pattern to match. Literals should be double quoted. Default: '_all'
* defaultindex :: Index to failover to if index not found
* index_interval :: Time between timestamped indices (can be 'none') for static index
* refresh: Object containing refresh parameters
* enable :: true/false, enable auto refresh by default. Default: false
* interval :: Seconds between auto refresh. Default: 30
* min :: The lowest interval a user may set
### Group Events
#### Sends
* time :: Object Includes from, to and index
#### Receives
* get_time :: Receives an object containing a $id, broadcasts back to it.
*/ */
angular.module('kibana.timepicker', []) angular.module('kibana.timepicker', [])
.controller('timepicker', function($scope, eventBus, $timeout, timer, $http) { .controller('timepicker', function($scope, eventBus, $timeout, timer, $http) {