Class FacetViewModel

Namespace

Dynamicweb.QueryPublisher

Assembly

Dynamicweb.QueryPublisher.dll

Represents a ViewModelBase for facet information.

public sealed class FacetViewModel : ViewModelBase

Inheritance

object

ViewModelBase

FacetViewModel

Inherited Members

ViewModelBase.ToJson()

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Properties

FacetOptions

Collection of facet options.

public IEnumerable<FacetOptionViewModel> FacetOptions { get; set; }

Property Value

IEnumerable<FacetOptionViewModel>

Field

Field to retrieve facet options from.

public string Field { get; set; }

Property Value

string

MaximumValue

Maximum value of the facet.

public object? MaximumValue { get; set; }

Property Value

object

MinimumValue

Minimum value of the facet.

public object? MinimumValue { get; set; }

Property Value

object

Name

The name of the facet, for example "Engine Type", presented to users as a search category. This name helps users identify different search/filter categories.

public string Name { get; set; }

Property Value

string

The display name of the facet.

OptionCount

Number of facet options

public int OptionCount { get; set; }

Property Value

int

OptionResultTotalCount

Total count of results across all options

public long OptionResultTotalCount { get; set; }

Property Value

long

OptionWithResultCount

Number of facet options that have a result associated

public int OptionWithResultCount { get; set; }

Property Value

int

QueryParameter

The query parameter associated with the facet, for example "ElectricalType".

public string QueryParameter { get; set; }

Property Value

string

QueryParameterDefaultValue

Default value of the query parameter, if none is set.

public string QueryParameterDefaultValue { get; set; }

Property Value

string

QueryParameterType

The type of the query parameter.

public string QueryParameterType { get; set; }

Property Value

string

RenderType

How the facet will be rendered to the user, for example "Checkboxes" or "Colors".

public string RenderType { get; set; }

Property Value

string

Type

Type of facet, for example "Field", "List", or "Term".

public string Type { get; set; }

Property Value

string

Value

Value of the facet.

public string Value { get; set; }

Property Value

string