Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CategoryPresentation

The configuration describes how the specific node is to be filtered, sorted, and/or grouped. Applied in this order:

  • grouping: Grouping might change all items on this level (introduces an extra layer).
          If an extra group-level is introduced then it will be subject for all
      consecutive processes in this class.
  • filter: Reduces which child-categories that passes through based on filter.
  • sorting: Changes the order of the categories.
  • limit: Limits the no of categories to display.
  • expanded: If any categories are left to be shown then this setting indicates whether or not
          to show the categories in the UI. Note that this is not available for the root-
      level node, as it always shows the first-level of category-nodes.
default
  • All features disabled.

Hierarchy

  • CategoryPresentation

Index

Constructors

Properties

Constructors

constructor

  • Creates a CategoryPresentation instance. Default: All features disabled.

    Parameters

    Returns CategoryPresentation

Properties

Optional expanded

expanded: boolean

Used to indicate whether tho show category-children or not. Default: undefined (N/A for the root-element) Default: null

Optional filter

filter: FilterConfiguration

Used to include only categories that match the provided filter (regex + minCount). Default: Disabled

Optional group

group: GroupConfiguration

Used to create an extra level of categories that group items together. Default: Disabled

Optional limit

limit: LimitPageConfiguration

Used to limit the number of items to display. Default: Disabled

Optional sort

sort: SortConfiguration

Used to change the order of the categories. Default: Disabled

Generated using TypeDoc