@visdesignlab/trrack-vis

Index

Interfaces

Type aliases

Variables

Type aliases

Bundle

Bundle: { bunchedNodes: string[]; bundleLabel: string; metadata: any }

Type declaration

bunchedNodes: string[]
bundleLabel: string
metadata: any

BundleMap

BundleMap: {}

Type declaration

[key: string]: Bundle

Config

Config: { backboneGlyph: ReactChild; bundleGlyph: ReactChild; currentGlyph: ReactChild; regularGlyph: ReactChild }

Type declaration

backboneGlyph: ReactChild
bundleGlyph: ReactChild
currentGlyph: ReactChild
regularGlyph: ReactChild

EventConfig

EventConfig<E>: {}

Type parameters

E: string

Type declaration

[key: string]: Partial<Config>

ExtendedStratifiedMap

ExtendedStratifiedMap<T, S, A>: {}

Type parameters

Type declaration

[key: string]: ExtendedHierarchyNode<T, S, A>

LinkProps

LinkProps: {} & SVGProps<SVGLineElement>

StratifiedList

StratifiedList<T, S, A>: HierarchyNode<ProvenanceNode<S, A>>[]

Type parameters

StratifiedMap

StratifiedMap<T, S, A>: {}

Type parameters

Type declaration

[key: string]: HierarchyNode<ProvenanceNode<S, A>>

TreeNode

TreeNode: HierarchyNode<unknown>

Variables

Const container

container: string = style({alignItems: 'center',justifyContent: 'center',overflow: 'auto',})

Const redoButtonStyle

redoButtonStyle: string = style({marginTop: '2px',borderRadius: '2px',display: 'inline-block',cursor: 'pointer',fontFamily: 'Lato,Helvetica Neue,Arial,Helvetica,sans-serif',fontSize: '14px',$nest: {'&:hover': {backgroundColor: '#6c7c7c',},'&:active': {backgroundColor: '#6c7c7c',},},})

Const undoButtonStyle

undoButtonStyle: string = style({marginTop: '2px',borderRadius: '2px',display: 'inline-block',cursor: 'pointer',fontFamily: 'Lato,Helvetica Neue,Arial,Helvetica,sans-serif',fontSize: '14px',marginRight: '1px',$nest: {'&:hover': {backgroundColor: '#6c7c7c',},'&:active': {backgroundColor: '#6c7c7c',},},})

Functions

BackboneNode

BackboneNode<T, S, A>(__namedParameters: { annotationContent: (nodeId: StateNode<S, A>) => ReactChild; annotationOpen: number; bookmark: any; bundleMap: BundleMap; current: boolean; duration: number; editAnnotations: boolean; eventConfig: EventConfig<S>; exemptList: string[]; expandedClusterList: string[]; first: boolean; iconOnly: boolean; node: StateNode<S, A>; nodeMap: any; popupContent: (nodeId: StateNode<S, A>) => ReactChild; prov: Provenance<T, S, A>; radius: number; setAnnotationOpen: any; setExemptList: any; strokeWidth: number; textSize: number }): Element

- Defined in packages/trrack-vis/src/components/BackboneNode.tsx:37
Type parameters
- T
- S: string
- A
Parameters
- __namedParameters: { annotationContent: (nodeId: StateNode<S, A>) => ReactChild; annotationOpen: number; bookmark: any; bundleMap: BundleMap; current: boolean; duration: number; editAnnotations: boolean; eventConfig: EventConfig<S>; exemptList: string[]; expandedClusterList: string[]; first: boolean; iconOnly: boolean; node: StateNode<S, A>; nodeMap: any; popupContent: (nodeId: StateNode<S, A>) => ReactChild; prov: Provenance<T, S, A>; radius: number; setAnnotationOpen: any; setExemptList: any; strokeWidth: number; textSize: number }
  - annotationContent: (nodeId: StateNode<S, A>) => ReactChild
    - - (nodeId: StateNode<S, A>): ReactChild
      - Parameters
        
        nodeId: StateNode<S, A>
        
        Returns ReactChild
  - annotationOpen: number
  - bookmark: any
  - bundleMap: BundleMap
  - current: boolean
  - duration: number
  - editAnnotations: boolean
  - eventConfig: EventConfig<S>
  - exemptList: string[]
  - expandedClusterList: string[]
  - first: boolean
  - iconOnly: boolean
  - node: StateNode<S, A>
  - nodeMap: any
  - popupContent: (nodeId: StateNode<S, A>) => ReactChild
    - - (nodeId: StateNode<S, A>): ReactChild
      - Parameters
        
        nodeId: StateNode<S, A>
        
        Returns ReactChild
  - prov: Provenance<T, S, A>
  - radius: number
  - setAnnotationOpen: any
  - setExemptList: any
  - strokeWidth: number
  - textSize: number
