Specifies all the series captions from data encoded in a separator-delimited string.
object.SetSeriesCaptionsFromString( captions )
By default, a new data series added to a chart with the method AddSeries has no caption.
You can set the series captions in a chart with captions encoded in a string (i.e.: the captions argument). The string must be formatted as a list of captions, two consecutive captions must be separated by a separator character that can be specified with the SetSeparators method.
Here is an example of series captions encoded in a string with the character ";" as separator.
myEncodedString= "Year 2000;Year 2001"
The string argument captions is parsed by the chart object according to the separator characters specified to the chart object (see the SetSeparators method for specifying separator characters and rules).
The ";" character is the default separator character.
The following JScript code shows how to specify the series captions corresponding to the table below using the SetSeriesCaptionsFromString method. This table has two series with captions "Year 2000" and "Year 2001". The categories are "North America", "South America", "Europe", "Middle East" and "Asia".
|
||||||||||||||||||
![]() |
//Let's build the series and categories string with ";" as separator sep= ";"; ignoremultseparators= true; //Before setting the series and categories, we must specify the separators chart.SetSeparators( sep, ignoremultseparators ); myString= "North America" + sep + "South America" + sep + "Europe" + sep + "Middle East" + sep + "Asia"; //Fill the chart with the categories stored in the myString variable chart.SetCategoriesFromString( myString ); //Add the first series "Year 2000" myString= "12" + sep + "7.5" + sep + "11.3" + sep + "9.2" + sep + "5.3"; //Fill the first series with the data stored in the myString variable chart.AddSeries(); chart.SetSeriesValuesFromString(0, myString); //Add the second series "Year 2001" myString= "14" + sep + "9.9" + sep + "13.1" + sep + "11.5" + sep + "4.9"; //Fill the second series with the data stored in the myString variable chart.AddSeries(); chart.SetSeriesValuesFromString(1, myString); //Specify the 2 series captions myString= "Year 2000" + sep + "Year 2001"; //Set the series captions with the strings stored in the myString variable chart.SetSeriesCaptionsFromString( myString );
SetSeriesCaptionsFromArray Method | GetSeriesCaption Method | GetSeriesValue Method | GetSeriesCount Method
Applies To: Chart Object