xpressinsight.types.Series

Purpose

Creates an annotation for a Series entity in an app, a declaration of a pandas Series datastructure. Every series must have at least one index.

Synopsis

xpressinsight.types.Series(index: Union[str, List[str]], dtype: Type[BasicType], alias: str = '', format: str = '', hidden: Hidden = Hidden.FALSE, manage: Manage = Manage.INPUT, read_only: bool = False, transform_labels_entity: str = '', update_after_execution: bool = False, *, update_keep_result_data: bool = False, update_progress: bool = False) -> Type[pandas.Series]

Arguments

index	The name of the index to use, or list of names for multiple indices. Each entry must be the name of an Index or PolarsIndex type entity within the app. The same index may appear in the list multiple times.
dtype	The data type.
alias	Used to provide an alternative name for an entity in the UI. The value is used in place of the entity name where appropriate in the UI.
format	The formatting string used for displaying numeric values.
hidden	Indicates whether the UI should hide the entity where appropriate.
manage	How and whether Insight handles an entity. Defines how the system manages the entity data.
read_only	Whether an entity is readonly. Specifies that the value(s) of the entity cannot be modified. See also hidden.
transform_labels_entity	The name of an entity in the schema from which to read labels for values of this entity. The type of the index set of the labels entity must match the data type of this entity. The data type of the labels entity can be any primitive type.
update_after_execution	Whether the value of the entity in the scenario is updated with the value of the corresponding model entity at the end of the scenario execution. If True the value of the entity is updated to correspond with the model entity after execution.
update_keep_result_data	Whether to retain result data when this input entity is updated outside a scenario execution (e.g. in a view or a REST API call). If False, the result data may be deleted when a view or REST API request updates this entity, depending on the configuration of AppConfig.result_data. If True, the result data will not be deleted when this entity is updated.
update_progress	Whether the value of the entity in the scenario is sent on progress updates. If True the value of the entity will be written back to the Insight repository when insight.send_progress_update is called from an execution mode where the send_progress attribute is True.

Example

Example of creating a Result series containing floating-point values, and is managed by Insight as a result entity. It is indexed by Indices, which must have been declared previously.

>>> Indices: xi.types.Index(...) # previous declaration
... Result: xi.types.Series(index=['Indices'], dtype=xi.real,
...                   manage=xi.Manage.RESULT, alias='Result Array')

Further information

1. The function Series is part of the package xpressinsight.types.

2. This function returns an Annotated type containing the Series entity object; for example, if xpressinsight has been imported as xi, then xi.types.Series(index='idx', dtype=xi.integer) is equivalent to Annotated[pandas.Series, xi.Series(index='idx', dtype=xi.integer)].

3. Parameters before update_progress can be specified positionally for reasons of backwards compatibility, but it's recommended that you always use named arguments if you're specifying parameters other than dtype and alias.

Contents

Index

Glossary

Search Results

xpressinsight.types.Series