Hide keyboard shortcuts

Hot-keys on this page

r m x p   toggle line displays

j k   next/prev highlighted chunk

0   (zero) top of page

1   (one) first highlighted chunk

1

2

3

4

5

6

7

8

9

10

11

12

13

14

15

16

17

18

19

20

21

22

23

24

25

26

27

28

29

30

31

32

33

34

35

36

37

38

39

40

41

42

43

44

45

46

47

48

49

50

51

52

53

54

55

56

57

58

59

60

61

62

63

64

65

66

67

68

69

70

71

72

73

74

75

76

77

78

79

80

81

82

83

84

85

86

87

88

89

90

91

92

93

94

95

96

97

98

99

100

101

102

103

104

105

106

107

108

109

110

111

112

113

114

115

116

117

118

119

120

121

122

123

124

125

126

127

128

129

130

131

132

133

134

135

136

137

138

139

140

141

142

143

144

145

146

147

148

149

150

151

152

153

154

155

156

157

158

159

160

161

162

163

164

165

166

167

168

169

170

171

r""" 

Graph editor 

""" 

from __future__ import absolute_import 

#***************************************************************************** 

# Copyright (C) 2009 Radoslav Kirov 

# 

# Distributed under the terms of the GNU General Public License (GPL) 

# 

# This code is distributed in the hope that it will be useful, 

# but WITHOUT ANY WARRANTY; without even the implied warranty of 

# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU 

# General Public License for more details. 

# 

# The full text of the GPL is available at: 

# 

# http://www.gnu.org/licenses/ 

#***************************************************************************** 

import sys 

 

from .graph_generators import graphs 

from sage.misc.html import html 

 

import sagenb.notebook.interact 

from sage.server.support import EMBEDDED_MODE 

 

 

def graph_to_js(g): 

""" 

Returns a string representation of a :class:`Graph` instance 

usable by the :func:`graph_editor`. The encoded information is 

the number of vertices, their 2D positions, and a list of edges. 

 

INPUT: 

 

- ``g`` - a :class:`Graph` instance 

 

OUTPUT: 

 

- a string 

 

EXAMPLES:: 

 

sage: from sage.graphs.graph_editor import graph_to_js 

sage: G = graphs.CompleteGraph(4) 

sage: graph_to_js(G) 

'num_vertices=4;edges=[[0,1],[0,2],[0,3],[1,2],[1,3],[2,3]];pos=[[0.5,0.0],[0.0,0.4999999999999999],[0.4999999999999999,1.0],[1.0,0.5000000000000001]];' 

sage: graph_to_js(graphs.StarGraph(2)) 

'num_vertices=3;edges=[[0,1],[0,2]];pos=[[0.75,0.5],[1.0,0.0],[0.0,1.0]];' 

""" 

string = '' 

vertex_list = g.get_vertices().keys() 

string += 'num_vertices=' + str(len(vertex_list)) + ';' 

string += 'edges=[' 

for i, e in enumerate(g.edges()): 

if(i != 0): 

string += ',' 

string += '[' + str(vertex_list.index(e[0])) + ',' + str(vertex_list.index(e[1])) + ']' 

string += '];' 

string += 'pos=[' 

pos = g.get_pos() 

max_x = max([i[0] for i in pos.values()]) 

max_y = max([i[1] for i in pos.values()]) 

min_x = min([i[0] for i in pos.values()]) 

min_y = min([i[1] for i in pos.values()]) 

if max_x == 0: 

max_x = 1 

if max_y == 0: 

max_y = 1 

for i, v in enumerate(vertex_list): 

if(i != 0): 

string += ',' 

new_pos = [float(pos[v][0] - min_x) / (max_x - min_x), 

1.0 - float(pos[v][1] - min_y) / (max_y - min_y)] 

string += str(new_pos) 

string += '];' 

string = string.replace(' ', '') 

return string 

 

def graph_editor(graph=None, graph_name=None, 

replace_input=True, **layout_options): 

