Entity

class orion_notebook.graph.extensibility.entity.Entity(value: str)

Bases: orion_notebook.graph.extensibility.extensiblemixin.ExtensibleMixin, orion_notebook.graph.nodes.node.Node

Class that represents a new entity result of applying a specific transformation.

The attribute additional_fields will hold other parameters that can be used both to generate the graph and apply subsequent transformations. The user can use this structure to save information they will need for later.

The display_information will hold information particular to the Entity that will be shown when retrieving its details

data: NodeData

details: Union[dict, NodeData]

get_extra_details() → None

Sets the details field with the display_information field. This method can be overridden to change the information to be displayed by the Entity

id: str

name: str

node_type: NodeType

position: dict

set_entity_color(color: str) → None

Sets the color. Must be valid css color value (hexadecimal, rgb, rgba, hsl, white, black, …)

Parameters

color (str) – color value

set_icon(icon: str) → None

Sets the node icon from orion icons

Parameters

icon (str) – icon name

set_icon_url(url: str) → None

Sets the node icon from url

Parameters

url (str) – icon url

set_link_label(label: str) → None

Sets the name of a specific Link

Parameters

label (str) – text that will be shown on the edge

set_value(value: str) → None

Sets the name of a specific Entity

Parameters

value (str) – the value to which the Entity name will be set