Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

  • IncludedItems

Index

Methods

exclude

  • exclude(itemId: string): boolean
  • Excludes one item. Returns True if the included items list has changed after the operation.

    Parameters

    • itemId: string

    Returns boolean

excludeAll

  • excludeAll(): void
  • Clears and switches to inclusion set

    Returns void

excludeList

  • excludeList(itemIds: string[]): boolean
  • Excludes the list of items. Returns True if the included items list has changed after the operation.

    Parameters

    • itemIds: string[]

    Returns boolean

getExcludedItemIds

  • getExcludedItemIds(): string[]
  • Returns excluded item ids. Useful for serialization.

    Returns string[]

getIncludedItemIds

  • getIncludedItemIds(): string[]
  • Returns included item ids. Useful for serialization.

    Returns string[]

getIncludedItems

  • Returns included items, but filtering out items from the all items array

    Parameters

    Returns IIncludable[]

getItemIdsSetSize

  • getItemIdsSetSize(): number
  • Returns the size of the item ids set. Mostly for testing

    Returns number

include

  • include(itemId: string): boolean
  • Includes one item. Returns True if the included items list has changed after the operation.

    Parameters

    • itemId: string

    Returns boolean

includeAll

  • includeAll(): void
  • Clears and switches to exclusion set

    Returns void

includeList

  • includeList(itemIds: string[]): boolean
  • Includes the list of items. Returns True if the included items list has changed after the operation.

    Parameters

    • itemIds: string[]

    Returns boolean

reconcile

  • Reconciles the items set with the all items array by removing items that are no longer present

    Parameters

    Returns void

removeId

  • removeId(id: string): void
  • Removes id. Is used when you need to remove item, for example remove an axis

    Parameters

    • id: string

    Returns void

testIsIncluded

  • testIsIncluded(itemId: string): boolean
  • Tests if the item is included

    Parameters

    • itemId: string

    Returns boolean

Generated using TypeDoc