VectorValue

Added in version 1.6.

class VectorValue(**kwargs)

A mutable value used in the vector style specification.

Constructors

class VectorValue

classmethod new() → VectorValue

Creates a new VectorValue with a null value.

Added in version 1.6.

classmethod new_boolean(boolean: bool) → VectorValue

Creates a new VectorValue with a boolean value.

Added in version 1.6.

Parameters:

boolean – a boolean value

classmethod new_color(color: RGBA) → VectorValue

Creates a new VectorValue with a color value.

Added in version 1.6.

Parameters:

color – a RGBA

classmethod new_from_value(value: Value) → VectorValue

Creates a new VectorValue from a Value.

Added in version 1.6.

Parameters:

value – a Value

classmethod new_number(number: float) → VectorValue

Creates a new VectorValue with a number value.

Added in version 1.6.

Parameters:

number – a number value

classmethod new_string(string: str) → VectorValue

Creates a new VectorValue with a string value.

Added in version 1.6.

Parameters:

string – a string value

Methods

class VectorValue

array_append(element: VectorValue) → None

Appends element to the array value of self. The value of element is copied.

Added in version 1.6.

Parameters:

element – a VectorValue to append to the array

dup() → VectorValue

Creates a duplicate of self.

Added in version 1.6.

equal(b: VectorValue) → bool

Compares two VectorValues for equality.

Added in version 1.6.

Parameters:

b – a VectorValue

free() → None

Frees a VectorValue.

Added in version 1.6.

get_boolean() → tuple[bool, bool]

Gets the boolean value of self.

Added in version 1.6.

get_color() → tuple[bool, RGBA]

Gets the color value of self.

If self is a string value, it will attempt to parse the string as a color.

Added in version 1.6.

get_number() → tuple[bool, float]

Gets the number value of self.

Added in version 1.6.

get_string() → tuple[bool, str | None]

Gets the string value of self.

Added in version 1.6.

get_value_type() → VectorValueType

Gets the type of value stored in self.

Added in version 1.6.

hash() → int

Calculates a hash value for self.

Added in version 1.6.

is_null() → bool

Checks if self is a null value.

Added in version 1.6.

set_boolean(boolean: bool) → None

Sets self to a boolean value.

Added in version 1.6.

Parameters:

boolean – a boolean value

set_color(color: RGBA) → None

Sets self to a color value.

Added in version 1.6.

Parameters:

color – a RGBA

set_number(number: float) → None

Sets self to a number value.

Added in version 1.6.

Parameters:

number – a number value

set_string(string: str) → None

Sets self to a string value.

Added in version 1.6.

Parameters:

string – a string value

start_array() → None

Sets self to an empty array value.

Added in version 1.6.

unset() → None

Sets self to a null value.

Added in version 1.6.