generativepy.table module

The table module can be used to draw tables.

A Table object will draw a simple table grid. It is possible to set the number of columns and the width of each column. The table can then be drawn using the specified fill and stroke styles.

The table content must be drawn separately. This makes it possible to draw any content in the table, formatted in any way.

The table get function can be used to obtain the coordinates of the centre of any table cell. THis allows user code to draw any required content. It is the responsibility of the user code to ensure that the content is correctly scaled and clipped as needed.

A companion class, TableLayout, can be used to obtains the metrics of the grid of a table, without actually drawing a table. This means that the TableLayout object can be created without the need for a drawing context. This is useful if you want to lay items out in a grid, but a drwaing context isn't available - for example, in the setup stages of creating a movie, or when working with a bitmap image mode.

Table class

Constructor

Table(ctx, position)

Creates a Table object, associated with the drawing context, at the specified position.

of_rows_cols

of_rows_cols(rows, cols)

Sets the size and number of rows and columns. Notice that the parameter are order rows then cols, rather than x, y ordering.

The rows list sets the width of each row, and the length of the rows list controls the number of rows.

The cols list sets the heights of each column, and the length of the cols list controls the number of columns.

Returns self.

get

get(row, col)

Gets the position of the centre of a particular cell (row col). Notice that the parameter are order row then col, rather than x, y ordering.

Returns (x, y) position of centre of cell.

Table class

Constructor

Table(ctx, position)

Creates a Table object, associated with the drawing context, at the specified position.

of_rows_cols

of_rows_cols(rows, cols)

Sets the size and number of rows and columns. Notice that the parameter are order rows then cols, rather than x, y ordering.

The rows list sets the width of each row, and the length of the rows list controls the number of rows.

The cols list sets the heights of each column, and the length of the cols list controls the number of columns.

Returns self.

background

Sets the fill for the background of the table.

If this method in not called, the table will not have a background fill.

background(pattern=Color(0))

This method is similar to the stroke method of shape objects.

linestyle

Controls the outline and inner divisions of the table.

If this method isn't called, the outline and iner divisions will not be drawn,

linestyle(pattern=Color(0), line_width=1, dash=[], cap=SQUARE, join=MITER, miter_limit=None)

This method is similar to the fill method of shape objects. There is no fill_rule for this parameter, because the table area is always a single rectangular area, so the fil rule would have no effect.

draw

draw()

Draws the table using the attributes set by the background and linestyle methods.

If neither of those methods has been called, the table will be invisible. In that case it is not necessary to call draw, as it will have no effect. It isn't an error to call draw in that case, it will just have no effect.

It is valid to have am invisible table, as it can still be used to position other elements on a grid. But if the table is not intended to be visible, consider using a TableLayout, which is effectively a table with no drawing capability. See below

get

get(row, col)

Gets the position of the centre of a particular cell (row col). Notice that the parameter are order row then col, rather than x, y ordering.

Returns (x, y) position of centre of cell.

TableLayout

A TableLayout object creates a table that is not visible, but still provides a get method to allow other objects to be positioned on a grid.

Since a TableLayout cannot be drawn, its contructor doesn't require a drawing context. It is useful for cases where you might need an invisible table layout but a drawing context isn't available. For example, if you are creating a bitmap image.

Constructor

Table(position)

Creates a TableLayout object at the specified position.

of_rows_cols

of_rows_cols(rows, cols)

Sets the size and number of rows and columns. Notice that the parameter are order rows then cols, rather than x, y ordering.

The rows list sets the width of each row, and the length of the rows list controls the number of rows.

The cols list sets the heights of each column, and the length of the cols list controls the number of columns.

Returns self.

get

get(row, col)

Gets the position of the centre of a particular cell (row col). Notice that the parameter are order row then col, rather than x, y ordering.

Returns (x, y) position of centre of cell.

See also

• generativepy.analytics module
• generativepy.bitmap module
• generativepy.color module
• generativepy.drawing module
• generativepy.drawing3d module
• generativepy.formulas module
• generativepy.geometry module
• generativepy.geometry3d module
• generativepy.gif module
• generativepy.graph module
• generativepy.math module
• generativepy.movie module
• generativepy.nparray module
• generativepy.shape2d module
• generativepy.tween module
• generativepy.utils module