tulipgui module API¶
Utility functions¶
- 
tlpgui.getAvailableViews()¶
- New in version 4.4. - Returns a list of the views names currently available in Tulip. - Return type
- list of string 
 
- 
tlpgui.createView(viewName, graph, dataSet={}, show=True)¶
- New in version 4.4. - Creates and adds a new Tulip view. If called through a Python Script editor in the main Tulip GUI, the view will be added in the Tulip workspace. If called through the classical Python shell, a dialog containing the view will be created and displayed. Returns an instance of the newly created view. - Parameters
- viewName (string) – the name of the view to create (use - tlpgui.getAvailableViews()to know which ones are installed)
- graph ( - tulip.tlp.Graph) – the graph to set on the new view
- dataSet ( - tulip.tlp.DataSet) – the optional parameters of the view
- show (boolean) – show the view if - True
 
- Return type
 
- 
tlpgui.createNodeLinkDiagramView(graph, dataSet={}, show=True)¶
- New in version 4.4. - Convenient function for creating the principal view offered by Tulip : a node link diagram. Its call is equivalent to: - nodeLinkView = tlp.createView("Node Link Diagram view", graph) - Parameters
- graph ( - tulip.tlp.Graph) – the graph to visualize
- dataSet ( - tulip.tlp.DataSet) – the optional parameters of the view
- show (boolean) – show the view if - True
 
- Return type
 
- 
tlpgui.getOpenedViews()¶
- New in version 4.4. - Returns a list of the views currently opened. - Return type
- list of - tlpgui.View
 
- 
tlpgui.getViewsOfGraph(graph)¶
- New in version 4.4. - Returns a list of views associated to a particular graph. - Parameters
- graph ( - tulip.tlp.Graph) – the graph on which to find views
- Return type
- list of - tlpgui.View
 
- 
tlpgui.closeView(view)¶
- New in version 4.4. - Closes and destroys an opened view. - Parameters
- view ( - tlpgui.View) – the view to close
 
- 
tlpgui.closeAllViews()¶
- New in version 4.4. - Closes and destroys all opened views (except the Python Script ones). 
- 
tlpgui.closeViewsRelatedToGraph(graph)¶
- New in version 4.4. - Closes and destroys all the views associated to a particular graph. - Parameters
- graph ( - tulip.tlp.Graph) – the graph on which to close views
 
- 
tlpgui.createInteractor(interactorName)¶
- New in version 4.4. - Creates a Tulip interactor. An interactor enables to add user interaction (usually trough the use of mouse and keyboards) to a Tulip view. Use function - tlpgui.getInteractorsCompatibleWithView()to get the names of the interactors compatible with a particular view. Use method- tlpgui.View.setInteractors()to modify the default interactors associated to a view.- Parameters
- interactorName (string) – the name of the interactor to create 
- Return type
- Throws
- an exception if the interactor name does not exist 
 
- 
tlpgui.getInteractorsCompatibleWithView(viewName)¶
- New in version 4.4. - Returns a list of interactors names compatible with a specific view. - Parameters
- viewName (string) – the name of the view for which to retrieve the compatible interactors 
- Return type
- list of string 
- Throws
- an exception if the view name does not exist 
 
tlpgui.ColorScalesManager¶
- 
class tlpgui.ColorScalesManager¶
- New in version 4.10. - That static class aims to facilitate working with Tulip color scales. It allows to easily retrieve Tulip predefined ones but also to register new ones in a persistent database for further reuse. - 
getColorScale(colorScaleName)¶
- Returns the color scale registered with the provided name. - Warning - If there is no such colorscale, the returned one will be empty. - Return type
 
 - 
getColorScalesList()¶
- Returns a list of the registered color scales names. - Return type
- list of strings 
 
 - 
registerColorScale(colorScaleName, colorScale)¶
- Registers a color scale in the persistent database for further reuse. - Warning - If there is already a color scale registered with such a name, it will not be overwritten. - Parameters
- colorScaleName (string) – the name of the color scale to register 
- colorScale (a - tlp.ColorScaleinstance, a list of- tlp.Coloror a dictionary with float keys (between 0.0 and 1.0) and- tlp.Colorvalues) – the color scale to set
 
 
 - 
