Options
All
  • Public
  • Public/Protected
  • All
Menu

The Filter interface defines what information is held for a chosen category as a filter.

Hierarchy

  • Filter

Implements

Index

Constructors

Properties

Constructors

constructor

  • new Filter(displayName: string[], category: ICategory, hidden?: boolean): Filter
  • Creates a Filter instance, holding the displayName and a copy of the original Category (excluding category.children).

    Parameters

    • displayName: string[]

      Holds an array of all displayNames for the path to this category.

    • category: ICategory

      A copy/reference to the actual category selected (from what was received in the categorize call).

    • hidden: boolean = false

      Whether or not the filter should be included in the category tree.

    Returns Filter

Properties

category

category: ICategory

Optional displayName

displayName: string[]

Optional hidden

hidden: boolean

Generated using TypeDoc