API Docs for:
Show:

DynamicChart Class

Module: DynamicChart

Methods

BasicBarChart

(
  • width
  • height
  • [chartMargins=""]
  • [dataDim=1]
  • [parent=body]
)
Object chainable

Defined in dynamic_chart.js:5958

Parameters:

  • width Number

    [Mandatory] The desired width for the chart (can't be changed later)
    Can be any value that is or can be converted to a positive integer.

  • height Number

    [Mandatory] The desired height for the chart (can't be changed later)
    Can be any value that is or can be converted to a positive integer.

  • [chartMargins=""] String optional

    [Optional] A String of 0 to 4 space-separated values that specifies the 4 margins of the chart.
    The string should respect the following format: "top right bottom left;" (notice the trailing semicolon)
    If less then 4 values are passed, only the covered subfield will be assigned using the input string, while the remaining ones will take a default value specified as an inner attribute of the class.

  • [dataDim=1] Number optional

    [Optional] The dimension of the data space, i.e. the number of subvalues for each data entry
    Can be any value that is or can be converted to an integer between 1 and MAXSPACEDIMENSION.

  • [parent=body] Object optional

    [Optional] The DOM element to which the diagram should be appended as a child

Returns:

Object: A (wrapped-in-a-proxy version of a) BasicBarChart object

FixedWidthBarChart

(
  • ticks
  • startingPoint
  • width
  • height
  • [chartMargins=""]
  • [dataDim=1]
  • [parent=body]
)
Object chainable

Defined in dynamic_chart.js:5992

Parameters:

  • ticks Number

    [Mandatory] The number of values that can be drawn at the same time (can't be changed later)
    Can be any value that is or can be converted to a positive integer.

  • startingPoint Number

    [Mandatory, but not used at the moment: inserted for future back-compatibility]
    The reference for the label of the first point.
    Should be an incrementable value;

  • width Number

    [Mandatory] The desired width for the chart (can't be changed later)
    Can be any value that is or can be converted to a positive integer.

  • height Number

    [Mandatory] The desired height for the chart (can't be changed later)
    Can be any value that is or can be converted to a positive integer.

  • [chartMargins=""] String optional

    [Optional] A String of 0 to 4 space-separated values that specifies the 4 margins of the chart.
    The string should respect the following format: "top right bottom left;" (notice the trailing semicolon)
    If less then 4 values are passed, only the covered subfield will be assigned using the input string, while the remaining ones will take a default value specified as an inner attribute of the class.

  • [dataDim=1] Number optional

    [Optional] The dimension of the data space, i.e. the number of subvalues for each data entry
    Can be any value that is or can be converted to an integer between 1 and MAXSPACEDIMENSION.

  • [parent=body] Object optional

    [Optional] The DOM element to which the diagram should be appended as a child

Returns:

Object: A properly initialized (wrapped-in-a-proxy version of a) FixedWidthBarChart object

SlidingBarChart

(
  • ticks
  • width
  • height
  • [chartMargins=""]
  • [dataDim=1]
  • [parent=body]
)
Object chainable

Defined in dynamic_chart.js:6033

Parameters:

  • ticks Number

    [Mandatory] The number of values that can be drawn at the same time (can't be changed later)
    Can be any value that is or can be converted to a positive integer.

  • width Number

    [Mandatory] The desired width for the chart (can't be changed later)
    Can be any value that is or can be converted to a positive integer.

  • height Number

    [Mandatory] The desired height for the chart (can't be changed later)
    Can be any value that is or can be converted to a positive integer.

  • [chartMargins=""] String optional

    [Optional] A String of 0 to 4 space-separated values that specifies the 4 margins of the chart.
    The string should respect the following format: "top right bottom left;" (notice the trailing semicolon)
    If less then 4 values are passed, only the covered subfield will be assigned using the input string, while the remaining ones will take a default value specified as an inner attribute of the class. For this particular chart the right margin can't be less than AXESLABELWIDTH pixel wide (if a smaller value is passed, it will be overwritten).

  • [dataDim=1] Number optional

    [Optional] The dimension of the data space, i.e. the number of subvalues for each data entry
    Can be any value that is or can be converted to an integer between 1 and MAXSPACEDIMENSION.

  • [parent=body] Object optional

    The DOM element to which the diagram should be appended as a child

Returns:

Object: A properly initialized (wrapped-in-a-proxy version of a) SlidingBarChart object

TimeWheelChart

(
  • ticks
  • startTime
  • width
  • height
  • [chartMargins=""]
  • [dataDim=1]
  • [parent=body]
)
Object chainable

Defined in dynamic_chart.js:6074

Parameters:

  • ticks Number

    [Mandatory] The number of values that can be drawn at the same time (can't be changed later) Can be any value that is or can be converted to a positive integer.

  • startTime String

    [Mandatory] The reference for the label of the first point.
    Should be an incrementable value.

  • width Number

    [Mandatory] The desired width for the chart (can't be changed later)
    Can be any value that is or can be converted to a positive integer.

  • height Number

    [Mandatory] The desired height for the chart (can't be changed later)
    Can be any value that is or can be converted to a positive integer.

  • [chartMargins=""] String optional

    [Optional] A String of 0 to 4 space-separated values that specifies the 4 margins of the chart.
    The string should respect the following format: "top right bottom left;" (notice the trailing semicolon)
    If less then 4 values are passed, only the covered subfield will be assigned using the input string, while the remaining ones will take a default value specified as an inner attribute of the class.

  • [dataDim=1] Number optional

    [Optional] The dimension of the data space, i.e. the number of subvalues for each data entry
    Can be any value that is or can be converted to an integer between 1 and MAXSPACEDIMENSION.

  • [parent=body] Object optional

    [Optional] The DOM element to which the diagram should be appended as a child

Returns:

Object: A properly initialized (wrapped-in-a-proxy version of a) TimeWheelChart object

Properties

DEFAULT_AXE_MARGIN

Number private final

Defined in dynamic_chart.js:66

Default axes margin (in pixels);

DEFAULT_AXES_COLOR

Number private final

Defined in dynamic_chart.js:151

Default line width for axes and notches;

Default: = "black"

DEFAULT_AXES_LABEL_SIZE

Number private final

Defined in dynamic_chart.js:118

Default size of axes' labels lext

Default: = 14

DEFAULT_AXES_LINE_WIDTH

Number private final

Defined in dynamic_chart.js:140

Default line width for axes and notches;

Default: = 1

DEFAULT_INNER_BACKGROUND

String | Object private final

Defined in dynamic_chart.js:76

Default background color for the main chart area.

Default: = "white"

DEFAULT_INNER_BORDER

Object private final

Defined in dynamic_chart.js:97

Default border for the main chart area.

Default: = none

DEFAULT_LABEL_SIZE

Number private final

Defined in dynamic_chart.js:48

Default size for chart's labels (in points);

DEFAULT_OUTER_BACKGROUND

String | Object private final

Defined in dynamic_chart.js:86

Default background color for the outer chart area.

Default: = "white"

DEFAULT_OUTER_BORDER

Object private final

Defined in dynamic_chart.js:107

Default border for the outer chart area.

Default: = none

DEFAULT_TITLE_SIZE

Number private final

Defined in dynamic_chart.js:57

Default size for chart's title text (in points);

FILL_COLORS

Array private final

Defined in dynamic_chart.js:39

Default fill colors bor graphic elements;

LEGEND_ITEM_FONT_SIZE

Number private final

Defined in dynamic_chart.js:198

Default font size for labels attached to legend's items (in pixel);

LEGEND_ITEM_HEIGHT

Number private final

Defined in dynamic_chart.js:171

Default height for legend's item boxes (in pixel);

LEGEND_ITEM_LEFT

Number private final

Defined in dynamic_chart.js:189

Default left margin for legend's items (in pixel);

LEGEND_ITEM_WIDTH

Number private final

Defined in dynamic_chart.js:162

Default width for legend's item boxes (in pixel);

LEGEND_MARGIN

Number private final

Defined in dynamic_chart.js:180

Default margin for legends (in pixel);

MAX_SPACE_DIMENSION

Number private final

Defined in dynamic_chart.js:28

Maximum dimension of the input space, i.e. max number of subvalues for each single point

NOTCH_LINE_LENGTH

Number private final

Defined in dynamic_chart.js:129

Length of notch lines, in pixels;

Default: = 5