removeColorScale(colorScaleName)¶
- Removes the color scale registered with the provided name from the persistent database. - Parameters
- colorScaleName (string) – the name of the color scale to remove 
 
 
- 
tlpgui.Interactor¶
- 
class tlpgui.Interactor¶
- New in version 4.4. - Bases: - tulip.tlp.Plugin- An interactor enables to add user interaction (usually through the use of mouse and keyboards) to a Tulip view. Use function - tlpgui.getInteractorsCompatibleWithView()to get the names of the interactors compatible with a particular view. Use function- tlpgui.createInteractor()to instantiate a specific interactor. Use method- tlpgui.View.setInteractors()to modify the default interactors associated to a view.- 
isCompatible(viewName)¶
- Returns if the interactor is compatible with a specific view. 
 - 
view()¶
 
- 
tlpgui.View¶
- 
class tlpgui.View¶
- New in version 4.4. - Bases: - tulip.tlp.Plugin- This is the base class for Tulip data views. Use the following functions to get instances on such object : - 
currentInteractor()¶
- Return type
 
 - 
draw()¶
- Draws/Updates the view. 
 - 
graph()¶
- Returns the graph currently attached to the view. - Return type
 
 - 
interactors()¶
- Returns the interactors currently installed on the view. - Return type
- list of - tlpgui.Interactor
 
 - 
resize(width, height)¶
- Resizes the view windows. That method only has an effect when working through the classical Python interpreter. - Parameters
- width (integer) – the new width of the view window 
- height (integer) – the new height of the view window 
 
 
 - 
saveSnapshot(picturePath, width, height)¶
- Takes a snapshot of the view and saves it to an image file on disk. The view is not required to be visible for that feature to work. Returns - Trueif the operation succeeded.- Parameters
- picturePath (string) – the absolute path of the image file with extension (used to infer image type) 
- width (integer) – the image width 
- height (integer) – the image height 
 
- Return type
- boolean 
 
 - 
setCurrentInteractor(interactor)¶
- Set the current active interactor on the view. - Parameters
- interactor ( - tlpgui.Interactor) – the interactor to set active
 
 - 
setGraph(graph)¶
- Sets the graph for the view. The current parameters will be kept. - Parameters
- graph ( - tulip.tlp.Graph) – the graph from which the view will be drawn.
 
 - 
setInteractors(interactors)¶
- Installs a new set of interactors on the view. - Parameters
- interactors (list of - tlpgui.Interactor) – the new interactors to install
 
 - 
setPos(x, y)¶
- Set the position on screen of the view windows. That method only has an effect when working through the classical Python interpreter. - Parameters
- x (integer) – the new x position of the view window 
- y (integer) – the new y position of the view window 
 
 
 - 
setState(dataSet)¶
- Sets the parameters for the view. - Parameters
- dataSet ( - tulip.tlp.DataSet) – the view parameters
 
 - 
setVisible(visible)¶
- Hides / Shows the view window. That method only has an effect when working through the classical Python interpreter. - Parameters
- visible (boolean) – the state of the view window visibility 
 
 - 
state()¶
- Returns the current parameters of the view. - Return type
 
 - 
triggers()¶
 
- 
tlpgui.GlMainView¶
- 
class tlpgui.GlMainView¶
- Bases: - tlpgui.View- This is the based class of Tulip OpenGL views. - 
centerView()¶
- Centers the OpenGL scene in the view window. 
 - 
drawOverview()¶
- Forces the redraw of the overview window. 
 - 
getRGBImage()¶
- Return a tuple of 3 elements. The first element is the image in RGB format (3 bytes per pixel) as a bytearray object; the second is the width of the image and the third is its height. - Return type
- ( - bytearray, int ,int)
 
 - 
overviewVisible()¶
- Returns the visibility state of the overview window. - Return type
- boolean 
 
 - 
