Druid-Extension/api/components/extended/data_list_api.md

druid.data_list API

at /druid/extended/data_list.lua

Functions

• init
• on_remove
• set_use_cache
• set_data
• get_data
• add
• remove
• remove_by_data
• clear
• get_index
• get_created_nodes
• get_created_components
• scroll_to_index

Fields

• scroll
• grid
• on_scroll_progress_change
• on_element_add
• on_element_remove
• top_index
• last_index
• scroll_progress

init

---

data_list:init(scroll, grid, create_function)

• Parameters:
  • scroll (druid.scroll): The Scroll instance for Data List component
  • grid (druid.grid): The StaticGrid} or @{DynamicGrid instance for Data List component
  • create_function (function): The create function callback(self, data, index, data_list). Function should return (node, [component])

on_remove

---

data_list:on_remove()

Druid System on_remove function

set_use_cache

---

data_list:set_use_cache(is_use_cache)

Set refresh function for DataList component

• Parameters:

  • is_use_cache (boolean): Use cache version of DataList. Requires make setup of components in on_element_add callback and clean in on_element_remove

• Returns:

  • Current (druid.data_list): DataList instance

set_data

---

data_list:set_data(data)

Set new data set for DataList component

• Parameters:

  • data (table): The new data array

• Returns:

  • Current (druid.data_list): DataList instance

get_data

---

data_list:get_data()

Return current data from DataList component

• Returns:
  • The (table): current data array

add

---

data_list:add(data, [index], [shift_policy])

Add element to DataList. Currenly untested

• Parameters:
  • data (table):
  • [index] (number|nil):
  • [shift_policy] (number|nil): The constant from const.SHIFT.*

remove

---

data_list:remove([index], [shift_policy])

Remove element from DataList. Currenly untested

• Parameters:
  • [index] (number|nil):
  • [shift_policy] (number|nil): The constant from const.SHIFT.*

remove_by_data

---

data_list:remove_by_data(data, [shift_policy])

Remove element from DataList by data value. Currenly untested

• Parameters:
  • data (table):
  • [shift_policy] (number|nil): The constant from const.SHIFT.*

clear

---

data_list:clear()

Clear the DataList and refresh visuals

get_index

---

data_list:get_index(data)

Return index for data value

• Parameters:

  • data (table):

• Returns:

  • `` (unknown|nil):

get_created_nodes

---

data_list:get_created_nodes()

Return all currenly created nodes in DataList

• Returns:
  • List (node[]): of created nodes

get_created_components

---

data_list:get_created_components()

Return all currenly created components in DataList

• Returns:
  • List (druid.component[]): of created nodes

scroll_to_index

---

data_list:scroll_to_index(index)

Instant scroll to element with passed index

• Parameters:
  • index (number):

Fields

• scroll (druid.scroll)

• grid (druid.grid)

• on_scroll_progress_change (event)

• on_element_add (event)

• on_element_remove (event)

• top_index (number)

• last_index (number)

• scroll_progress (number)