Attribute

The right panel allows you to add new attributes. The top half allows you to edit existing attributes, the bottom half allows you to add new attributes.

A number of components, such as neighborhoods, areas, buildings and zones, have adjustable attributes. These attributes are used:

• to provide meaningful information
• as parameters in calculations
• to provide (visual) information to distinguish themselves among peers

Attributes can be defined and redefined by a user. Some attributes are predefined by the Tygron Platform and already exist as default properties of a component. Some components can even inherit properties from other type of components, such as a Building that inherits attributes from it's referenced Function.

In general the Tygron Platform allows users to inspect, adjust and reset existing attributes of these components and define and remove new ones.

The group of components than can store attributes is called Attribute Items. The current list of Attribute Items is:

• Areas
• Buildings
• Functions and their overrides
• Indicators
• Neighborhoods
• Net loads
• Net lines
• Net functions
• Overlays
• Panels
• Terrains
• Weathers
• Zones

Note that although Globals seem to behave similarly to attributes, they are not part of any specific Attribute Item in a project. Instead they are individual components part of the project.

Attribute values

An attribute always consists of a name and a value. The name of an attribute is usually written in capital letters, and uses underscores in place of spaces. Values must be numbers (positive, negative, or decimal).

Note that not there are some restrictions for attribute names.

Some components have properties which are also reflected in attributes. Properties such as the color of the component are present both as a dedicated property and as an attribute. Changing either the property or the attribute automatically updates the other.

Attributes are unique to each component; sharing an attribute name between components does not link their values.

Attribute arrays

Main article: Attribute array

Attributes are most commonly a single value, but can also be an array of values.

Attribute values during a session

Attributes can be read during a session. Primarily, it is possible to read attributes of components using TQL. By requesting the value of an attribute of a component using TQL, the value of that attribute can be used in, for example, Excel calculations.

It is possible that, when requesting the value of an attribute of a component, that attribute does not exist for that component. In this case, the value of that attribute is deemed to be "0".

Note that this means that an attribute value of 0 can mean that the proper value of the attribute is 0, or that the attribute does not exist.

Attributes can be changed during a session via Events (e.g., AREA_SET_ATTRIBUTE) or TQL, allowing updates from Excel calculations.

Common attribute values

Some attributes may have a more exact spectrum of values which are valid. For example, the ACTIVE attribute is either 1 or a 0.

Note that these attributes can be given other values as well. The resulting behavior for calculations and functionality depending on these attributes is undefined.

ACTIVE

Applies to: Areas, Neighborhoods, Overlays, Indicators and Stakeholders

Some components may have an "active" property. When that property indicates the component is active, the "ACTIVE" attribute's value is "1". When the component is inactive, the attribute's value is "0".

COLOR

Applies to: Areas, Neighborhoods, Zones

Main article: Color

Spatial components with attributes commonly have a "COLOR" attribute, defining the color by which they are displayed.The value corresponds to the color property of that component. When that color property is changed, the attribute is changed, and vice versa.

Examples of special attribute values

URBANIZATION

Applies to: Neighborhoods

The "URBANIZATION" attribute is an indicator for the degree of urbanization. It ranges from 1 (dense urbanization) to 5 (virtually no urbanization).

NATURE_RESERVE

Applies to: Areas

The "NATURE_RESERVE" attribute indicates whether an area is a protected area of nature. This usually means the allowance for pollution and noise is lower. Areas with an "NATURE_RESERVE" attribute value of "1" are deemed protected nature. When the attribute's value is 0, the area is not necessarily deemed protected nature.

Notes

• When removing attributes which are related to properties of the component, the value of the properties will be changed as well, as though the attribute was set to "0".

How-to's

• How to add an Attribute
• How to remove an Attribute
• How to edit an Attribute
• How to import Attributes
• How to edit Attributes of multiple Items
• How to remove Attributes from multiple Items
• How to change multiple Attributes at once for Water Overlays

See also

• Overlay Key
• Global

API Endpoints

• Api session event editor address set attribute
• Api session event editor area set attribute
• Api session event editor attributeaction set attribute
• Api session event editor building set attribute
• Api session event editor chatchannel set attribute
• Api session event editor functionoverride set attribute
• Api session event editor indicator set attribute
• Api session event editor neighborhood set attribute
• Api session event editor netfunction set attribute
• Api session event editor netline set attribute
• Api session event editor netload set attribute
• Api session event editor overlay set attribute
• Api session event editor panel set attribute
• Api session event editor parametric set attribute
• Api session event editor scenario set attribute
• Api session event editor terraintype set attribute
• Api session event editor weather set attribute
• Api session event editor zoning set attribute
• Api session event editor address set attributes
• Api session event editor area set attributes
• Api session event editor attributeaction set attributes
• Api session event editor building set attributes
• Api session event editor chatchannel set attributes
• Api session event editor functionoverride set attributes
• Api session event editor indicator set attributes
• Api session event editor neighborhood set attributes
• Api session event editor netfunction set attributes
• Api session event editor netline set attributes
• Api session event editor netload set attributes
• Api session event editor overlay set attributes
• Api session event editor panel set attributes
• Api session event editor parametric set attributes
• Api session event editor scenario set attributes
• Api session event editor terraintype set attributes
• Api session event editor weather set attributes
• Api session event editor zoning set attributes
• Api session event editor address remove attribute
• Api session event editor area remove attribute
• Api session event editor attributeaction remove attribute
• Api session event editor building remove attribute
• Api session event editor chatchannel remove attribute
• Api session event editor functionoverride remove attribute
• Api session event editor indicator remove attribute
• Api session event editor neighborhood remove attribute
• Api session event editor netfunction remove attribute
• Api session event editor netline remove attribute
• Api session event editor netload remove attribute
• Api session event editor overlay remove attribute
• Api session event editor panel remove attribute
• Api session event editor parametric remove attribute
• Api session event editor scenario remove attribute
• Api session event editor terraintype remove attribute
• Api session event editor weather remove attribute
• Api session event editor zoning remove attribute