""" 

Opens a graph editor in the Sage notebook. 

 

INPUT: 

 

- ``graph`` - a :class:`Graph` instance (default: 

graphs.CompleteGraph(2)); the graph to edit 

 

- ``graph_name`` - a string (default: None); the variable name to 

use for the updated instance; by default, this function attempts 

to determine the name automatically 

 

- ``replace_input`` - a boolean (default: True); whether to 

replace the text in the input cell with the updated graph data 

when "Save" is clicked; if this is False, the data is **still** 

evaluated as if it had been entered in the cell 

 

EXAMPLES:: 

 

sage: g = graphs.CompleteGraph(3) 

sage: graph_editor(g) # not tested 

sage: graph_editor(graphs.HouseGraph()) # not tested 

sage: graph_editor(graph_name='my_graph') # not tested 

sage: h = graphs.StarGraph(6) 

sage: graph_editor(h, replace_input=False) # not tested 

""" 

if graph is None: 

graph = graphs.CompleteGraph(2) 

 

if not EMBEDDED_MODE: 

return "This graph editor only runs in the Sage notebook." 

 

graph.layout(save_pos = True, **layout_options) 

 

if graph_name is None: 

graph_name = '' 

locs = sys._getframe(1).f_locals 

for var in locs: 

if id(locs[var]) == id(graph): 

graph_name = var 

 

cell_id = sagenb.notebook.interact.SAGE_CELL_ID 

 

# TODO: Put reasonable checks for large graphs, before disaster 

# occurs (i.e., breaks browser). 

 

close_button = r"""<button onclick="cell_delete_output(%(cell_id)s);">Close</button>""" % locals() 

 

if replace_input: 

eval_strategy = r""" 

f += ' graph_editor(' + g[2] + ');' 

\$('#cell_input_%(cell_id)s').val(f); 

cell_input_resize(%(cell_id)s); 

evaluate_cell(%(cell_id)s, false); 

""" % locals() 

else: 

eval_strategy = r""" 

saved_input = \$('#cell_input_%(cell_id)s').val(); 

\$('#cell_input_%(cell_id)s').val(f); 

evaluate_cell(%(cell_id)s, false); 

\$('#cell_input_%(cell_id)s').val(saved_input); 

send_cell_input(%(cell_id)s); 

cell_input_resize(%(cell_id)s); 

""" % locals() 

 

update_button = r"""<button onclick=" 

var f, g, saved_input; 

g = \$('#iframe_graph_editor_%(cell_id)s')[0].contentWindow.update_sage(); 

 

if (g[2] === '') { 

alert('You need to give a Sage variable name to the graph, before saving it.'); 

return; 

} 

f = g[2] + ' = Graph(' + g[0] + '); ' + g[2] + '.set_pos(' + g[1] + '); ' 

%(eval_strategy)s 

">Save</button>""" % locals() 

 

graph_js = graph_to_js(graph) 

data_fields = """<input type="hidden" id="graph_data_%(cell_id)s" value="%(graph_js)s"><input type="hidden" id="graph_name_%(cell_id)s" value="%(graph_name)s">""" % locals() 

 

return html(r"""<div id="graph_editor_%(cell_id)s"><table><tbody> 

<tr><td><iframe style="width: 800px; height: 400px; border: 0;" id="iframe_graph_editor_%(cell_id)s" src="/javascript/graph_editor/graph_editor.html?cell_id=%(cell_id)s"></iframe>%(data_fields)s</td></tr> 

<tr><td>%(update_button)s%(close_button)s</td></tr> 

</tbody></table></div>""" % locals()) 

 

# This is commented out because the mouse_out call raises an error in 

# Firebug's console when the event fires but the function itself has 

# not yet been loaded. 

 

# <tr><td><iframe style="width: 800px; height: 400px; border: 0;" id="iframe_graph_editor_%(cell_id)s" src="/javascript/graph_editor/graph_editor.html?cell_id=%(cell_id)s" onmouseout="\$('#iframe_graph_editor_%(cell_id)s')[0].contentWindow.mouse_out();"></iframe>%(data_fields)s</td></tr>