Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Variable

A variable is a placeholder for prefixes, suffixes and similar and is only used in the context of the FlexibleUnit. Under the hood it's similar to an array. To get a better understanding of variables read the Flexible Unit's documentation first.

see

FlexibleUnit

Hierarchy

  • Variable

Index

Constructors

Properties

Methods

Constructors

constructor

  • Creates a new variable.

    Parameters

    • values: Value[]

      the different values the variable can take

    • isOptional: boolean = true

      whether the variable should be optional

    Returns Variable

Properties

isOptional

isOptional: boolean = false

whether the variable is optional

Methods

add

combine

copy

  • Creates a deep copy of this variable.

    Parameters

    • Optional isOptional: boolean

      whether the copy should be optional

    Returns Variable

    a deep copy of this variable

divide

filteredCopy

  • filteredCopy(selection: string[], isOptional?: boolean): Variable

multiply

pow

subcopy

  • subcopy(startPoint: string, endPoint?: string, isOptional?: boolean): Variable

  • Creates a deep copy of this variable starting inclusively from the Value having the first argument as short property and ending inclusively at the Value having the second argument as short property.

    Parameters

    • startPoint: string
    • Optional endPoint: string
    • Optional isOptional: boolean

      whether the subcopy should be optional

    Returns Variable

    a subcopy of this variable

subtract

Generated using TypeDoc