ParameterMap Extends
A map of analytics.Parameter to analytics.Value. Individual parameters are identified by name (the query parameter name). Two different instances of Parameter with the same .name are treated as identical independent of all other attributes in the analytics.Parameter typedef.

As of this writing multiple values per parameter are not supported, though this aspect of GA tracking behavior needs to be verified. So this aspect of the API as well as the associated types are subject to change.

Inheritance

Constructor

analytics.ParameterMap(var_args)

Parameters

var_args : ...analytics.Parameter | analytics.Value
An optional list of alternating key, value pairs.

Instance Methods

Defined in analytics.ParameterMap
addAll(map)
Adds all elements from map.
Arguments:
map : !analytics.ParameterMap
No description.
clone() ⇒ !analytics.ParameterMap
Create a copy of *this*.
Returns: !analytics.ParameterMap  No description.
contains(parameters) ⇒ boolean
Returns true if this instance contains all entries in parameters.
Arguments:
parameters : !analytics.ParameterMap
No description.
Returns: boolean  True if this instance contains all entries in parameters.
equals(that) ⇒ boolean
Returns true if this instance contains exactly the same entries as that.
Arguments:
that : !analytics.ParameterMap
No description.
Returns: boolean  True if this instance contains exactly the same entries as that.
forEachEntry(receiver)
Apply receiver to each analytics.ParameterMap.Entry having been previously set in the map.
Arguments:
receiver : !function(!analytics.Parameter, !analytics.Value)
No description.
get(param) ⇒ ?analytics.Value
Returns the current value associated with the key, or null if it hasn't been set. Does not return the default value if the *same* value has not been previously set, explicitly, by the caller.
Arguments:
param : !analytics.Parameter
No description.
Returns: ?analytics.Value  The value or null if not previously set.
hasParameter(parameter) ⇒ boolean
Returns true if this instance contains key.
Arguments:
parameter : !analytics.Parameter
No description.
Returns: boolean  True if this instance has an entry for the specified parameter.
remove(param)
Removes the entry associated w/ key, if any.
Arguments:
param : !analytics.Parameter
No description.
set(param, value)
Sets the value associated with the parameter replacing any existing value.
Arguments:
param : !analytics.Parameter
No description.
value : analytics.Value
No description.
toObject() ⇒ !Object.<string, analytics.Value>
Returns an object representation of the parameter map. Callers are free to manipulate the returned object.
Returns: !Object.<string, analytics.Value>  No description.
toString()
No description.

Package ParameterMap

Package Reference