Class AnalyticsBusinessService<T>

Service 初始化过程的通用接口

Type Parameters

Hierarchy

SmartBusinessService<T>
- AnalyticsBusinessService

Constructors

constructor

new AnalyticsBusinessService<T>(dsCoreService, smartFilterBar?): AnalyticsBusinessService<T>
Type Parameters
- T
Parameters
- dsCoreService: DSCoreService
- Optional smartFilterBar: SmartFilterBarService
Returns AnalyticsBusinessService<T>
Inherited from SmartBusinessService.constructor
- Defined in packages/core/src/lib/services/smart-business.service.ts:45

Properties

`Protected` id

__id__: string

`Readonly` _dataSource$

_dataSource$: Observable<string> = ...

`Readonly` analytics$

analytics$: Observable<{
    columns: ({
        caption?: string;
        dimension?: string;
        displayBehaviour?: DisplayBehaviour;
        displayHierarchy?: boolean;
        exclude?: boolean;
        hierarchy?: string;
        label?: string;
        level?: string;
        memberCaption?: string;
        members?: Member[];
        name?: string;
        order?: OrderDirection;
        parameter?: string;
        properties?: string[];
        property: Property | PropertyHierarchy;
        unbookedData?: boolean;
        zeroSuppression?: boolean;
    } | {
        caption?: string;
        dimension?: string;
        domain?: [number, number?];
        formatting?: {
            currencyCode?: string;
            decimal?: number;
            digitsInfo?: string;
            shortNumber?: boolean;
            unit?: string;
            useUnderlyingUnit?: boolean;
        };
        measure: string;
        members?: Member[];
        order?: OrderDirection;
        palette?: {
            colors?: string[];
            name?: string;
            pattern?: any;
            reverse?: boolean;
        };
        property: Property | PropertyHierarchy;
    })[];
    rows: ({
        caption?: string;
        dimension?: string;
        displayBehaviour?: DisplayBehaviour;
        displayHierarchy?: boolean;
        exclude?: boolean;
        hierarchy?: string;
        label?: string;
        level?: string;
        memberCaption?: string;
        members?: Member[];
        name?: string;
        order?: OrderDirection;
        parameter?: string;
        properties?: string[];
        property: Property | PropertyHierarchy;
        unbookedData?: boolean;
        zeroSuppression?: boolean;
    } | {
        caption?: string;
        dimension?: string;
        domain?: [number, number?];
        formatting?: {
            currencyCode?: string;
            decimal?: number;
            digitsInfo?: string;
            shortNumber?: boolean;
            unit?: string;
            useUnderlyingUnit?: boolean;
        };
        measure: string;
        members?: Member[];
        order?: OrderDirection;
        palette?: {
            colors?: string[];
            name?: string;
            pattern?: any;
            reverse?: boolean;
        };
        property: Property | PropertyHierarchy;
    })[];
}> = ...

合并相应 Entity Property 后的 Analytics 注解

Type declaration

columns: ({
    caption?: string;
    dimension?: string;
    displayBehaviour?: DisplayBehaviour;
    displayHierarchy?: boolean;
    exclude?: boolean;
    hierarchy?: string;
    label?: string;
    level?: string;
    memberCaption?: string;
    members?: Member[];
    name?: string;
    order?: OrderDirection;
    parameter?: string;
    properties?: string[];
    property: Property | PropertyHierarchy;
    unbookedData?: boolean;
    zeroSuppression?: boolean;
} | {
    caption?: string;
    dimension?: string;
    domain?: [number, number?];
    formatting?: {
        currencyCode?: string;
        decimal?: number;
        digitsInfo?: string;
        shortNumber?: boolean;
        unit?: string;
        useUnderlyingUnit?: boolean;
    };
    measure: string;
    members?: Member[];
    order?: OrderDirection;
    palette?: {
        colors?: string[];
        name?: string;
        pattern?: any;
        reverse?: boolean;
    };
    property: Property | PropertyHierarchy;
})[]
rows: ({
    caption?: string;
    dimension?: string;
    displayBehaviour?: DisplayBehaviour;
    displayHierarchy?: boolean;
    exclude?: boolean;
    hierarchy?: string;
    label?: string;
    level?: string;
    memberCaption?: string;
    members?: Member[];
    name?: string;
    order?: OrderDirection;
    parameter?: string;
    properties?: string[];
    property: Property | PropertyHierarchy;
    unbookedData?: boolean;
    zeroSuppression?: boolean;
} | {
    caption?: string;
    dimension?: string;
    domain?: [number, number?];
    formatting?: {
        currencyCode?: string;
        decimal?: number;
        digitsInfo?: string;
        shortNumber?: boolean;
        unit?: string;
        useUnderlyingUnit?: boolean;
    };
    measure: string;
    members?: Member[];
    order?: OrderDirection;
    palette?: {
        colors?: string[];
        name?: string;
        pattern?: any;
        reverse?: boolean;
    };
    property: Property | PropertyHierarchy;
})[]