pickNodeEdge(x, y, pickNode, pickEdge)¶
- Returns a tuple of 3 elements. The first one is a bool indicating if a node/edge has been found found at the (x,y) position in the view, the second element is the node found, the third the edge found. - Parameters
- x (integer) – the x coordinate 
- y (integer) – the y coordinate 
- pickNode (boolean) – enable/disable the node picking 
- pickEdge – enable/disable the edge picking 
 
- Return type
- (boolean, - tulip.tlp.node,- tulip.tlp.edge)
 
 - 
quickAccessBarVisible()¶
- Returns the visibility state of the quick access bar. - Return type
- boolean 
 
 - 
rotateCamera(x, y, z)¶
- Rotate the view camera by (x, y, z) - Parameters
- x (integer) – the angle of the rotation around X axis in degree 
- y (integer) – the angle of the rotation around Y axis in degree 
- z (integer) – the angle of the rotation around Z axis in degree 
 
 
 - 
setOverviewVisible(state)¶
- Sets the visibility state of the overview window. - Parameters
- state (boolean) – the visibility state of the overview window. 
 
 - 
setQuickAccessBarVisible(state)¶
- Allows to control the quiack access bar visibility. - Parameters
- state (boolean) – the visibility state of the quick access bar. 
 
 - 
setViewOrtho(state)¶
- enable/disable the orthogonal projection for OpenGL rendering. Perspective projection is used when orthogonal one is disabled. - Parameters
- state (boolean) – the state of the orthogonal projection 
 
 - 
translateCamera(x, y, z)¶
- Translate the view camera by (x, y, z) - Parameters
- x (integer) – the translation offset along the X axis 
- y (integer) – the translation offset along the Y axis 
- z (integer) – the translation offset along the Z axis 
 
 
 - 
viewToWorld(vpos)¶
- Return the 3D world position for the given view position - Parameters
- vpos ( - tlp.Coord) – the view position
 
 - 
worldToView()¶
- Return the view position for the given 3D position - Parameters
- wpos ( - tlp.Coord) – the world position
 
 - 
zoom(step)¶
- Zoom by step - Parameters
- step (integer) – the zoom step 
 
 - 
zoomAndPanAnimation(bb, duration)¶
- Do a zoom and pan animation during a specific duration. At the end of the animation, the view will be zoomed and centered on the content of the given bounding box. - Parameters
- bb – the bounding box in scene coordinates on which the view has to be zoomed and panned. If it is not valid, the scene bounding box will be used. 
- duration (float) – the animation duration in msecs 
 
 
 - 
zoomFactor()¶
- Zoom by factor - Parameters
- factor (float) – the zoom factor 
 
 - 
zoomXY(step, x, y)¶
- Zoom by step to the given (x,y) view position - Parameters
- step (integer) – the zoom step 
- x (integer) – the x coordinate of the view position 
- y (integer) – the y coordinate of the view position 
 
 
 
- 
tlpgui.NodeLinkDiagramComponent¶
- 
class tlpgui.NodeLinkDiagramComponent¶
- New in version 4.4. - Bases: - tlpgui.GlMainView- That class represents the main type of view offered by Tulip : a node link diagram. - 
getInputData()¶
- Returns the current rendering input data for the node link diagram view. - Return type
 
 - 
getRenderingParameters()¶
- Returns a copy of the current rendering parameters for the node link diagram view. - Return type
 
 - 
quickAccessBarVisible()¶
- Returns the visibility state of the quick access bar. - Return type
- boolean 
 
 - 
setQuickAccessBarVisible(state)¶
- Sets the visibility state of the quick access bar. - Parameters
- state (boolean) – the visibility state of the quick access bar 
 
 - 
