FilterBehavior

class

Back to Helios Web API

Kind

class

Source

src/behaviors/FilterBehavior.js:56

Description

Built-in behavior for graph filtering.

Signature

export class FilterBehavior extends Behavior {

Parameters

Name	Type	Attributes	Default	Description
options	Object|HeliosFilter	optional		Filter model or rule options for numeric, categorical, string, and query rules.

Returns

Behavior that applies render-only or render-plus-layout filtered graph views.

Type FilterBehavior

Notes

scope: "render" keeps the layout topology intact; scope: "render+layout" rebuilds the active graph view used by both rendering and dynamic layouts.

Instance Properties

id

Source: src/behaviors/FilterBehavior.js:57

Id exposed by the class.

Filtering And State

Graph filtering and interaction state. When active, FilterBehavior and SelectionBehavior coordinate this area.

getPublicState()

Source: src/behaviors/FilterBehavior.js:205

Returns the current public state value or state.

Example

const value = helios.getPublicState();

replaceRules({ nodeRules = [], edgeRules = [], scope, minComponentSize } = {}) → {FilterBehavior}

Source: src/behaviors/FilterBehavior.js:248

Replace all active node and edge filter rules.

Parameters

Name	Type	Attributes	Default	Description
options	Object	optional		Replacement filter options.
|nodeRules	Array.<Object>	optional		Node rules to apply.
|edgeRules	Array.<Object>	optional		Edge rules to apply.
|scope	'render'|'render+layout'	optional		Filter scope.
nodeRules		optional	[]	Value passed to replaceRules.
edgeRules		optional	[]	Value passed to replaceRules.
scope				Attribute scope: node, edge, or network.
minComponentSize		optional	{}	Value passed to replaceRules.

Returns

This behavior instance.

Type FilterBehavior

Notes

render+layout changes the graph view consumed by dynamic layouts. Use render when hiding items should not change layout forces.

clear() → {FilterBehavior}

Source: src/behaviors/FilterBehavior.js:268

Remove the active graph filter and restore the unfiltered render view.

Returns

This behavior instance.

Type FilterBehavior

setFilterModel(model, { reason = 'model', trackOverride = true } = {}) → {this}

Source: src/behaviors/FilterBehavior.js:290

Set the filter model setting.

Parameters

Name	Type	Attributes	Default	Description
model				Value passed to setFilterModel.
reason	string	optional	'model'	Reason for this operation.
trackOverride		optional	true } = {}	Value passed to setFilterModel.

Returns

This instance.

Type this

Network And Persistence

Network replacement, serialization, and visualization state persistence. ExporterBehavior and InterfaceBehavior can surface parts of this flow in the UI.

attach(context)

Source: src/behaviors/FilterBehavior.js:67

Configures or reads attach.

Parameters

Name	Type	Attributes	Default	Description
context				Value passed to attach.

serialize()

Source: src/behaviors/FilterBehavior.js:102

Handles serialize for the current graph or visualization state.

restore(snapshot = {}) → {this}

Source: src/behaviors/FilterBehavior.js:186

Updates the restore state on the current instance.

Parameters

Name	Type	Attributes	Default	Description
snapshot		optional	{}	Value passed to restore.

Returns

This instance.

Type this

Appearance

Visual rendering settings for nodes, edges, labels, legends, density, shading, and background. AppearanceBehavior, LabelsBehavior, and LegendsBehavior cover the built-in controls.

setMinComponentSize(value) → {number|this}

Source: src/behaviors/FilterBehavior.js:230

Read or set the set min component size setting.

Parameters

Name	Type	Attributes	Default	Description
value	number			New set min component size value. Omit this argument to read the current value.

Returns

Current set min component size value when called without arguments; otherwise this instance for chaining.

Type number|this

Example

helios.setMinComponentSize(1);

Configuration

General configuration setters and compatibility helpers.

getModel()

Source: src/behaviors/FilterBehavior.js:213

Returns the current model value or state.

Example

const value = helios.getModel();

setScope(scope) → {this}

Source: src/behaviors/FilterBehavior.js:224

Set the scope setting.

Parameters

Name	Type	Attributes	Default	Description
scope				Attribute scope: node, edge, or network.

Returns

This instance.

Type this

Utilities

Additional public helpers that do not belong to a narrower API area.

update(options = {}) → {Object|this}

Source: src/behaviors/FilterBehavior.js:82

Read or set the update setting.

Parameters

Name	Type	Attributes	Default	Description
options	Object	optional	{}	Options object for this operation.

Returns

Current update value when called without arguments; otherwise this instance for chaining.

Type Object|this

Example

helios.update({
  enabled: true,
});

stateEntries()

Source: src/behaviors/FilterBehavior.js:116

Configures or reads state entries.

emitChange(reason, detail = {})

Source: src/behaviors/FilterBehavior.js:201

Configures or reads emit change.

Parameters

Name	Type	Attributes	Default	Description
reason	string			Reason for this operation.
detail		optional	{}	Event payload passed to listeners.

filters(options) → {Object|this}

Source: src/behaviors/FilterBehavior.js:217

Read or set the filters setting.

Parameters

Name	Type	Attributes	Default	Description
options	Object			Options object for this operation.

Returns

Current filters value when called without arguments; otherwise this instance for chaining.

Type Object|this

Example

helios.filters({
  enabled: true,
});

syncFromHelios({ preferActiveModel = false, silent = false } = {})

Source: src/behaviors/FilterBehavior.js:314

Configures or reads sync from helios.

Parameters

Name	Type	Attributes	Default	Description
preferActiveModel		optional	false	Value passed to syncFromHelios.
silent		optional	false } = {}	Value passed to syncFromHelios.