Reference 〉Function

SpatialPlot.agentLoc( bool update = False )

Helper function to retrieve historical agent location, color, and size data.

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

  • update bool, optional

    Toggles between two different representations of the return value: Matplotlib wants agent coordinates in two x and y lists to create the plot, but one list of x,y tuples to update it.

    Default value: False

Return Value tuple(list)

A tuple of lists of location, breed color, size, and id for each agent.

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.