phoenix_title wx.lib.plot.polyobjects.PolyLine

Creates PolyLine object

param points:

The points that make up the line

type points:

list of [x, y] values

param **attr:

keyword attributes

Keyword and Default

Description

Type

colour='black'

Line color

wx.Colour

width=1

Line width

float

style=wx.PENSTYLE_SOLID

Line style

wx.PenStyle

legend=''

Legend string

str

drawstyle='line'

see below

str

Draw style

Description

'line'

Draws an straight line between consecutive points

'steps-pre'

Draws a line down from point A and then right to point B

'steps-post'

Draws a line right from point A and then down to point B

'steps-mid-x'

Draws a line horizontally to half way between A and B, then draws a line vertically, then again horizontally to point B.

'steps-mid-y'

Draws a line vertically to half way between A and B, then draws a line horizonatally, then again vertically to point B. Note: This typically does not look very good

Warning

All methods except __init__ are private.


class_hierarchy Class Hierarchy

Inheritance diagram for class PolyLine:

sub_classes Known Subclasses

wx.lib.plot.polyobjects.PolySpline


super_classes Known Superclasses

wx.lib.plot.polyobjects.PolyPoints


method_summary Methods Summary

__init__

Initialize self. See help(type(self)) for accurate signature.

draw

Draw the lines.

getSymExtent

Get the Width and Height of the symbol.


api Class API

class PolyLine(PolyPoints)

Creates PolyLine object

Parameters:
  • points (list of [x, y] values) – The points that make up the line

  • **attr – keyword attributes

Keyword and Default

Description

Type

colour='black'

Line color

wx.Colour

width=1

Line width

float

style=wx.PENSTYLE_SOLID

Line style

wx.PenStyle

legend=''

Legend string

str

drawstyle='line'

see below

str

Draw style

Description

'line'

Draws an straight line between consecutive points

'steps-pre'

Draws a line down from point A and then right to point B

'steps-post'

Draws a line right from point A and then down to point B

'steps-mid-x'

Draws a line horizontally to half way between A and B, then draws a line vertically, then again horizontally to point B.

'steps-mid-y'

Draws a line vertically to half way between A and B, then draws a line horizonatally, then again vertically to point B. Note: This typically does not look very good

Warning

All methods except __init__ are private.


Methods

__init__(self, points, **attr)

Initialize self. See help(type(self)) for accurate signature.



draw(self, dc, printerScale, coord=None)

Draw the lines.

Parameters:
  • dc (wx.DC) – The DC to draw on.

  • printerScale (float) –

  • coord – The legend coordinate?



getSymExtent(self, printerScale)

Get the Width and Height of the symbol.

Parameters:

printerScale (float) –