Skip to content

Attribute

This page contains hakowan.grammar.scale.attribute.Attribute class specification.

AttributeLike: TypeAlias = str | Attribute module-attribute

Type alias for a attribute-like objects.

  • A string object will be converted to an attribute with the name set to the string.
  • An attribute object will be unchanged.

Attribute dataclass

An attribute represents a scalar or vector field that is defined on the 3D geometry.

An attribute is the 3D equivalent of a column in a table. Each attribute is uniquely identified by the attribute name, which must exists in the data frame, and optionally associated with a scale.

Attributes:

Name Type Description
name str

The name of the attribute as it is defined in the data frame.
scale ScaleLike | None

The scale to be applied to the attribute. None means no scale is used.
Note

The attribute object can be constructed with hakowan.attribute() function, which is an alias of the constructor of this class.

Source code in hakowan/grammar/scale/attribute.py 
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
@dataclass(slots=True)
class Attribute:
    """An attribute represents a scalar or vector field that is defined on the 3D geometry.

    An attribute is the 3D equivalent of a column in a table. Each attribute is uniquely identified
    by the attribute name, which must exists in the data frame, and optionally associated with a scale.

    Attributes:
        name: The name of the attribute as it is defined in the data frame.
        scale: The scale to be applied to the attribute. `None` means no scale is used.

    Note:
        The attribute object can be constructed with `hakowan.attribute()` function, which is an
        alias of the constructor of this class.
    """

    name: str
    scale: ScaleLike | None = None

    # (internal) The name of the attribute with scale applied.
    _internal_name: str | None = None

    # (internal) The name of the attribute representing the color field mapped from the scaled attribute.
    _internal_color_field: str | None = None