Enumeration UITabBarStyleFlag

Static ReadonlyClosable

Static ReadonlyExpandSingleTabToFullWidth

Static ReadonlyExpandSingleTabToFullWidthAndPin

Static ReadonlyNone

Static ReadonlyNoSelectionPossible

Static ReadonlyPinSingleTab

Static ReadonlyVerticalTabButtons

Static ReadonlyWithAddButton

StaticaddFlag

• addFlag<T, K>(value, bits): K

• Adds the flag bits to the enum value.

  Type Parameters

  • T
  • K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">

  Parameters

  • value: K
  • bits: EnumValueTyped<T, number>

  Returns K

StaticcombineFlags

• combineFlags<T>(values): EnumValueTyped<T, number>

• Takes an array of enum values and combines them as a single enum flag value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.

  Type Parameters

  • T extends Enum

  Parameters

  • values: EnumValue<T, number>[] | EnumValueTyped<T, number>[]

    The array of values to be combined using bitwise-or operator.

  Returns EnumValueTyped<T, number>

  The combined enum value.

StaticgetEnumName

• getEnumName<T>(index): string

• Type Parameters

  • T

  Parameters

  • index: EnumValue<T, number>

  Returns string

  Obsolete

  Compatibility

StaticgetEnumNames

• getEnumNames(): string[]

• Returns string[]

  Obsolete

  Compatibility

StaticgetEnumValue

• getEnumValue(index): number

• Parameters

  • index: number

  Returns number

  Obsolete

  Compatibility

StaticgetEnumValues

• getEnumValues(): number[]

• Returns number[]

  Obsolete

  Compatibility

StaticgetNameForValue

• getNameForValue<T>(enumValue): string

• Gets the name for the enumeration value that matches the specified enumValue.

  Type Parameters

  • T

  Parameters

  • enumValue: number | BrandedType<number, "enum"> | BrandedType<T, "enum">

    The enumeration value.

  Returns string

  The enumeration value or undefined if not found.

StaticgetNames

• getNames(): string[]

• Gets the enumeration names

  Returns string[]

  The enumeration names.

StaticgetValueAtIndex

• getValueAtIndex<T>(index): EnumValueTyped<T, number>

• Gets the enumeration value at the specified index.

  Type Parameters

  • T = number

  Parameters

  • index: number

    The index.

  Returns EnumValueTyped<T, number>

  The enumeration value or undefined if not found.

StaticgetValues

• getValues<T>(): EnumValueTyped<T, number>[]

• Gets the enumeration values

  Type Parameters

  • T = any

  Returns EnumValueTyped<T, number>[]

  The enumeration values.

StatichasFlag

• hasFlag<T, K>(value, bits): boolean

• Determines if the enum value has the flags set.

  Type Parameters

  • T
  • K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">

  Parameters

  • value: K
  • bits: EnumValueTyped<T, number>

  Returns boolean

StatichasFlagChanged

• hasFlagChanged<T, K>(previousValue, newValue, bits): boolean

• Determines if the enum bits were changed from previousValue to currentValue.

  Type Parameters

  • T
  • K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">

  Parameters

  • previousValue: K
  • newValue: K
  • bits: EnumValueTyped<T, number>

  Returns boolean

StaticiterateNames

• iterateNames(): Generator<string, any, any>

• Iterates the enumeration names

  Returns Generator<string, any, any>

  The enumeration names.

StaticiterateValues

• iterateValues<T>(): Generator<EnumValueTyped<T, number>, any, any>

• Iterates the enumeration values

  Type Parameters

  • T = any

  Returns Generator<EnumValueTyped<T, number>, any, any>

  The enumeration values.

StaticremoveFlag

• removeFlag<T, K>(value, bits): K

• Removes the flag bits from the enum value.

  Type Parameters

  • T
  • K = number | BrandedType<number, "enum"> | BrandedType<T, "enum">

  Parameters

  • value: K
  • bits: EnumValueTyped<T, number>

  Returns K

StaticsplitFlags

• splitFlags<T>(value): EnumValueTyped<T, number>[]

• Takes a single enum value and splits it into separated flag values set on the value. This assumes that the target enum is a flag enum that can have their values combined using bitwise operators.

  Type Parameters

  • T extends Enum

  Parameters

  • value: number | BrandedType<number, "enum"> | BrandedType<T, "enum">

    The enum value to have it's value split using bitwise-and operator.

  Returns EnumValueTyped<T, number>[]

  An array of each "bit flag" set in the enum.