FilterService

class wvc.FilterService()

Lists and applies filters using the viewer’s model API.

Index

Constructors

• constructor

Properties

• serviceName

Accessors

• webViewer

Methods

• applyFilter
• getFilters
• reset

Constructors

wvc.FilterService.constructor()

FilterService(webViewer: IWebViewer): FilterService

Parameters

webViewer: IWebViewer

Optional viewer supplying model filters.

Returns: FilterService

Properties

wvc.FilterService.serviceName

readonly

serviceName: “FilterService”

Registry identifier for this service.

Accessors

wvc.FilterService.webViewer()

Viewer supplying the filters; undefined before initialization.

get webViewer(): (undefined | IWebViewer)

Viewer supplying model filters; undefined before initialization.

Returns: (undefined | IWebViewer)

set webViewer(webViewer: (undefined | IWebViewer)): void

Viewer supplying the filters; undefined before initialization.

Parameters

webViewer: (undefined | IWebViewer)

Returns: void

Methods

wvc.FilterService.applyFilter()

applyFilter(filterId: FilterId): void

Parameters

filterId: FilterId

Filter to apply.

Returns: void

void

Throws

When the viewer is not initialized.

wvc.FilterService.getFilters()

getFilters(): Map

Returns: Map

The model filters, or an empty map before initialization.

wvc.FilterService.reset()

reset(): void

Returns: void

void; notifies consumers to refresh the filter list.