xpressinsight.Series.init

Purpose

Initializes Series.

Synopsis

xpressinsight.Series.__init__(self, index: str | List[str] | NoneType = None, dtype: Type[BasicType] = None, 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, entity_name: str = None, series_name: str = None, index_types: List[Type[BasicType]] = None)

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. When used in an AppConfig-decorated class, this is required and the same index may appear in the list multiple times. When used in a ScenarioData-decorated class, this is optional if given, the names must be unique and there must be one for each index column. If not specified, names derived from the index entities in the source scenario will be used.
index	The name of the index to use, or list of names for multiple indices. Where entity is used in an app definition, 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.
entity_name	The entity name. If not given, the name of the class attribute will be used instead. Only valid for entities in a ScenarioData-decorated class.
series_name	The name to use for the values in the resultant series. If not given, the entity name will be used. Only valid for entities in a ScenarioData-decorated class.
index_types	The types of the columns to use for the index(es) in the resultant series. Only valid for entities in an ScenarioData-decorated class, where it is optional.

Further information

1. The method __init__ is part of the class xpressinsight.Series.

2. 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 index, dtype and alias.

Contents

Index

Glossary

Search Results

xpressinsight.Series.init