Returns Element

BookmarkListView

BookmarkListView<T, S, A>(__namedParameters: { currentNode: string; eventConfig: EventConfig<S>; graph: ProvenanceGraph<S, A> }): Element

- Defined in packages/trrack-vis/src/components/BookmarkListView.tsx:15
Type parameters
- T
- S: string
- A
Parameters
- __namedParameters: { currentNode: string; eventConfig: EventConfig<S>; graph: ProvenanceGraph<S, A> }
  - currentNode: string
  - eventConfig: EventConfig<S>
  - graph: ProvenanceGraph<S, A>
Returns Element

BookmarkNode

BookmarkNode<T, S, A>(__namedParameters: { current: boolean; eventConfig: EventConfig<S>; node: StateNode<S, A> }): Element

- Defined in packages/trrack-vis/src/components/BookmarkNode.tsx:15
Type parameters
- T
- S: string
- A
Parameters
- __namedParameters: { current: boolean; eventConfig: EventConfig<S>; node: StateNode<S, A> }
  - current: boolean
  - eventConfig: EventConfig<S>
  - node: StateNode<S, A>
Returns Element

BookmarkToggle

BookmarkToggle<T, S, A>(__namedParameters: { bookmarkView: boolean; graph: ProvenanceGraph<any, any>; setBookmarkView: (b: boolean) => void }): Element

- Defined in packages/trrack-vis/src/components/BookmarkToggle.tsx:12
Type parameters
- T
- S: string
- A
Parameters
- __namedParameters: { bookmarkView: boolean; graph: ProvenanceGraph<any, any>; setBookmarkView: (b: boolean) => void }
  - bookmarkView: boolean
  - graph: ProvenanceGraph<any, any>
  - setBookmarkView: (b: boolean) => void
    - - (b: boolean): void
      - Parameters
        
        b: boolean
        
        Returns void
Returns Element

BookmarkTransitions

BookmarkTransitions(xOffset: number, yOffset: number, nodeList: any[]): { enter: enter; leave: start; start: start; update: update }

- Defined in packages/trrack-vis/src/components/BookmarkTransitions.tsx:2
Parameters
- xOffset: number
- yOffset: number
- nodeList: any[]
Returns { enter: enter; leave: start; start: start; update: update }
- enter: enter
- leave: start
- start: start
- update: update

DFS

DFS<T, S, A>(nodes: StratifiedMap<T, S, A>, node: string, depthMap: any, currentPath: string[]): void

- Defined in packages/trrack-vis/src/Utils/TreeLayout.ts:30
Type parameters
- T
- S
- A
Parameters
- nodes: StratifiedMap<T, S, A>
- node: string
- depthMap: any
- currentPath: string[]
Returns void

Const Link

Link(props: LinkProps): Element

- Defined in packages/trrack-vis/src/components/Link.tsx:5
Parameters
- props: LinkProps
Returns Element

ProvVis

ProvVis<T, S, A>(__namedParameters: { annotationContent: (nodeId: StateNode<S, A>) => ReactChild; annotationHeight: number; backboneCircleRadius: number; backboneCircleStroke: number; backboneGutter: number; bundleMap: BundleMap; changeCurrent: (id: NodeID) => void; clusterLabels: boolean; clusterVerticalSpace: number; current: string; duration: number; editAnnotations: boolean; ephemeralUndo: boolean; eventConfig: EventConfig<S>; gutter: number; height: number; iconOnly: boolean; linkWidth: number; nodeMap: Nodes<S, A>; popupContent: (nodeId: StateNode<S, A>) => ReactChild; prov: Provenance<T, S, A>; regularCircleRadius: number; regularCircleStroke: number; root: string; sideOffset: number; textSize: number; topOffset: number; verticalSpace: number; width: number }): Element

