5.17.2 Metody

 

 

AddLegend

 

void AddLegend(ReportChartLegendPosition aPosition, string aStyle);

Sub AddLegend(ByVal aPosition As  ReportChartLegendPosition, ByVal aStyle As  String)

 

Metoda służy do dodania do wykresu legendy opisującej serie danych umieszczonych na wykresie.

Parametr aPosition określa lokalizację legendy. Możliwe są poniższe wartości:

ReportChartLegendPosition.Bottom - poniżej obszaru wykresu

ReportChartLegendPosition.Top - powyżej obszaru wykresu

ReportChartLegendPosition.Left - na lewo od obszaru wykresu

ReportChartLegendPosition.Right - na prawo od obszaru wykresu

Parametr aStyle określa nazwę stylu dla tekstów umieszczonych w wygenerowanej legendzie.


 

AddSeries

 

ReportChartSeries AddSeries(string aName, MigraDoc.DocumentObjectModel.Shapes.Chart.ChartType aChartType, string aVarName, string  aAggrName,MigraDoc.DocumentObjectModel.Color aColor, MigraDoc.DocumentObjectModel.Color  aFillColor);

 

Function AddSeries(ByVal aName As  String, ByVal aChartPar As MigraDoc.DocumentObjectModel.Shapes.Charts.ChartType, ByVal aVarName As  String, ByVal aAggrName As  String, ByVal aColor As  MigraDoc.DocumentObjectModel.Color, ByVal aFillColor As MigraDoc.DocumentObjectModel.Color) As ReportChartSeries

 

Metoda służy do dodania serii danych do wykresu tworzonego na podstawie danych archiwalnych zmiennych procesowych.

Parametr aName określa nazwę serii danych. Nazwa serii jest używana w legendzie wykresu.

Parametr aChartType określa sposób wyświetlania danych serii. W ramach pojedynczego wykresu można stosować różne typy serii, ale nie wszystkie kombinacje są dozwolone.

Parametry aVarName i aAggrName określają nazwę zmiennej procesowej oraz nazwę wyliczanego agregatu.

Parametr aColor określa kolor linii dla rysowania serii, a parametr aFillColor określa kolor wypełniania (stosowany dla niektórych typów serii, np. słupkowego).

 

ReportChartSeries AddSeries(string aName, MigraDoc.DocumentObjectModel.Shapes.Chart.ChartType aChartType, string aFieldName, MigraDoc.DocumentObjectModel.Color aColor, MigraDoc.DocumentObjectModel.Color  aFillColor);

 

Function AddSeries(ByVal aName As  String, ByVal aChartPar As MigraDoc.DocumentObjectModel.Shapes.Charts.ChartType, ByVal aFieldName As  String, ByVal aColor As  MigraDoc.DocumentObjectModel.Color, ByVal aFillColor As MigraDoc.DocumentObjectModel.Color) As ReportChartSeries

 

 

Metoda służy do dodania serii danych do wykresu tworzonego na podstawie danych przekazanych w momencie tworzenia wykresu (poprzez obiekt typu DataTable lub ICollection).

Parametr aChartType określa sposób wyświetlania danych serii. W ramach pojedynczego wykresu można stosować różne typy serii, ale nie wszystkie kombinacje są dozwolone.

Parametr aFieldName określa nazwę elementu używanego przez serię. Jest to nazwa kolumny w obiekcie typy DataTable lub nazwa właściwości obiektów przekazanych w kolekcji ICollection.

Parametr aColor określa kolor linii dla rysowania serii, a parametr aFillColor określa kolor wypełniania (stosowany dla niektórych typów serii, np. słupkowego).

 

 

AddXSeries

 

void AddXSeries(string aFieldName);

Sub AddXSeries(ByVal aFieldName As  String)

 

Metoda określa serię danych używanych do opisu osi X wykresu. Parametr aFieldName określa nazwę elementu używanego przez serię osi X. Jest to nazwa kolumny w obiekcie typy DataTable lub nazwa właściwości obiektów przekazanych w kolekcji ICollection.

 

