- Copyright_Notice
- objectHovered
- objectHighlighted
- viewChanged
- nodeContextSizeChanged
- matchesFound
- viewUpdated
- constructor
- getStyles
- updateStyles
- updateDefinitions
- updateData
- setHighlightedNode
- setHighlightedConnection
- findNodes
- setView
- setModes
- zoomOutViewLevel
- getNode
- setFilters
Copyright 2016 Netflix, Inc.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
The objectHovered
event is fired whenever on mouseover on a 'node' or 'connection' .
object.type
will be either 'node' or 'connection'. In case another 'node' or 'connection'
is already in focus (because of click/highlight event), then this event won't be triggered.
object
object The object that has been hovered,
The objectHighlighted
event is fired whenever an object is highlighted.
object.type
will be either 'node' or 'connection'
object
object The object that has been highlighted, or the highlighted object that has been updated.
The viewChanged
event is fired whenever the view changes
view
array The currently selected view (e.g. [] for global, ['us-east-1'] for one node deep, ['us-east-1', 'api'] for two nodes deep)
The nodeContextSizeChanged
event is fired whenever the context panel size for node context size changes
dimensions
object The dimensions of the node context panels
The matchesFound
event is fired whenever nodes are found via findNodes().
matches
object The matches object { total, visible }
The viewUpdated
event is fired whenever the current displayed graph's view updates.
Represents a Vizceral component.
canvas
object? The canvas to render the graph onto; if not provided, will create a canvas accessible by this.renderer.domElementtargetFramerate
Number? Target frame rate to render at. Will not limit FPS if not provided or set to 0.
Get an array of all possible defined styles
Returns array Array of all possible styles
Update the global styles
styles
An
Object object map of style names to values
Update the global definitions
definitions
An
Object object map of definitions. See the format and defaults in (https://github.com/Netflix/Vizceral/wiki/Configuration#definitions-for-data-to-display)
Set the new set of traffic data to render. This is expected to be called with the complete set of traffic data anytime there is an update.
trafficData
data
object The traffic data that matches the format in (https://github.com/Netflix/Vizceral/wiki/How-to-Use#graph-data-format)
Sets the highlighted node. If the node is undefined, clears any highlighting.
node
object The node to highlight
Sets the highlighted connection. If the connection is undefined, clears any highlighting.
connection
object The connection to highlight
Highlight nodes that match searchString. Searches the node name and the list of sub nodes, if nodes have one.
searchString
string The string to match against the nodes.
Returns object { total, totalMatches, visible, visibleMatches }
Set the current view of the component to the passed in array. If the passed in array does not match an existing node at the passed in depth, the component will try each level up the array until it finds a match, defaulting to the top level view.
Ex: [] - show the base graph view ['us-east-1'] - show the graph view for 'us-east-1' if it exists ['us-east-1', 'api'] - show the view for the api node in the us-east-1 graph if it exists
viewArray
array the array containing the view to set. (optional, default[]
)objectNameToHighlight
string a node or connection to set as highlighted in the current viewArray
Set the current modes of vizceral
modes
If zoomed into a node or a service, zoom out one level up. If in the global view, this is a noop.
Get a specific node object
viewArray
array e.g. [ node1, node2 ]
Set the set of filters to apply along with their current values.
filters
object The filters that match the format in (https://github.com/Netflix/Vizceral/wiki/Configuration#filters)