IHierarchyGraph | UI Widget Toolkit

a set of links and nodes to render as a connected graph

Hierarchy

IGraph
- IHierarchyGraph

Index

Properties

Optional api

api: object

Type declaration

Optional brush?: function

fire a brush event for this element

param

any event to pass to the renderer
- - (event?: IEvent): void
  - Parameters
    - Optional event: IEvent
    Returns void
Optional createImage?: function
- - (): void
  - Returns void
Optional cursorChange?: function

fire a mouse/touch change event for this element

param

any event to pass to the renderer
- - (event?: IEvent): void
  - Parameters
    - Optional event: IEvent
    Returns void
Optional focus?: function

fire a focus event for this element

param

any event to pass to the renderer
- - (event?: IEvent): void
  - Parameters
    - Optional event: IEvent
    Returns void
Optional getOptions?: function
- - (): IOptions
  - Returns IOptions
Optional hover?: function

deprecated

('Deprecated since 1.14.0 in favor of focus. Will be removed in 2.x') fire a hover event for this element

param

any event to pass to the renderer
- - (event?: IEvent): void
  - Parameters
    - Optional event: IEvent
    Returns void
Optional pan?: function

pan to a given event location
- - (event?: IEvent): void
  - Parameters
    - Optional event: IEvent
    Returns void
Optional render?: function

Render the element.

param

an IRenderer object that can render this element

param

any options to pass to the renderer
- - (renderer?: UIRenderer, options?: IOptions): Promise<any>
  - Parameters
    - Optional renderer: UIRenderer
    - Optional options: IOptions
    Returns Promise<any>
Optional saveImage?: function
- - (): void
  - Returns void
Optional select?: function

fire a select event for this element

param

any event to pass to the renderer
- - (event?: IEvent): void
  - Parameters
    - Optional event: IEvent
    Returns void
Optional zoom?: function

fire a zoom event for this element

param

any event to pass to the renderer
- - (event?: IEvent): void
  - Parameters
    - Optional event: IEvent
    Returns void

Optional contextMenuItems

contextMenuItems: IContextMenuItem[]

the context menu definitions for when the user right clicks

Optional decimator

decimator: IGraphNodeDecimator

a decimator used to control graph node visibility

Optional getElements

getElements: function

get all elements associated with the render call of this UIElement

Type declaration

- (): UIElement[]
- Returns UIElement[]

Optional getTooltip

getTooltip: function

get tooltip data for the element

param: any event to pass to the renderer

Type declaration

- (event?: IEvent): ITooltipData[]
- Parameters
  - Optional event: IEvent
  Returns ITooltipData[]

Optional handleUpdate

handleUpdate: function

Type declaration

- (caller: UIElement, options: IOptions): void
- Parameters
  - caller: UIElement
  - options: IOptions
  Returns void

Optional legend

legend: ILegend

add a legend definition to render

Optional onBrush

onBrush: function

callback when a brush action occurs in this element

param: the event related to this callback

Type declaration

- (event: IEvent): void
- Parameters
  - event: IEvent
  Returns void

Optional onClick

onClick: function

callback when user clicks on an item

Type declaration

- (event: IEvent): void
- Parameters
  - event: IEvent
  Returns void

Optional onCursorChanged

onCursorChanged: function

callback when the cursor change occurs in this element

param: the event related to this callback

Type declaration

- (event: IEvent): void
- Parameters
  - event: IEvent
  Returns void

Optional onDoubleClick

onDoubleClick: function

the callback when an item in this data is double clicked

param: contains the data for the item that was clicked

Type declaration

- (event: IEvent): void
- Parameters
  - event: IEvent
  Returns void

Optional onHover

onHover: function

callback when a hover occurs in this element

param: the event related to this callback

Type declaration

- (event: IEvent): void
- Parameters
  - event: IEvent
  Returns void

Optional onRender

onRender: function

callback when a re-render occurs in this element

param: the options used when render was called

Type declaration

- (options: IOptions): void
- Parameters
  - options: IOptions
  Returns void

Optional onTooltip

onTooltip: function

callback when a tooltip occurs in this element

param: the event related to this callback

Type declaration

- (event: IEvent): any
- Parameters
  - event: IEvent
  Returns any

Optional onZoom

onZoom: function

callback when a zoom action occurs in this element

param: the event related to this callback

Type declaration

- (event: IEvent): void
- Parameters
  - event: IEvent
  Returns void

Optional options

options: IOptions

Optional renderer

renderer: UIRenderer

Optional title

title: string

Optional type

type: UIType

Generated using TypeDoc

Hierarchy

Index

Properties

Properties

Optional api

Type declaration

Optional brush?: function

Parameters

Optional event: IEvent

Returns void

Optional createImage?: function

Returns void

Optional cursorChange?: function

Parameters

Optional event: IEvent

Returns void

Optional focus?: function

Parameters

Optional event: IEvent

Returns void

Optional getOptions?: function

Returns IOptions

Optional hover?: function

Parameters

Optional event: IEvent

Returns void

Optional pan?: function

Parameters

Optional event: IEvent

Returns void

Optional render?: function

Parameters

Optional renderer: UIRenderer

Optional options: IOptions

Returns Promise<any>

Optional saveImage?: function

Returns void

Optional select?: function

Parameters

Optional event: IEvent

Returns void

Optional zoom?: function

Parameters

Optional event: IEvent

Returns void

Optional contextMenuItems

Optional decimator

Optional getElements

Type declaration

Returns UIElement[]

Optional getTooltip

Type declaration

Parameters

Optional event: IEvent

Returns ITooltipData[]

Optional handleUpdate

Type declaration

Parameters

caller: UIElement

options: IOptions

Returns void

Optional legend

links

Optional manager

Optional nodes

Optional onBrush

Type declaration

Parameters

event: IEvent

Returns void

Optional onClick

Type declaration

Parameters

event: IEvent

Returns void

Optional onCursorChanged

Type declaration

Parameters

event: IEvent

Returns void