Class Lists

Hierarchy

Lists

Index

Constructors

constructor

Constructors

constructor

new Lists(): Lists

Returns Lists

Methods

addItem

addItem<T>(inputs: AddItemDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31346
Add item to the end of the list

group

add

shortname

add item to list

drawable

false

Type parameters
- T
Parameters
- inputs: AddItemDto<T>
  
  a list and an item
Returns T[]

list with added item

addItemAtIndex

addItemAtIndex<T>(inputs: AddItemAtIndexDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31256
Add item to the list

group

add

shortname

add item

drawable

false

Type parameters
- T
Parameters
- inputs: AddItemAtIndexDto<T>
  
  a list, item and an index
Returns T[]

list with added item

addItemAtIndexes

addItemAtIndexes<T>(inputs: AddItemAtIndexesDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31265
Adds item to the list of provided indexes

group

add

shortname

add item at indexes

drawable

false

Type parameters
- T
Parameters
- inputs: AddItemAtIndexesDto<T>
  
  a list, item and an indexes
Returns T[]

list with added item

addItemFirstLast

addItemFirstLast<T>(inputs: AddItemFirstLastDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31364
Add item to the beginning or the end of the list

group

add

shortname

item at first or last

drawable

false

Type parameters
- T
Parameters
- inputs: AddItemFirstLastDto<T>
  
  a list, item and an option for first or last position
Returns T[]

list with added item

addItemsAtIndexes

addItemsAtIndexes<T>(inputs: AddItemsAtIndexesDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31274
Adds items to the list of provided indexes matching 1:1, first item will go to first index provided, etc.

group

add

shortname

add items

drawable

false

Type parameters
- T
Parameters
- inputs: AddItemsAtIndexesDto<T>
  
  a list, items and an indexes
Returns T[]

list with added items

createEmptyList

createEmptyList(): []

- Defined in bitbybit-docs.d.ts:31372
Creates an empty list

group

create

shortname

empty list

drawable

false

Returns []

an empty array list

flipLists

flipLists<T>(inputs: ListCloneDto<T[]>): T[][]

- Defined in bitbybit-docs.d.ts:31220
Flip 2d lists - every nth element of each list will form a separate list

group

edit

shortname

flip lists

drawable

false

Type parameters
- T
Parameters
- inputs: ListCloneDto<T[]>
  
  a list of lists to flip
Returns T[][]

item

getByPattern

getByPattern<T>(inputs: GetByPatternDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31184
Gets elements by pattern

group

get

shortname

by pattern

drawable

false

Type parameters
- T
Parameters
- inputs: GetByPatternDto<T>
  
  a list and index
Returns T[]

list with filtered items

getItem

getItem<T>(inputs: ListItemDto<T>): T

- Defined in bitbybit-docs.d.ts:31148
Gets an item from the list by using a 0 based index

group

get

shortname

item by index

drawable

false

Type parameters
- T
Parameters
- inputs: ListItemDto<T>
  
  a list and an index
Returns T

item

getListDepth

getListDepth(inputs: ListCloneDto<[]>): number

- Defined in bitbybit-docs.d.ts:31238
Get the depth of the list

group

get

shortname

max list depth

drawable

false

Parameters
- inputs: ListCloneDto<[]>
  
  a list
Returns number

number of depth

getLongestListLength

getLongestListLength<T>(inputs: GetLongestListLength<T[]>): number

- Defined in bitbybit-docs.d.ts:31202
Gets the longest list length from the list of lists

group

get

shortname

longest list length

drawable

false

Type parameters
- T
Parameters
- inputs: GetLongestListLength<T[]>
  
  a list of lists
Returns number

number of max length

getNthItem

getNthItem<T>(inputs: GetNthItemDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31175
Gets nth item in the list

group

get

shortname

every n-th

drawable

false

Type parameters
- T
Parameters
- inputs: GetNthItemDto<T>
  
  a list and index
Returns T[]

list with filtered items

getSubList

getSubList<T>(inputs: SubListDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31166
Gets a sub list between start and end indexes

group

get

shortname

sublist

drawable

false

Type parameters
- T
Parameters
- inputs: SubListDto<T>
  
  a list and start and end indexes
Returns T[]

sub list

groupNth

groupNth<T>(inputs: GroupListDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31229
Group in lists of n elements

group

edit

shortname

group elements

drawable

false

Type parameters
- T
Parameters
- inputs: GroupListDto<T>
  
  a list
Returns T[]

items grouped in lists of n elements

listLength

listLength<T>(inputs: ListCloneDto<T>): number

- Defined in bitbybit-docs.d.ts:31247
Gets the length of the list

group

get

shortname

list length

drawable

false

Type parameters
- T
Parameters
- inputs: ListCloneDto<T>
  
  a length list
Returns number

a number

mergeElementsOfLists

mergeElementsOfLists<T>(inputs: MergeElementsOfLists<T[]>): T[]

- Defined in bitbybit-docs.d.ts:31193
Merge elements of lists on a given level and flatten output if needed

group

get

shortname

merge levels

drawable

false

Type parameters
- T
Parameters
- inputs: MergeElementsOfLists<T[]>
  
  lists, level and flatten data
Returns T[]

list with merged lists and flattened lists

prependItem

prependItem<T>(inputs: AddItemDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31355
Add item to the beginning of the list

group

add

shortname

prepend item to list

drawable

false

Type parameters
- T
Parameters
- inputs: AddItemDto<T>
  
  a list and an item
Returns T[]

list with added item

randomGetThreshold

randomGetThreshold<T>(inputs: RandomThresholdDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31157
Gets items randomly by using a threshold

group

get

shortname

random get threshold

drawable

false

Type parameters
- T
Parameters
- inputs: RandomThresholdDto<T>
  
  a list and a threshold for randomization of items to remove
Returns T[]

list with remaining items

randomRemoveThreshold

randomRemoveThreshold<T>(inputs: RandomThresholdDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31319
Removes items randomly by using a threshold

group

remove

shortname

random remove threshold

drawable

false

Type parameters
- T
Parameters
- inputs: RandomThresholdDto<T>
  
  a list and a threshold for randomization of items to remove
Returns T[]

list with removed items

removeAllItems

removeAllItems<T>(inputs: ListDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31301
Remove all items from the list

group

remove

shortname

remove all items

drawable

false

Type parameters
- T
Parameters
- inputs: ListDto<T>
  
  a list
Returns T[]

The length is set to 0 and same array memory object is returned

removeDuplicateNumbers

removeDuplicateNumbers(inputs: RemoveDuplicatesDto<number>): number[]

- Defined in bitbybit-docs.d.ts:31328
remove duplicate numbers from the list

group

remove

shortname

remove duplicates

drawable

false

Parameters
- inputs: RemoveDuplicatesDto<number>
  
  a list of numbers
Returns number[]

list with unique numbers

removeDuplicateNumbersTolerance

removeDuplicateNumbersTolerance(inputs: RemoveDuplicatesToleranceDto<number>): number[]

- Defined in bitbybit-docs.d.ts:31337
remove duplicate numbers from the list with tolerance

group

remove

shortname

remove duplicates tol

drawable

false

Parameters
- inputs: RemoveDuplicatesToleranceDto<number>
  
  a list of numbers and the tolerance
Returns number[]

list with unique numbers

removeItemAtIndex

removeItemAtIndex<T>(inputs: RemoveItemAtIndexDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31283
Remove item from the list

group

remove

shortname

remove item

drawable

false

Type parameters
- T
Parameters
- inputs: RemoveItemAtIndexDto<T>
  
  a list and index
Returns T[]

list with removed item

removeItemsAtIndexes

removeItemsAtIndexes<T>(inputs: RemoveItemsAtIndexesDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31292
Remove items from the list of provided indexes

group

remove

shortname

remove items

drawable

false

Type parameters
- T
Parameters
- inputs: RemoveItemsAtIndexesDto<T>
  
  a list and indexes
Returns T[]

list with removed items

removeNthItem

removeNthItem<T>(inputs: RemoveNthItemDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31310
Remove item from the list

group

remove

shortname

every n-th

drawable

false

Type parameters
- T
Parameters
- inputs: RemoveNthItemDto<T>
  
  a list and index
Returns T[]

list with removed item

repeat

repeat<T>(inputs: MultiplyItemDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31381
Repeat the item and add it in the new list

group

create

shortname

repeat

drawable

false

Type parameters
- T
Parameters
- inputs: MultiplyItemDto<T>
  
  an item to multiply
Returns T[]

list

repeatInPattern

repeatInPattern<T>(inputs: RepeatInPatternDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31390
Repeat the list items by adding them in the new list till the certain length of the list is reached

group

create

shortname

repeat in pattern

drawable

false

Type parameters
- T
Parameters
- inputs: RepeatInPatternDto<T>
  
  a list to multiply and a length limit
Returns T[]

list

reverse

reverse<T>(inputs: ListCloneDto<T>): T[]

- Defined in bitbybit-docs.d.ts:31211
Reverse the list

group

edit

shortname

reverse

drawable

false

Type parameters
- T
Parameters
- inputs: ListCloneDto<T>
  
  a list and an index
Returns T[]

item

sortByPropValue

sortByPropValue(inputs: SortJsonDto<any>): any[]

- Defined in bitbybit-docs.d.ts:31417
Sort by numeric JSON property value

group

sorting

shortname

sort json objects

drawable

false

Parameters
- inputs: SortJsonDto<any>
  
  a list to sort, a property to sort by and an option for ascending or descending order
Returns any[]

list

sortNumber

sortNumber(inputs: SortDto<number>): number[]

- Defined in bitbybit-docs.d.ts:31399
Sort the list of numbers in ascending or descending order

group

sorting

shortname

sort numbers

drawable

false

Parameters
- inputs: SortDto<number>
  
  a list of numbers to sort and an option for ascending or descending order
Returns number[]

list

sortTexts

sortTexts(inputs: SortDto<string>): string[]

- Defined in bitbybit-docs.d.ts:31408
Sort the list of texts in ascending or descending order alphabetically

group

sorting

shortname

sort texts

drawable

false

Parameters
- inputs: SortDto<string>
  
  a list of texts to sort and an option for ascending or descending order
Returns string[]

list

Generated using TypeDoc