Please note : This help page is not for the latest version of Enterprise Architect. The latest help can be found here.

Prev Next

ChartSeries Class

ChartSeries Methods

Method

Description

See also

AddBoxPlotData(double ave, double min, double q1, double q2, double q3, double max, double notched)

long

For a chart having the BoxPlot category, adds a single datapoint to the series.

Parameters:

  • ave: double, the mean value at this point
  • min: double, the minimum value at this point
  • q1: double, the first quartile value
  • q2: double, the second quartile value
  • q3: double, the third quartile value
  • max: double the maximum value at this point
  • notched: double, for a series with notched style, the notched value to express at this point
ChartCategory

AddDataPoint(double Y)

long

Adds a datapoint to the series. Returns the index of the point, which is the number of points -1.

Parameters:

  • Y: double, the Y axis value

AddDatapoint2(double Y, double X)

long

Adds a datapoint to the series. Returns the index of the point, which is the number of points -1.

Parameters:

  • Y: double, the Y axis value
  • X: double, the X axis value

AddDataPoint3(string category, double Y)

long

Adds a Y axis value for a given category on the X axis.

Parameters:

  • category: string, the category or column name
  • Y: double, the value

AddStockData(double open, double high, double low, double closing, VARIANT timestamp)

void

Adds data to a series for a chart of the Stock category.

Parameters:

  • open: double, opening value
  • high: double, high value
  • low: double, low value
  • closing: double, closing value
  • timestamp: {datetime, double utcsecs} either VARIANT date value or double, in which case the value is interpreted as the number of seconds since midnight on January 1st, 1970, UTC time

AddSurfaceColours(VARIANT colors)

void

Adds one or more colors to the series.

Parameters:

  • colors: long, or long[], a single RGB color or an array of RGB color values

CloseShape(boolean close, boolean fill)

void

Connects the first and last datapoints and fills the shape if 'fill' is true.

Parameters

  • close: Boolean, if true closes the series
  • fill: Boolean, fills the shape

GetDataPointCount()

long

Returns the number of datapoints in the series.

GetDataPointValue(long index)

LDISPATCH

Returns a ChartDataValue interface for the datapoint with the given index.

Parameters:

  • index: long, the index of the datapoint (typically returned by AddDataPoint functions; a value in the range 0 to n-1, where n is the number of points returned by the GetDataPointCount function)
ChartDataValue Class

GetSeriesFormat()

LDISPATCH

Returns a ChartFormatSeries interface that allows the chart appearance to be changed.

ChartFormatSeries Class

SetBarShape(long barshape)

void

Sets the shape for Bar charts, 0 for Box, 1 for Pyramid, 2 for PyramidPartial.

Parameters:

  • barshape: ChartBarShape, one of the ChartBarShape enumerations
ChartBarShape

SetColorMapCount(long count)

void

Sets the number of colors used when rendering the series. Typical values are 4, 8, 16 and 32

Parameters:

  • count: long, the number of colors to use

SetColorMode(ChartColorMode mode)

void

For 3D charts, sets the interpolation method for filling shapes. Single, for example, would result in the 3D object being filled by varying the color slightly. The level of variation will depend on the number of colors used by the chart (see SetColorMapCount).

Parameters:

  • mode: ChartColorMode
ChartColorMode

SetDrawFlat(boolean flat)

void

Draws the shape flattened when set to true.

Parameters:

  • flat: Boolean, draw flat

SetFrameColor(long color)

void

Sets the color of the frame for 3D objects.

Parameters:

  • color: long, the RGB color value for coloring the frame

SetFrameStyle(ChartFrameStyle style)

void

Sets the frame style for the chart - none, mesh, contour or both.

Parameters:

  • style: ChartFrameStyle, one of the ChartFrameStyle enumerations
ChartFrameStyle

SetGradientType(long type)

void

Sets the gradient type to use.

Parameters:

  • type: long, one of the ChartGradientType enumerations
ChartGradientType

SetGroupID(long id)

void

Groups series on a stacked chart having the same id. Must be a non-negative number.

Parameters:

  • id: long, a non-negative number used to group the series on a chart

SetLevelRangeMode(long mode)

void

Sets the mode for ranges in series.

  • 0 - Minimum and maximum for Series
  • 1 - Minimum and maximum for Y axis
  • 2 - Custom

Parameters:

  • mode: long, either 0 or 1 supported

SetRelatedAxis(string axis, long index)

void

Sets the related axis for a series. The related axis is created using the Split function of the ChartAxis interface. The axis is first created using Split, then a new series is created, and this function called on it to one of its axes. The axis is specified by the index parameter; the value is one of the ChartAxisIndex enumerations (0 for X, 1 for Y or 2 for Z)

Parameters:

  • axis: string, the guid of the axis returned by a ChartAxis.Split method call; returned by the ChartAxis.GetGuid method
  • index: long, one of the ChartAxisIndex enumerations
ChartAxisIndex

SetStockSeriesType(ChartStockSeriesType type)

void

For Stock charts, sets the graphic used to render the series.

Parameters:

  • type: ChartStockSeriesType, one of the ChartStockSeriesType enumerations
ChartStockSeriesType

SetWireFrame(boolean wired)

void

Sets the wireframe option on or off. When set to true, the chart is no longer rendered as a solid object but is instead rendered as a frame composed of wires.

Parameters:

  • wired: Boolean, displays as a wireframe object if true