/  Python Yamcs Client  /  Timeline  /  Model

Model

class yamcs.timeline.model.Band(proto)

Superclass for bands. Implementations:

property band_type: str

Type of band.

property description: str

Description of this band.

property id: str

Band identifier.

property name: str

Name of this band.

class yamcs.timeline.model.CommandBand(proto=None)

Display issued commands.

property band_type: str

Type of band.

property description: str

Description of this band.

property id: str

Band identifier.

property name: str

Name of this band.

class yamcs.timeline.model.Item(proto=None)
property activity: Optional[Activity]

Activity definition.

property background_color: Optional[str]

CSS color string.

property border_color: Optional[str]

CSS color string.

property border_width: Optional[int]
property corner_radius: Optional[int]
property duration: timedelta

Item duration.

property id: str

Item identifier.

property item_type: str

Type of item.

property margin_left: Optional[int]
property name: str

Name of this item.

property start: datetime

Item start time.

property tags: List[str]

Item tags. Used by bands to filter what is visible.

property text_color: Optional[str]

CSS color string.

property text_size: Optional[int]
class yamcs.timeline.model.ItemBand(proto=None)

Show a selection of timeline items.

property band_type: str

Type of band.

property description: str

Description of this band.

property frozen: bool

Fix this line to the top of the view. Frozen bands are always rendered above other bands.

property id: str

Band identifier.

property item_background_color: str

CSS color string.

property item_border_color: str

CSS color string.

property item_border_width: int
property item_corner_radius: int
property item_height: int
property item_margin_left: int
property item_text_color: str

CSS color string.

property item_text_overflow: str

One of show, clip, or hide.

property item_text_size: int
property margin_bottom: int
property margin_top: int
property multiline: bool

Draw items on multiple lines if otherwise there would be collisions.

property name: str

Name of this band.

property space_between_items: int

In case of multilining, this indicates the minimum horizontal space between items. If an item does not meet this treshold, it gets rendered on a different line.

property space_between_lines: int

In case of multilining, this indicates the vertical space between lines.

property tags: List[str]

Item tags that this band filters on.

class yamcs.timeline.model.Spacer(proto=None)

Insert empty vertical space.

property band_type: str

Type of band.

property description: str

Description of this band.

property height: int

Spacer height

property id: str

Band identifier.

property name: str

Name of this band.

class yamcs.timeline.model.TimeRuler(proto=None)

Displays absolute time, formatted in a timezone of choice.

property band_type: str

Type of band.

property description: str

Description of this band.

property id: str

Band identifier.

property name: str

Name of this band.

property timezone: str

IANA timezone name.

Corresponds with the third column of the following table: https://data.iana.org/time-zones/data/zone1970.tab

In addition, the name UTC is supported.

class yamcs.timeline.model.View(proto=None)
property bands: List[Band]

Bands included in this view.

property description: str

Description of this view.

property id: str

View identifier.

property name: str

Name of this view.