@feds01/graphika

---

@feds01/graphika / legend/manager

legend/manager

Classes

default

Defined in: legend/manager.ts:32

Constructors

Constructor

new default(graph, data): default;

Defined in: legend/manager.ts:59

Constructor for a legend manager object. This object is responsible for drawing the legend on the graph.

Parameters

Parameter	Type	Description
graph	default	The graph object that the legend is drawn on
data	DataSource[]	The data sources that the legend is drawn for

Returns

default

Properties

Property	Modifier	Type	Description	Defined in
alignment	public	LegendAlignment	Since v0.0.1 The alignment of the legend box on the graph.	legend/manager.ts:43
position	public	LegendPosition	Since v0.0.1 The position of where the legend box is drawn on the graph.	legend/manager.ts:38
requiredSpace	public	number	Since v0.0.1 The required space for the legend box to be drawn.	legend/manager.ts:48

Methods

draw()

draw(): void;

Defined in: legend/manager.ts:142

Function that draws this component.

Returns

void

drawLegend()

drawLegend(
   label, 
   colour, 
   style, 
   x, 
   y
): void;

Defined in: legend/manager.ts:115

Function to draw a label with a key box denoting one of the graph legends.

Parameters

Parameter	Type	Description
label	string	The name of the line that represents this legend.
colour	string	The colour of the key box.
style	BorderStyle	Border style of the key box.
x	number	X coordinate of where to draw the label.
y	number	Y coordinate of where to draw the label.

Returns

void

getRequiredSpaceFor()

getRequiredSpaceFor(item): number;

Defined in: legend/manager.ts:97

Parameters

Parameter	Type
item	string

Returns

number

Type Aliases

LegendAlignment

type LegendAlignment = "start" | "center" | "end";

Defined in: legend/manager.ts:29

---

LegendOptions

type LegendOptions = {
  alignment?: LegendAlignment;
  draw?: boolean;
  position?: LegendPosition;
};

Defined in: legend/manager.ts:23

Properties

Property	Type	Defined in
alignment?	LegendAlignment	legend/manager.ts:26
draw?	boolean	legend/manager.ts:24
position?	LegendPosition	legend/manager.ts:25

---

LegendPosition

type LegendPosition = "left" | "right" | "top" | "bottom";

Defined in: legend/manager.ts:30