src/lib/services/sz-how-ui.service.ts
Provides methods, eventing, and utilities used to display the result of a "How" operation. A "How" report displays all the steps that were taken to resolve multiple input streams to a single entity.
Properties |
|
Methods |
|
Accessors |
constructor(configDataService: SzConfigDataService, entityDataService: SzEntityDataService, prefs: SzPrefsService)
|
||||||||||||
Sets up the service class and sets the "entityDataService" injected in to it to a static reference so static methods can have access to the injected services.
Parameters :
|
Public clear |
clear()
|
clear out any data previously loaded. call this method when a new entity is loaded
Returns :
void
|
Public collapseAll | ||||||||||||
collapseAll(idsToExclude?: string | string[], emitEvent?: boolean)
|
||||||||||||
Collapse all nodes and groups currently expanded.
Parameters :
Returns :
void
|
Public collapseNode | ||||||||||||||||
collapseNode(id: string, itemType?: SzResolutionStepListItemType, debug?: boolean)
|
||||||||||||||||
Collapse a node found in either "stepNodes" represents a step or "170e0833-0522-406d-bf07-1c50e7" uid string if step group wrapper that isn't an actual resolution step itself. actually "GROUP"'s, this parameter allows you to specify between node's and groups with the same ID's.
Parameters :
Returns :
void
|
Public expandChildNodes | ||||||||||||||||
expandChildNodes(groupId, itemType?: SzResolutionStepListItemType, childNodeTypes?: SzResolutionStepListItemType[])
|
||||||||||||||||
Expand all children of a specific node group. an Interim entity might have the same Id as a step inside of that node. This allows you to specify that you want just the group or the node inside the group.
Parameters :
Returns :
void
|
expandNode | ||||||||||||||||
expandNode(id: string, itemType?: SzResolutionStepListItemType, debug?: boolean)
|
||||||||||||||||
Expand a node found in "stepNodes" represents a step or "170e0833-0522-406d-bf07-1c50e7" uid string if step group wrapper that isn't an actual resolution step itself. actually "GROUP"'s, this parameter allows you to specify between node's and groups with the same ID's.
Parameters :
Returns :
void
|
Static getHowDataForEntity | ||||||
getHowDataForEntity(entityId: SzEntityIdentifier)
|
||||||
Query the
Parameters :
Returns :
Observable<SzHowEntityResponse>
|
Public getParentContainingNode | ||||||||||||||||||||
getParentContainingNode(childNodeId: string, childNodeItemType?: SzResolutionStepListItemType, parentItemType?: SzResolutionStepListItemType, debug?: boolean)
|
||||||||||||||||||||
Get the direct ancestor of a child node. It is technically possible that there is more than 1 parent of a child but exceedingly unlikely except in cases that resolved to two separate final entities.
Parameters :
Returns :
SzResolutionStepNode
|
Static getResolutionStepCardType | ||||||||||||
getResolutionStepCardType(step: SzResolutionStep, stepNumber?: number)
|
||||||||||||
Get the type of
Parameters :
Returns :
SzResolutionStepDisplayType
|
Static getResolutionStepListItemType | ||||||
getResolutionStepListItemType(item: SzResolutionStep | SzResolutionStepNode)
|
||||||
Used to get the
Parameters :
Returns :
SzResolutionStepListItemType
|
Public getRootNodeContainingNode | ||||||||||||
getRootNodeContainingNode(childNodeId: string, debug?: boolean)
|
||||||||||||
Get the Root level node group that contains a specific child step. So say if you have a add record step that is a child of an interim step that is a child of a merge step, that is a child of a final result card you can get the "FINAL" card from the child id of the record step.
Parameters :
Returns :
SzResolutionStepNode
|
Public getStepNodeById | ||||||||||||
getStepNodeById(id: string, debug?: boolean)
|
||||||||||||
Get an array of StepNodes that match a specific id.
Parameters :
Returns :
SzResolutionStepNode[]
an array of SzResolutionStepNode that have the matching id |
Public isGroupExpanded | ||||||
isGroupExpanded(groupId: string)
|
||||||
is a specific group expanded
Parameters :
Returns :
boolean
|
Public isStepExpanded | ||||||
isStepExpanded(virtualEntityId: string)
|
||||||
is a specific step card expanded
Parameters :
Returns :
boolean
|
Public isStepMemberOfStack |
isStepMemberOfStack(vId: string, gId?: string, debug?: boolean)
|
is a step a child member of a group that is of itemType
Returns :
boolean
|
Public isStepPinned |
isStepPinned(vId: string, gId?: string)
|
is a step that was a member of a stack group(or could be) pinned in place.
Returns :
boolean
|
Public pinStep | ||||||||||||
pinStep(vId: string, gId: string)
|
||||||||||||
Step nodes that are children of nodes with a itemType of
Parameters :
Returns :
Map<string, SzResolutionStepNode>
|
Public selectStep | ||||||
selectStep(vId: string)
|
||||||
Expand a specific node and all parent nodes of node that need to be expanded in order for the node to be visible. Collapse all other nodes that are not the node or a direct decendent.
Parameters :
Returns :
void
|
Static setVirtualEntityIdsForNode | ||||||||||||
setVirtualEntityIdsForNode(isNested: boolean, step: SzResolutionStepNode)
|
||||||||||||
Set the
Parameters :
Returns :
{}
|
Public stepCanBeUnPinned | ||||||||||||
stepCanBeUnPinned(vId: string, debug?: boolean)
|
||||||||||||
Checks to see whether or not a specific step can become a child of a sibling stack or create one, and that the resulting stack would have at least 2 items it in.
Parameters :
Returns :
boolean
|
Public toggleExpansion | ||||||||||||||||||||
toggleExpansion(id: string, groupId?: string, itemType?: SzResolutionStepListItemType, debug?: boolean)
|
||||||||||||||||||||
Alternate the expanded state of a Step or Group Node.
looking for a node with a type of "STEP" who's id matches the
Parameters :
Returns :
void
|
Public unPinStep | ||||||||||||
unPinStep(vId: string, debug?: boolean)
|
||||||||||||
Step nodes that are children of nodes with a itemType of
Parameters :
Returns :
void
|
Public configDataService |
Type : SzConfigDataService
|
Public entityDataService |
Type : SzEntityDataService
|
Public onGroupExpansionChange |
Default value : this._onGroupExpansionChange.asObservable()
|
when a group is expanded or collapsed this observeable emits the id of the group that was changed |
Public onStepExpansionChange |
Default value : this._onStepExpansionChange.asObservable()
|
when a group is expanded or collapsed this observeable emits the id of the group that was changed |
Public prefs |
Type : SzPrefsService
|
expandedGroups |
getexpandedGroups()
|
An array of all the groups currently expanded. Groups include "Interim Entities" than can have children, Stacks of multiple "Add Record" Operations and "Final Entity" nodes |
expandedNodes |
getexpandedNodes()
|
An array of all step cards currently expanded. Cards can all be collapsed and are often children of Group nodes. |
isNavExpanded | ||||||
getisNavExpanded()
|
||||||
is the navigation rail expanded
Returns :
boolean
|
||||||
setisNavExpanded(value: boolean)
|
||||||
is the navigation rail expanded
Parameters :
Returns :
void
|
orderedFeatures |
getorderedFeatures()
|
this is the features ordered by what is returned from the config request
Returns :
[] | undefined
|
stepGroupStacks |
getstepGroupStacks()
|
get just the nodes found in "stepNodeGroups" that are of type "STACK"
Returns :
SzResolutionStepNode[]
|
stepNodeGroups | ||||||
setstepNodeGroups(value: Map<string | SzResolutionStepNode>)
|
||||||
set the step node groups present in an initial "how" presentation.
Parameters :
Returns :
void
|
stepNodes | ||||||
getstepNodes()
|
||||||
get the step nodes present in the current "how" presentation. This input should be in the form of a fully nested array. The array should start at the top level with "Final Cards" and each final card should have "children" nodes, and each of those children nodes can have children etc.
Returns :
Array<SzResolutionStepNode>
|
||||||
setstepNodes(value: Array<SzResolutionStepNode>)
|
||||||
set the step nodes present in an initial "how" presentation. This input should be in the form of a fully nested array. The array should start at the top level with "Final Cards" and each final card should have "children" nodes, and each of those children nodes can have children etc.
Parameters :
Returns :
void
|