GraphSeries

Instantiation

Seal #

seal

Seal the instance against further setup writes

Signature:

Public Sub Seal()

Called by the factory after the last setup write. Once sealed, the creation-only setters raise through ThrowError.

GuardNotSealed #

guard-not-sealed

Guard a setup setter against post-creation writes

Signature:

Private Sub GuardNotSealed(ByVal propName As String)

Parameters:

• propName: String. The property name reported in the error message.

Table #

table

The cross-table this builder reads

Signature:

Public Property Get Table() As CrossTable

Returns: CrossTable. The stored cross-table.

Table #

table-set

Assign the cross-table

Signature:

Public Property Set Table(ByVal tabl As CrossTable)

Parameters:

• tabl: CrossTable. The cross-table to store.

Building

BuildSeries #

build-series

Build the buffer from the table scope and its graph settings

Signature:

Private Sub BuildSeries()

FlipCoordinates controls the plot direction: horizontal bars when it answers True, vertical bars otherwise. For a spatio-temporal table the column count is the geographic unit count and the row categories are the ones of the section, because every table of a section shares them.

Remarks:

• TableSpecs.GeoCount carries the default of 5 and clamps the value to 1 to 20, so an empty or unreadable cell needs no guard here.

BuildUnivariateSeries #

build-univariate-series

Build the series of a single-variable table

Signature:

Private Sub BuildUnivariateSeries(ByVal tabId As String, _
                                  ByVal plotType As String, _
                                  ByVal hasPerc As Boolean)

One bar series over the value column, labelled by the row categories and named by the column label. A table carrying percentages gets a second series of points on the right axis, so the percentages sit over the bars. Horizontal bars are left without that overlay, because a point series on a horizontal chart reads poorly.

Parameters:

• tabId: String. The table identifier every named range carries.
• plotType: String. "bar" for vertical bars, "hbar" for horizontal ones.
• hasPerc: Boolean. Whether the table carries a percentage column.

BuildMultiColumnSeries #

build-multi-column-series

Build the series of a table with several data columns

Signature:

Private Sub BuildMultiColumnSeries(ByVal specs As TableSpecs, _
                                   ByVal tabId As String, _
                                   ByVal tabSecId As String, _
                                   ByVal tabType As Byte, _
                                   ByVal nbCols As Long, _
                                   ByVal plotType As String)

The graph mode comes from TableSpecs.GraphMode. "values" and "yes" give one bar series per column over the value ranges. "percentages" gives one bar series per column over the percentage ranges, and reports when the table carries none. "both" gives value bars on the left axis and percentage points on the right, per column. A spatio-temporal table takes its row categories from its section.

Parameters:

• specs: TableSpecs. The specifications of the table.
• tabId: String. The table identifier every named range carries.
• tabSecId: String. The section identifier, for a spatio-temporal table.
• tabType: Byte. The table scope.
• nbCols: Long. How many data columns to walk.
• plotType: String. "bar" or "hbar".

Remarks:

• A graph mode outside the three the setup dropdowns offer files an error entry. It used to fall through the Select Case with no arm, which left the chart with no series and raised 1004 in Graphs.Format two frames later.

Checking

SpecsId #

specs-id

A name for this instance that no other instance shares

Signature:

Private Function SpecsId() As String

The report of everything this builder decided to leave out.

AnalysisOutput merges the entries of every collaborator into one report, and Checking.Add raises on a duplicate key, so a key made of a bare counter collides as soon as two instances file an entry. One instance serves one table, so the table identifier names it.

Returns: String. The identifier every key of this instance carries.

LogInfo #

log-info

Record a diagnostic entry in the internal checking store

Signature:

Private Sub LogInfo(ByVal label As String, _
                    Optional ByVal scope As Byte = checkingNote)

Creates the Checking store on first use and appends the message under a key naming this class, this table and a counter.

Parameters:

• label: String. The message to record.
• scope: Optional Byte. Severity from CheckingLogType. Defaults to checkingNote.

ErrorHandling

ThrowError #

throw-error

Raise a ProjectError-based exception

Signature:

Private Sub ThrowError(ByVal errNumber As Long, ByVal message As String)

Parameters:

• errNumber: Long. The error code to raise.
• message: String. Human-readable description of the failure.

Throws:

• ProjectError. Always raises the specified error.

• AnalysisOutput.cls
• TableSpecs.cls
• Graphs.cls
• TestGraphSeries.bas