ym.Util

Überblick

Hilfsmethoden der Karten-API.

Methoden

clearTimer(index) ab v3

Entfernt einen Beobachter aus der Timer-Warteschlange.

Parameter

Name Beschreibung Datentyp Standardwert
index   int  

Rückgabe

void

domTemplate(target, options) ab v3

Erzeugt eine Template-Funktion aus einer Zeichenkette.

Parameter

Name Beschreibung Datentyp Standardwert
target   string  
options [optional] object  

Rückgabe

function

each(array, iterator, context) ab v3

Iteriert über eine Array.

Parameter

Name Beschreibung Datentyp Standardwert
array   array  
iterator   function  
context [optional]    

Rückgabe

void

filter(array, iterator, context) ab v3

Iteriert unter Berücksichtigung eines Filters über ein Array.

Parameter

Name Beschreibung Datentyp Standardwert
array   array  
iterator   function  
context [optional]    

Rückgabe

array

formatAddressLine(addressObj, options) ab v3

Wandelt ein Adressobjekt in eine Zeichenfolge um.

Parameter

Name Beschreibung Datentyp Standardwert
addressObj   ym.util.AddressFormat oder
 ym.util.AddressCompatibilityFormat
 oder ym.util.GeoJSONFormat
 
options
Name Beschreibung Datentyp Standardwert
altText [optional] string null
prependCountry [optional] bool false
avoidZip [optional] bool false
[optional]
object

Rückgabe

string

formatNumber(number, digits) ab v3

Rundet eine Zahl auf eine vorgegebene Genauigkeit.

Parameter

Name Beschreibung Datentyp Standardwert
number   double  
digits [optional] int  

Rückgabe

int

getUrlParams(forceLoad) ab v3

Ladet die Parameter einer URL.

Parameter

Name Beschreibung Datentyp Standardwert
forceLoad [optional] bool

Rückgabe

object

humanMetricDistance(distance, forceDecimalFormat, exponent) ab v3

Liefert den metrischen Abstand einer ganzen Zahl.

Parameter

Name Beschreibung Datentyp Standardwert
distance      
forceDecimalFormat      
exponent      

Rückgabe

string

humanNumberFormat(number, exponent, zeroFix) ab v3

Stellt eine Zahl im deutschen Nummernformat dar.

Parameter

Name Beschreibung Datentyp Standardwert
number   string oder Zahl  
exponent [optional] int 0
zeroFix [optional] bool false

Rückgabe

string

ltrim(s) ab v3

Entfernt Leerzeichen am Anfang einer Zeichenfolge.

Parameter

Name Beschreibung Datentyp Standardwert
s   string  

Rückgabe

string

map(array, iterator, context) ab v3

Iteriert über ein Array und bildet jedes Element durch den Iterator ab.

Name Beschreibung Datentyp Standardwert
array   array  
iterator   function  
context [optional]    

Rückgabe

array

mixin(class, mixin) ab v3

Fügt einer Klasse eine Methode hinzu.

Parameter

Name Beschreibung Datentyp Standardwert
class   class  
mixin   object  

Rückgabe

class

nextId() ab v3

Erzeugt eine eindeutige ID für die Session.

Rückgabe

int

parseHTML(htmlStr, parent) ab v3

Erzeugt ein DOM-Element, das optional an ein übergeordnetes Element angehängt werden kann.

Parameter

Name Beschreibung Datentyp Standardwert
htmlStr   string  
parent [optional] HTMLElement  

Rückgabe

HTMLElement

replaceUrl(data) ab v3

Ersetzt die URL-Abfrage der aktuellen Seiten-URL.

Parameter

Name Beschreibung Datentyp Standardwert
data   object  

Rückgabe

void

rtrim(s) ab v3

Entfernt Leerzeichen vom Ende einer Zeichenfolge.

Parameter

Name Beschreibung Datentyp Standardwert
s   string  

Rückgabe

string

serialize(data, noUrlEncode) ab v3

Erzeugt eine URL-Abfrage aus einem Objekt.

Parameter

Name Beschreibung Datentyp Standardwert
data   object  
noUrlEncode [optional] bool false

Rückgabe

string

stringTemplate(target, options) ab v3

Erzeugt eine Template-Funktion aus einer Zeichenfolge.

Parameter

Name Beschreibung Datentyp Standardwert
target   string  
options [optional] object null

Rückgabe

function

timer(options, context) ab v3

Parameter

Name Beschreibung Datentyp Standardwert
options   object  
context   object  

Rückgabe

int

trim(s) ab v3

Entfernt am Anfang und Ende einer Zeichenfolge die Leerzeichen.

Parameter

Name Beschreibung Datentyp Standardwert
s   string  

Rückgabe

string

trimPrecision(number, digits) ab v3

Bringt einen Double-Wert auf eine bestimmte Präzision.

Parameter

Name Beschreibung Datentyp Standardwert
number   double  
digits   int  

Rückgabe

double

unserialize(str) ab v3

Erzeugt ein Objekt aus einer URL-Abfrage.

Parameter

Name Beschreibung Datentyp Standardwert
str   string  

Rückgabe

object