setRenderingParameters(parameters)¶
- Sets the rendering parameters for the node link diagram view. - Parameters
- parameters ( - tlpgui.GlGraphRenderingParameters) – the new rendering parameters
 
 
- 
tlpgui.GlGraphRenderingParameters¶
- 
class tlpgui.GlGraphRenderingParameters¶
- New in version 4.4. - That class holds all the rendering parameters for a Tulip OpenGL graph drawing. Use - tulipgui.tlpgui.NodeLinkDiagramComponent.getRenderingParameters()to get an instance on a such object.- 
getDisplayFilteringProperty()¶
- Returns the boolean property used to filter the rendering of graph elements. - Return type
 
 - 
getEdgesLabelStencil()¶
- Returns the stencil value for edges labels. - Return type
- integer 
 
 - 
getEdgesStencil()¶
- Returns the stencil value for edges. - Return type
- integer 
 
 - 
getElementOrderingProperty()¶
- Returns the double property used for the ordered rendering of graph elements. - Return type
 
 - 
getFontsPath()¶
- Returns the absolute path used for fonts loading (.ttf files). - Return type
- string 
 
 - 
getLabelsAreBillboarded()¶
- Returns the state of the labels billboarding (always facing the camera). - Return type
- boolean 
 
 - 
getLabelsDensity()¶
- Returns the labels density value. - Return type
- integer 
 
 - 
getMaxSizeOfLabel()¶
- Returns the maximum size of labels. That value is only used if the labels are not scaled to nodes sizes. - Return type
- integer 
 
 - 
getMetaNodesLabelStencil()¶
- Returns the stencil value for meta-nodes labels. - Return type
- integer 
 
 - 
getMetaNodesStencil()¶
- Returns the stencil value for meta-nodes. - Return type
- integer 
 
 - 
getMinSizeOfLabel()¶
- Returns the minimum size of labels. That value is only used if the labels are not scaled to nodes sizes. - Return type
- integer 
 
 - 
getNodesLabelStencil()¶
- Returns the stencil value for nodes labels. - Return type
- integer 
 
 - 
getNodesStencil()¶
- Returns the stencil value for nodes. - Return type
- integer 
 
 - 
getSelectedEdgesStencil()¶
- Returns the stencil value for selected edges. - Return type
- integer 
 
 - 
getSelectedMetaNodesStencil()¶
- Returns the stencil value for selected meta-nodes. - Return type
- integer 
 
 - 
getSelectedNodesStencil()¶
- Returns the stencil value for selected nodes. - Return type
- integer 
 
 - 
getSelectionColor()¶
- Returns the color of selection. - Return type
 
 - 
getTexturePath()¶
- Returns the absolute path used for texture loading. - Return type
- string 
 
 - 
isAntialiased()¶
- Returns if antialiasing rendering is activated. - Return type
- boolean 
 
 - 
isDisplayEdges()¶
- Returns the state of the display of edges. - Return type
- boolean 
 
 - 
isDisplayMetaNodes()¶
- Returns the state of the display of meta-nodes. - Return type
- boolean 
 
 - 
isDisplayNodes()¶
- Returns the state of the display of nodes. - Return type
- boolean 
 
 - 
isEdge3D()¶
- Returns the state of the 3d edge rendering. - Return type
- boolean 
 
 - 
isEdgeColorInterpolate()¶
- Returns the state of the edge color interpolation. - Return type
- boolean 
 
 - 
isEdgeSizeInterpolate()¶
- Returns the state of the edge size interpolation. - Return type
- boolean 
 
 - 
isElementOrdered()¶
- Returns the state of the ordered rendering of graph elements. - Return type
- boolean 
 
 - 
isElementOrderedDescending()¶
- New in version 4.8. - Returns if the graph elements are sorted in descending order when the element ordering is activated - Return type
- boolean 
 
 - 
isElementZOrdered()¶
- Returns the state of the z-ordered rendering. - Return type
- boolean 
 
 - 
isLabelFixedFontSize()¶
- Return type
- boolean 
 
 - 
isLabelScaled()¶
- Returns the state of the scaling of labels to nodes sizes. - Return type
- boolean 
 
 - 
isViewArrow()¶
- Returns the state of the display of arrows along the graph edges. - Return type
- boolean 
 
 - 