- Defined in packages/trrack-vis/src/components/ProvVis.tsx:80
Type parameters
- T
- S: string
- A
Parameters
- __namedParameters: { annotationContent: (nodeId: StateNode<S, A>) => ReactChild; annotationHeight: number; backboneCircleRadius: number; backboneCircleStroke: number; backboneGutter: number; bundleMap: BundleMap; changeCurrent: (id: NodeID) => void; clusterLabels: boolean; clusterVerticalSpace: number; current: string; duration: number; editAnnotations: boolean; ephemeralUndo: boolean; eventConfig: EventConfig<S>; gutter: number; height: number; iconOnly: boolean; linkWidth: number; nodeMap: Nodes<S, A>; popupContent: (nodeId: StateNode<S, A>) => ReactChild; prov: Provenance<T, S, A>; regularCircleRadius: number; regularCircleStroke: number; root: string; sideOffset: number; textSize: number; topOffset: number; verticalSpace: number; width: number }
  - annotationContent: (nodeId: StateNode<S, A>) => ReactChild
    - - (nodeId: StateNode<S, A>): ReactChild
      - Parameters
        
        nodeId: StateNode<S, A>
        
        Returns ReactChild
  - annotationHeight: number
  - backboneCircleRadius: number
  - backboneCircleStroke: number
  - backboneGutter: number
  - bundleMap: BundleMap
  - changeCurrent: (id: NodeID) => void
    - - (id: NodeID): void
      - Parameters
        
        id: NodeID
        
        Returns void
  - clusterLabels: boolean
  - clusterVerticalSpace: number
  - current: string
  - duration: number
  - editAnnotations: boolean
  - ephemeralUndo: boolean
  - eventConfig: EventConfig<S>
  - gutter: number
  - height: number
  - iconOnly: boolean
  - linkWidth: number
  - nodeMap: Nodes<S, A>
  - popupContent: (nodeId: StateNode<S, A>) => ReactChild
    - - (nodeId: StateNode<S, A>): ReactChild
      - Parameters
        
        nodeId: StateNode<S, A>
        
        Returns ReactChild
  - prov: Provenance<T, S, A>
  - regularCircleRadius: number
  - regularCircleStroke: number
  - root: string
  - sideOffset: number
  - textSize: number
  - topOffset: number
  - verticalSpace: number
  - width: number
Returns Element

ProvVisCreator

ProvVisCreator<T, S, A>(node: Element, prov: Provenance<T, S, A>, callback?: (id: NodeID) => void, buttons?: boolean, ephemeralUndo?: boolean, fauxRoot?: NodeID, config?: Partial<ProvVisConfig>): void

- Defined in packages/trrack-vis/src/components/ProvVisCreator.tsx:33
Type parameters
- T
- S: string
- A
Parameters
- node: Element
- prov: Provenance<T, S, A>
- Optional callback: (id: NodeID) => void
  - - (id: NodeID): void
    - Parameters
      - id: NodeID
      Returns void
- Default value buttons: boolean = true
- Default value ephemeralUndo: boolean = false
- Default value fauxRoot: NodeID = prov.graph.root
- Default value config: Partial<ProvVisConfig> = {}
Returns void

UndoRedoButton

UndoRedoButton<T, S, A>(__namedParameters: { graph: ProvenanceGraph<S, A>; redoCallback: () => void; undoCallback: () => void }): Element

- Defined in packages/trrack-vis/src/components/UndoRedoButton.tsx:13
Type parameters
- T
- S: string
- A
Parameters
- __namedParameters: { graph: ProvenanceGraph<S, A>; redoCallback: () => void; undoCallback: () => void }
  - graph: ProvenanceGraph<S, A>
  - redoCallback: () => void
    - - (): void
      - Returns void
  - undoCallback: () => void
    - - (): void
      - Returns void
Returns Element

UndoRedoButtonCreator

UndoRedoButtonCreator<T, S, A>(node: Element, graph: ProvenanceGraph<S, A>, undoCallback: () => void, redoCallback: () => void): void

- Defined in packages/trrack-vis/src/components/ProvVisCreator.tsx:73
Type parameters
- T
- S: string
- A
Parameters
- node: Element
- graph: ProvenanceGraph<S, A>
- undoCallback: () => void
  - - (): void
    - Returns void
- redoCallback: () => void
  - - (): void
    - Returns void
Returns void

bundleTransitions

bundleTransitions(xOffset: number, yOffset: number, clusterOffset: number, backboneOffset: number, duration?: number, expandedClusterList: string[], stratifiedMap: any, nodeList: any[], annotationOpen: number, annotationHeight: number, bundleMap?: BundleMap): { enter: enter; leave: start; start: start; update: update }

- Defined in packages/trrack-vis/src/components/BundleTransitions.tsx:5
Parameters
- xOffset: number
- yOffset: number
- clusterOffset: number
- backboneOffset: number
- Default value duration: number = 500
- expandedClusterList: string[]
- stratifiedMap: any
- nodeList: any[]
- annotationOpen: number
- annotationHeight: number
- Optional bundleMap: BundleMap
Returns { enter: enter; leave: start; start: start; update: update }
- enter: enter
- leave: start
- start: start
- update: update

findBackboneBundleNodes

findBackboneBundleNodes(nodeMap: any, bundleMap?: BundleMap): string[]

- Defined in packages/trrack-vis/src/Utils/findBackboneBundleNodes.ts:6
Parameters
- nodeMap: any
- Optional bundleMap: BundleMap
Returns string[]

findBundleParent

