Web SDK documentation
  1. Injectables
  2. GlobalContextInlineOrchestratorService

File

global-context/core/widget-inline/orchestrator/global-context-inline-orchestrator.service.ts

Index

Properties
Methods

Constructor

constructor()

Methods

adjustAggregationForDateTime
adjustAggregationForDateTime(params: literal type)
Parameters :
Name Type Optional
params literal type No
Returns : literal type
applyRefreshOptionChange
applyRefreshOptionChange(params: literal type)
Parameters :
Name Type Optional
params literal type No
Returns : literal type
calculateAggregation
calculateAggregation(dateTimeContext: DateTimeContext | null | undefined, currentAggregation: aggregationType | null | undefined)
Parameters :
Name Type Optional
dateTimeContext DateTimeContext | null | undefined No
currentAggregation aggregationType | null | undefined No
Returns : aggregationType | null
computeEffectiveConfig
computeEffectiveConfig(baseConfig: GlobalContextState | null | undefined)
Parameters :
Name Type Optional
baseConfig GlobalContextState | null | undefined No
Returns : GlobalContextState
deriveAggregationValue
deriveAggregationValue(config: GlobalContextState | null | undefined)
Parameters :
Name Type Optional
config GlobalContextState | null | undefined No
Returns : aggregationType | null
emitConfiguration
emitConfiguration(componentId: string, configuration: GlobalContextState | null | undefined)
Parameters :
Name Type Optional
componentId string No
configuration GlobalContextState | null | undefined No
Returns : GlobalContextState
executeHandler
executeHandler(context: ExecuteHandlerContext)
Parameters :
Name Type Optional
context ExecuteHandlerContext No
Returns : void
getAggregationUnlinkReason
getAggregationUnlinkReason()
Returns : AggregationUnlinkReason | null
getConfigSnapshot
getConfigSnapshot()
Returns : GlobalContextState
getDisplayMode
getDisplayMode()
Returns : WidgetDisplayMode
getFieldSources
getFieldSources()
Returns : FieldSourcesMap
getGlobalState
getGlobalState()
Returns : Partial<GlobalContextState>
getLatestVisibility
getLatestVisibility()
Returns : VisibilityContext | null
getLinkDisableReasons
getLinkDisableReasons()
Returns : Partial<Record<GlobalContextState, string>>
getLocalState
getLocalState()
Returns : Partial<GlobalContextState>
handleFormChange
handleFormChange(context: HandleFormChangeContext)
Parameters :
Name Type Optional
context HandleFormChangeContext No
Returns : void
handleGlobalStateChange
handleGlobalStateChange(context: HandleGlobalStateChangeContext)
Parameters :
Name Type Optional
context HandleGlobalStateChangeContext No
Returns : void
initConfig
initConfig(config: GlobalContextState | null | undefined)
Parameters :
Name Type Optional
config GlobalContextState | null | undefined No
Returns : void
initializeStateAndSources
initializeStateAndSources(params: literal type)
Parameters :
Name Type Optional
params literal type No
Returns : void
initWidgetControls
initWidgetControls(controls: WidgetControls | null | undefined)
Parameters :
Name Type Optional
controls WidgetControls | null | undefined No
Returns : void
ngOnDestroy
ngOnDestroy()
Returns : void
processGlobalStateChange
processGlobalStateChange(state: Partial, sources: FieldSourcesMap)
Parameters :
Name Type Optional
state Partial<GlobalContextState> No
sources FieldSourcesMap No
Returns : Partial<GlobalContextState>
processRefresh
processRefresh(params: literal type)
Parameters :
Name Type Optional
params literal type No
Returns : RefreshResult
resolveAggregationChangeForForm
resolveAggregationChangeForForm(params: literal type)
Parameters :
Name Type Optional
params literal type No
Returns : AggregationChangeInstruction | null
resolveVisibilityContext
resolveVisibilityContext(config: GlobalContextState | null | undefined)
Parameters :
Name Type Optional
config GlobalContextState | null | undefined No
Returns : VisibilityContext | null
setDisplayMode
setDisplayMode(mode: WidgetDisplayMode | null | undefined)
Parameters :
Name Type Optional
mode WidgetDisplayMode | null | undefined No
Returns : void
setFieldSources
setFieldSources(value: FieldSourcesMap)
Parameters :
Name Type Optional
value FieldSourcesMap No
Returns : void
setGlobalState
setGlobalState(state: Partial)
Parameters :
Name Type Optional
state Partial<GlobalContextState> No
Returns : void
setLoading
setLoading(isLoading: boolean)
Parameters :
Name Type Optional
isLoading boolean No
Returns : void
setLocalState
setLocalState(state: Partial)
Parameters :
Name Type Optional
state Partial<GlobalContextState> No
Returns : void
shouldValidateAggregationForUnlinkedDateTime
shouldValidateAggregationForUnlinkedDateTime(state: Partial, sources: FieldSourcesMap)
Parameters :
Name Type Optional
state Partial<GlobalContextState> No
sources FieldSourcesMap No
Returns : boolean
toggleAllLinks
toggleAllLinks(args: literal type)
Parameters :
Name Type Optional
args literal type No
Returns : LinkToggleOutcome
toggleLink
toggleLink(args: literal type)
Parameters :
Name Type Optional
args literal type No
Returns : LinkToggleOutcome
updateFieldSources
updateFieldSources(updater: (sources: FieldSourcesMap) => void)
Parameters :
Name Type Optional
updater function No
Returns : void
updateGlobalState
updateGlobalState(updater: (state: Partial) => void)
Parameters :
Name Type Optional
updater function No
Returns : void
updateGlobalStateFromForm
updateGlobalStateFromForm(formValue: Partial, sources: FieldSourcesMap)
Parameters :
Name Type Optional
formValue Partial<GlobalContextState> No
sources FieldSourcesMap No
Returns : void
updateLocalState
updateLocalState(updater: (state: Partial) => void)
Parameters :
Name Type Optional
updater function No
Returns : void
validateAggregationLink
validateAggregationLink(context: AggregationValidationContext)
Parameters :
Name Type Optional
context AggregationValidationContext No
Returns : AggregationValidationResult

Properties

Readonly globalContextChange$
Default value : new Subject<GlobalContextEvent>()
Readonly refresh$
Default value : new Subject<void>()

results matching ""

    No results matching ""