Search Results for

    Show / Hide Table of Contents

    Class AggregatorBase

    It is the base class for all aggregators.

    Inheritance
    object
    AggregatorBase
    DateRangeAggregator
    GeoDistanceAggregator
    NestedAggregator
    NumericRangeAggregator
    TermsAggregator
    TreeAggregator
    Inherited Members
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [JsonConverter(typeof(JsonInheritanceConverter), new object[] { "kind" })]
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public abstract class AggregatorBase

    Properties

    Aggregators

    An optional aggregator list for nested aggregations.

    Declaration
    [JsonProperty("aggregators", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public ICollection<AggregatorBase> Aggregators { get; set; }
    Property Value
    ICollection<AggregatorBase>

    Filter

    An optional filter to limit the data set the aggregation is operation on.

    Declaration
    [JsonProperty("filter", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public FilterBase Filter { get; set; }
    Property Value
    FilterBase

    Name

    The slug name of the aggregation. It must be unique per aggregation request.

    Declaration
    [JsonProperty("name", Required = Required.Always)]
    [Required]
    public string Name { get; set; }
    Property Value
    string

    Names

    Language specific field names.

    Declaration
    [JsonProperty("names", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public TranslatedStringDictionary Names { get; set; }
    Property Value
    TranslatedStringDictionary

    UiBehavior

    Optional behavior that the UI should keep in regards to the aggregation

    Declaration
    [JsonProperty("uiBehavior", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public UiAggregatorBehavior UiBehavior { get; set; }
    Property Value
    UiAggregatorBehavior

    Methods

    FromJson(string)

    Declaration
    public static AggregatorBase FromJson(string data)
    Parameters
    string data

    Returns
    AggregatorBase

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX