Class Filaments

Hierarchy (View Summary)

Sources
- Filaments

Index

Constructors

Properties

base colour length sources

Methods

addSource setLength setLengthMinMax

Constructors

constructor

new Filaments(): Filaments
Creates an instance of Filaments.

Returns Filaments
Overrides Sources.constructor
- Defined in Androecium/Filaments/index.ts:49

Properties

base

base: baseFilaments

Base of filaments

colour

colour:
    | "pinkish"
    | "yellowish"
    | "whitenish"
    | "creamish"
    | "lilac"
    | "redish"
    | "purplish"
    | (
        | "pinkish"
        | "yellowish"
        | "whitenish"
        | "creamish"
        | "lilac"
        | "redish"
        | "purplish"
    )[]

Colour of filaments.

length

length: { max?: number; min?: number; value?: number }

Filaments length in milimeters (mm).

sources

sources: Source[]

Source.

Methods

addSource

addSource(data: Source): void
Parameters
- data: Source
Returns void
Inherited from Sources.addSource
- Defined in Sources.ts:13

setLength

setLength(value: number): void
Sets a single value for length.
Parameters
- value: number
  The length value in milimeters (mm).
Returns void
Throws
Error if present is false and value is not null.
- Defined in Androecium/Filaments/index.ts:71

setLengthMinMax

setLengthMinMax(min: number, max: number): void
Sets the length values, considering the value of present.
Parameters
- min: number
  The minimum length value in milimeters (mm).
- max: number
  The maximum length value in milimeters (mm).
Returns void
Throws
Error if present is false and either min or max is not null.

Throws
Error if min is greater than or equal to max.
- Defined in Androecium/Filaments/index.ts:61