`Readonly` analyticsAnnotation$

analyticsAnnotation$: Observable<AnalyticsAnnotation> = ...

`Readonly` dataSettings$

dataSettings$: Observable<DataSettings> = ...

`Readonly` dataSource$

dataSource$: Observable<DataSource> = ...

`Readonly` destroy$

destroy$: Observable<void> = ...

`Protected` `Readonly` destroySubject$

destroySubject$: ReplaySubject<void> = ...

dsCoreService

dsCoreService: DSCoreService

`Protected` entityService$

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

`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> = ...

`Protected` notInitializedErrorMessage

notInitializedErrorMessage: string = ...

`Readonly` presentationVariant$

presentationVariant$: Observable<PresentationVariant> = ...

`Protected` refresh$

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

`Protected` result$

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

`Optional` smartFilterBar

smartFilterBar?: SmartFilterBarService

`Readonly` state$

state$: Observable<EntityBusinessState> = ...

`Protected` `Readonly` stateSubject$

stateSubject$: ReplaySubject<EntityBusinessState> = ...

Accessors

analyticsAnnotation

get analyticsAnnotation(): AnalyticsAnnotation
Returns AnalyticsAnnotation
- Defined in packages/core/src/lib/services/analytics.service.ts:14

dataSettings

get dataSettings(): DataSettings
Returns DataSettings
Inherited from SmartBusinessService.dataSettings
- Defined in packages/core/src/lib/services/entity-business.service.ts:42
set dataSettings(value): void
Parameters
- value: DataSettings
Returns void
Inherited from SmartBusinessService.dataSettings
- Defined in packages/core/src/lib/services/entity-business.service.ts:45

entityService

get entityService(): EntityService<T>
Returns EntityService<T>
Inherited from SmartBusinessService.entityService
- Defined in packages/core/src/lib/services/entity-business.service.ts:109

presentationVariant

get presentationVariant(): PresentationVariant
Returns PresentationVariant
Inherited from SmartBusinessService.presentationVariant
- Defined in packages/core/src/lib/services/entity-business.service.ts:75
set presentationVariant(value): void
Parameters
- value: PresentationVariant
Returns void
Inherited from SmartBusinessService.presentationVariant
- Defined in packages/core/src/lib/services/entity-business.service.ts:78

selectionVariant

get selectionVariant(): SelectionVariant
Returns SelectionVariant
Inherited from SmartBusinessService.selectionVariant
- Defined in packages/core/src/lib/services/entity-business.service.ts:69
set selectionVariant(value): void
Parameters
- value: SelectionVariant
Returns void
Inherited from SmartBusinessService.selectionVariant
- Defined in packages/core/src/lib/services/entity-business.service.ts:72

slicers

get slicers(): (string | ISlicer | IFilter | IAdvancedFilter)[]
Returns (string | ISlicer | IFilter | IAdvancedFilter)[]
Inherited from SmartBusinessService.slicers
- Defined in packages/core/src/lib/services/entity-business.service.ts:83
set slicers(value): void
Parameters
- value: (string | ISlicer | IFilter | IAdvancedFilter)[]
Returns void
Inherited from SmartBusinessService.slicers
- Defined in packages/core/src/lib/services/entity-business.service.ts:86

Methods

calculateFilters

calculateFilters(queryOptions?): QueryOptions<any>
过滤器存在优先级覆盖顺序
1. queryOptions 指定的过滤器
2. FilterBar 中选择的过滤器
3. SelectionVariant 中指定的过滤器
Parameters
- Optional queryOptions: QueryOptions<any>
Returns QueryOptions<any>
Inherited from SmartBusinessService.calculateFilters
- Defined in packages/core/src/lib/services/smart-business.service.ts:89

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 SmartBusinessService.effect
- Defined in packages/store/src/lib/component-store.ts:271

`Protected` get

get(): EntityBusinessState
Returns EntityBusinessState
Inherited from SmartBusinessService.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: EntityBusinessState
      Returns R
Returns R
Inherited from SmartBusinessService.get
- Defined in packages/store/src/lib/component-store.ts:189

getAnnotation

getAnnotation<AT>(term, qualifier?): Observable<AT>
Type Parameters
- AT extends Annotation
Parameters
- term: AnnotationTerm
- Optional qualifier: string
Returns Observable<AT>
Inherited from SmartBusinessService.getAnnotation
- Defined in packages/core/src/lib/services/entity-business.service.ts:281

getCalculatedMember

getCalculatedMember(measure, type, calendar?): Property
Parameters
- measure: string
- type: PeriodFunctions
- Optional calendar: string
Returns Property
Inherited from SmartBusinessService.getCalculatedMember
- Defined in packages/core/src/lib/services/entity-business.service.ts:285

getEntityType

getEntityType(): Promise<EntityType>
Returns Promise<EntityType>
Experiment
使用 async await 方式作为 getXXX method 的异步处理方式; 用 Observable 作为 selectXXX method 的异步处理方式;
Inherited from SmartBusinessService.getEntityType
- Defined in packages/core/src/lib/services/entity-business.service.ts:198

getIndicator

getIndicator(id): Indicator
Parameters
- id: string
Returns Indicator
Inherited from SmartBusinessService.getIndicator
- Defined in packages/core/src/lib/services/entity-business.service.ts:289

getProperty

getProperty(name): Promise<Property>
Parameters
- name: string | Dimension | Measure
Returns Promise<Property>
Experiment
使用 async await 方式作为 getXXX method 的异步处理方式
Inherited from SmartBusinessService.getProperty
- Defined in packages/core/src/lib/services/entity-business.service.ts:207

`Protected` initState

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

`Protected` isMeetRequired

isMeetRequired(analytics): boolean
Parameters
- analytics: AnalyticsAnnotation
Returns boolean
- Defined in packages/core/src/lib/services/analytics.service.ts:56

onAfterServiceInit

onAfterServiceInit(): Observable<void>
可监听的初始化完成状态

Returns Observable<void>
Inherited from SmartBusinessService.onAfterServiceInit
- Defined in packages/core/src/lib/services/smart-business.service.ts:62

onDestroy

onDestroy(): void
Completes all relevant Observable streams.

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

onInit

onInit(): Observable<any>
Service 初始化, 判断满足条件后才能往后发送事件, 否则可能造成后续逻辑报错

Returns Observable<any>
Overrides SmartBusinessService.onInit
- Defined in packages/core/src/lib/services/analytics.service.ts:38

patchState

patchState(partialStateOrUpdaterFn): void
Patches the state with provided partial state.
Parameters
- partialStateOrUpdaterFn: Partial<EntityBusinessState> | Observable<Partial<EntityBusinessState>> | ((state) => Partial<EntityBusinessState>)
  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 SmartBusinessService.patchState
- Defined in packages/store/src/lib/component-store.ts:171

query

query(options?): Observable<QueryReturn<T>>
Parameters
- Optional options: QueryOptions<any>
Returns Observable<QueryReturn<T>>
Inherited from SmartBusinessService.query
- Defined in packages/core/src/lib/services/entity-business.service.ts:215

refresh

refresh(force?): void
Parameters
- Optional force: boolean
Returns void
Inherited from SmartBusinessService.refresh
- Defined in packages/core/src/lib/services/entity-business.service.ts:269

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: EntityBusinessState
      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 SmartBusinessService.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 SmartBusinessService.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 SmartBusinessService.select
- Defined in packages/store/src/lib/component-store.ts:219

selectEntityType

selectEntityType(): Observable<EntityType>
Returns Observable<EntityType>
Inherited from SmartBusinessService.selectEntityType
- Defined in packages/core/src/lib/services/entity-business.service.ts:211

selectQuery

selectQuery(options?): Observable<QueryReturn<T>>
如果先改变查询条件和逻辑，可以在子类中重写此方法
Parameters
- Optional options: QueryOptions<any>
  QueryOptions
Returns Observable<QueryReturn<T>>
Overrides SmartBusinessService.selectQuery
- Defined in packages/core/src/lib/services/analytics.service.ts:46

selectResult

selectResult(): Observable<QueryReturn<T>>
Returns Observable<QueryReturn<T>>
Inherited from SmartBusinessService.selectResult
- Defined in packages/core/src/lib/services/entity-business.service.ts:273

setState

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

sync

sync(source, options?): void
Parameters
- source: ComponentStore<EntityBusinessState>
- Optional options: {
  watchProperty?: keyof EntityBusinessState | (keyof EntityBusinessState)[];
  }
  - Optional watchProperty?: keyof EntityBusinessState | (keyof EntityBusinessState)[]
Returns void
Inherited from SmartBusinessService.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 | EntityBusinessState)
  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 | EntityBusinessState
    - Parameters
      state: EntityBusinessState
      value: OriginType
      Returns void | EntityBusinessState
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 SmartBusinessService.updater
- Defined in packages/store/src/lib/component-store.ts:84

Class AnalyticsBusinessService<T>

Type Parameters

T

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Type Parameters

T

Parameters

dsCoreService: DSCoreService

Optional smartFilterBar: SmartFilterBarService

Returns AnalyticsBusinessService<T>

Properties

Protected __id__

Readonly _dataSource$

Readonly analytics$

Type declaration

Readonly analyticsAnnotation$

Readonly dataSettings$

Readonly dataSource$

Readonly destroy$

Protected Readonly destroySubject$

dsCoreService

Protected entityService$

Readonly entitySet$

entityType

Deprecated

Readonly initialise$

internalError$

Protected isInitialized

loading$

Protected notInitializedErrorMessage

Readonly presentationVariant$

Protected refresh$

Protected result$

Optional smartFilterBar

Readonly state$

Protected Readonly stateSubject$

Accessors

analyticsAnnotation

Returns AnalyticsAnnotation

dataSettings

Returns DataSettings

Parameters

value: DataSettings

Returns void

entityService

Returns EntityService<T>

presentationVariant

Returns PresentationVariant

Parameters

value: PresentationVariant

Returns void

selectionVariant

Returns SelectionVariant

Parameters

value: SelectionVariant

Returns void

slicers

Returns (string | ISlicer | IFilter | IAdvancedFilter)[]

Parameters

value: (string | ISlicer | IFilter | IAdvancedFilter)[]

Returns void

Methods

calculateFilters

Parameters

Optional queryOptions: QueryOptions<any>

Returns QueryOptions<any>

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

`Optional` smartFilterBar: SmartFilterBarService

`Protected` id

`Readonly` _dataSource$

`Readonly` analytics$

`Readonly` analyticsAnnotation$

`Readonly` dataSettings$

`Readonly` dataSource$

`Readonly` destroy$

`Protected` `Readonly` destroySubject$

`Protected` entityService$

`Readonly` entitySet$

`Readonly` initialise$

`Protected` isInitialized

`Protected` notInitializedErrorMessage

`Readonly` presentationVariant$

`Protected` refresh$

`Protected` result$

`Optional` smartFilterBar

`Readonly` state$

`Protected` `Readonly` stateSubject$

`Optional` queryOptions: QueryOptions<any>

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

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

`Protected` get

`Optional` qualifier: string

`Optional` calendar: string

`Protected` initState

`Protected` isMeetRequired

`Optional` options: QueryOptions<any>

`Optional` force: boolean