api documentation for searchkit (v0.10.1)

A suite of react components to help create a UI quickly for elasticsearch

table of contents

  1. module searchkit
    1. object searchkit.AccessorManager
    2. object searchkit.SearchRequest
    3. object searchkit.SearchkitManager
    4. object searchkit.history
    5. object searchkit.index
  2. module searchkit.AccessorManager
    1. function searchkit.AccessorManager ()
  3. module searchkit.SearchRequest
    1. function searchkit.SearchRequest (transport, query, searchkit)
  4. module searchkit.SearchkitManager
    1. function searchkit.SearchkitManager (host, options)
  5. module searchkit.history
    1. function searchkit.history.createHistory ()
  6. module searchkit.index
    1. function searchkit.index.Accessor ()
    2. function searchkit.index.AccessorManager ()
    3. function searchkit.index.AggsContainer (key, inner, aggsArray)
    4. function searchkit.index.AnonymousAccessor (buildSharedQuery)
    5. function searchkit.index.ArrayState ()
    6. function searchkit.index.AvgBucketPipeline (key, buckets_path)
    7. function searchkit.index.AvgMetric (key, field)
    8. function searchkit.index.AxiosESTransport (host, options)
    9. function searchkit.index.BaseQueryAccessor (key)
    10. function searchkit.index.BoolMust (val)
    11. function searchkit.index.BoolMustNot (val)
    12. function searchkit.index.BoolShould (val)
    13. function searchkit.index.CardinalityMetric (key, field)
    14. function searchkit.index.CheckboxFilterAccessor (key, options)
    15. function searchkit.index.ChildrenBucket (key, type)
    16. function searchkit.index.ChildrenFieldContext (fieldOptions)
    17. function searchkit.index.DynamicRangeAccessor (key, options)
    18. function searchkit.index.ESTransport ()
    19. function searchkit.index.EmbeddedFieldContext ()
    20. function searchkit.index.EventEmitter ()
    21. function searchkit.index.FacetAccessor (key, options)
    22. function searchkit.index.FastClick ()
    23. function searchkit.index.FieldContext (fieldOptions)
    24. function searchkit.index.FieldContextFactory (fieldOptions)
    25. function searchkit.index.FieldMetricFactory (metricOp)
    26. function searchkit.index.FilterBasedAccessor ()
    27. function searchkit.index.FilterBucket (key, filter)
    28. function searchkit.index.FilteredQuery (filtered)
    29. function searchkit.index.GeoBoundsMetric (key, field, options)
    30. function searchkit.index.GeohashBucket (key, field, options)
    31. function searchkit.index.HasChildQuery (type, query, options)
    32. function searchkit.index.HasParentQuery (parent_type, query, options)
    33. function searchkit.index.HierarchicalFacetAccessor (key, options)
    34. function searchkit.index.HighlightAccessor (fields)
    35. function searchkit.index.HistogramBucket (key, field, options)
    36. function searchkit.index.HitsAccessor (options)
    37. function searchkit.index.ImmutableQuery (index)
    38. function searchkit.index.LevelState ()
    39. function searchkit.index.LoadingComponent ()
    40. function searchkit.index.MatchPhrasePrefix (query, str)
    41. function searchkit.index.MatchQuery (field, query, options)
    42. function searchkit.index.MaxMetric (key, field)
    43. function searchkit.index.MinMetric (key, field)
    44. function searchkit.index.MockESTransport ()
    45. function searchkit.index.MultiMatchQuery (query, options)
    46. function searchkit.index.NestedBucket (key, path)
    47. function searchkit.index.NestedFacetAccessor (key, options)
    48. function searchkit.index.NestedFieldContext (fieldOptions)
    49. function searchkit.index.NestedQuery (path, filter, options)
    50. function searchkit.index.NoFiltersHitCountAccessor ()
    51. function searchkit.index.NoopQueryAccessor ()
    52. function searchkit.index.NumericOptionsAccessor (key, options)
    53. function searchkit.index.ObjectState ()
    54. function searchkit.index.PageSizeAccessor (defaultSize)
    55. function searchkit.index.PaginationAccessor ()
    56. function searchkit.index.PureRender (target)
    57. function searchkit.index.PureRenderComponent ()
    58. function searchkit.index.QueryAccessor (key, options)
    59. function searchkit.index.QueryString (query, options)
    60. function searchkit.index.RangeAccessor (key, options)
    61. function searchkit.index.RangeBucket (key, field, ranges)
    62. function searchkit.index.RangeQuery (key, options)
    63. function searchkit.index.RenderComponentPropType ()
    64. function searchkit.index.ResetSearchAccessor (options)
    65. function searchkit.index.SearchRequest (transport, query, searchkit)
    66. function searchkit.index.SearchkitComponent (props)
    67. function searchkit.index.SearchkitManager (host, options)
    68. function searchkit.index.SearchkitProvider ()
    69. function searchkit.index.SignificantTermsBucket (key, field, options)
    70. function searchkit.index.SimpleQueryString (query, options)
    71. function searchkit.index.SortingAccessor (key, options)
    72. function searchkit.index.SourceFilterAccessor (source)
    73. function searchkit.index.State (value)
    74. function searchkit.index.StatefulAccessor (key, urlString)
    75. function searchkit.index.StatsMetric (key, field)
    76. function searchkit.index.SuggestionsAccessor (field)
    77. function searchkit.index.SumMetric (key, field)
    78. function searchkit.index.TermQuery (key, value)
    79. function searchkit.index.TermsBucket (key, field, options)
    80. function searchkit.index.TermsQuery (key, value)
    81. function searchkit.index.TopHitsMetric (key, top_hits)
    82. function searchkit.index.Utils ()
    83. function searchkit.index.ValueState ()
    84. function searchkit.index.ViewOptionsAccessor (key, options)
    85. function searchkit.index.block (name)
    86. function searchkit.index.createHistory ()
    87. function searchkit.index.renderComponent (component, props, children)
    88. function searchkit.index.shallowEqualWithoutFunctions (objA, objB)
    89. function searchkit.index.shouldPureComponentUpdate (nextProps, nextState)
    90. object searchkit.index.noopQueryAccessor
    91. string searchkit.index.VERSION

