Class SmartFilterService<State>

是否需要对 SelectOptions 进行响应过滤 Dimension Members

Type Parameters

Hierarchy

Constructors

constructor

Properties

__id__ _dataSource$ dataSettings$ dataSource$ destroy$ destroySubject$ dimension$ dsCoreService entityService$ entitySet$ entityType initialise$ internalError$ isInitialized loading$ membersTree$ membersWithSchema$ notInitializedErrorMessage presentationVariant$ refresh$ result$ selectOptions$ showAllMember$ smartFilterBar? state$ stateSubject$

Accessors

dataSettings dimension entityService options presentationVariant selectionVariant slicers

Methods

calculateFilters effect get getAnnotation getCalculatedMember getEntityType getIndicator getProperty initState onAfterServiceInit onDestroy onInit patchState query refresh select selectEntityType selectQuery selectResult setState sync updater

Constructors

constructor

Properties

Protected __id__

__id__: string

Readonly _dataSource$

_dataSource$: Observable<string> = ...

Readonly dataSettings$

dataSettings$: Observable<DataSettings> = ...

Readonly dataSource$

dataSource$: Observable<DataSource> = ...

Readonly destroy$

destroy$: Observable<void> = ...

Protected Readonly destroySubject$

destroySubject$: ReplaySubject<void> = ...

Readonly dimension$

dimension$: Observable<Dimension> = ...

dsCoreService

dsCoreService: DSCoreService

Protected entityService$

entityService$: BehaviorSubject<EntityService<IDimensionMember>> = ...

Readonly entitySet$

entitySet$: Observable<string> = ...

entityType

entityType: EntityType

Deprecated

use getEntityType or selectEntityType method

Readonly initialise$

initialise$: Observable<boolean> = ...

internalError$

internalError$: ReplaySubject<any> = ...

Protected isInitialized

isInitialized: boolean = false

loading$

loading$: BehaviorSubject<boolean> = ...

Readonly membersTree$

membersTree$: Observable<TreeNodeInterface<IDimensionMember>[]> = ...

Readonly membersWithSchema$

membersWithSchema$: Observable<{
    members: IDimensionMember[];
    schema: EntitySchema;
}> = ...

Type declaration

Protected notInitializedErrorMessage

notInitializedErrorMessage: string = ...

Readonly presentationVariant$

presentationVariant$: Observable<PresentationVariant> = ...

Protected refresh$

refresh$: ReplaySubject<boolean | void> = ...

Protected result$

result$: BehaviorSubject<QueryReturn<IDimensionMember>> = ...

Readonly selectOptions$

selectOptions$: Observable<IMember[]> = ...

Readonly showAllMember$

showAllMember$: Observable<boolean> = ...

Optional smartFilterBar

smartFilterBar?: SmartFilterBarService

Readonly state$

state$: Observable<State> = ...

Protected Readonly stateSubject$

stateSubject$: ReplaySubject<State> = ...

Accessors

dataSettings

dimension

entityService

options

presentationVariant

selectionVariant

slicers

Methods

calculateFilters

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.

Protected get

getAnnotation

getCalculatedMember

getEntityType

getIndicator

getProperty

Protected initState

onAfterServiceInit

onDestroy

onInit

patchState

  • patchState(partialStateOrUpdaterFn): void

  • Patches the state with provided partial state.

    Parameters

    • partialStateOrUpdaterFn: Partial<State> | Observable<Partial<State>> | ((state) => Partial<State>)

      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.

query

refresh

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: State

          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.

  • 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>

  • 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>

selectEntityType

selectQuery

  • selectQuery(options?): Observable<{
        data: IDimensionMember[];
        schema: {
            columns: {
                label: string;
                name: string;
                type: string;
            }[];
            recursiveHierarchy: {
                descendantCountProperty: string;
                externalKeyProperty: string;
                labelProperty: string;
                levelProperty: string;
                memberTypeProperty: string;
                parentNodeProperty: string;
                valueProperty: string;
            };
        };
    }> | Observable<{
        data: {
            dimension: string;
            hierarchy: string;
            memberCaption: any;
            memberKey: any;
            parentKey: any;
        }[];
        schema: {
            columns: {
                label: string;
                name: string;
                type: string;
            }[];
            recursiveHierarchy: {
                descendantCountProperty: string;
                externalKeyProperty: string;
                labelProperty: string;
                levelProperty: string;
                memberTypeProperty: string;
                parentNodeProperty: string;
                valueProperty: string;
            };
        };
    }>

  • 如果先改变查询条件和逻辑，可以在子类中重写此方法

    Parameters

    Returns Observable<{
        data: IDimensionMember[];
        schema: {
            columns: {
                label: string;
                name: string;
                type: string;
            }[];
            recursiveHierarchy: {
                descendantCountProperty: string;
                externalKeyProperty: string;
                labelProperty: string;
                levelProperty: string;
                memberTypeProperty: string;
                parentNodeProperty: string;
                valueProperty: string;
            };
        };
    }> | Observable<{
        data: {
            dimension: string;
            hierarchy: string;
            memberCaption: any;
            memberKey: any;
            parentKey: any;
        }[];
        schema: {
            columns: {
                label: string;
                name: string;
                type: string;
            }[];
            recursiveHierarchy: {
                descendantCountProperty: string;
                externalKeyProperty: string;
                labelProperty: string;
                levelProperty: string;
                memberTypeProperty: string;
                parentNodeProperty: string;
                valueProperty: string;
            };
        };
    }>

selectResult

setState

sync

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 | State)

      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 | State

        • Parameters

          • state: State
          • value: OriginType

          Returns void | State

    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.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc