topologicpy 0.8.45__py3-none-any.whl → 0.8.47__py3-none-any.whl
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- topologicpy/ANN.py +19 -19
- topologicpy/BVH.py +5 -5
- topologicpy/CSG.py +17 -17
- topologicpy/Cell.py +295 -295
- topologicpy/CellComplex.py +67 -67
- topologicpy/Cluster.py +35 -35
- topologicpy/Color.py +8 -8
- topologicpy/DGL.py +52 -52
- topologicpy/Dictionary.py +22 -22
- topologicpy/Edge.py +77 -77
- topologicpy/EnergyModel.py +25 -25
- topologicpy/Face.py +270 -270
- topologicpy/Graph.py +1212 -697
- topologicpy/Grid.py +24 -24
- topologicpy/Helper.py +8 -8
- topologicpy/Honeybee.py +13 -13
- topologicpy/Matrix.py +11 -11
- topologicpy/Neo4j.py +21 -21
- topologicpy/Plotly.py +213 -213
- topologicpy/PyG.py +41 -41
- topologicpy/ShapeGrammar.py +7 -7
- topologicpy/Shell.py +104 -104
- topologicpy/Sun.py +46 -46
- topologicpy/Topology.py +392 -392
- topologicpy/Vector.py +25 -25
- topologicpy/Vertex.py +64 -64
- topologicpy/Wire.py +250 -250
- topologicpy/version.py +1 -1
- {topologicpy-0.8.45.dist-info → topologicpy-0.8.47.dist-info}/METADATA +1 -1
- topologicpy-0.8.47.dist-info/RECORD +38 -0
- topologicpy-0.8.45.dist-info/RECORD +0 -38
- {topologicpy-0.8.45.dist-info → topologicpy-0.8.47.dist-info}/WHEEL +0 -0
- {topologicpy-0.8.45.dist-info → topologicpy-0.8.47.dist-info}/licenses/LICENSE +0 -0
- {topologicpy-0.8.45.dist-info → topologicpy-0.8.47.dist-info}/top_level.txt +0 -0
topologicpy/Plotly.py
CHANGED
@@ -47,26 +47,26 @@ class Plotly:
|
|
47
47
|
figure : plotly.graph_objs._figure.Figure
|
48
48
|
The input plotly figure.
|
49
49
|
values : list , optional
|
50
|
-
The input list of values to use for the color bar.
|
50
|
+
The input list of values to use for the color bar. Default is [].
|
51
51
|
nTicks : int , optional
|
52
|
-
The number of ticks to use on the color bar.
|
52
|
+
The number of ticks to use on the color bar. Default is 5.
|
53
53
|
xPosition : float , optional
|
54
|
-
The x location of the color bar.
|
54
|
+
The x location of the color bar. Default is -0.15.
|
55
55
|
width : int , optional
|
56
|
-
The width in pixels of the color bar.
|
56
|
+
The width in pixels of the color bar. Default is 15
|
57
57
|
outlineWidth : int , optional
|
58
|
-
The width in pixels of the outline of the color bar.
|
58
|
+
The width in pixels of the outline of the color bar. Default is 0.
|
59
59
|
title : str , optional
|
60
|
-
The title of the color bar.
|
60
|
+
The title of the color bar. Default is "".
|
61
61
|
subTitle : str , optional
|
62
|
-
The subtitle of the color bar.
|
62
|
+
The subtitle of the color bar. Default is "".
|
63
63
|
units: str , optional
|
64
|
-
The units used in the color bar.
|
64
|
+
The units used in the color bar. Default is ""
|
65
65
|
colorScale : str , optional
|
66
|
-
The desired type of plotly color scales to use (e.g. "viridis", "plasma").
|
66
|
+
The desired type of plotly color scales to use (e.g. "viridis", "plasma"). Default is "viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
|
67
67
|
In addition to these, three color-blind friendly scales are included. These are "protanopia", "deuteranopia", and "tritanopia" for red, green, and blue colorblindness respectively.
|
68
68
|
mantissa : int , optional
|
69
|
-
The desired length of the mantissa for the values listed on the color bar.
|
69
|
+
The desired length of the mantissa for the values listed on the color bar. Default is 6.
|
70
70
|
Returns
|
71
71
|
-------
|
72
72
|
plotly.graph_objs._figure.Figure
|
@@ -327,18 +327,18 @@ class Plotly:
|
|
327
327
|
graph : topologic_core.Graph
|
328
328
|
The input graph.
|
329
329
|
sagitta : float , optional
|
330
|
-
The length of the sagitta. In mathematics, the sagitta is the line connecting the center of a chord to the apex (or highest point) of the arc subtended by that chord.
|
330
|
+
The length of the sagitta. In mathematics, the sagitta is the line connecting the center of a chord to the apex (or highest point) of the arc subtended by that chord. Default is 0 which means a straight edge is drawn instead of an arc. Default is 0.
|
331
331
|
absolute : bool , optional
|
332
|
-
If set to True, the sagitta length is treated as an absolute value. Otherwise, it is treated as a ratio based on the length of the edge.
|
333
|
-
For example, if the length of the edge is 10, the sagitta is set to 0.5, and absolute is set to False, the sagitta length will be 5.
|
332
|
+
If set to True, the sagitta length is treated as an absolute value. Otherwise, it is treated as a ratio based on the length of the edge. Default is False.
|
333
|
+
For example, if the length of the edge is 10, the sagitta is set to 0.5, and absolute is set to False, the sagitta length will be 5. Default is True.
|
334
334
|
sides : int , optional
|
335
|
-
The number of sides of the arc.
|
335
|
+
The number of sides of the arc. Default is 8.
|
336
336
|
directed : bool , optional
|
337
|
-
If set to True, arrowheads are drawn to show direction.
|
337
|
+
If set to True, arrowheads are drawn to show direction. Default is False.
|
338
338
|
arrowSize : int, optional
|
339
|
-
The desired size of arrowheads for directed graphs.
|
339
|
+
The desired size of arrowheads for directed graphs. Default is 0.1.
|
340
340
|
arrowSizeKey: str , optional
|
341
|
-
The edge dictionary key under which to find the arrowhead size.
|
341
|
+
The edge dictionary key under which to find the arrowhead size. Default is None.
|
342
342
|
vertexColor : str , optional
|
343
343
|
The desired color of the output vertices. This can be any plotly color string and may be specified as:
|
344
344
|
- A hex string (e.g. '#ff0000')
|
@@ -348,31 +348,31 @@ class Plotly:
|
|
348
348
|
- A named CSS color.
|
349
349
|
The default is "black".
|
350
350
|
vertexColorKey : str , optional
|
351
|
-
The dictionary key under which to find the vertex color.
|
351
|
+
The dictionary key under which to find the vertex color. Default is None.
|
352
352
|
vertexSize : float , optional
|
353
|
-
The desired size of the vertices.
|
353
|
+
The desired size of the vertices. Default is 6.
|
354
354
|
vertexLabelKey : str , optional
|
355
|
-
The dictionary key to use to display the vertex label.
|
355
|
+
The dictionary key to use to display the vertex label. Default is None.
|
356
356
|
vertexGroupKey : str , optional
|
357
|
-
The dictionary key to use to display the vertex group.
|
357
|
+
The dictionary key to use to display the vertex group. Default is None.
|
358
358
|
vertexGroups : list , optional
|
359
|
-
The list of vertex groups against which to index the color of the vertex.
|
359
|
+
The list of vertex groups against which to index the color of the vertex. Default is [].
|
360
360
|
vertexMinGroup : int or float , optional
|
361
|
-
For numeric vertexGroups, vertexMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the minimum value in vertexGroups.
|
361
|
+
For numeric vertexGroups, vertexMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the minimum value in vertexGroups. Default is None.
|
362
362
|
vertexMaxGroup : int or float , optional
|
363
|
-
For numeric vertexGroups, vertexMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the maximum value in vertexGroups.
|
363
|
+
For numeric vertexGroups, vertexMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the maximum value in vertexGroups. Default is None.
|
364
364
|
showVertices : bool , optional
|
365
|
-
If set to True the vertices will be drawn. Otherwise, they will not be drawn.
|
365
|
+
If set to True the vertices will be drawn. Otherwise, they will not be drawn. Default is True.
|
366
366
|
showVertexLabels : bool , optional
|
367
|
-
If set to True, the vertex labels are shown permenantely on screen. Otherwise, they are not.
|
367
|
+
If set to True, the vertex labels are shown permenantely on screen. Otherwise, they are not. Default is False.
|
368
368
|
showVertexLegend : bool , optional
|
369
|
-
If set to True the vertex legend will be drawn. Otherwise, it will not be drawn.
|
369
|
+
If set to True the vertex legend will be drawn. Otherwise, it will not be drawn. Default is False.
|
370
370
|
vertexLegendLabel : str , optional
|
371
|
-
The legend label string used to identify vertices.
|
371
|
+
The legend label string used to identify vertices. Default is "Topology Vertices".
|
372
372
|
vertexLegendRank : int , optional
|
373
|
-
The legend rank order of the vertices of this topology.
|
373
|
+
The legend rank order of the vertices of this topology. Default is 1.
|
374
374
|
vertexLegendGroup : int , optional
|
375
|
-
The number of the vertex legend group to which the vertices of this topology belong.
|
375
|
+
The number of the vertex legend group to which the vertices of this topology belong. Default is 1.
|
376
376
|
edgeColor : str , optional
|
377
377
|
The desired color of the output edges. This can be any plotly color string and may be specified as:
|
378
378
|
- A hex string (e.g. '#ff0000')
|
@@ -382,31 +382,31 @@ class Plotly:
|
|
382
382
|
- A named CSS color.
|
383
383
|
The default is "black".
|
384
384
|
edgeColorKey : str , optional
|
385
|
-
The dictionary key under which to find the edge color.
|
385
|
+
The dictionary key under which to find the edge color. Default is None.
|
386
386
|
edgeWidth : float , optional
|
387
|
-
The desired thickness of the output edges.
|
387
|
+
The desired thickness of the output edges. Default is 1.
|
388
388
|
edgeWidthKey : str , optional
|
389
|
-
The dictionary key under which to find the edge width.
|
389
|
+
The dictionary key under which to find the edge width. Default is None.
|
390
390
|
edgeLabelKey : str , optional
|
391
|
-
The dictionary key to use to display the edge label.
|
391
|
+
The dictionary key to use to display the edge label. Default is None.
|
392
392
|
edgeDash : bool , optional
|
393
|
-
If set to True, the edges are drawn as dashed lines.
|
393
|
+
If set to True, the edges are drawn as dashed lines. Default is False.
|
394
394
|
edgeDashKey : str , optional
|
395
|
-
The key under which to find the boolean flag to draw edges as dashed lines.
|
395
|
+
The key under which to find the boolean flag to draw edges as dashed lines. Default is None.
|
396
396
|
edgeGroupKey : str , optional
|
397
|
-
The dictionary key to use to display the edge group.
|
397
|
+
The dictionary key to use to display the edge group. Default is None.
|
398
398
|
edgeGroups : list , optional
|
399
|
-
The list of groups to use for indexing the color of edges.
|
399
|
+
The list of groups to use for indexing the color of edges. Default is None.
|
400
400
|
showEdges : bool , optional
|
401
|
-
If set to True the edges will be drawn. Otherwise, they will not be drawn.
|
401
|
+
If set to True the edges will be drawn. Otherwise, they will not be drawn. Default is True.
|
402
402
|
showEdgeLabels : bool , optional
|
403
|
-
If set to True, the edge labels are shown permenantely on screen. Otherwise, they are not.
|
403
|
+
If set to True, the edge labels are shown permenantely on screen. Otherwise, they are not. Default is False.
|
404
404
|
showEdgeLegend : bool , optional
|
405
|
-
If set to True the edge legend will be drawn. Otherwise, it will not be drawn.
|
405
|
+
If set to True the edge legend will be drawn. Otherwise, it will not be drawn. Default is False.
|
406
406
|
colorScale : str , optional
|
407
|
-
The desired type of plotly color scales to use (e.g. "Viridis", "Plasma").
|
407
|
+
The desired type of plotly color scales to use (e.g. "Viridis", "Plasma"). Default is "Viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
|
408
408
|
silent : bool , optional
|
409
|
-
If set to True, error and warning messages are suppressed.
|
409
|
+
If set to True, error and warning messages are suppressed. Default is False.
|
410
410
|
|
411
411
|
Returns
|
412
412
|
-------
|
@@ -911,9 +911,9 @@ class Plotly:
|
|
911
911
|
The input topology. This must contain faces and or edges.
|
912
912
|
|
913
913
|
showVertices : bool , optional
|
914
|
-
If set to True the vertices will be drawn. Otherwise, they will not be drawn.
|
914
|
+
If set to True the vertices will be drawn. Otherwise, they will not be drawn. Default is True.
|
915
915
|
vertexSize : float , optional
|
916
|
-
The desired size of the output vertices.
|
916
|
+
The desired size of the output vertices. Default is 1.1.
|
917
917
|
vertexSizeKey : str , optional
|
918
918
|
The dictionary key under which to find the vertex size.The default is None.
|
919
919
|
vertexColor : str , optional
|
@@ -927,7 +927,7 @@ class Plotly:
|
|
927
927
|
vertexColorKey : str , optional
|
928
928
|
The dictionary key under which to find the vertex color.The default is None.
|
929
929
|
vertexBorderWidth : float , optional
|
930
|
-
The desired width of the border of the output vertices.
|
930
|
+
The desired width of the border of the output vertices. Default is 1.
|
931
931
|
vertexBorderColor : str , optional
|
932
932
|
The desired color of the border of the output vertices. This can be any plotly color string and may be specified as:
|
933
933
|
- A hex string (e.g. '#ff0000')
|
@@ -937,33 +937,33 @@ class Plotly:
|
|
937
937
|
- A named CSS color.
|
938
938
|
The default is "black".
|
939
939
|
vertexLabelKey : str , optional
|
940
|
-
The dictionary key to use to display the vertex label.
|
940
|
+
The dictionary key to use to display the vertex label. Default is None.
|
941
941
|
vertexGroupKey : str , optional
|
942
|
-
The dictionary key to use to display the vertex group.
|
942
|
+
The dictionary key to use to display the vertex group. Default is None.
|
943
943
|
vertexGroups : list , optional
|
944
|
-
The list of vertex groups against which to index the color of the vertex.
|
944
|
+
The list of vertex groups against which to index the color of the vertex. Default is [].
|
945
945
|
vertexMinGroup : int or float , optional
|
946
|
-
For numeric vertexGroups, vertexMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the minimum value in vertexGroups.
|
946
|
+
For numeric vertexGroups, vertexMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the minimum value in vertexGroups. Default is None.
|
947
947
|
vertexMaxGroup : int or float , optional
|
948
|
-
For numeric vertexGroups, vertexMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the maximum value in vertexGroups.
|
948
|
+
For numeric vertexGroups, vertexMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the maximum value in vertexGroups. Default is None.
|
949
949
|
showVertexLegend : bool, optional
|
950
|
-
If set to True, the legend for the vertices of this topology is shown. Otherwise, it isn't.
|
950
|
+
If set to True, the legend for the vertices of this topology is shown. Otherwise, it isn't. Default is False.
|
951
951
|
vertexLegendLabel : str , optional
|
952
|
-
The legend label string used to identify vertices.
|
952
|
+
The legend label string used to identify vertices. Default is "Topology Vertices".
|
953
953
|
vertexLegendRank : int , optional
|
954
|
-
The legend rank order of the vertices of this topology.
|
954
|
+
The legend rank order of the vertices of this topology. Default is 1.
|
955
955
|
vertexLegendGroup : int , optional
|
956
|
-
The number of the vertex legend group to which the vertices of this topology belong.
|
956
|
+
The number of the vertex legend group to which the vertices of this topology belong. Default is 1.
|
957
957
|
directed : bool , optional
|
958
|
-
If set to True, arrowheads are drawn to show direction.
|
958
|
+
If set to True, arrowheads are drawn to show direction. Default is False.
|
959
959
|
arrowSize : int, optional
|
960
|
-
The desired size of arrowheads for directed graphs.
|
960
|
+
The desired size of arrowheads for directed graphs. Default is 0.1.
|
961
961
|
arrowSizeKey: str , optional
|
962
|
-
The edge dictionary key under which to find the arrowhead size.
|
962
|
+
The edge dictionary key under which to find the arrowhead size. Default is None.
|
963
963
|
showEdges : bool , optional
|
964
|
-
If set to True the edges will be drawn. Otherwise, they will not be drawn.
|
964
|
+
If set to True the edges will be drawn. Otherwise, they will not be drawn. Default is True.
|
965
965
|
edgeWidth : float , optional
|
966
|
-
The desired thickness of the output edges.
|
966
|
+
The desired thickness of the output edges. Default is 1.
|
967
967
|
edgeWidthKey : str , optional
|
968
968
|
The dictionary key under which to find the edge width.The default is None.
|
969
969
|
edgeColor : str , optional
|
@@ -977,32 +977,32 @@ class Plotly:
|
|
977
977
|
edgeColorKey : str , optional
|
978
978
|
The dictionary key under which to find the edge color.The default is None.
|
979
979
|
edgeDash : bool , optional
|
980
|
-
If set to True, the edges are drawn as dashed lines.
|
980
|
+
If set to True, the edges are drawn as dashed lines. Default is False.
|
981
981
|
edgeDashKey : str , optional
|
982
|
-
The key under which to find the boolean flag to draw edges as dashed lines.
|
982
|
+
The key under which to find the boolean flag to draw edges as dashed lines. Default is None.
|
983
983
|
edgeLabelKey : str , optional
|
984
|
-
The dictionary key to use to display the edge label.
|
984
|
+
The dictionary key to use to display the edge label. Default is None.
|
985
985
|
edgeGroupKey : str , optional
|
986
|
-
The dictionary key to use to display the edge group.
|
986
|
+
The dictionary key to use to display the edge group. Default is None.
|
987
987
|
edgeGroups : list , optional
|
988
|
-
The list of edge groups against which to index the color of the edge.
|
988
|
+
The list of edge groups against which to index the color of the edge. Default is [].
|
989
989
|
edgeMinGroup : int or float , optional
|
990
|
-
For numeric edgeGroups, edgeMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the edgeGroupKey. If set to None, it is set to the minimum value in edgeGroups.
|
990
|
+
For numeric edgeGroups, edgeMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the edgeGroupKey. If set to None, it is set to the minimum value in edgeGroups. Default is None.
|
991
991
|
edgeMaxGroup : int or float , optional
|
992
|
-
For numeric edgeGroups, edgeMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the edgeGroupKey. If set to None, it is set to the maximum value in edgeGroups.
|
992
|
+
For numeric edgeGroups, edgeMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the edgeGroupKey. If set to None, it is set to the maximum value in edgeGroups. Default is None.
|
993
993
|
showEdgeLegend : bool, optional
|
994
|
-
If set to True, the legend for the edges of this topology is shown. Otherwise, it isn't.
|
994
|
+
If set to True, the legend for the edges of this topology is shown. Otherwise, it isn't. Default is False.
|
995
995
|
edgeLegendLabel : str , optional
|
996
|
-
The legend label string used to identify edges.
|
996
|
+
The legend label string used to identify edges. Default is "Topology Edges".
|
997
997
|
edgeLegendRank : int , optional
|
998
|
-
The legend rank order of the edges of this topology.
|
998
|
+
The legend rank order of the edges of this topology. Default is 2.
|
999
999
|
edgeLegendGroup : int , optional
|
1000
|
-
The number of the edge legend group to which the edges of this topology belong.
|
1000
|
+
The number of the edge legend group to which the edges of this topology belong. Default is 2.
|
1001
1001
|
|
1002
1002
|
showFaces : bool , optional
|
1003
|
-
If set to True the faces will be drawn. Otherwise, they will not be drawn.
|
1003
|
+
If set to True the faces will be drawn. Otherwise, they will not be drawn. Default is True.
|
1004
1004
|
faceOpacity : float , optional
|
1005
|
-
The desired opacity of the output faces (0=transparent, 1=opaque).
|
1005
|
+
The desired opacity of the output faces (0=transparent, 1=opaque). Default is 0.5.
|
1006
1006
|
faceOpacityKey : str , optional
|
1007
1007
|
The dictionary key under which to find the face opacity.The default is None.
|
1008
1008
|
faceColor : str , optional
|
@@ -1016,33 +1016,33 @@ class Plotly:
|
|
1016
1016
|
faceColorKey : str , optional
|
1017
1017
|
The dictionary key under which to find the face color.The default is None.
|
1018
1018
|
faceLabelKey : str , optional
|
1019
|
-
The dictionary key to use to display the face label.
|
1019
|
+
The dictionary key to use to display the face label. Default is None.
|
1020
1020
|
faceGroupKey : str , optional
|
1021
|
-
The dictionary key to use to display the face group.
|
1021
|
+
The dictionary key to use to display the face group. Default is None.
|
1022
1022
|
faceGroups : list , optional
|
1023
|
-
The list of face groups against which to index the color of the face. This can bhave numeric or string values. This should match the type of value associated with the faceGroupKey.
|
1023
|
+
The list of face groups against which to index the color of the face. This can bhave numeric or string values. This should match the type of value associated with the faceGroupKey. Default is [].
|
1024
1024
|
faceMinGroup : int or float , optional
|
1025
|
-
For numeric faceGroups, minGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the faceGroupKey. If set to None, it is set to the minimum value in faceGroups.
|
1025
|
+
For numeric faceGroups, minGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the faceGroupKey. If set to None, it is set to the minimum value in faceGroups. Default is None.
|
1026
1026
|
faceMaxGroup : int or float , optional
|
1027
|
-
For numeric faceGroups, maxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the faceGroupKey. If set to None, it is set to the maximum value in faceGroups.
|
1027
|
+
For numeric faceGroups, maxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the faceGroupKey. If set to None, it is set to the maximum value in faceGroups. Default is None.
|
1028
1028
|
showFaceLegend : bool, optional
|
1029
|
-
If set to True, the legend for the faces of this topology is shown. Otherwise, it isn't.
|
1029
|
+
If set to True, the legend for the faces of this topology is shown. Otherwise, it isn't. Default is False.
|
1030
1030
|
faceLegendLabel : str , optional
|
1031
|
-
The legend label string used to idenitfy edges.
|
1031
|
+
The legend label string used to idenitfy edges. Default is "Topology Faces".
|
1032
1032
|
faceLegendRank : int , optional
|
1033
|
-
The legend rank order of the faces of this topology.
|
1033
|
+
The legend rank order of the faces of this topology. Default is 3.
|
1034
1034
|
faceLegendGroup : int , optional
|
1035
|
-
The number of the face legend group to which the faces of this topology belong.
|
1035
|
+
The number of the face legend group to which the faces of this topology belong. Default is 3.
|
1036
1036
|
intensityKey: str, optional
|
1037
|
-
If not None, the dictionary of each vertex is searched for the value associated with the intensity key. This value is then used to color-code the vertex based on the colorScale.
|
1037
|
+
If not None, the dictionary of each vertex is searched for the value associated with the intensity key. This value is then used to color-code the vertex based on the colorScale. Default is None.
|
1038
1038
|
intensities : list , optional
|
1039
|
-
The list of intensities against which to index the intensity of the vertex.
|
1039
|
+
The list of intensities against which to index the intensity of the vertex. Default is [].
|
1040
1040
|
colorScale : str , optional
|
1041
|
-
The desired type of plotly color scales to use (e.g. "Viridis", "Plasma").
|
1041
|
+
The desired type of plotly color scales to use (e.g. "Viridis", "Plasma"). Default is "Viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
|
1042
1042
|
mantissa : int , optional
|
1043
|
-
The
|
1043
|
+
The number of decimal places to round the result to. Default is 6.
|
1044
1044
|
tolerance : float , optional
|
1045
|
-
The desired tolerance.
|
1045
|
+
The desired tolerance. Default is 0.0001.
|
1046
1046
|
|
1047
1047
|
Returns
|
1048
1048
|
-------
|
@@ -1335,25 +1335,25 @@ class Plotly:
|
|
1335
1335
|
categories : list
|
1336
1336
|
The list of categories to use on the X and Y axes.
|
1337
1337
|
minValue : float , optional
|
1338
|
-
The desired minimum value to use for the color scale. If set to None, the minmum value found in the input matrix will be used.
|
1338
|
+
The desired minimum value to use for the color scale. If set to None, the minmum value found in the input matrix will be used. Default is None.
|
1339
1339
|
maxValue : float , optional
|
1340
|
-
The desired maximum value to use for the color scale. If set to None, the maximum value found in the input matrix will be used.
|
1340
|
+
The desired maximum value to use for the color scale. If set to None, the maximum value found in the input matrix will be used. Default is None.
|
1341
1341
|
title : str , optional
|
1342
|
-
The desired title to display.
|
1342
|
+
The desired title to display. Default is "Confusion Matrix".
|
1343
1343
|
xTitle : str , optional
|
1344
|
-
The desired X-axis title to display.
|
1344
|
+
The desired X-axis title to display. Default is "Actual Categories".
|
1345
1345
|
yTitle : str , optional
|
1346
|
-
The desired Y-axis title to display.
|
1346
|
+
The desired Y-axis title to display. Default is "Predicted Categories".
|
1347
1347
|
width : int , optional
|
1348
|
-
The desired width of the figure.
|
1348
|
+
The desired width of the figure. Default is 950.
|
1349
1349
|
height : int , optional
|
1350
|
-
The desired height of the figure.
|
1350
|
+
The desired height of the figure. Default is 500.
|
1351
1351
|
showScale : bool , optional
|
1352
|
-
If set to True, a color scale is shown on the right side of the figure.
|
1352
|
+
If set to True, a color scale is shown on the right side of the figure. Default is True.
|
1353
1353
|
colorScale : str , optional
|
1354
|
-
The desired type of plotly color scales to use (e.g. "Viridis", "Plasma").
|
1354
|
+
The desired type of plotly color scales to use (e.g. "Viridis", "Plasma"). Default is "Viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
|
1355
1355
|
colorSamples : int , optional
|
1356
|
-
The number of discrete color samples to use for displaying the data.
|
1356
|
+
The number of discrete color samples to use for displaying the data. Default is 10.
|
1357
1357
|
backgroundColor : list or str , optional
|
1358
1358
|
The desired background color. This can be any color list or plotly color string and may be specified as:
|
1359
1359
|
- An rgb list (e.g. [255,0,0])
|
@@ -1365,13 +1365,13 @@ class Plotly:
|
|
1365
1365
|
- A named CSS color.
|
1366
1366
|
The default is 'rgba(0,0,0,0)' (transparent).
|
1367
1367
|
marginLeft : int , optional
|
1368
|
-
The desired left margin in pixels.
|
1368
|
+
The desired left margin in pixels. Default is 0.
|
1369
1369
|
marginRight : int , optional
|
1370
|
-
The desired right margin in pixels.
|
1370
|
+
The desired right margin in pixels. Default is 0.
|
1371
1371
|
marginTop : int , optional
|
1372
|
-
The desired top margin in pixels.
|
1372
|
+
The desired top margin in pixels. Default is 40.
|
1373
1373
|
marginBottom : int , optional
|
1374
|
-
The desired bottom margin in pixels.
|
1374
|
+
The desired bottom margin in pixels. Default is 0.
|
1375
1375
|
|
1376
1376
|
Returns
|
1377
1377
|
-------
|
@@ -1450,25 +1450,25 @@ class Plotly:
|
|
1450
1450
|
categories : list
|
1451
1451
|
The list of categories to use on the X and Y axes.
|
1452
1452
|
minValue : float , optional
|
1453
|
-
The desired minimum value to use for the color scale. If set to None, the minmum value found in the input matrix will be used.
|
1453
|
+
The desired minimum value to use for the color scale. If set to None, the minmum value found in the input matrix will be used. Default is None.
|
1454
1454
|
maxValue : float , optional
|
1455
|
-
The desired maximum value to use for the color scale. If set to None, the maximum value found in the input matrix will be used.
|
1455
|
+
The desired maximum value to use for the color scale. If set to None, the maximum value found in the input matrix will be used. Default is None.
|
1456
1456
|
title : str , optional
|
1457
|
-
The desired title to display.
|
1457
|
+
The desired title to display. Default is "Confusion Matrix".
|
1458
1458
|
xTitle : str , optional
|
1459
|
-
The desired X-axis title to display.
|
1459
|
+
The desired X-axis title to display. Default is "Actual".
|
1460
1460
|
yTitle : str , optional
|
1461
|
-
The desired Y-axis title to display.
|
1461
|
+
The desired Y-axis title to display. Default is "Predicted".
|
1462
1462
|
width : int , optional
|
1463
|
-
The desired width of the figure.
|
1463
|
+
The desired width of the figure. Default is 950.
|
1464
1464
|
height : int , optional
|
1465
|
-
The desired height of the figure.
|
1465
|
+
The desired height of the figure. Default is 500.
|
1466
1466
|
showScale : bool , optional
|
1467
|
-
If set to True, a color scale is shown on the right side of the figure.
|
1467
|
+
If set to True, a color scale is shown on the right side of the figure. Default is True.
|
1468
1468
|
colorScale : str , optional
|
1469
|
-
The desired type of plotly color scales to use (e.g. "Viridis", "Plasma").
|
1469
|
+
The desired type of plotly color scales to use (e.g. "Viridis", "Plasma"). Default is "Viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
|
1470
1470
|
colorSamples : int , optional
|
1471
|
-
The number of discrete color samples to use for displaying the data.
|
1471
|
+
The number of discrete color samples to use for displaying the data. Default is 10.
|
1472
1472
|
backgroundColor : list or str , optional
|
1473
1473
|
The desired background color. This can be any color list or plotly color string and may be specified as:
|
1474
1474
|
- An rgb list (e.g. [255,0,0])
|
@@ -1480,15 +1480,15 @@ class Plotly:
|
|
1480
1480
|
- A named CSS color.
|
1481
1481
|
The default is 'rgba(0,0,0,0)' (transparent).
|
1482
1482
|
marginLeft : int , optional
|
1483
|
-
The desired left margin in pixels.
|
1483
|
+
The desired left margin in pixels. Default is 0.
|
1484
1484
|
marginRight : int , optional
|
1485
|
-
The desired right margin in pixels.
|
1485
|
+
The desired right margin in pixels. Default is 0.
|
1486
1486
|
marginTop : int , optional
|
1487
|
-
The desired top margin in pixels.
|
1487
|
+
The desired top margin in pixels. Default is 40.
|
1488
1488
|
marginBottom : int , optional
|
1489
|
-
The desired bottom margin in pixels.
|
1489
|
+
The desired bottom margin in pixels. Default is 0.
|
1490
1490
|
mantissa : int , optional
|
1491
|
-
The desired number of digits of the mantissa.
|
1491
|
+
The desired number of digits of the mantissa. Default is 6.
|
1492
1492
|
|
1493
1493
|
"""
|
1494
1494
|
#import plotly.figure_factory as ff
|
@@ -1622,11 +1622,11 @@ class Plotly:
|
|
1622
1622
|
predicted : list
|
1623
1623
|
The predicted values to display.
|
1624
1624
|
title : str , optional
|
1625
|
-
The desired title to display.
|
1625
|
+
The desired title to display. Default is "Correlation between Actual and Predicted Values".
|
1626
1626
|
xTitle : str , optional
|
1627
|
-
The desired X-axis title to display.
|
1627
|
+
The desired X-axis title to display. Default is "Actual Values".
|
1628
1628
|
yTitle : str , optional
|
1629
|
-
The desired Y-axis title to display.
|
1629
|
+
The desired Y-axis title to display. Default is "Predicted Values".
|
1630
1630
|
dotColor : str , optional
|
1631
1631
|
The desired color of the dots. This can be any plotly color string and may be specified as:
|
1632
1632
|
- A hex string (e.g. '#ff0000')
|
@@ -1644,11 +1644,11 @@ class Plotly:
|
|
1644
1644
|
- A named CSS color.
|
1645
1645
|
The default is 'red'.
|
1646
1646
|
width : int , optional
|
1647
|
-
The desired width of the figure.
|
1647
|
+
The desired width of the figure. Default is 800.
|
1648
1648
|
height : int , optional
|
1649
|
-
The desired height of the figure.
|
1649
|
+
The desired height of the figure. Default is 600.
|
1650
1650
|
theme : str , optional
|
1651
|
-
The plotly color scheme to use. The options are "dark", "light", "default".
|
1651
|
+
The plotly color scheme to use. The options are "dark", "light", "default". Default is "default".
|
1652
1652
|
backgroundColor : list or str , optional
|
1653
1653
|
The desired background color. This can be any color list or plotly color string and may be specified as:
|
1654
1654
|
- An rgb list (e.g. [255,0,0])
|
@@ -1660,13 +1660,13 @@ class Plotly:
|
|
1660
1660
|
- A named CSS color.
|
1661
1661
|
The default is 'rgba(0,0,0,0)' (transparent).
|
1662
1662
|
marginLeft : int , optional
|
1663
|
-
The desired left margin in pixels.
|
1663
|
+
The desired left margin in pixels. Default is 0.
|
1664
1664
|
marginRight : int , optional
|
1665
|
-
The desired right margin in pixels.
|
1665
|
+
The desired right margin in pixels. Default is 0.
|
1666
1666
|
marginTop : int , optional
|
1667
|
-
The desired top margin in pixels.
|
1667
|
+
The desired top margin in pixels. Default is 40.
|
1668
1668
|
marginBottom : int , optional
|
1669
|
-
The desired bottom margin in pixels.
|
1669
|
+
The desired bottom margin in pixels. Default is 0.
|
1670
1670
|
|
1671
1671
|
Returns
|
1672
1672
|
-------
|
@@ -1780,23 +1780,23 @@ class Plotly:
|
|
1780
1780
|
data_labels : list
|
1781
1781
|
The labels to use for the data.
|
1782
1782
|
width : int , optional
|
1783
|
-
The desired width of the figure.
|
1783
|
+
The desired width of the figure. Default is 950.
|
1784
1784
|
height : int , optional
|
1785
|
-
The desired height of the figure.
|
1785
|
+
The desired height of the figure. Default is 500.
|
1786
1786
|
title : str , optional
|
1787
|
-
The chart title.
|
1787
|
+
The chart title. Default is "Training and Testing Results".
|
1788
1788
|
xTitle : str , optional
|
1789
|
-
The X-axis title.
|
1789
|
+
The X-axis title. Default is "Epochs".
|
1790
1790
|
xSpacing : float , optional
|
1791
|
-
The X-axis spacing.
|
1791
|
+
The X-axis spacing. Default is 1.0.
|
1792
1792
|
yTitle : str , optional
|
1793
|
-
The Y-axis title.
|
1793
|
+
The Y-axis title. Default is "Accuracy and Loss".
|
1794
1794
|
ySpacing : float , optional
|
1795
|
-
The Y-axis spacing.
|
1795
|
+
The Y-axis spacing. Default is 0.1.
|
1796
1796
|
useMarkers : bool , optional
|
1797
|
-
If set to True, markers will be displayed.
|
1797
|
+
If set to True, markers will be displayed. Default is False.
|
1798
1798
|
chartType : str , optional
|
1799
|
-
The desired type of chart. The options are "Line", "Bar", or "Scatter". It is case insensitive.
|
1799
|
+
The desired type of chart. The options are "Line", "Bar", or "Scatter". It is case insensitive. Default is "Line".
|
1800
1800
|
backgroundColor : list or str , optional
|
1801
1801
|
The desired background color. This can be any color list or plotly color string and may be specified as:
|
1802
1802
|
- An rgb list (e.g. [255,0,0])
|
@@ -1816,13 +1816,13 @@ class Plotly:
|
|
1816
1816
|
- A named CSS color.
|
1817
1817
|
The default is 'lightgray'
|
1818
1818
|
marginLeft : int , optional
|
1819
|
-
The desired left margin in pixels.
|
1819
|
+
The desired left margin in pixels. Default is 0.
|
1820
1820
|
marginRight : int , optional
|
1821
|
-
The desired right margin in pixels.
|
1821
|
+
The desired right margin in pixels. Default is 0.
|
1822
1822
|
marginTop : int , optional
|
1823
|
-
The desired top margin in pixels.
|
1823
|
+
The desired top margin in pixels. Default is 40.
|
1824
1824
|
marginBottom : int , optional
|
1825
|
-
The desired bottom margin in pixels.
|
1825
|
+
The desired bottom margin in pixels. Default is 0.
|
1826
1826
|
|
1827
1827
|
Returns
|
1828
1828
|
-------
|
@@ -1874,13 +1874,13 @@ class Plotly:
|
|
1874
1874
|
height : int , optional
|
1875
1875
|
The height in pixels of the figure. The default value is 950.
|
1876
1876
|
xAxis : bool , optional
|
1877
|
-
If set to True the x axis is drawn. Otherwise it is not drawn.
|
1877
|
+
If set to True the x axis is drawn. Otherwise it is not drawn. Default is False.
|
1878
1878
|
yAxis : bool , optional
|
1879
|
-
If set to True the y axis is drawn. Otherwise it is not drawn.
|
1879
|
+
If set to True the y axis is drawn. Otherwise it is not drawn. Default is False.
|
1880
1880
|
zAxis : bool , optional
|
1881
|
-
If set to True the z axis is drawn. Otherwise it is not drawn.
|
1881
|
+
If set to True the z axis is drawn. Otherwise it is not drawn. Default is False.
|
1882
1882
|
axisSize : float , optional
|
1883
|
-
The size of the X, Y, Z, axes.
|
1883
|
+
The size of the X, Y, Z, axes. Default is 1.
|
1884
1884
|
backgroundColor : list or str , optional
|
1885
1885
|
The desired background color. This can be any color list or plotly color string and may be specified as:
|
1886
1886
|
- An rgb list (e.g. [255,0,0])
|
@@ -1900,7 +1900,7 @@ class Plotly:
|
|
1900
1900
|
marginBottom : int , optional
|
1901
1901
|
The size in pixels of the bottom margin. The default value is 0.
|
1902
1902
|
tolerance : float , optional
|
1903
|
-
The desired tolerance.
|
1903
|
+
The desired tolerance. Default is 0.0001.
|
1904
1904
|
|
1905
1905
|
Returns
|
1906
1906
|
-------
|
@@ -2071,9 +2071,9 @@ class Plotly:
|
|
2071
2071
|
The input topology. This must contain faces and or edges.
|
2072
2072
|
|
2073
2073
|
showVertices : bool , optional
|
2074
|
-
If set to True the vertices will be drawn. Otherwise, they will not be drawn.
|
2074
|
+
If set to True the vertices will be drawn. Otherwise, they will not be drawn. Default is True.
|
2075
2075
|
vertexSize : float , optional
|
2076
|
-
The desired size of the vertices.
|
2076
|
+
The desired size of the vertices. Default is 1.1.
|
2077
2077
|
vertexColor : str , optional
|
2078
2078
|
The desired color of the output vertices. This can be any plotly color string and may be specified as:
|
2079
2079
|
- A hex string (e.g. '#ff0000')
|
@@ -2083,28 +2083,28 @@ class Plotly:
|
|
2083
2083
|
- A named CSS color.
|
2084
2084
|
The default is "black".
|
2085
2085
|
vertexLabelKey : str , optional
|
2086
|
-
The dictionary key to use to display the vertex label.
|
2086
|
+
The dictionary key to use to display the vertex label. Default is None.
|
2087
2087
|
vertexGroupKey : str , optional
|
2088
|
-
The dictionary key to use to display the vertex group.
|
2088
|
+
The dictionary key to use to display the vertex group. Default is None.
|
2089
2089
|
vertexGroups : list , optional
|
2090
|
-
The list of vertex groups against which to index the color of the vertex.
|
2090
|
+
The list of vertex groups against which to index the color of the vertex. Default is [].
|
2091
2091
|
vertexMinGroup : int or float , optional
|
2092
|
-
For numeric vertexGroups, vertexMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the minimum value in vertexGroups.
|
2092
|
+
For numeric vertexGroups, vertexMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the minimum value in vertexGroups. Default is None.
|
2093
2093
|
edgeMaxGroup : int or float , optional
|
2094
|
-
For numeric vertexGroups, vertexMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the maximum value in vertexGroups.
|
2094
|
+
For numeric vertexGroups, vertexMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the vertexGroupKey. If set to None, it is set to the maximum value in vertexGroups. Default is None.
|
2095
2095
|
showVertexLegend : bool, optional
|
2096
|
-
If set to True, the legend for the vertices of this topology is shown. Otherwise, it isn't.
|
2096
|
+
If set to True, the legend for the vertices of this topology is shown. Otherwise, it isn't. Default is False.
|
2097
2097
|
vertexLegendLabel : str , optional
|
2098
|
-
The legend label string used to identify vertices.
|
2098
|
+
The legend label string used to identify vertices. Default is "Topology Vertices".
|
2099
2099
|
vertexLegendRank : int , optional
|
2100
|
-
The legend rank order of the vertices of this topology.
|
2100
|
+
The legend rank order of the vertices of this topology. Default is 1.
|
2101
2101
|
vertexLegendGroup : int , optional
|
2102
|
-
The number of the vertex legend group to which the vertices of this topology belong.
|
2102
|
+
The number of the vertex legend group to which the vertices of this topology belong. Default is 1.
|
2103
2103
|
|
2104
2104
|
showEdges : bool , optional
|
2105
|
-
If set to True the edges will be drawn. Otherwise, they will not be drawn.
|
2105
|
+
If set to True the edges will be drawn. Otherwise, they will not be drawn. Default is True.
|
2106
2106
|
edgeWidth : float , optional
|
2107
|
-
The desired thickness of the output edges.
|
2107
|
+
The desired thickness of the output edges. Default is 1.
|
2108
2108
|
edgeColor : str , optional
|
2109
2109
|
The desired color of the output edges. This can be any plotly color string and may be specified as:
|
2110
2110
|
- A hex string (e.g. '#ff0000')
|
@@ -2114,28 +2114,28 @@ class Plotly:
|
|
2114
2114
|
- A named CSS color.
|
2115
2115
|
The default is "black".
|
2116
2116
|
edgeLabelKey : str , optional
|
2117
|
-
The dictionary key to use to display the edge label.
|
2117
|
+
The dictionary key to use to display the edge label. Default is None.
|
2118
2118
|
edgeGroupKey : str , optional
|
2119
|
-
The dictionary key to use to display the edge group.
|
2119
|
+
The dictionary key to use to display the edge group. Default is None.
|
2120
2120
|
edgeGroups : list , optional
|
2121
|
-
The list of edge groups against which to index the color of the edge.
|
2121
|
+
The list of edge groups against which to index the color of the edge. Default is [].
|
2122
2122
|
edgeMinGroup : int or float , optional
|
2123
|
-
For numeric edgeGroups, edgeMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the edgeGroupKey. If set to None, it is set to the minimum value in edgeGroups.
|
2123
|
+
For numeric edgeGroups, edgeMinGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the edgeGroupKey. If set to None, it is set to the minimum value in edgeGroups. Default is None.
|
2124
2124
|
edgeMaxGroup : int or float , optional
|
2125
|
-
For numeric edgeGroups, edgeMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the edgeGroupKey. If set to None, it is set to the maximum value in edgeGroups.
|
2125
|
+
For numeric edgeGroups, edgeMaxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the edgeGroupKey. If set to None, it is set to the maximum value in edgeGroups. Default is None.
|
2126
2126
|
showEdgeLegend : bool, optional
|
2127
|
-
If set to True, the legend for the edges of this topology is shown. Otherwise, it isn't.
|
2127
|
+
If set to True, the legend for the edges of this topology is shown. Otherwise, it isn't. Default is False.
|
2128
2128
|
edgeLegendLabel : str , optional
|
2129
|
-
The legend label string used to identify edges.
|
2129
|
+
The legend label string used to identify edges. Default is "Topology Edges".
|
2130
2130
|
edgeLegendRank : int , optional
|
2131
|
-
The legend rank order of the edges of this topology.
|
2131
|
+
The legend rank order of the edges of this topology. Default is 2.
|
2132
2132
|
edgeLegendGroup : int , optional
|
2133
|
-
The number of the edge legend group to which the edges of this topology belong.
|
2133
|
+
The number of the edge legend group to which the edges of this topology belong. Default is 2.
|
2134
2134
|
|
2135
2135
|
showFaces : bool , optional
|
2136
|
-
If set to True the faces will be drawn. Otherwise, they will not be drawn.
|
2136
|
+
If set to True the faces will be drawn. Otherwise, they will not be drawn. Default is True.
|
2137
2137
|
faceOpacity : float , optional
|
2138
|
-
The desired opacity of the output faces (0=transparent, 1=opaque).
|
2138
|
+
The desired opacity of the output faces (0=transparent, 1=opaque). Default is 0.5.
|
2139
2139
|
faceColor : str , optional
|
2140
2140
|
The desired color of the output faces. This can be any plotly color string and may be specified as:
|
2141
2141
|
- A hex string (e.g. '#ff0000')
|
@@ -2145,33 +2145,33 @@ class Plotly:
|
|
2145
2145
|
- A named CSS color.
|
2146
2146
|
The default is "#FAFAFA".
|
2147
2147
|
faceLabelKey : str , optional
|
2148
|
-
The dictionary key to use to display the face label.
|
2148
|
+
The dictionary key to use to display the face label. Default is None.
|
2149
2149
|
faceGroupKey : str , optional
|
2150
|
-
The dictionary key to use to display the face group.
|
2150
|
+
The dictionary key to use to display the face group. Default is None.
|
2151
2151
|
faceGroups : list , optional
|
2152
|
-
The list of face groups against which to index the color of the face. This can bhave numeric or string values. This should match the type of value associated with the faceGroupKey.
|
2152
|
+
The list of face groups against which to index the color of the face. This can bhave numeric or string values. This should match the type of value associated with the faceGroupKey. Default is [].
|
2153
2153
|
faceMinGroup : int or float , optional
|
2154
|
-
For numeric faceGroups, minGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the faceGroupKey. If set to None, it is set to the minimum value in faceGroups.
|
2154
|
+
For numeric faceGroups, minGroup is the desired minimum value for the scaling of colors. This should match the type of value associated with the faceGroupKey. If set to None, it is set to the minimum value in faceGroups. Default is None.
|
2155
2155
|
faceMaxGroup : int or float , optional
|
2156
|
-
For numeric faceGroups, maxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the faceGroupKey. If set to None, it is set to the maximum value in faceGroups.
|
2156
|
+
For numeric faceGroups, maxGroup is the desired maximum value for the scaling of colors. This should match the type of value associated with the faceGroupKey. If set to None, it is set to the maximum value in faceGroups. Default is None.
|
2157
2157
|
showFaceLegend : bool, optional
|
2158
|
-
If set to True, the legend for the faces of this topology is shown. Otherwise, it isn't.
|
2158
|
+
If set to True, the legend for the faces of this topology is shown. Otherwise, it isn't. Default is False.
|
2159
2159
|
faceLegendLabel : str , optional
|
2160
|
-
The legend label string used to idenitfy edges.
|
2160
|
+
The legend label string used to idenitfy edges. Default is "Topology Faces".
|
2161
2161
|
faceLegendRank : int , optional
|
2162
|
-
The legend rank order of the faces of this topology.
|
2162
|
+
The legend rank order of the faces of this topology. Default is 3.
|
2163
2163
|
faceLegendGroup : int , optional
|
2164
|
-
The number of the face legend group to which the faces of this topology belong.
|
2164
|
+
The number of the face legend group to which the faces of this topology belong. Default is 3.
|
2165
2165
|
width : int , optional
|
2166
2166
|
The width in pixels of the figure. The default value is 950.
|
2167
2167
|
height : int , optional
|
2168
2168
|
The height in pixels of the figure. The default value is 950.
|
2169
2169
|
xAxis : bool , optional
|
2170
|
-
If set to True the x axis is drawn. Otherwise it is not drawn.
|
2170
|
+
If set to True the x axis is drawn. Otherwise it is not drawn. Default is False.
|
2171
2171
|
yAxis : bool , optional
|
2172
|
-
If set to True the y axis is drawn. Otherwise it is not drawn.
|
2172
|
+
If set to True the y axis is drawn. Otherwise it is not drawn. Default is False.
|
2173
2173
|
zAxis : bool , optional
|
2174
|
-
If set to True the z axis is drawn. Otherwise it is not drawn.
|
2174
|
+
If set to True the z axis is drawn. Otherwise it is not drawn. Default is False.
|
2175
2175
|
backgroundColor : list or str , optional
|
2176
2176
|
The desired background color. This can be any color list or plotly color string and may be specified as:
|
2177
2177
|
- An rgb list (e.g. [255,0,0])
|
@@ -2191,39 +2191,39 @@ class Plotly:
|
|
2191
2191
|
marginBottom : int , optional
|
2192
2192
|
The size in pixels of the bottom margin. The default value is 0.
|
2193
2193
|
camera : list , optional
|
2194
|
-
The desired location of the camera).
|
2194
|
+
The desired location of the camera). Default is [-1.25, -1.25, 1.25].
|
2195
2195
|
center : list , optional
|
2196
|
-
The desired center (camera target).
|
2196
|
+
The desired center (camera target). Default is [0, 0, 0].
|
2197
2197
|
up : list , optional
|
2198
|
-
The desired up vector.
|
2198
|
+
The desired up vector. Default is [0, 0, 1].
|
2199
2199
|
renderer : str , optional
|
2200
|
-
The desired renderer. See Plotly.Renderers().
|
2200
|
+
The desired renderer. See Plotly.Renderers(). Default is "notebook".
|
2201
2201
|
intensityKey : str , optional
|
2202
|
-
If not None, the dictionary of each vertex is searched for the value associated with the intensity key. This value is then used to color-code the vertex based on the colorScale.
|
2202
|
+
If not None, the dictionary of each vertex is searched for the value associated with the intensity key. This value is then used to color-code the vertex based on the colorScale. Default is None.
|
2203
2203
|
showScale : bool , optional
|
2204
|
-
If set to True, the colorbar is shown.
|
2204
|
+
If set to True, the colorbar is shown. Default is False.
|
2205
2205
|
cbValues : list , optional
|
2206
|
-
The input list of values to use for the colorbar.
|
2206
|
+
The input list of values to use for the colorbar. Default is [].
|
2207
2207
|
cbTicks : int , optional
|
2208
|
-
The number of ticks to use on the colorbar.
|
2208
|
+
The number of ticks to use on the colorbar. Default is 5.
|
2209
2209
|
cbX : float , optional
|
2210
|
-
The x location of the colorbar.
|
2210
|
+
The x location of the colorbar. Default is -0.15.
|
2211
2211
|
cbWidth : int , optional
|
2212
|
-
The width in pixels of the colorbar.
|
2212
|
+
The width in pixels of the colorbar. Default is 15
|
2213
2213
|
cbOutlineWidth : int , optional
|
2214
|
-
The width in pixels of the outline of the colorbar.
|
2214
|
+
The width in pixels of the outline of the colorbar. Default is 0.
|
2215
2215
|
cbTitle : str , optional
|
2216
|
-
The title of the colorbar.
|
2216
|
+
The title of the colorbar. Default is "".
|
2217
2217
|
cbSubTitle : str , optional
|
2218
|
-
The subtitle of the colorbar.
|
2218
|
+
The subtitle of the colorbar. Default is "".
|
2219
2219
|
cbUnits: str , optional
|
2220
|
-
The units used in the colorbar.
|
2220
|
+
The units used in the colorbar. Default is ""
|
2221
2221
|
colorScale : str , optional
|
2222
|
-
The desired type of plotly color scales to use (e.g. "viridis", "plasma").
|
2222
|
+
The desired type of plotly color scales to use (e.g. "viridis", "plasma"). Default is "viridis". For a full list of names, see https://plotly.com/python/builtin-colorscales/.
|
2223
2223
|
mantissa : int , optional
|
2224
|
-
The desired length of the mantissa for the values listed on the colorbar.
|
2224
|
+
The desired length of the mantissa for the values listed on the colorbar. Default is 6.
|
2225
2225
|
tolerance : float , optional
|
2226
|
-
The desired tolerance.
|
2226
|
+
The desired tolerance. Default is 0.0001.
|
2227
2227
|
|
2228
2228
|
Returns
|
2229
2229
|
-------
|
@@ -2325,9 +2325,9 @@ class Plotly:
|
|
2325
2325
|
path : str
|
2326
2326
|
The input file path.
|
2327
2327
|
width : int, optional
|
2328
|
-
The width of the exported image in pixels.
|
2328
|
+
The width of the exported image in pixels. Default is 1920.
|
2329
2329
|
height : int , optional
|
2330
|
-
The height of the exported image in pixels.
|
2330
|
+
The height of the exported image in pixels. Default is 1200.
|
2331
2331
|
overwrite : bool , optional
|
2332
2332
|
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't.
|
2333
2333
|
|
@@ -2368,9 +2368,9 @@ class Plotly:
|
|
2368
2368
|
path : str
|
2369
2369
|
The input file path.
|
2370
2370
|
width : int, optional
|
2371
|
-
The width of the exported image in pixels.
|
2371
|
+
The width of the exported image in pixels. Default is 1920.
|
2372
2372
|
height : int , optional
|
2373
|
-
The height of the exported image in pixels.
|
2373
|
+
The height of the exported image in pixels. Default is 1200.
|
2374
2374
|
overwrite : bool , optional
|
2375
2375
|
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't.
|
2376
2376
|
|
@@ -2411,9 +2411,9 @@ class Plotly:
|
|
2411
2411
|
path : str
|
2412
2412
|
The input file path.
|
2413
2413
|
width : int, optional
|
2414
|
-
The width of the exported image in pixels.
|
2414
|
+
The width of the exported image in pixels. Default is 1920.
|
2415
2415
|
height : int , optional
|
2416
|
-
The height of the exported image in pixels.
|
2416
|
+
The height of the exported image in pixels. Default is 1200.
|
2417
2417
|
overwrite : bool , optional
|
2418
2418
|
If set to True the ouptut file will overwrite any pre-existing file. Otherwise, it won't.
|
2419
2419
|
|
@@ -2452,13 +2452,13 @@ class Plotly:
|
|
2452
2452
|
figure : plotly.graph_objs._figure.Figure
|
2453
2453
|
The input plotly figure.
|
2454
2454
|
camera : list , optional
|
2455
|
-
The desired location of the camera.
|
2455
|
+
The desired location of the camera. Default is [-1.25, -1.25, 1.25].
|
2456
2456
|
center : list , optional
|
2457
|
-
The desired center (camera target).
|
2457
|
+
The desired center (camera target). Default is [0, 0, 0].
|
2458
2458
|
up : list , optional
|
2459
|
-
The desired up vector.
|
2459
|
+
The desired up vector. Default is [0, 0, 1].
|
2460
2460
|
projection : str , optional
|
2461
|
-
The desired type of projection. The options are "orthographic" or "perspective". It is case insensitive.
|
2461
|
+
The desired type of projection. The options are "orthographic" or "perspective". It is case insensitive. Default is "perspective"
|
2462
2462
|
|
2463
2463
|
Returns
|
2464
2464
|
-------
|
@@ -2496,15 +2496,15 @@ class Plotly:
|
|
2496
2496
|
figure : plotly.graph_objs._figure.Figure
|
2497
2497
|
The input plotly figure.
|
2498
2498
|
camera : list , optional
|
2499
|
-
The desired location of the camera.
|
2499
|
+
The desired location of the camera. Default is [0, 0, 0].
|
2500
2500
|
center : list , optional
|
2501
|
-
The desired center (camera target).
|
2501
|
+
The desired center (camera target). Default is [0, 0, 0].
|
2502
2502
|
up : list , optional
|
2503
|
-
The desired up vector.
|
2503
|
+
The desired up vector. Default is [0, 0, 1].
|
2504
2504
|
renderer : str , optional
|
2505
|
-
The desired renderer. See Plotly.Renderers(). If set to None, the code will attempt to discover the most suitable renderer.
|
2505
|
+
The desired renderer. See Plotly.Renderers(). If set to None, the code will attempt to discover the most suitable renderer. Default is None.
|
2506
2506
|
projection : str, optional
|
2507
|
-
The desired type of projection. The options are "orthographic" or "perspective". It is case insensitive.
|
2507
|
+
The desired type of projection. The options are "orthographic" or "perspective". It is case insensitive. Default is "perspective"
|
2508
2508
|
|
2509
2509
|
|
2510
2510
|
Returns
|
@@ -2610,7 +2610,7 @@ class Plotly:
|
|
2610
2610
|
path : str
|
2611
2611
|
The image file path.
|
2612
2612
|
format : str , optional
|
2613
|
-
The desired format. This can be any of "jpg", "jpeg", "pdf", "png", "svg", or "webp". It is case insensitive.
|
2613
|
+
The desired format. This can be any of "jpg", "jpeg", "pdf", "png", "svg", or "webp". It is case insensitive. Default is "png".
|
2614
2614
|
width : int , optional
|
2615
2615
|
The width in pixels of the figure. The default value is 1920.
|
2616
2616
|
height : int , optional
|