Search Results for

    Show / Hide Table of Contents

    Class TreeAggregator

    Aggregator for a FieldTreeView.

    Inheritance
    object
    AggregatorBase
    TreeAggregator
    Inherited Members
    AggregatorBase.Name
    AggregatorBase.Names
    AggregatorBase.Aggregators
    AggregatorBase.Filter
    AggregatorBase.UiBehavior
    object.Equals(object)
    object.Equals(object, object)
    object.GetHashCode()
    object.GetType()
    object.MemberwiseClone()
    object.ReferenceEquals(object, object)
    object.ToString()
    Namespace: System.Dynamic.ExpandoObject
    Syntax
    [GeneratedCode("NJsonSchema", "13.20.0.0 (NJsonSchema v10.9.0.0 (Newtonsoft.Json v13.0.0.0))")]
    public class TreeAggregator : AggregatorBase

    Properties

    Field

    The fields ID to execute the aggregation on.

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

    Path

    Path to get buckets for.
    Remark: If this is not null, missing items will only be returned if they're a direct child of this path.

    Declaration
    [JsonProperty("path", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string Path { get; set; }
    Property Value
    string

    SearchString

    Search string to filter the buckets.

    Declaration
    [JsonProperty("searchString", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public string SearchString { get; set; }
    Property Value
    string

    Size

    The size parameter can be set to define how many buckets should be returned out of the overall list.

    Declaration
    [JsonProperty("size", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    public int? Size { get; set; }
    Property Value
    int?

    SortDirection

    Sorting for results. If null, sorts by item count.

    Declaration
    [JsonProperty("sortDirection", Required = Required.Default, NullValueHandling = NullValueHandling.Ignore)]
    [JsonConverter(typeof(StringEnumConverter))]
    public SortDirection? SortDirection { get; set; }
    Property Value
    SortDirection?

    Methods

    FromJson(string)

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

    Returns
    TreeAggregator

    ToJson()

    Declaration
    public string ToJson()
    Returns
    string

    Back to top Generated by DocFX