setType()

Signature:

set_parameter_type(
    value: Union[hec.ParameterType, str],
    in_place: bool = False
) -> TimeSeries

Detailed Documentation

The hec-python-library equivalent of Jython method setType():

If in_place=True, the instance itself is modified. In this case the returned value (which can be ignored in python) is the modified instance, which can be used in chaining methods.

Notes: The direct equivalent requires using in_place=True or iset_parameter_type().

Example:

ts2 = ts1.set_parameter_type("Inst")

---

Signature:

iset_parameter_type(
    value: Union[hec.ParameterType, str],
) -> TimeSeries

Convenience method for callint set_parameter_type(...) with in_place=True.

Example:

ts1.iset_parameter_type("Inst")