Class SmartFilterBarService

点击搜索事件, Filters变化的实时事件
全局 Filters
FilterBar 内的联合过滤 ValueHelp
往里面增加 Filters
删除 Filters

Hierarchy

ComponentStore<SmartFilterBarState>
- SmartFilterBarService

Index

Constructors

Constructors

constructor

new SmartFilterBarService(_parent?): SmartFilterBarService
Parameters
- Optional _parent: SmartFilterBarService
Returns SmartFilterBarService
Overrides ComponentStore<SmartFilterBarState>.constructor
- Defined in packages/core/src/lib/services/smart-filter-bar.service.ts:42

Properties

`Private` _filters$

_filters$: BehaviorSubject<ISlicer[]> = ...

Filters in this Filter Bar,

`Private` _go$

_go$: Subject<void> = ...

`Private` _goWithDistinct$

_goWithDistinct$: Subject<void> = ...

`Private` _model$

_model$: BehaviorSubject<ISlicer[]> = ...

Merged parent's filters

`Private` `Optional` _parent

_parent?: SmartFilterBarService

`Readonly` destroy$

destroy$: Observable<void> = ...

`Protected` `Readonly` destroySubject$

destroySubject$: ReplaySubject<void> = ...

`Protected` isInitialized

isInitialized: boolean = false

`Protected` notInitializedErrorMessage

notInitializedErrorMessage: string = ...

`Readonly` slicers$

slicers$: Observable<ISlicer[]> = ...

`Readonly` state$

state$: Observable<SmartFilterBarState> = ...

`Protected` `Readonly` stateSubject$

stateSubject$: ReplaySubject<SmartFilterBarState> = ...

Accessors

slicers

get slicers(): ISlicer[]
Returns ISlicer[]
- Defined in packages/core/src/lib/services/smart-filter-bar.service.ts:34

Methods

change

change(ftrs): void
Parameters
- ftrs: ISlicer[]
Returns void
- Defined in packages/core/src/lib/services/smart-filter-bar.service.ts:92

distinctGo

distinctGo(): void
Go when slicers distinct until changed

Returns void
- Defined in packages/core/src/lib/services/smart-filter-bar.service.ts:84

effect

effect<ProvidedType, OriginType, ObservableType, ReturnType>(generator): ReturnType
Creates an effect.

This effect is subscribed to throughout the lifecycle of the ComponentStore.
Type Parameters
- ProvidedType = void
- OriginType extends unknown = Observable<ProvidedType>
- ObservableType = OriginType extends Observable<A>
  ? A
  : never
- ReturnType = (ProvidedType | ObservableType) extends void
  ? (() => void)
  : ((observableOrValue) => Subscription)
Parameters
- generator: ((origin$) => Observable<unknown>)
  A function that takes an origin Observable input and returns an Observable. The Observable that is returned will be subscribed to for the life of the component.
  - - (origin$): Observable<unknown>
    - Parameters
      origin$: OriginType
      Returns Observable<unknown>
Returns ReturnType
A function that, when called, will trigger the origin Observable.
Inherited from ComponentStore.effect
- Defined in packages/store/src/lib/component-store.ts:271

`Protected` get

get(): SmartFilterBarState
Returns SmartFilterBarState
Inherited from ComponentStore.get
- Defined in packages/store/src/lib/component-store.ts:188
get<R>(projector): R
Type Parameters
- R
Parameters
- projector: ((s) => R)
  - - (s): R
    - Parameters
      s: SmartFilterBarState
      Returns R
Returns R
Inherited from ComponentStore.get
- Defined in packages/store/src/lib/component-store.ts:189

getFilters

getFilters(): ISlicer[]
Returns ISlicer[]
- Defined in packages/core/src/lib/services/smart-filter-bar.service.ts:100

go

go(): void
Explicit call go method to send when slicers changed

Returns void
- Defined in packages/core/src/lib/services/smart-filter-bar.service.ts:77

`Protected` initState

initState(state): void
Initializes state. If it was already initialized then it resets the state.
Parameters
- state: SmartFilterBarState
Returns void
Inherited from ComponentStore.initState
- Defined in packages/store/src/lib/component-store.ts:142

onChange

onChange(): Observable<ISlicer[]>
Returns Observable<ISlicer[]>
- Defined in packages/core/src/lib/services/smart-filter-bar.service.ts:96

onDestroy

onDestroy(): void
Completes all relevant Observable streams.

Returns void
Inherited from ComponentStore.onDestroy
- Defined in packages/store/src/lib/component-store.ts:64

onGo

onGo(): Observable<void>
Returns Observable<void>
- Defined in packages/core/src/lib/services/smart-filter-bar.service.ts:88

patchState

patchState(partialStateOrUpdaterFn): void
Patches the state with provided partial state.
Parameters
- partialStateOrUpdaterFn: Partial<SmartFilterBarState> | Observable<Partial<SmartFilterBarState>> | ((state) => Partial<SmartFilterBarState>)
  a partial state or a partial updater function that accepts the state and returns the partial state.
Returns void
Throws
Error if the state is not initialized.
Inherited from ComponentStore.patchState
- Defined in packages/store/src/lib/component-store.ts:171

put

put(...value): void
Parameters
- Rest ...value: ISlicer[]
Returns void
- Defined in packages/core/src/lib/services/smart-filter-bar.service.ts:104

remove

remove(value): void
Parameters
- value: string | ISlicer
Returns void
- Defined in packages/core/src/lib/services/smart-filter-bar.service.ts:114

select

select<Result>(projector, config?): Observable<Result>
Creates a selector.
Type Parameters
- Result
Parameters
- projector: ((s) => Result)
  A pure projection function that takes the current state and returns some new slice/projection of that state.
  - - (s): Result
    - Parameters
      s: SmartFilterBarState
      Returns Result
