Options
All
  • Public
  • Public/Protected
  • All
Menu

Interface EllipsisNode

A node that is used when there are more than the maximum number of allowed annotations hanging off of a node. This node represents an ellipsis annotation, indicating a number of additional annotations.

Hierarchy

Implemented by

Index

Properties

cardinality

cardinality: number

The number of nodes this node represents. For OpNodes, this will be 1, and for GroupNodes it will be a count of the total number of descendents it contains.

include

include: InclusionType

If the node is to be included or excluded from the main graph when rendered. Defaults to UNSPECIFIED, which means that the rendering algorithm determines if it will be included or not. Then can be set to INCLUDE or EXCLUDE manually by the user.

isGroupNode

isGroupNode: boolean

Whether this node is a type that may contain other nodes. Those types should extend from GroupNode.

For an OpNode, isGroupNode will be false, even though it may have embeddings. These embedding Nodes will have their parentNode set to the OpNode. However, embeddings are later rendered as annotations, not as children to be made visible on expansion (like a Metanode or SeriesNode).

name

name: string

The name of the node, used frequently to look up nodes by name.

nodeAttributes

nodeAttributes: object

Node attributes specify customizable visual aspects of a node and application-specific metadata associated with a node. The name 'nodeAttributes' is meant to avoid naming-conflicts with the 'attr' in subclasses of Node.

Type declaration

  • [key: string]: any

numMoreNodes

numMoreNodes: number

The number of nodes this ellipsis represents.

parentNode

parentNode: Node

The Node which is this Node's parent. This is of type Node and not GroupNode because of embeddings, which will have a parent OpNode.

type

type: NodeType

Which type of node this is.

Methods

setNumMoreNodes

  • setNumMoreNodes(numNodes: number): any
  • Sets the number of nodes this ellipsis represents and changes the node name accordingly.

    Parameters

    • numNodes: number

    Returns any

Generated using TypeDoc