module searchkit

module searchkit.AccessorManager

function searchkit.AccessorManager ()

module searchkit.SearchRequest

function searchkit.SearchRequest (transport, query, searchkit)

module searchkit.SearchkitManager

function searchkit.SearchkitManager (host, options)

module searchkit.history

function searchkit.history.createHistory ()

module searchkit.index

function searchkit.index.Accessor ()

function searchkit.index.AccessorManager ()

function searchkit.index.AggsContainer (key, inner, aggsArray)

function searchkit.index.AnonymousAccessor (buildSharedQuery)

function searchkit.index.ArrayState ()

function searchkit.index.AvgBucketPipeline (key, buckets_path)

function searchkit.index.AvgMetric (key, field)

function searchkit.index.AxiosESTransport (host, options)

function searchkit.index.BaseQueryAccessor (key)

function searchkit.index.BoolMust (val)

function searchkit.index.BoolMustNot (val)

function searchkit.index.BoolShould (val)

function searchkit.index.CardinalityMetric (key, field)

function searchkit.index.CheckboxFilterAccessor (key, options)

function searchkit.index.ChildrenBucket (key, type)

function searchkit.index.ChildrenFieldContext (fieldOptions)

function searchkit.index.DynamicRangeAccessor (key, options)

function searchkit.index.ESTransport ()

function searchkit.index.EmbeddedFieldContext ()

function searchkit.index.EventEmitter ()

function searchkit.index.FacetAccessor (key, options)

function searchkit.index.FastClick ()

function searchkit.index.FieldContext (fieldOptions)

function searchkit.index.FieldContextFactory (fieldOptions)

function searchkit.index.FieldMetricFactory (metricOp)

function searchkit.index.FilterBasedAccessor ()

function searchkit.index.FilterBucket (key, filter)

function searchkit.index.FilteredQuery (filtered)

function searchkit.index.GeoBoundsMetric (key, field, options)

function searchkit.index.GeohashBucket (key, field, options)

function searchkit.index.HasChildQuery (type, query, options)

function searchkit.index.HasParentQuery (parent_type, query, options)

function searchkit.index.HierarchicalFacetAccessor (key, options)

function searchkit.index.HighlightAccessor (fields)

function searchkit.index.HistogramBucket (key, field, options)

function searchkit.index.HitsAccessor (options)

function searchkit.index.ImmutableQuery (index)

function searchkit.index.LevelState ()

function searchkit.index.LoadingComponent ()

function searchkit.index.MatchPhrasePrefix (query, str)

function searchkit.index.MatchQuery (field, query, options)

function searchkit.index.MaxMetric (key, field)

function searchkit.index.MinMetric (key, field)

function searchkit.index.MockESTransport ()

function searchkit.index.MultiMatchQuery (query, options)

function searchkit.index.NestedBucket (key, path)

function searchkit.index.NestedFacetAccessor (key, options)

function searchkit.index.NestedFieldContext (fieldOptions)

function searchkit.index.NestedQuery (path, filter, options)

function searchkit.index.NoFiltersHitCountAccessor ()

function searchkit.index.NoopQueryAccessor ()

function searchkit.index.NumericOptionsAccessor (key, options)

function searchkit.index.ObjectState ()

function searchkit.index.PageSizeAccessor (defaultSize)

function searchkit.index.PaginationAccessor ()

function searchkit.index.PureRender (target)

function searchkit.index.PureRenderComponent ()

function searchkit.index.QueryAccessor (key, options)

function searchkit.index.QueryString (query, options)

function searchkit.index.RangeAccessor (key, options)

function searchkit.index.RangeBucket (key, field, ranges)

function searchkit.index.RangeQuery (key, options)

function searchkit.index.RenderComponentPropType ()

function searchkit.index.ResetSearchAccessor (options)

function searchkit.index.SearchRequest (transport, query, searchkit)

function searchkit.index.SearchkitComponent (props)

function searchkit.index.SearchkitManager (host, options)

function searchkit.index.SearchkitProvider ()

function searchkit.index.SignificantTermsBucket (key, field, options)

function searchkit.index.SimpleQueryString (query, options)

function searchkit.index.SortingAccessor (key, options)

function searchkit.index.SourceFilterAccessor (source)

function searchkit.index.State (value)

function searchkit.index.StatefulAccessor (key, urlString)

function searchkit.index.StatsMetric (key, field)

function searchkit.index.SuggestionsAccessor (field)

function searchkit.index.SumMetric (key, field)

function searchkit.index.TermQuery (key, value)

function searchkit.index.TermsBucket (key, field, options)

function searchkit.index.TermsQuery (key, value)

function searchkit.index.TopHitsMetric (key, top_hits)

function searchkit.index.Utils ()

function searchkit.index.ValueState ()

function searchkit.index.ViewOptionsAccessor (key, options)

function searchkit.index.block (name)

function searchkit.index.createHistory ()

function searchkit.index.renderComponent (component, props, children)

function searchkit.index.shallowEqualWithoutFunctions (objA, objB)

function searchkit.index.shouldPureComponentUpdate (nextProps, nextState)

[ this document was created with utility2 ]