Interface FacetGroupSettingValue

A single filter condition applied to a facet. Used in:

  • NavigateToInventoryFilters.facetFilters

  • ReportFacetsConfig.defaultFilters

  • ReportFacetsSelection.facets

  • getAllFactSheets facet selection

  • facetKey — the field or dimension to filter on (e.g. 'FactSheetTypes', 'lifecycle', 'lxState', or a tag-group UUID). Use 'FactSheetTypes' to scope to a specific type.

  • keys — selected values for this facet. An empty array means "no restriction" and is the correct way to override the implicit lxState filter that normally excludes DRAFT and REJECTED Fact Sheets (pass { facetKey: 'lxState', keys: [] }).

  • operator — logical operator combining multiple keys; defaults to OR

  • dateFilter — optional date-range scope for lifecycle or date-based facets

  • subscriptionFilter — optional subscription-type scope

  • excludeTransitiveRelations — when true, excludes Fact Sheets matched only via transitive relation traversal

  • subFilter — nested filter applied within the result set of this facet

interface FacetGroupSettingValue {
    dateFilter?: DateFilter;
    excludeTransitiveRelations?: boolean;
    facetKey: string;
    facetType?: FacetType;
    keys: string[];
    operator?: FacetKeyOperator;
    subFilter?: {
        facetFilters: FacetFilter[];
        fullTextSearch?: string;
        ids?: string[];
    };
    subscriptionFilter?: SubscriptionFilter;
}

Hierarchy

Properties

dateFilter?: DateFilter
excludeTransitiveRelations?: boolean
facetKey: string
facetType?: FacetType
keys: string[]
operator?: FacetKeyOperator
subFilter?: {
    facetFilters: FacetFilter[];
    fullTextSearch?: string;
    ids?: string[];
}

Type declaration

  • facetFilters: FacetFilter[]
  • Optional fullTextSearch?: string
  • Optional ids?: string[]
subscriptionFilter?: SubscriptionFilter

Generated using TypeDoc