Index

src/app/data/issue-graph/graph-data.ts

computeRelatedFolders
computeRelatedFolders(linkIssues, interfaces: Map)

The graph displays edges between issue folders that contain issues which link to each other. This function computes this information. Drawing is handled in IssueGraphComponent.

Parameters :
Name Type Optional Description
linkIssues No

contains only issues that link to other issues

interfaces Map No

mapping from ids of locations to interfaces attached to locations

issueCounts
issueCounts(bugCount: number, featureRequestCount: number, unclassifiedCount: number)

Issues counts

Parameters :
Name Type Optional Description
bugCount number No

number of bugs

featureRequestCount number No

number of feature requests

unclassifiedCount number No

number of unclassified issues

Returns : Map<IssueCategory, number>

counts mapping IssueCategory values to the count specified by arguments

removeOfferingComponents
removeOfferingComponents(locationIds, interfaces: Map)
Parameters :
Name Type Optional Description
locationIds No

ids of components and interfaces

interfaces Map No

mapping from

src/app/issue-list/issue-filter.component.ts

convertValueForFilter
convertValueForFilter(type: string, value: any)

Converts a predicate value into the backend representation for use in the filter.

Parameters :
Name Type Optional
type string No
value any No
getDefaultForType
getDefaultForType(type: string)

Returns the default value for a predicate type.

Parameters :
Name Type Optional
type string No

src/app/graphs/issue-graph/issue-graph-nodes.ts

createComponentNode
createComponentNode(component: GraphComponent, position?: Position)

Create a new ComponentNode

Parameters :
Name Type Optional Description
component GraphComponent No

The component data

position Position Yes

The initial position, nullable

Returns : ComponentNode
createConsumptionEdge
createConsumptionEdge(componentId: string, interfaceId: string)

Create an edge consuming an interface

Parameters :
Name Type Optional Description
componentId string No

The component node id consuming the interface

interfaceId string No

The interface node id providing the interface

Returns : Edge
createInterfaceNode
createInterfaceNode(intrface: GraphInterface, position?: Position)

Create a new InterfaceNode

Parameters :
Name Type Optional Description
intrface GraphInterface No

The interface data

position Position Yes

The initial position, nullable

Returns : InterfaceNode
createInterfaceProvisionEdge
createInterfaceProvisionEdge(componentId: string, interfaceId: string)

Create an edge connecting the component with the interface this component provides

Parameters :
Name Type Optional Description
componentId string No

The component node id providing the interface

interfaceId string No

The interface node id

Returns : Edge
createIssueFolderNode
createIssueFolderNode(node: IssueNode, issueCategory: IssueCategory, issueCount: string)

Creates a new IssueFolderNode

Parameters :
Name Type Optional Description
node IssueNode No

The node (e.g. a ComponentNode) to which this issue folder belongs to

issueCategory IssueCategory No

The issue category

issueCount string No

How many issues of this category the node has assigned to it

Returns : IssueFolderNode
createIssueGroupContainerNode
createIssueGroupContainerNode(node: IssueNode)
Parameters :
Name Type Optional Description
node IssueNode No

The node (e.g. InterfaceNode or ComponentNode) to which this container belongs to

createRelationEdge
createRelationEdge(sourceId: string, targetId: string, edgeType)

Create a new RelationEdge

Parameters :
Name Type Optional Default value Description
sourceId string No

The source node id

targetId string No

The target node id

edgeType No FolderEdgeType.RelatedTo

The type of edge

Returns : RelationEdge
getIssueFolderId
getIssueFolderId(id: string, issueCategory: IssueCategory)

Encode the node id and the issue category into a folder id

Parameters :
Name Type Optional Description
id string No

The id of the node the folder belongs to, e.g. a ComponentNode

issueCategory IssueCategory No

The category of the issue

Returns : string

src/app/graphql.module.ts

createErrorLink
createErrorLink(authService: AuthenticationService, toastr: ToastrService)
Parameters :
Name Type Optional
authService AuthenticationService No
toastr ToastrService No
Returns : ApolloLink
provideDefaultApollo
provideDefaultApollo(httpLink: HttpLink, authService: AuthenticationService, toastr: ToastrService)

Create Apollo instance where credentials from local storage are attached to requests

Parameters :
Name Type Optional
httpLink HttpLink No
authService AuthenticationService No
toastr ToastrService No
Returns : ApolloClientOptions<any>
providePublicApollo
providePublicApollo(httpLink: HttpLink, authService: AuthenticationService, toastr: ToastrService)

Creates Apollo Client used for user registration with public endpoint. In contrast to provideDefaultApollo no token is attached to reqeusts.

Parameters :
Name Type Optional
httpLink HttpLink No
authService AuthenticationService No
toastr ToastrService No
Returns : NamedOptions

src/app/data-dgql/id.ts

decodeListId
decodeListId(id: ListIdEnc)
Parameters :
Name Type Optional Description
id ListIdEnc No

an encoded List ID

Returns : ListId
decodeNodeId
decodeNodeId(id: NodeIdEnc)
Parameters :
Name Type Optional Description
id NodeIdEnc No

the encoded node ID

Returns : NodeId
encodeListId
encodeListId(ld: ListId)

Encodes a List ID into a string.

See encodeNodeId for more details.

Parameters :
Name Type Optional Description
ld ListId No

a List ID

Returns : ListIdEnc
encodeNodeId
encodeNodeId(nd: NodeId)

Encodes a NodeId into a string. This is due to a limitation in Javascript where objects cannot be == compared with each other apart from identity. Encoding them as a string allows NodeIds to be used as object or Map keys.

Parameters :
Name Type Optional Description
nd NodeId No

the node ID

Returns : NodeIdEnc
nodeTypeFromTypename
nodeTypeFromTypename(typename: string)

Returns the NodeType for a given __typename value. __typename is a tag found in GraphQL data.

Parameters :
Name Type Optional Description
typename string No

the __typename value

Returns : NodeType | null

src/app/graphs/issue-graph/group-behaviours.ts

distance
distance(x, y, x2, y2)
Parameters :
Name Optional
x No
y No
x2 No
y2 No

src/app/graphs/automatic-layout.ts

doGraphLayout
doGraphLayout(nodes: Array)

Automatically lay out the provided nodes.

Parameters :
Name Type Optional Description
nodes Array No

All nodes that are to be laid-out

Returns : void

src/app/data/label/label-store.service.ts

isFilterLabel
isFilterLabel(label: any)
Parameters :
Name Type Optional
label any No
Returns : boolean

src/app/data-dgql/load.ts

listParams
listParams(params: ListParams)

Converts ListParams to GraphQL parameters.

Parameters :
Name Type Optional
params ListParams No

src/app/data-dgql/queries/util.ts

promisifyApolloFetch
promisifyApolloFetch(f: Observable)

Apollo's GraphQL fetch method returns an Observable even though we only ever see one update emitted from it.

Hence, we just convert it to a promise here.

Parameters :
Name Type Optional Description
f Observable No

the observable

Returns : Promise<T>

a promise that resolves as soon as the observable emits an update

src/app/components/issue-label/issue-label.component.ts

readCssColor
readCssColor(color: string)

Reads a CSS color into an RGB tuple. Undefined behavior if the string is not a valid color.

Parameters :
Name Type Optional Description
color string No

a CSS color string

src/app/route-animations.ts

slideTo
slideTo(direction: string)
Parameters :
Name Type Optional
direction string No

results matching ""

    No results matching ""