Class SmartEChartEngine

Hierarchy

  • SmartChartEngine<SmartChartEngineState>
    • SmartEChartEngine

Constructors

constructor

Properties

chartAnnotation$ chartClick$ chartContextMenu$ chartHighlight$ context data$ destroy$ destroySubject$ echartsInstance$ echartsOptions$ entityType$ error$ isInitialized notInitializedErrorMessage options$ selectChanged$ settings$ state$ stateSubject$

Accessors

chartAnnotation data echarts entityType options settings setttings

Methods

changeData createLazyEvent dispatchAction effect get initState onChartOptions onDestroy patchState processData select selectChartOptions setState sync updater

Constructors

constructor

Properties

Readonly chartAnnotation$

chartAnnotation$: Observable<ChartAnnotation> = ...

Readonly chartClick$

chartClick$: Observable<any> = ...

Readonly chartContextMenu$

chartContextMenu$: Observable<EChartEngineEvent> = ...

Readonly chartHighlight$

chartHighlight$: Observable<unknown> = ...

Private context

context: EChartsContext

Readonly data$

data$: Observable<QueryReturn<unknown>> = ...

Readonly destroy$

destroy$: Observable<void> = ...

Protected Readonly destroySubject$

destroySubject$: ReplaySubject<void> = ...

Protected echartsInstance$

echartsInstance$: BehaviorSubject<EChartsType> = ...

Readonly echartsOptions$

echartsOptions$: Observable<{
    error?: undefined;
    options: any;
} | {
    error: any;
    options?: undefined;
}> = ...

Readonly entityType$

entityType$: Observable<EntityType> = ...

Readonly error$

error$: BehaviorSubject<any> = ...

Protected isInitialized

isInitialized: boolean = false

Protected notInitializedErrorMessage

notInitializedErrorMessage: string = ...

Readonly options$

options$: Observable<ChartOptions> = ...

Readonly selectChanged$

selectChanged$: Observable<any> = ...

https://echarts.apache.org/en/api.html#events.selectchanged

Readonly settings$

settings$: Observable<ChartSettings> = ...

Readonly state$

state$: Observable<SmartChartEngineState> = ...

Protected Readonly stateSubject$

stateSubject$: ReplaySubject<SmartChartEngineState> = ...

Accessors

chartAnnotation

data

echarts

entityType

options

settings

setttings

Methods

changeData

Protected createLazyEvent

dispatchAction

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

Protected initState

  • initState(state): void

  • Initializes state. If it was already initialized then it resets the state.

    Parameters

    • state: SmartChartEngineState

    Returns void

onChartOptions

onDestroy

patchState

  • patchState(partialStateOrUpdaterFn): void

  • Patches the state with provided partial state.

    Parameters

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

      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.

processData

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

          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>

selectChartOptions

  • selectChartOptions(): Observable<{
        error?: undefined;
        options: any;
    } | {
        error: any;
        options?: undefined;
    }>

  • Returns Observable<{
        error?: undefined;
        options: any;
    } | {
        error: any;
        options?: undefined;
    }>

setState

  • setState(stateOrUpdaterFn): void

  • Sets the state specific value.

    Parameters

    • stateOrUpdaterFn: SmartChartEngineState | ((state) => SmartChartEngineState)

      object of the same type as the state or an updaterFn, returning such object.

    Returns void

sync

  • sync(source, options?): void

  • Parameters

    • source: ComponentStore<SmartChartEngineState>
    • Optional options: {
          watchProperty?: keyof SmartChartEngineState | (keyof SmartChartEngineState)[];
      }
      • Optional watchProperty?: keyof SmartChartEngineState | (keyof SmartChartEngineState)[]

    Returns void

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

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

        • Parameters

          • state: SmartChartEngineState
          • value: OriginType

          Returns void | SmartChartEngineState

    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