sas.qtgui.Perspectives package

Subpackages

Submodules

sas.qtgui.Perspectives.perspective module

class sas.qtgui.Perspectives.perspective.Perspective

Bases: object

Mixin class for all perspectives, all perspectives should have these methods

__annotate_func__ = None
__annotations_cache__ = {}
__dict__ = mappingproxy({'__module__': 'sas.qtgui.Perspectives.perspective', '__firstlineno__': 19, '__doc__': '\nMixin class for all perspectives,\nall perspectives should have these methods\n', 'name': <classmethod(<property object>)>, 'title': <property object>, 'setData': <function Perspective.setData>, 'removeData': <function Perspective.removeData>, 'allowBatch': <function Perspective.allowBatch>, 'allowSwap': <function Perspective.allowSwap>, 'swapData': <function Perspective.swapData>, 'ext': <classmethod(<property object>)>, 'isSerializable': <function Perspective.isSerializable>, 'serialiseAll': <function Perspective.serialiseAll>, 'updateFromParameters': <function Perspective.updateFromParameters>, 'updateFromConstraints': <function Perspective.updateFromConstraints>, 'supports_reports': <property object>, 'getReport': <function Perspective.getReport>, 'setClosable': <function Perspective.setClosable>, 'isClosable': <function Perspective.isClosable>, 'supports_fitting_menu': <property object>, 'preferences': <property object>, 'supports_copy': <property object>, 'supports_copy_excel': <property object>, 'supports_copy_latex': <property object>, 'supports_paste': <property object>, 'clipboard_copy': <function Perspective.clipboard_copy>, 'clipboard_paste': <function Perspective.clipboard_paste>, 'excel_clipboard_copy': <function Perspective.excel_clipboard_copy>, 'latex_clipboard_copy': <function Perspective.latex_clipboard_copy>, 'supports_save_parameters': <property object>, 'save_parameters': <function Perspective.save_parameters>, '__static_attributes__': (), '__dict__': <attribute '__dict__' of 'Perspective' objects>, '__weakref__': <attribute '__weakref__' of 'Perspective' objects>, '__annotations_cache__': {}})
__doc__ = '\nMixin class for all perspectives,\nall perspectives should have these methods\n'
__firstlineno__ = 19
__module__ = 'sas.qtgui.Perspectives.perspective'
__static_attributes__ = ()
__weakref__

list of weak references to the object

allowBatch() → bool

Can this perspective handle batch processing, default no

allowSwap() → bool

Does this perspective allow swapping of data, i.e. replacement of data without changing parameters, default no

clipboard_copy()

Called by copy menu item

clipboard_paste()

Called by paste menu item

excel_clipboard_copy()

Called by copy excel menu item

abstract class property ext: str

File extension used when saving perspective data

getReport() → ReportData | None

A string containing the HTML to be shown in the report

isClosable() → bool

Flag that determines whether this perspective can be closed

isSerializable() → bool

Can this perspective be serialised - default is no

latex_clipboard_copy()

Called by copy latex menu item

abstract class property name: str

Name of the perspective

property preferences: list[PreferencesWidget] | None

Return a list of widgets that should be added to the preferences panel.

removeData(data_list: QStandardItem | list[QStandardItem] | None)

Remove data from

save_parameters()

Save parameters to a file

serialiseAll() → dict
abstractmethod setClosable(value: bool)

Set whether this perspective can be closed

abstractmethod setData(data_item: list[QStandardItem], is_batch: bool = False)

Set the data to be processed in this perspective, called when the ‘send data’ button is pressed

property supports_copy: bool

Does this perspective support copy functionality?

property supports_copy_excel: bool

Does this perspective support copy functionality?

property supports_copy_latex: bool

Does this perspective support copy functionality?

property supports_fitting_menu: bool

Should the fitting menu be shown when using this perspective (unless its Fitting, probably not)

property supports_paste: bool

Does this perspective allow pasting?

property supports_reports: bool

Does this perspective have a report functionality (currently used by menus and toolbar)

property supports_save_parameters: bool

Can this perspective save its parameters to a file

swapData(new_data: QStandardItem)

Swap in new data without changing parameters

abstract property title: str

Window title

updateFromConstraints(constraints: dict[str, list])

Updates all tabs with constraints present in constraint_dict, where constraint_dict keys are the fit page name, and the value is a list of constraints. A constraint is represented by a list [value, param, value_ex, validate, function] of attributes of a Constraint object

abstractmethod updateFromParameters(params: dict)

Update the perspective using a dictionary of parameters e.g. those loaded via open project or open analysis menu items

class sas.qtgui.Perspectives.perspective.PerspectiveMeta

Bases: ObjectType, ABCMeta

Metaclass for both ABC and Qt objects

This is needed to enable the mixin of Perspective until a future refactoring unified the Qt functionality of all the perspectives and brings it into the base class

__doc__ = 'Metaclass for both ABC and Qt objects\n\nThis is needed to enable the mixin of Perspective until\na future refactoring unified the Qt functionality  of\nall the perspectives and brings it into the base class\n'
__firstlineno__ = 10
__module__ = 'sas.qtgui.Perspectives.perspective'
__static_attributes__ = ()

Module contents