Open Source Dokumentenmanagement
Dokumentation

Durchsuchbare Dokumentation aufrufen | Zurück zur Dokumentationsübersicht

Navigation: Dokumentationen agorum core > agorum core JavaScript-API

JavaScript-Bibliothek ac

Diese JavaScript-Bibliothek bietet generelle Hilfs-Funktionen.

Verwendung

Sie benötigen die folgende Bibliothek, um diese JavaScript-Bibliothek verwenden zu können. Die Bibliothek geben Sie am Anfang des Skripts an.

let ac = require('ac');

Funktionen

eq (equals)

Prüft, ob 2 Werte gleich sind mit angegebener Präzision.


Syntax

ac.eq(value1, value2, precision);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
value1 Definiert Wert 1 für den Vergleich. Ja – Beispiel
value2 Definiert Wert 2 für den Vergleich. Ja –
precision Definiert die Nachkommastellen. Nein 2


Beispiel

let ac = require('ac');

ac.eq(123.44546, 123.45, 2);

// liefert "true" zurück


Rückgabewerte

Sie erhalten einen booleschen Wert zurück.

Wert Beschreibung
true Wert 1 und Wert 2 sind identisch.
false Wert 1 und Wert 2 sind nicht identisch.


Verwendung

Diese Funktion verwenden Sie, um 2 Werte miteinander zu vergleichen.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

format

Ruft die angegebene Formatierung auf.


Syntax

ac.format(value, format);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
value Definiert den Wert, den das System formatiert. Ja – Beispiel
format Gibt die Formatierung an. Ja –


Beispiele


Datum formatieren

let ac = require('ac');

ac.format(new Date(), 'dd.MM.yyyy');

// Liefert das aktuelle Datum zurück, etwa 19.05.2022.

In diesem Beispiel ruft das System intern die Funktion formatDate auf, da value ein Date ist.


Zahlen formatieren

let ac = require('ac');

ac.format(123.4, 'en|0.5');

// Liefert "123.5" zurück

In diesem Beispiel ruft das System intern die Funktion formatNumber auf, da value eine Number ist.


Rückgabewerte

Das System gibt den angegebenen Wert formatiert zurück.


Verwendung

Diese Funktion verwenden Sie, wenn Sie Werte formatieren möchten.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

formatDate

Wandelt ein Datum in einen String mit angegebenem Format um.


Syntax

ac.formatDate(value, dateFormat);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
value Definiert den Wert, den das System umwandelt. Ja – Beispiel
dateFormat Definiert das Datumsformat für das Umwandeln. Ja –


Beispiel

let ac = require('ac');

ac.formatDate(new Date(), 'dd.MM.yyyy');


Rückgabewerte

Sie erhalten das Datum als String zurück.

19.05.2022


Verwendung

Diese Funktion verwenden Sie, wenn Sie ein Datum als String benötigen.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

formatNumber

Wandelt eine Zahl in einen String um.

Die Standard-Java-DecimalFormat-Angaben gelten.


Syntax

ac.formatNumber(number, 'language|DecimalFormat');


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
number Definiert die Zahl, die das System in einen String umwandelt. Ja – Beispiel
language|DecimalFormat Definiert die Sprache des Formats inklusive Dezimal-Separator. Nein de


Beispiel

let ac = require('ac');

ac.formatNumber(123.4, 'en|0.5');


Rückgabewerte

Sie erhalten die Zahl als String zurück.

123.5


Verwendung

Diese Funktion verwenden Sie, wenn Sie eine Zahl als String benötigen.


Exceptions

Für diese Funktion existieren keine Exceptions.

formatString

Formatiert einen String.


Syntax

ac.formatString(String , x, y);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
String Definiert den String an, den das System formatiert. Ja – Beispiele
x

Definiert die Startposition des Strings.

  • x beginnt ab 1.
  • Wenn x negativ ist, beginnt das System von hinten, wobei -1 das letzte Zeichen ist.
 Ja –
y

Definiert die Endposition des Strings.

  • y beginnt ab 1.
  • Wenn y negativ ist, beginnt das System von hinten, wobei -1 das letzte Zeichen ist.
 Ja –


Beispiele


Beispiel 1

let ac = require('ac');

ac.formatString('0123456789', '1');

Ergebnis:

'0'


Beispiel 2

let ac = require('ac');

ac.formatString('0123456789', '1,2');

Ergebnis:

'01'


Beispiel 3

let ac = require('ac');

ac.formatString('0123456789', '-1');

Ergebnis:

'9'


Beispiel 4

let ac = require('ac');

ac.formatString('0123456789', '-1,2');

Ergebnis:

'123456789'

Beispiel 5 
let ac = require('ac');

ac.formatString('0123456789', '-1,-2');

Ergebnis:

'89'


Rückgabewerte

Sie erhalten den String im angegebenen Format zurück.

'0'


Verwendung

