Reference 〉Function

TimeSeries.event( int t, str color = '#CC0000', str|bool linestyle = '--', int linewidth = 1 )

Draws a vertical line on the plots area at time t. This function should not be called directly; specify an event instead.

WARNING: This is an internal function. Its use in user code is not recommended or supported, and its signature can change in future updates without warning. Use one of the suggested functions above instead, if applicable.

Parameters

  • t int, required

    The model time at which to draw the line.

  • color str, optional

    A hex string or color name for the line to be drawn on the plot list.

    Default value: '#CC0000'

  • linestyle str|bool, optional

    The style of line to be drawn, or set False to draw no line. See Matplotlib linestyle reference for possible values.

    Default value: '--'

  • linewidth int, optional

    The thickness of the line to be drawn.

    Default value: 1

Notes and Examples

  1. Contribute a Note

    Your email address will not be published. Required fields are marked *

    You may use limited HTML for formatting. Please embed blocks of code in <pre><code> </code></pre> tags.

History