findBundleParent(nodeId: string, bundleMap?: BundleMap): string[]

- Defined in packages/trrack-vis/src/Utils/findBundleParent.ts:3
Parameters
- nodeId: string
- Optional bundleMap: BundleMap
Returns string[]

getPathTo

getPathTo<T, S, A>(nodes: StratifiedMap<T, S, A>, from: string, to: string): string[]

- Defined in packages/trrack-vis/src/Utils/TreeLayout.ts:69
Type parameters
- T
- S
- A
Parameters
- nodes: StratifiedMap<T, S, A>
- from: string
- to: string
Returns string[]

getX

getX(width: number, xOffset: number, backboneOffset: number): number

- Defined in packages/trrack-vis/src/components/LinkTransitions.ts:120
Parameters
- width: number
- xOffset: number
- backboneOffset: number
Returns number

linkTransitions

linkTransitions(xOffset: number, yOffset: number, clusterOffset: number, backboneOffset: number, duration?: number, annotationOpen: number, annotationHeight: number): { enter: enter; leave: start; start: start; update: update }

- Defined in packages/trrack-vis/src/components/LinkTransitions.ts:1
Parameters
- xOffset: number
- yOffset: number
- clusterOffset: number
- backboneOffset: number
- Default value duration: number = 500
- annotationOpen: number
- annotationHeight: number
Returns { enter: enter; leave: start; start: start; update: update }
- enter: enter
- leave: start
- start: start
- update: update

nodeTransitions

nodeTransitions(xOffset: number, yOffset: number, clusterOffset: number, backboneOffset: number, duration?: number, annotationOpen: number, annotationHeight: number): { enter: enter; leave: start; start: start; update: update }

- Defined in packages/trrack-vis/src/components/NodeTransitions.ts:3
Parameters
- xOffset: number
- yOffset: number
- clusterOffset: number
- backboneOffset: number
- Default value duration: number = 500
- annotationOpen: number
- annotationHeight: number
Returns { enter: enter; leave: start; start: start; update: update }
- enter: enter
- leave: start
- start: start
- update: update

search

search<T, S, A>(nodes: StratifiedMap<T, S, A>, node: string, final: string, path: string[]): boolean

- Defined in packages/trrack-vis/src/Utils/TreeLayout.ts:81
Type parameters
- T
- S
- A
Parameters
- nodes: StratifiedMap<T, S, A>
- node: string
- final: string
- path: string[]
Returns boolean

translate

translate(x: number, y: number): string

- Defined in packages/trrack-vis/src/Utils/translate.ts:1
Parameters
- x: number
- y: number
Returns string

Const treeColor

treeColor(current?: boolean): string

- Defined in packages/trrack-vis/src/components/Styles.ts:4
Parameters
- Optional current: boolean
Returns string

treeLayout

treeLayout<T, S, A>(nodes: StratifiedMap<T, S, A>, current: string, root: string): string[]

- Defined in packages/trrack-vis/src/Utils/TreeLayout.ts:16
Type parameters
- T
- S
- A
Parameters
- nodes: StratifiedMap<T, S, A>
- current: string
- root: string
Returns string[]

Index

Interfaces

Type aliases

Variables

Functions

Type aliases

Bundle

Type declaration

bunchedNodes: string[]

bundleLabel: string

metadata: any

BundleMap

Type declaration

[key: string]: Bundle

Config

Type declaration

backboneGlyph: ReactChild

bundleGlyph: ReactChild

currentGlyph: ReactChild

regularGlyph: ReactChild

EventConfig

Type parameters

E: string

Type declaration

[key: string]: Partial<Config>

ExtendedStratifiedMap

Type parameters

T

S

A

Type declaration

[key: string]: ExtendedHierarchyNode<T, S, A>

LinkProps

StratifiedList

Type parameters

T

S

A

StratifiedMap

Type parameters

T

S

A

Type declaration

[key: string]: HierarchyNode<ProvenanceNode<S, A>>

TreeNode

Variables

Const container

Const redoButtonStyle

Const undoButtonStyle

Functions

BackboneNode

Type parameters

T

S: string

A

Parameters

annotationContent: (nodeId: StateNode<S, A>) => ReactChild

Parameters

nodeId: StateNode<S, A>

Returns ReactChild

annotationOpen: number

bookmark: any

bundleMap: BundleMap

current: boolean

duration: number

editAnnotations: boolean

eventConfig: EventConfig<S>

exemptList: string[]

expandedClusterList: string[]

first: boolean

iconOnly: boolean

node: StateNode<S, A>

nodeMap: any

popupContent: (nodeId: StateNode<S, A>) => ReactChild

Parameters

nodeId: StateNode<S, A>

Returns ReactChild

prov: Provenance<T, S, A>

radius: number