Interface FoldingOptions

interface FoldingOptions {
    childField?: string;
    collectionField?: string;
    numberOfFoldedResults?: number;
    parentField?: string;
}

Properties

childField? collectionField? numberOfFoldedResults? parentField?

Properties

OptionalchildField

childField?: string

The name of the field that uniquely identifies a result within a collection.

Default Value

foldingchild

OptionalcollectionField

collectionField?: string

The name of the field on which to do the folding. The folded result list component will use the values of this field to resolve the collections of result items.

Default Value

foldingcollection

OptionalnumberOfFoldedResults

numberOfFoldedResults?: number

The number of child results to fold under the root collection element, before expansion.

Default Value

2

OptionalparentField

parentField?: string

The name of the field that determines whether a certain result is a top result containing other child results within a collection.

Default Value

foldingparent

Settings

Member Visibility

On This Page

Properties