:py:mod:`vspyx.MonitorView` =========================== .. py:module:: vspyx.MonitorView Package Contents ---------------- Classes ~~~~~~~ .. autoapisummary:: vspyx.MonitorView.AnnotatedValue vspyx.MonitorView.Column vspyx.MonitorView.Highlight vspyx.MonitorView.Instance vspyx.MonitorView.Line vspyx.MonitorView.Module .. py:class:: AnnotatedValue AnnotatedValue .. py:attribute:: Data :annotation: :vspyx.Runtime.Value .. py:attribute:: Highlighting :annotation: :List[Highlight] .. py:attribute:: Units :annotation: :str .. py:method:: __str__(self) -> str Return str(self). .. py:class:: Column Bases: :py:obj:`vspyx.Core.Object` .. autoapi-inheritance-diagram:: vspyx.MonitorView.Column :parts: 1 :private-bases: Column .. py:attribute:: ID :annotation: :str .. py:method:: CloneState(self) -> Any .. py:method:: GetValue(self, uLine: Line) -> AnnotatedValue GetValue(self, line: Line) -> AnnotatedValue .. py:method:: UpdateState(self, state: Any) -> Any .. py:class:: Highlight Highlight .. py:class:: EDirectionHint Bases: :py:obj:`enum.IntEnum` .. autoapi-inheritance-diagram:: vspyx.MonitorView.Highlight.EDirectionHint :parts: 1 :private-bases: Enum where members are also (and must be) ints .. py:attribute:: Down :annotation: = 2 .. py:attribute:: Indeterminite :annotation: = 5 .. py:attribute:: Left :annotation: = 3 .. py:attribute:: NONE :annotation: = 0 .. py:attribute:: Right :annotation: = 4 .. py:attribute:: Up :annotation: = 1 .. py:class:: EType Bases: :py:obj:`enum.IntEnum` .. autoapi-inheritance-diagram:: vspyx.MonitorView.Highlight.EType :parts: 1 :private-bases: Enum where members are also (and must be) ints .. py:attribute:: Callout :annotation: = 2 .. py:attribute:: Change :annotation: = 1 .. py:attribute:: NONE :annotation: = 0 .. py:attribute:: ChangedAgo :annotation: :Any .. py:attribute:: DirectionHint :annotation: :Highlight.EDirectionHint .. py:attribute:: Index :annotation: :int .. py:attribute:: LastChangedAgo :annotation: :Any .. py:attribute:: Type :annotation: :Highlight.EType .. py:class:: Instance Bases: :py:obj:`vspyx.Runtime.Component` .. autoapi-inheritance-diagram:: vspyx.MonitorView.Instance :parts: 1 :private-bases: Instance .. py:class:: NameModes Bases: :py:obj:`enum.IntEnum` .. autoapi-inheritance-diagram:: vspyx.MonitorView.Instance.NameModes :parts: 1 :private-bases: Enum where members are also (and must be) ints .. py:attribute:: Long :annotation: = 1 .. py:attribute:: Short :annotation: = 0 .. py:class:: ScrollModes Bases: :py:obj:`enum.IntEnum` .. autoapi-inheritance-diagram:: vspyx.MonitorView.Instance.ScrollModes :parts: 1 :private-bases: Enum where members are also (and must be) ints .. py:attribute:: Scrolling :annotation: = 1 .. py:attribute:: Static :annotation: = 0 .. py:class:: SortingModes Bases: :py:obj:`enum.IntEnum` .. autoapi-inheritance-diagram:: vspyx.MonitorView.Instance.SortingModes :parts: 1 :private-bases: Enum where members are also (and must be) ints .. py:attribute:: Ascending :annotation: = 1 .. py:attribute:: Descending :annotation: = 2 .. py:attribute:: NoSorting :annotation: = 0 .. py:class:: TimestampModes Bases: :py:obj:`enum.IntEnum` .. autoapi-inheritance-diagram:: vspyx.MonitorView.Instance.TimestampModes :parts: 1 :private-bases: Enum where members are also (and must be) ints .. py:attribute:: Absolute :annotation: = 1 .. py:attribute:: Relative :annotation: = 0 .. py:attribute:: Columns :annotation: :List[Column] .. py:attribute:: DesiredLevel :annotation: :vspyx.Runtime.PointLevel .. py:attribute:: InReviewBuffer :annotation: :bool .. py:attribute:: MinimumLevel :annotation: :vspyx.Runtime.PointLevel .. py:attribute:: NameMode :annotation: :Instance.NameModes .. py:attribute:: NumberOfLines :annotation: :int .. py:attribute:: OnConfigurationMutation :annotation: :vspyx.Core.Callback_634bd5c449 .. py:attribute:: Paused :annotation: :bool .. py:attribute:: PercentBufferFilled :annotation: :float .. py:attribute:: PercentBufferPosition :annotation: :float .. py:attribute:: ScrollMode :annotation: :Instance.ScrollModes .. py:attribute:: SortColumn :annotation: :Column .. py:attribute:: SortMode :annotation: :Instance.SortingModes .. py:attribute:: TimestampMode :annotation: :Instance.TimestampModes .. py:method:: AddFilter(self, name: str, mode: int, expression: str) -> Any .. py:method:: Clear(self) -> Any .. py:method:: CloneConfiguration(self) -> Any Return the immutable configuration of this object. Except for the resolver parenting relationship, this represents the entire serializable state of the object. .. py:method:: GetLines(self, start: int, num: int) -> List[Line] Make the lines of the monitor :Parameter start: line number to begin returning from; set to 0 in scrolling mode to get latest lines :Parameter num: number of lines :Returns: the lines .. py:method:: New() -> Instance New(config: Any) -> Instance :staticmethod: .. py:method:: RemoveFilter(self, id: str) -> bool .. py:method:: Save(self, path: str) -> Any .. py:method:: SetupFromBuffer(self, buffer: str) -> vspyx.Core.ScheduledTask_ef25277eaf .. py:method:: SetupFromCommunicationComponent(self, component: vspyx.Communication.Component) -> Any .. py:method:: UpdateFilter(self, id: str, name: str, mode: int, expression: str) -> bool .. py:class:: Line Bases: :py:obj:`vspyx.Core.Object` .. autoapi-inheritance-diagram:: vspyx.MonitorView.Line :parts: 1 :private-bases: Line .. py:attribute:: Children :annotation: :List[Line] .. py:attribute:: Count :annotation: :int .. py:attribute:: Description :annotation: :str .. py:attribute:: ID :annotation: :int .. py:attribute:: Name :annotation: :str .. py:attribute:: Parents :annotation: :List[Line] .. py:attribute:: Point :annotation: :vspyx.Runtime.Point .. py:attribute:: RelativeTimestamp :annotation: :Any .. py:attribute:: RenderLineCount :annotation: :int .. py:attribute:: Statistics :annotation: :vspyx.Runtime.Trace.Statistics .. py:method:: ChildrenCount(self) -> int .. py:method:: ParentsCount(self) -> int .. py:method:: Serialize(self, columns: List[Column], dataBytesLimit: int) -> Any .. py:method:: __str__(self) -> str Return str(self). .. py:class:: Module Bases: :py:obj:`vspyx.Core.Module` .. autoapi-inheritance-diagram:: vspyx.MonitorView.Module :parts: 1 :private-bases: Module