isViewEdgeLabel()¶
- Returns the state of the display of edges labels. - Return type
- boolean 
 
 - 
isViewMetaLabel()¶
- Returns the state of the display of labels inside meta-nodes. - Return type
- boolean 
 
 - 
isViewNodeLabel()¶
- Returns the state of the display of nodes labels. - Return type
- boolean 
 
 - 
isViewOutScreenLabel()¶
- Returns the state of the display of labels for elements outside the screen. - Return type
- boolean 
 
 - 
setAntialiasing()¶
- enable/disable antialiasing. - Parameters
- antialiasing (boolean) – the antialiasing state 
 
 - 
setDisplayEdges(displayEdges)¶
- enable/disable the display of edges. - Parameters
- displayEdges (boolean) – the state of the display of edges. 
 
 - 
setDisplayFilteringProperty(property)¶
- Sets the boolean property used to filter the rendering of graph elements. If sets to - None, the filtering is deactivated. If the value for a node/edge in that property is- False, it will not be displayed.- Parameters
- property ( - tulip.tlp.BooleanProperty) – the boolean property used to filter the rendering of graph elements
 
 - 
setDisplayMetaNodes(displayMetaNodes)¶
- enable/disable the display of nodes. - Parameters
- displayMetaNodes (boolean) – the state of the display of meta-nodes. 
 
 - 
setDisplayNodes(displayNodes)¶
- enable/disable the display of nodes. - Parameters
- displayNodes (boolean) – the state of the display of nodes. 
 
 - 
setEdge3D(edge3d)¶
- enable/disable the 3d display of edges instead of 2d lines. - Parameters
- edge3d (boolean) – the state of the 3d edge rendering 
 
 - 
setEdgeColorInterpolate(interpolate)¶
- enable/disable the interpolation of nodes colors along edges. - Parameters
- interpolate (boolean) – the state of the edge color interpolation 
 
 - 
setEdgeSizeInterpolate(interpolate)¶
- enable/disable the interpolation of nodes sizes along edges. - Parameters
- interpolate (boolean) – the state of the edge size interpolation 
 
 - 
setEdgesLabelStencil(stencil)¶
- Sets the stencil value for edges labels. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 255. - Parameters
- stencil (integer) – a value in the range [0, 255] 
 
 - 
setEdgesStencil(stencil)¶
- Sets the stencil value for edges. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 255. - Parameters
- stencil (integer) – a value in the range [0, 255] 
 
 - 
setElementOrdered(elementOrdered)¶
- enable/disable the ordered rendering of graph elements according to the values in the element ordering property. - Parameters
- elementsOrdered – the state of the ordered rendering 
 
 - 
setElementOrderedDescending(elementOrderedDescending)¶
- New in version 4.8. - Defines if the graph elements are sorted in descending order when the element ordering is activated. - Parameters
- elementsOrderedDescending – whether graph elements have to be sorted in descending order 
 
 - 
setElementOrderingProperty(property)¶
- Defines which property should be used for the ordered rendering of graph elements. Setting it to - Nonewill use the “viewMetric” property if the ordering is enabled.- Parameters
- property ( - tulip.tlp.NumericProperty) – the property to use to order the rendering of graph elements
 
 - 
setElementZOrdered(zOrdering)¶
- enable/disable the ordered rendering of elements according to their distance to the camera. - Parameters
- zOrdering (boolean) – the state of the z-ordered rendering 
 
 - 
setFontsPath(path)¶
- Sets the absolute path for fonts loading (.ttf files). - Parameters
- path (string) – the absolute path of a directory for fonts loading. 
 
 - 
setLabelFixedFontSize(fixedFontSize)¶
- Parameters
- fixedFontSize (boolean) – the state of using fixed font size with labels 
 
 - 
setLabelScaled(labelScaled)¶
- enable/disable the scaling of labels to nodes sizes. - Parameters
- labelScaled (boolean) – the state of the scaling of labels to nodes sizes. 
 
 - 
setLabelsAreBillboarded(billboardLabels)¶
- enable/disable labels billboarding (always facing the camera). - Parameters
- billboardLabels (boolean) – the state of labels billboarding 
 
 - 
setLabelsDensity(density)¶
- Sets the labels density value. It must be in the range [-100, 100]. The labels are displayed according to that value : - -100 : no labels are displayed 
- 0 : only non overlapping labels are displayed 
- 100 : all labels are displayed 
 - Parameters
- density (integer) – a value in the range [-100, 100] 
 
 - 
setMaxSizeOfLabel(size)¶
- Sets the maximum size of labels. That value is only used if the labels are not scaled to nodes sizes. - Parameters
- size – the maximum size of labels 
- Type
- integer 
 
 - 
setMetaNodesLabelStencil()¶
- Sets the stencil value for meta-nodes labels. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 255. - Parameters
- stencil (integer) – a value in the range [0, 255] 
 
 - 
setMetaNodesStencil(stencil)¶
- Sets the stencil value for meta-nodes. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 255. - Parameters
- stencil (integer) – a value in the range [0, 255] 
 
 - 
setMinSizeOfLabel(size)¶
- Sets the minimum size of labels. That value is only used if the labels are not scaled to nodes sizes. - Parameters
- size – the minimum size of labels 
- Type
- integer 
 
 - 
setNodesLabelStencil(stencil)¶
- Sets the stencil value for nodes labels. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 255. - Parameters
- stencil (integer) – a value in the range [0, 255] 
 
 - 
setNodesStencil(stencil)¶
- Sets the stencil value for nodes. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 255. - Parameters
- stencil (integer) – a value in the range [0, 255] 
 
 - 
setSelectedEdgesStencil(stencil)¶
- Sets the stencil value for selected edges. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 2. - Parameters
- stencil (integer) – a value in the range [0, 255] 
 
 - 
setSelectedMetaNodesStencil(stencil)¶
- Sets the stencil value for selected meta-nodes. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 2. - Parameters
- stencil (integer) – a value in the range [0, 255] 
 
 - 
setSelectedNodesStencil(stencil)¶
- Sets the stencil value for selected nodes. The lower the value is, the more the objects will be drawn on top of other ones. The default value is 2. - Parameters
- stencil (integer) – a value in the range [0, 255] 
 
 - 
setSelectionColor(color)¶
- Sets the color of selected elements. - Parameters
- color ( - tulip.tlp.Color) – the selection color
 
 - 
setTexturePath(path)¶
- Sets the absolute path for textures loading. - Parameters
- path (string) – the absolute path of a directory for textures loading. 
 
 - 
setViewArrow(arrow)¶
- enable/disable the display of arrows along the graph edges. - Parameters
- arrow (boolean) – the state of the arrows rendering 
 
 - 
setViewEdgeLabel(edgeLabel)¶
- enable/disable the display of edges labels. - Parameters
- edgeLabel (boolean) – the state of the edges labels rendering 
 
 - 
setViewMetaLabel(metaLabel)¶
- enable/disable the display of labels inside meta-nodes. - Parameters
- metaLabel – the state of the display of labels inside meta-nodes. 
 
 - 
setViewNodeLabel(nodeLabel)¶
- enable/disable the display of nodes labels. - Parameters
- nodeLabel (boolean) – the state of the nodes labels rendering 
 
 - 
setViewOutScreenLabel(outScreenLabel)¶
- enable/disable the display of labels for elements outside the screen. - Parameters
- outScreenLabel (boolean) – the state of the labels rendering for elements outside the screen. 
 
 
- 
tlpgui.GlGraphInputData¶
- 
class tlpgui.GlGraphInputData¶
- New in version 4.4. - That class defines all the visual properties used to render a graph (layout, colors, sizes, …). By default, Tulip creates a pool of default properties whose name is prefixed by “view”. Through the use of that class, you can set other properties as rendering input data. - Use - tulipgui.tlpgui.NodeLinkDiagramComponent.getInputData()to get an instance on a such object.- 
getElementBorderColor()¶
- Returns the color property that defines the current borders colors of graph elements (see Colors of graph elements and labels). - Return type
 
 - 
getElementBorderWidth()¶
- Returns the double property that defines the current borders widths of graph elements (see Border width of graph elements and labels). - Return type
 
 - 
getElementColor()¶
- Returns the color property that defines the current colors of graph elements (see Colors of graph elements and labels). - Return type
 
 - 
getElementFont()¶
- Returns the string property that defines the current font files used to render the labels of graph elements (see Labels of graph elements). - Return type
 
 - 
getElementFontSize()¶
- Returns the integer property that defines the current font size for labels of graph elements (see Labels of graph elements). - Return type
 
 - 
getElementLabel()¶
- Returns the string property that defines the current labels of graph elements (see Labels of graph elements). - Return type
 
 - 
getElementLabelBorderColor()¶
- Returns the color property that defines the current labels border colors of graph elements (see Colors of graph elements and labels). - Return type
 
 - 
getElementLabelBorderWidth()¶
- Returns the double property that defines the current labels borders widths of graph elements (see Border width of graph elements and labels). - Return type
 
 - 
getElementLabelColor()¶
- Returns the color property that defines the current labels colors of graph elements (see Colors of graph elements and labels). - Return type
 
 - 
getElementLabelPosition()¶
- Returns the integer property that defines the current labels positions of graph elements (see Labels of graph elements). - Return type
 
 - 
getElementLayout()¶
- Returns the layout property that defines the current layout of graph elements (see Graph layout). - Return type
 
 - 
getElementRotation()¶
- Returns the double property that defines the current rotations of graph nodes (see Rotations of the nodes). - Return type
 
 - 
getElementSelected()¶
- Returns the boolean property that defines the current selection of graph elements (see Selection). - Return type
 
 - 
getElementShape()¶
- Returns the integer property that defines the current shapes of graph elements (see Shapes of graph elements). - Return type
 
 - 
getElementSize()¶
- Returns the size property that defines the current sizes of graph elements (see Sizes of graph elements). - Return type
 
 - 
getElementSrcAnchorShape()¶
- Returns the integer property that defines the current shapes of the source edges extremities (see Shapes of graph elements). - Return type
 
 - 
getElementSrcAnchorSize()¶
- Returns the size property that defines the current sizes of the source edges extremities (see Sizes of graph elements). - Return type
 
 - 
getElementTexture()¶
- Returns the string property that defines the current image files used to texture the shapes of graph elements (see Applying a texture to nodes or edges). - Return type
 
 - 
getElementTgtAnchorShape()¶
- Returns the integer property that defines the current shapes of the target edges extremities (see Shapes of graph elements). - Return type
 
 - 
getElementTgtAnchorSize()¶
- Returns the size property that defines the current sizes of the target edges extremities (see Sizes of graph elements). - Return type
 
 - 
getGraph()¶
- Returns the graph associated to these data. - Return type
 
 - 
reloadGraphProperties()¶
- Restores all default graph visual properties (whose name is prefixed by “view”) as rendering input data. 
 - 
setElementBorderColor(property)¶
- Sets the color property that defines the current borders colors of graph elements (see Colors of graph elements and labels). - Parameters
- property ( - tulip.tlp.ColorProperty) – a color property attached to the graph associated to these data.
 
 - 
setElementBorderWidth(property)¶
- Sets the double property that defines the current borders widths of graph elements (see Border width of graph elements and labels). - Parameters
- property ( - tulip.tlp.DoubleProperty) – a double property attached to the graph associated to these data.
 
 - 
setElementColor(property)¶
- Sets the color property that defines the current colors of graph elements (see Colors of graph elements and labels). - Parameters
- property ( - tulip.tlp.ColorProperty) – a color property attached to the graph associated to these data.
 
 - 
setElementFont(property)¶
- Sets the string property that defines the current font files used to render the labels of graph elements (see Labels of graph elements). - Parameters
- property ( - tulip.tlp.StringProperty) – a string property attached to the graph associated to these data.
 
 - 
setElementFontSize(property)¶
- Sets the integer property that defines the current font size for labels of graph elements (see Labels of graph elements). - Parameters
- property ( - tulip.tlp.IntegerProperty) – an integer property attached to the graph associated to these data.
 
 - 
setElementLabel(property)¶
- Sets the string property that defines the current labels of graph elements (see Labels of graph elements). - Parameters
- property ( - tulip.tlp.StringProperty) – a string property attached to the graph associated to these data.
 
 - 
setElementLabelBorderColor()¶
- Sets the color property that defines the current labels borders colors of graph elements (see Colors of graph elements and labels). - Parameters
- property ( - tulip.tlp.ColorProperty) – a color property attached to the graph associated to these data.
 
 - 
setElementLabelBorderWidth(property)¶
- Sets the double property that defines the current labels borders widths of graph elements (see Border width of graph elements and labels). - Parameters
- property ( - tulip.tlp.DoubleProperty) – a double property attached to the graph associated to these data.
 
 - 
setElementLabelColor(property)¶
- Sets the color property that defines the current labels colors of graph elements (see Colors of graph elements and labels). - Parameters
- property ( - tulip.tlp.ColorProperty) – a color property attached to the graph associated to these data.
 
 - 
setElementLabelPosition(property)¶
- Sets the integer property that defines the current labels positions of graph elements (see Labels of graph elements). - Parameters
- property ( - tulip.tlp.IntegerProperty) – an integer property attached to the graph associated to these data.
 
 - 
setElementLayout(property)¶
- Sets the layout property that defines the current layout of graph elements (see Graph layout). - Parameters
- property ( - tulip.tlp.LayoutProperty) – a layout property attached to the graph associated to these data.
 
 - 
setElementRotation(property)¶
- Sets the double property that defines the current rotations graph nodes (see Rotations of the nodes). - Parameters
- property ( - tulip.tlp.DoubleProperty) – a double property attached to the graph associated to these data.
 
 - 
setElementSelected(property)¶
- Sets the boolean property that defines the current selection of graph elements (see Selection). - Parameters
- property ( - tulip.tlp.BooleanProperty) – a boolean property attached to the graph associated to these data.
 
 - 
setElementShape(property)¶
- Sets the integer property that defines the current shapes of graph elements (see Shapes of graph elements). - Parameters
- property ( - tulip.tlp.IntegerProperty) – an integer property attached to the graph associated to these data.
 
 - 
setElementSize(property)¶
- Sets the size property that defines the current sizes of graph elements (see Sizes of graph elements). - Parameters
- property ( - tulip.tlp.SizeProperty) – a size property attached to the graph associated to these data.
 
 - 
setElementSrcAnchorShape(property)¶
- Sets the integer property that defines the current shapes of the source edges extremities (see Shapes of graph elements). - Parameters
- property ( - tulip.tlp.IntegerProperty) – an integer property attached to the graph associated to these data.
 
 - 
setElementSrcAnchorSize(property)¶
- Sets the size property that defines the current sizes of the source edges extremities (see Shapes of graph elements). - Parameters
- property ( - tulip.tlp.SizeProperty) – a size property attached to the graph associated to these data.
 
 - 
setElementTexture(property)¶
- Sets the string property that defines the current image files used to texture the shapes of graph elements (see Applying a texture to nodes or edges). - Parameters
- property ( - tulip.tlp.StringProperty) – a string property attached to the graph associated to these data.
 
 - 
setElementTgtAnchorShape(property)¶
- Sets the integer property that defines the current shapes of the target edges extremities (see Shapes of graph elements). - Parameters
- property ( - tulip.tlp.IntegerProperty) – an integer property attached to the graph associated to these data.
 
 - 
setElementTgtAnchorSize(property)¶
- Sets the size property that defines the current sizes of the target edges extremities (see Shapes of graph elements). - Parameters
- property ( - tulip.tlp.SizeProperty) – a size property attached to the graph associated to these data.
 
 
-