Diese Funktion verwenden Sie, wenn Sie einen String formatiert benötigen.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

ge (greater equal)

Prüft, ob Wert 1 größer oder gleich ist als Wert 2 mit angegebener Präzision.


Syntax

ac.ge(value1, value2, precision);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
value1 Definiert Wert 1 für den Vergleich. Ja – Beispiel
value2 Definiert Wert 2 für den Vergleich. Ja –
precision Definiert die Nachkommastellen. Nein 2


Beispiel

let ac = require('ac');

ac.ge(123.44546, 123.45, 2);

// liefert "true" zurück


Rückgabewerte

Sie erhalten einen booleschen Wert zurück.

Wert Beschreibung
true Wert 1 ist größer oder gleich Wert 2.
false Wert 1 ist nicht größer oder gleich Wert 2.


Verwendung

Diese Funktion verwenden Sie, wenn Sie prüfen möchten, ob Wert 1 größer oder gleich ist als Wert 2.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

gt (greater than)

Prüft, ob Wert 1 größer ist als Wert 2 mit angegebener Präzision.


Syntax

ac.gt(value1, value2, precision);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
value1 Definiert Wert 1 für den Vergleich. Ja – Beispiel
value2 Definiert Wert 2 für den Vergleich. Ja –
precision Definiert die Nachkommastellen. Nein 2


Beispiel

let ac = require('ac');

ac.gt(123.44546, 122.0, 2);

// liefert "true" zurück


Rückgabewerte

Sie erhalten einen booleschen Wert zurück.

Wert Beschreibung
true Wert 1 ist größer als Wert 2.
false Wert 1 ist nicht größer als Wert 2.


Verwendung

Diese Funktion verwenden Sie, um zu prüfen, ob Wert 1 größer als Wert 2 ist.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

le (less equal)

Prüft, ob Wert 1 kleiner gleich ist als Wert 2 mit angegebener Präzision.


Syntax

ac.le(value1, value2, precision);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
value1 Definiert Wert 1 für den Vergleich. Ja – Beispiel
value2 Definiert Wert 2 für den Vergleich. Ja –
precision Definiert die Nachkommastellen. Nein 2


Beispiel

let ac= require('ac');

ac.le(123.44546, 123.45, 2);

// liefert "true" zurück


Rückgabewerte

Sie erhalten einen booleschen Wert zurück.

Wert Beschreibung
true Wert 1 ist kleiner oder gleich Wert 2.
false Wert 1 ist nicht kleiner oder gleich Wert 2.


Verwendung

Diese Funktion verwenden Sie, wenn Sie prüfen möchten, ob Wert 1 kleiner oder gleich ist als Wert 2.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

lt (less than)

Prüft, ob Wert 1 kleiner ist als Wert 2 mit angegebener Präzision.


Syntax

ac.lt(value1, value2, precision);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
value1 Definiert Wert 1 für den Vergleich. Ja – Beispiel
value2 Definiert Wert 2 für den Vergleich. Ja –
precision Definiert die Nachkommastellen. Nein 2


Beispiel

let ac = require('ac');

ac.lt(123.44546, 122.0, 2);

// liefert "false" zurück


Rückgabewerte

Sie erhalten einen booleschen Wert zurück.

Wert Beschreibung
true Wert 1 ist kleiner als Wert 2.
false Wert 1 ist nicht kleiner als Wert 2.


Verwendung

Diese Funktion verwenden Sie, wenn Sie prüfen möchten, ob Wert 1 kleiner ist als Wert 2.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

parseBoolean

Wandelt einen String in einen Boolean.


Syntax

ac.parseBoolean(String);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
String Definiert den String, den das System umwandelt. Ja – Beispiel


Beispiel

let ac = require('ac');

ac.parseBoolean('true');


Rückgabewerte

Sie erhalten den String als Boolean zurück.

true


Verwendung

Diese Funktion verwenden Sie, wenn Sie einen String als Boolean benötigen.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

parseDate

Wandelt einen String mit angegebenem Format in ein Datum um.


Syntax

ac.parseDate(date, dateFormat, language);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
date Definiert das Datum. Ja – Beispiel
dateFormat Definiert das Datumsformat für das Umwandeln. Ja –
language Definiert, ob das System Monate etwa in Englisch oder Deutsch schreibt.
  • Oct
  • Okt
  • October
  • Oktober
 Ja –


Beispiel

let ac = require('ac');

ac.parseDate('01.01.2018', 'dd.MM.yyyy','en');


Rückgabewerte

Sie erhalten den String als Datum formatiert zurück.

"2018-01-01T00:00:00.000Z"


Verwendung

Diese Funktion verwenden Sie, wenn Sie einen String als Datum benötigen.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

parseDouble

Wandelt einen String in eine double-Zahl.


Syntax

ac.parseDouble(String, language);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
String Definiert den String, den das System umwandelt. Ja – Beispiel
language Definiert die Formatierung der Nachkommastellen.

Für Komma 
'de'

Für Punkt

'en'
 Ja –


Beispiel

let ac = require('ac');

ac.parseDouble('123.1','en');


Rückgabewerte

Sie erhalten den String als double-Zahl zurück.

123.1


Verwendung

Diese Funktion verwenden Sie, wenn Sie einen String als double-Zahl benötigen.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

parseFloat

Wandelt einen String in eine float-Zahl.


Syntax

ac.parseFloat(String, language);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
String Definiert den String, den das System umwandelt. Ja – Beispiel
language Definiert die Formatierung der Nachkommastellen.

Für Komma 
'de'

Für Punkt

'en'
 Ja –


Beispiel

let ac = require('ac');

ac.parseDouble('123.1','en');


Rückgabewerte

Sie erhalten den String als float-Zahl zurück.

123.1


Verwendung

Diese Funktion verwenden Sie, wenn Sie einen String als float-Zahl benötigen.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

parseInt

Wandelt einen String in eine integer-Zahl.


Syntax

ac.parseInt(String);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
String Definiert den String an, den das System umwandelt. Ja – Beispiel

Beispiel

let ac = require('ac');

ac.parseInt('123');


Rückgabewerte

Sie erhalten den String als integer-Zahl zurück.

123


Verwendung

Diese Funktion verwenden Sie, wenn Sie einen String als integer-Zahl benötigen.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

parseLong

Wandelt einen String in eine long-Zahl.


Syntax

ac.parseLong(String);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
String Definiert den String, den das System umwandelt. Ja – Beispiel


Beispiel

let ac = require('ac');

ac.parseLong('123');


Rückgabewerte

Sie erhalten den String als long-Zahl zurück.

123


Verwendung

Diese Funktion verwenden Sie, wenn Sie einen String als long-Zahl benötigen.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

round

Rundet einen Wert anhand der übergebenen Präzision.


Syntax

ac.round(value, precision);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
value Definiert den Wert, den das System rundet. Ja – Beispiel
precision Definiert die Nachkommastellen für das Runden. Nein 2


Beispiel

let ac = require('ac');

ac.round(123.44546, 2);


Rückgabewerte

Sie erhalten den gerundeten Wert zurück.

123.45


Verwendung

Diese Funktion verwenden Sie, wenn Sie einen Wert runden möchten.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

sum

Summiert die Werte einer bestimmten Spalte in einem Array von maps auf (siehe Funktion toCSV).


Syntax

ac.sum(rows, col);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
rows Definiert ein Array von maps, das die Zeilenwerte enthält. Ja – Beispiel
col Definiert die Spalte, deren Werte das System aufsummiert, etwa die Spalte row2. Ja –


Beispiel

let ac = require('ac');

let rows = [
  {
    row1: new Date(),
    row2: 1.5,
    row3: 'Eine Zeichenkette 1'
  },
  {
    row1: new Date('2018-01-01'),
    row2: 123.456,
    row3: 'Eine \nZeichenkette 2'
  }  
];

ac.sum(rows, 'row2');


Rückgabewerte

Sie erhalten die aufsummierte Spalte zurück.

124.956


Verwendung

Diese Funktion verwenden Sie, wenn Sie bestimmte Spalten aufsummieren möchten.


Exceptions

Zu dieser Funktion existieren keine Exceptions.

toCSV

Wandelt eine Array-Struktur in ein CSV-Format.


Syntax

ac.toCSV(rows, cols, colSeparator, rowSeparator, quoteCharacter);


Parameter

Parameter Beschreibung Pflicht Standard Weitere Informationen
rows Definiert ein Array von maps, das die Zeilenwerte enthält. Ja – Beispiel
cols Definiert die Spalten inklusive Formatierung. Ja –
colSeparator Definiert den Spaltentrenner. Nein ;
rowSeparator Definiert den Zeilentrenner. Nein /n
quoteCharacter Definiert das Zeichen pro Wert. Nein "


Beispiel

let ac = require('ac');

let cols = [
  'row1:dd.MM.yyyy',
  'row2:de|0.0',
  'row3'
];

let rows = [
  {
    row1: new Date(),
    row2: 1.5,
    row3: 'Eine Zeichenkette 1'
  },
  {
    row1: new Date('2018-01-01'),
    row2: 123.456,
    row3: 'Eine \nZeichenkette 2'
  }  
];

ac.toCSV(rows, cols, ';', '\n', '"');


Rückgabewerte

Sie erhalten die Array-Struktur im CSV-Format zurück.

24.05.2022;1,5;Eine Zeichenkette 1
01.01.2018;123,5;"Eine
Zeichenkette 2"


Verwendung

Diese Funktion verwenden Sie, wenn Sie diverse Spalten und Zeilen in das CSV-Format umgewandelt benötigen.


Exceptions

Zu dieser Funktion existieren keine Exceptions.