Metoda jest używana tylko dla wykresów z kolekcji danych. Dla wykresów z danych historycznych oś X jest zawsze osią czasu.

 

 

 

CustomizeXAxis

 

void CustomizeXAxis(MigraDoc.DocumentObjectModel.Color aLineColor, string aStyle, string aFormat, int aTickDensity);

Sub CustomizeXAxis(ByVal aLine As  MigraDoc.DocumentObjectModel.Color, ByVal aStyle As  String, ByVal aFormat As  String, ByVal aTickDensity As  Integer)

 

Metoda służy do określenia sposobu utworzenia osi X wykresu.

 

Parametr aLineColor określa kolor linii osi. Parametr aStyle definiuje nazwę stylu używanego do generacji tekstów opisujących skalę osi. Parametr aFormat określa sposób formatowania (konwersji wartość na tekst) wartości skali osi X. Parametr aTickDensity określa gęstość opisu skali osi. Wartość 1 oznacza, że będzie opisany każdy punkt wykresu. Wartości większe od 1 oznaczają: co który punkt ma być opisany.

 
 

 

CustomizeYAxis

 

void CustomizeYAxis(double? aMinValue, double? aMaxValue, double? aTickValue, bool aHasGridLines, MigraDoc.DocumentObjectModel.Color aLineColor, string aStyle, string aFormat);

Sub CustomizeYAxis(ByVal aMinValue As  Double?, ByVal aMaxValue As  Double?, ByVal aTickValue As  Double?, ByVal aHasGridLines As  Boolean, ByVal aLine As  MigraDoc.DocumentObjectModel.Color, ByVal aStyle As  String, ByVal aFormat As  String)

 

Metoda służy do określenia sposobu utworzenia osi Y wykresu.

Parametry aMinValue, aMaxValue i aTickValue służą do definiowania sposobu opisu skali osi Y. Oznaczają one odpowiednio: wartość minimalną skali, wartość maksymalną oraz odstęp pomiędzy kolejnymi opisami na skali osi. Przekazanie wartości null (Nothing) oznacza automatyczne skalowanie osi Y.

Parametr aHasGrdiLines określa, czy należy rysować poziome linie siatki wartości na wykresie. Parametr aLineColor określa kolor linii osi i siatki.

Parametr aStyle definiuje nazwę stylu używanego do generacji tekstów opisujących skalę osi. Parametr aFormat określa sposób formatowania (konwersji wartości na tekst) wartości skali osi X.

 

 

GenerateContent

 

void GenerateContent ();

Sub GenerateContent ()

 

Metoda służy do wygenerowanie kompletnej zawartości wykresu na podstawie dostępnych danych. Użycie metody nie jest obowiązkowe. Metoda Render klasy Report automatycznie wywołuje metodę GenerateContent dla wszystkich wykresów, dla których metoda nie była jeszcze wykonana.

 

 

 

SetQueryData

 

void SetQueryData(DateTime aStartTime, DateTime aStartTime, TimeSpan aAggrInterval);

Sub SetQueryData(ByVal aStartTime As  Date, ByVal aEndTime As  Date, ByVal aAggrInterval As System.TimeSpan) 

 

Metoda określa parametry zapytania o dane w przypadku wykresów tworzonych na podstawie odczytu danych archiwalnych zmiennych procesowych.

Parametry aStartTime i aEndTime określają czasy początku i końca zapytania o dane. Parametr aAggrInterval określa okres agregacji danych.

 

 

 

SetXAxisTitle

 

void SetXAxisTitle(string aTitle, string aStyle);

Sub SetXAxisTitle(ByVal aTitle As  String, ByVal aStyle As  String)

 

Metoda służy do określenia opisu osi X wykresu. Parametr aTitle definiuje opis osi, a parametr aStyle nazwę stylu.


 

 

SetYAxisTitle

 

void SetYAxisTitle(string aTitle, string aStyle);

Sub SetYAxisTitle(ByVal aTitle As  String, ByVal aStyle As  String)

 

Metoda służy do określenia opisu osi Y wykresu. Parametr aTitle definiuje opis osi, a parametr aStyle nazwę stylu.