Class: Section

Section

Class that represents a section of the main report. You should not try to instantiate it directly.


new Section(store, reportTree)

Creates an instance of Section. This constructor should only be called by the Report class

Parameters:
Name Type Description
store any
reportTree any
Source:

Methods


calcPercent(totalRef)

Parameters:
Name Type Description
totalRef string
Source:
Returns:

this


increment(path [, value])

Parameters:
Name Type Argument Default Description
path string
value number <optional>
1
Source:
Returns:

this


section(name)

Parameters:
Name Type Description
name string
Source:
Returns:

new Section under name


set(path, value)

Parameters:
Name Type Description
path string
value any
Source:
Returns:

this


subSection()

Legacy method from v1.0.0 Will be removed soon

.

Legacy method from v1.0.0 Will be removed soon

Deprecated:
  • Legacy method from v1.0.0 Will be removed soon
Source:
Returns:

new Section under name


summary()

Source:
Returns:

summary Section


toJSON()

Returns the object that should be serialized as a JSON representation of the report

.

Returns the object that should be serialized as a JSON representation of the report

Source:
Returns:

internal report