OKSeries class documentation

Authors

Riccardo Mottola

Copyright: (C) 2011-2015 Free Software Foundation

Software documentation for the OKSeries class

OKSeries : NSObject

Declared in:
OKSeries.h

OKseries provides the series data storage used by charts.

A series contains an array of scalar data (NSNumbers) and additional information like color, description and title


Instance Variables

Method summary

addObject: 

- (void) addObject: (id)obj;
adds object and updates of minimum and maximum value

color 

- (NSColor*) color;
color with which the series is drawn

count 

- (NSUInteger) count;
number of elemens in Array

description 

- (NSString*) description;
a more verbose description of the series

highlighted 

- (BOOL) highlighted;
if the series is drawn highlighted in a multi-series plot

maxValue 

- (NSNumber*) maxValue;
largest value in series

minValue 

- (NSNumber*) minValue;
smallest value in series

objectAtIndex: 

- (id) objectAtIndex: (NSUInteger)index;
returns object at the specified index

removeAllObjects 

- (void) removeAllObjects;
removes all elements, leaving an empty series

removeObjectAtIndex: 

- (void) removeObjectAtIndex: (NSUInteger)index;
removes the element in series given by index

setColor: 

- (void) setColor: (NSColor*)c;
sets the color with which the series is drawn

setDescription: 

- (void) setDescription: (NSString*)aDescription;
sets a more verbose description of the series

setHighlighted: 

- (void) setHighlighted: (BOOL)status;
set if the series is drawn highlighted in a multi-series plot

setTitle: 

- (void) setTitle: (NSString*)aTitle;
sets the caption of the series

title 

- (NSString*) title;
caption of the series



Instance Variables for OKSeries Class

color

@protected NSColor* color;
Series color, used when drawing the chart. E.g. the line color or the pie sector

description

@protected NSString* description;
Description forthcoming.

highlighted

@protected BOOL highlighted;
if the series should be highlighted compared to others, e.g. drawin in bold or brighter colour

maxValue

@protected NSNumber* maxValue;
maximum value, kept updated while adding/removing

minValue

@protected NSNumber* minValue;
minimum value, kept updated while adding/removing

seriesArray

@protected NSMutableArray* seriesArray;
Array containing series data

title

@protected NSString* title;
Description forthcoming.