Vector module

class lys.widgets.canvas.interface.Vector.VectorData(canvas, wave, axis)[source]

Bases: WaveData

Interface to access vector data in the canvas.

Instance of VectorData is automatically generated by display or append methods.

getAutoScale()[source]

Get the automatically-calculated scale of the vector.

Returns:

The scale of the vector.

Return type:

float

getColor()[source]

Get the color of the vector.

Parameters:

str – The color of the vector such as ‘#ff0000’.

getPivot()[source]

Get pivot point of the vector plot.

Returns:

string that indicate pivot point.

Return type:

str

getScale()[source]

Get the scale of the vector.

Returns:

The scale of the vector.

Return type:

float

getWidth()[source]

Get the width of the vector.

Returns:

The width of the vector.

Return type:

float

setColor(color)[source]

Set the color of the vector.

Parameters:

color (str) – The color of the vector such as ‘#ff0000’.

setPivot(pivot)[source]

Set pivot point of the vector plot.

Parameters:

pivot ('tail' or 'middle' or 'tip') – The pivot point

setScale(scale='auto')[source]

Set the scale of the vector.

Parameters:

scale (float or 'auto') – The scale of the vector.

setWidth(width)[source]

Set the width of the vector.

Parameters:

width (float) – The width of the vector.