- Optional config: SelectConfig
  SelectConfig that changes the behavior of selector, including the debouncing of the values until the state is settled.
Returns Observable<Result>
An observable of the projector results.
Inherited from ComponentStore.select
- Defined in packages/store/src/lib/component-store.ts:212
select<Selectors, Result>(...args): Observable<Result>
Type Parameters
- Selectors extends Observable<unknown>[]
- Result
Parameters
- Rest ...args: [...selectors: Selectors[], projector: Projector<Selectors, Result>]
Returns Observable<Result>
Inherited from ComponentStore.select
- Defined in packages/store/src/lib/component-store.ts:216
select<Selectors, Result>(...args): Observable<Result>
Type Parameters
- Selectors extends Observable<unknown>[]
- Result
Parameters
- Rest ...args: [...selectors: Selectors[], projector: Projector<Selectors, Result>, config: SelectConfig]
Returns Observable<Result>
Inherited from ComponentStore.select
- Defined in packages/store/src/lib/component-store.ts:219

setState

setState(stateOrUpdaterFn): void
Sets the state specific value.
Parameters
- stateOrUpdaterFn: SmartFilterBarState | ((state) => SmartFilterBarState)
  object of the same type as the state or an updaterFn, returning such object.
Returns void
Inherited from ComponentStore.setState
- Defined in packages/store/src/lib/component-store.ts:156

sync

sync(source, options?): void
Parameters
- source: ComponentStore<SmartFilterBarState>
- Optional options: {
  watchProperty?: never[];
  }
  - Optional watchProperty?: never[]
Returns void
Inherited from ComponentStore.sync
- Defined in packages/store/src/lib/component-store.ts:306

updater

updater<ProvidedType, OriginType, ValueType, ReturnType>(updaterFn): ReturnType
Creates an updater.

Throws an error if updater is called with synchronous values (either imperative value or Observable that is synchronous) before ComponentStore is initialized. If called with async Observable before initialization then state will not be updated and subscription would be closed.
Type Parameters
- ProvidedType = void
- OriginType = ProvidedType
- ValueType = OriginType
- ReturnType = OriginType extends void
  ? (() => void)
  : ((observableOrValue) => Subscription)
Parameters
- updaterFn: ((state, value) => void | SmartFilterBarState)
  A static updater function that takes 2 parameters (the current state and an argument object) and returns a new instance of the state.
  - - (state, value): void | SmartFilterBarState
    - Parameters
      state: SmartFilterBarState
      value: OriginType
      Returns void | SmartFilterBarState
Returns ReturnType
A function that accepts one argument which is forwarded as the second argument to updaterFn. Every time this function is called subscribers will be notified of the state change.
Inherited from ComponentStore.updater
- Defined in packages/store/src/lib/component-store.ts:84

Class SmartFilterBarService

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Parameters

Optional _parent: SmartFilterBarService

Returns SmartFilterBarService

Properties

Private _filters$

Private _go$

Private _goWithDistinct$

Private _model$

Private Optional _parent

Readonly destroy$

Protected Readonly destroySubject$

Protected isInitialized

Protected notInitializedErrorMessage

Readonly slicers$

Readonly state$

Protected Readonly stateSubject$

Accessors

slicers

Returns ISlicer[]

Methods

change

Parameters

ftrs: ISlicer[]

Returns void

distinctGo

Returns void

effect

Type Parameters

ProvidedType = void

OriginType extends unknown = Observable<ProvidedType>

ObservableType = OriginType extends Observable<A> ? A : never

ReturnType = (ProvidedType | ObservableType) extends void ? (() => void) : ((observableOrValue) => Subscription)

Parameters

generator: ((origin$) => Observable<unknown>)

Parameters

origin$: OriginType

Returns Observable<unknown>

Returns ReturnType

Protected get

Returns SmartFilterBarState

Type Parameters

R

Parameters

projector: ((s) => R)

Parameters

s: SmartFilterBarState

Returns R

Returns R

getFilters

Returns ISlicer[]

go

Returns void

Protected initState

Parameters

state: SmartFilterBarState

Returns void

onChange

Returns Observable<ISlicer[]>

onDestroy

Returns void

onGo

Returns Observable<void>

patchState

Parameters

partialStateOrUpdaterFn: Partial<SmartFilterBarState> | Observable<Partial<SmartFilterBarState>> | ((state) => Partial<SmartFilterBarState>)

Returns void

Throws

put

Parameters

Rest ...value: ISlicer[]

Returns void

`Optional` _parent: SmartFilterBarService

`Private` _filters$

`Private` _go$

`Private` _goWithDistinct$

`Private` _model$

`Private` `Optional` _parent

`Readonly` destroy$

`Protected` `Readonly` destroySubject$

`Protected` isInitialized

`Protected` notInitializedErrorMessage

`Readonly` slicers$

`Readonly` state$

`Protected` `Readonly` stateSubject$

ObservableType = OriginType extends Observable<A>
? A
: never

ReturnType = (ProvidedType | ObservableType) extends void
? (() => void)
: ((observableOrValue) => Subscription)

`Protected` get

`Protected` initState

`Rest` ...value: ISlicer[]

`Optional` config: SelectConfig

`Rest` ...args: [...selectors: Selectors[], projector: Projector<Selectors, Result>]

`Rest` ...args: [...selectors: Selectors[], projector: Projector<Selectors, Result>, config: SelectConfig]

`Optional` options: {
watchProperty?: never[];
}

`Optional` watchProperty?: never[]

ReturnType = OriginType extends void
? (() => void)
: ((observableOrValue) => Subscription)