Prototype SLiCAP figure object. :param fileName: Name of the file for saving the figure. :type fileName: str
| 219 | return traceDict |
| 220 | |
| 221 | class figure(object): |
| 222 | """ |
| 223 | Prototype SLiCAP figure object. |
| 224 | |
| 225 | :param fileName: Name of the file for saving the figure. |
| 226 | :type fileName: str |
| 227 | """ |
| 228 | def __init__(self, fileName): |
| 229 | |
| 230 | self.fileType = ini.plot_file_type |
| 231 | """ |
| 232 | Graphic file type (*str*) for saving the figure. Defaults to fileName |
| 233 | """ |
| 234 | |
| 235 | self.axisHeight = ini.axis_height |
| 236 | """ |
| 237 | Relative height (*int, float*) of a single axis. Defaults to ini.axis_height. |
| 238 | |
| 239 | To do: absolute measures in inch or cm. |
| 240 | """ |
| 241 | |
| 242 | self.axisWidth = ini.axis_width |
| 243 | """ |
| 244 | Relative width (*int, float*) of a single axis. Defaults to ini.axis_width. |
| 245 | |
| 246 | To do: absolute measures in inch or cm. |
| 247 | """ |
| 248 | |
| 249 | self.axes = [] |
| 250 | """ |
| 251 | List with **SLiCAPplots.axis** objects to be plotted on this figure. |
| 252 | Defaults to []. |
| 253 | """ |
| 254 | |
| 255 | self.show = False |
| 256 | """ |
| 257 | (*bool*) if 'True' the figure will be displayed with the method |
| 258 | **SLiCAPplots.figure.plot()**. Defaults to []. |
| 259 | """ |
| 260 | |
| 261 | self.save = True |
| 262 | """ |
| 263 | (*bool*) if 'True' the figure will be saved to the img folder in pdf and in svg format |
| 264 | Defaults to True. |
| 265 | """ |
| 266 | |
| 267 | self.fileName = fileName |
| 268 | """ |
| 269 | File name of the figure. |
| 270 | """ |
| 271 | |
| 272 | self.traceDict = {} |
| 273 | """ |
| 274 | Dictionary with key-value pairs: |
| 275 | |
| 276 | - key: label of the trace |
| 277 | - value: trace object |
| 278 | """ |
no outgoing calls
no test coverage detected