Class Filter

Property

Cytoscape selector identifying the elements to filter out cytoscape selectors

Property

whether the filter is currently active or not

Property

whether the filter is currently activable

Property

the class to add to filtered elems to easily retrieve them later on

Property

unique key to identify a filter

Hierarchy

Filter

Index

Constructors

Properties

_compareFn _key _locked active

Accessors

filterTag key locked

Methods

lock shouldFilter unlock

Constructors

constructor

new Filter(key: string, compareFn: ((grapholElement: GrapholElement) => boolean)): Filter
Parameters
- key: string
  
  Unique identifier
- compareFn: ((grapholElement: GrapholElement) => boolean)
  
  Function receiving a GrapholElement and returning true if the element should be filtered, false otherwise
  - - (grapholElement: GrapholElement): boolean
    - Parameters
      
      grapholElement: GrapholElement
      
      Returns boolean
Returns Filter
- Defined in src/model/renderers/filter.ts:27

Properties

`Private` _compareFn

_compareFn: ((grapholElement: GrapholElement) => boolean) = ...

Type declaration

- (grapholElement: GrapholElement): boolean
- Parameters
  - grapholElement: GrapholElement
  Returns boolean

`Private` _key

_key: string

`Private` _locked

_locked: boolean = false

active

active: boolean = false

Accessors

filterTag

get filterTag(): string
Returns string
- Defined in src/model/renderers/filter.ts:36

key

get key(): string
Returns string
- Defined in src/model/renderers/filter.ts:32

locked

get locked(): boolean
Returns boolean
- Defined in src/model/renderers/filter.ts:40

Methods

lock

lock(): void
Returns void
- Defined in src/model/renderers/filter.ts:42

shouldFilter

shouldFilter(grapholElement: GrapholElement): boolean
Parameters
- grapholElement: GrapholElement
Returns boolean
- Defined in src/model/renderers/filter.ts:50

unlock

unlock(): void
Returns void
- Defined in src/model/renderers/filter.ts:46