Expanding available examples for beginners to reference

[KullinElliott]

What is the best way to submit examples to the project? The current documentation on "dearpygui.readthedocs.io" still has openings for more examples to help someone new trying to start their own projects.

Having built our companies data collection app using Qt, I have to say that I prefer using DearPyGui now. The plotting utilities alone have features I only dreamed of having in Qt.

However, several times I have run into the issue where I couldn't find a good example to help me solve my next problem.

For example, I was trying to figure out how return a list of a tables header values. After reading deep into the documentation I was able to piece something together after an hour.

I would like to know where I can submit examples for review for later being added to the projects documentation. The goal being to help new users become more comfortable building their projects using dpg.

[KullinElliott]

Here is are three examples in one script for returning some table element values using a button. Since I had to spend more time figuring out how to do this than I should had, I figured why not try to add this to the main documentation so that others can spend less time trying to do something similar in the future.

---

import dearpygui.dearpygui as dpg

dpg.create_context()

def _list_table_headers(sender, app_data, user_data):
print(f"sender: {sender}, \t app_data: {app_data}, \t user_data: {user_data}")
# Return the list of unique column ID values for the parent table that is passed using 'user_data'
cols = dpg.get_item_children(user_data, 0)
# Return the list of unique row ID values for the parent table that is passed using 'user_data'
rows = dpg.get_item_children(user_data, 1)
print("Column ID(s): {}".format(cols))
print("Row ID(s) : {}".format(rows))

header_list = []
for col in cols:
    header_configuration = dpg.get_item_configuration(col)
    print("    Header Configuration: {}".format(header_configuration))
    header_label = header_configuration['label']
    print("    Labels: {}".format(header_label))
    header_list.append(header_label)
print('  Header Labels: {}'.format(header_list))

def _list_table_rows(sender, app_data, user_data):
print(f"sender: {sender}, \t app_data: {app_data}, \t user_data: {user_data}")
rows = dpg.get_item_children(user_data, 1)
print("Row ID(s) : {}".format(rows))

index_list = []
for row in rows:
    row_configuration = dpg.get_item_configuration(row)
    print("    Row Configuration: {}".format(row_configuration))
    row_label = row_configuration['label']
    print("    Labels: {}".format(row_label))
    index_list.append(row_label)
print('  Row Labels: {}'.format(index_list))
print('  Row indexes do not normally have labels. These labels can be set but do not display.')

def _list_table_cells(sender, app_data, user_data):
print(f"sender: {sender}, \t app_data: {app_data}, \t user_data: {user_data}")
cols = dpg.get_item_children(user_data, 0)
rows = dpg.get_item_children(user_data, 1)
print("Column ID(s): {}".format(cols))
print("Row ID(s) : {}".format(rows))

cell_value_list = []
cell_id_list = []
# Column value starts at 0 to return element in list
for col in range(len(cols)):
    for row in rows:  # Row uses the row ID
        # Row requires ID with column list element value
        cell_id = dpg.get_item_children(row, 1)[col]
        # Return the value inside the corresponding cell id
        cell_value = dpg.get_value(cell_id)

        cell_id_list.append(cell_id)
        cell_value_list.append(cell_value)
        print('    [ Cell ID, Value ] = [ {}, {} ]'.format(cell_id, cell_value))
print("  List of cell IDs   : {}".format(cell_id_list))
print("  List of cell labels: {}".format(cell_value_list))

with dpg.window(label="Tutorial"):
dpg.add_button(label="List Table Header Labels", callback=_list_table_headers, user_data='__table_1')
dpg.add_button(label="List Table Row Labels", callback=_list_table_rows, user_data='__table_1')
dpg.add_button(label="List Table Cell Labels", callback=_list_table_cells, user_data='__table_1')

with dpg.table(header_row=True, width=400, height=300, tag='__table_1'):

    # use add_table_column to add columns to the table,
    # table columns use child slot 0
    dpg.add_table_column(label='Header 1')
    dpg.add_table_column(label='Header 2')
    dpg.add_table_column(label='Header 3')

    # add_table_next_column will jump to the next row
    # once it reaches the end of the columns
    # table next column use slot 1
    for i in range(0, 4):
        with dpg.table_row():
            for j in range(0, 3):
                dpg.add_text(f"Row{i} Column{j}")

dpg.create_viewport(title='Custom Title', width=800, height=600)
dpg.setup_dearpygui()
dpg.show_viewport()
dpg.start_dearpygui()
dpg.destroy_context()