diff --git a/dearpygui/_dearpygui.pyi b/dearpygui/_dearpygui.pyi index 456a4b845..5cb6a66d2 100644 --- a/dearpygui/_dearpygui.pyi +++ b/dearpygui/_dearpygui.pyi @@ -1,4 +1,4 @@ -from typing import List, Any, Callable, Union, Tuple +from typing import List, Any, Callable, Union, Tuple, Optional from dearpygui._dearpygui import * ########################################################## @@ -6,11 +6,11 @@ from dearpygui._dearpygui import * ########################################################## # ~ Dear PyGui Version: master -def add_2d_histogram_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', xbins: int ='', ybins: int ='', xmin_range: float ='', xmax_range: float ='', ymin_range: float ='', ymax_range: float ='', density: bool ='', outliers: bool ='', col_major: bool ='') -> Union[int, str]: +def add_2d_histogram_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', xbins: int ='', ybins: int ='', xmin_range: float ='', xmax_range: float ='', ymin_range: float ='', ymax_range: float ='', density: bool ='', outliers: bool ='', col_major: bool ='') -> Union[int, str]: """Adds a 2d histogram series.""" ... -def add_3d_slider(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[float], Tuple[float, ...]] ='', max_x: float ='', max_y: float ='', max_z: float ='', min_x: float ='', min_y: float ='', min_z: float ='', scale: float ='') -> Union[int, str]: +def add_3d_slider(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[float], Tuple[float, ...]] ='', max_x: float ='', max_y: float ='', max_z: float ='', min_x: float ='', min_y: float ='', min_z: float ='', scale: float ='') -> Union[int, str]: """Adds a 3D box slider.""" ... @@ -18,612 +18,612 @@ def add_alias(alias : str, item : Union[int, str]) -> None: """Adds an alias.""" ... -def add_area_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', fill: Union[List[int], Tuple[int, ...]] ='', contribute_to_bounds: bool ='') -> Union[int, str]: +def add_area_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', fill: Union[List[int], Tuple[int, ...]] ='', contribute_to_bounds: bool ='') -> Union[int, str]: """Adds an area series to a plot.""" ... -def add_axis_tag(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', default_value: float ='', color: Union[List[int], Tuple[int, ...]] ='', auto_rounding: bool ='') -> Union[int, str]: +def add_axis_tag(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', default_value: float ='', color: Union[List[int], Tuple[int, ...]] ='', auto_rounding: bool ='') -> Union[int, str]: """Adds custom labels to axes.""" ... -def add_bar_group_series(values : Union[List[float], Tuple[float, ...]], label_ids : Union[List[str], Tuple[str, ...]], group_size : int, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', group_width: float ='', shift: int ='', horizontal: bool ='', stacked: bool ='') -> Union[int, str]: +def add_bar_group_series(values : Union[List[float], Tuple[float, ...]], label_ids : Union[List[str], Tuple[str, ...]], group_size : int, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', group_width: float ='', shift: int ='', horizontal: bool ='', stacked: bool ='') -> Union[int, str]: """Adds a bar groups series to a plot.""" ... -def add_bar_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', weight: float ='', horizontal: bool ='') -> Union[int, str]: +def add_bar_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', weight: float ='', horizontal: bool ='') -> Union[int, str]: """Adds a bar series to a plot.""" ... -def add_bool_value(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_bool_value(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a bool value.""" ... -def add_button(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', small: bool ='', arrow: bool ='', direction: int ='', repeat: bool ='') -> Union[int, str]: +def add_button(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', small: bool ='', arrow: bool ='', direction: int ='', repeat: bool ='') -> Union[int, str]: """Adds a button.""" ... -def add_candle_series(dates : Union[List[float], Tuple[float, ...]], opens : Union[List[float], Tuple[float, ...]], closes : Union[List[float], Tuple[float, ...]], lows : Union[List[float], Tuple[float, ...]], highs : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', bull_color: Union[List[int], Tuple[int, ...]] ='', bear_color: Union[List[int], Tuple[int, ...]] ='', weight: float ='', tooltip: bool ='', time_unit: int ='') -> Union[int, str]: +def add_candle_series(dates : Union[List[float], Tuple[float, ...]], opens : Union[List[float], Tuple[float, ...]], closes : Union[List[float], Tuple[float, ...]], lows : Union[List[float], Tuple[float, ...]], highs : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', bull_color: Union[List[int], Tuple[int, ...]] ='', bear_color: Union[List[int], Tuple[int, ...]] ='', weight: float ='', tooltip: bool ='', time_unit: int ='') -> Union[int, str]: """Adds a candle series to a plot.""" ... -def add_char_remap(source : int, target : int, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_char_remap(source : int, target : int, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='') -> Union[int, str]: """Remaps a character.""" ... -def add_checkbox(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: bool ='') -> Union[int, str]: +def add_checkbox(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: bool ='') -> Union[int, str]: """Adds a checkbox.""" ... -def add_child_window(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', border: bool ='', autosize_x: bool ='', autosize_y: bool ='', no_scrollbar: bool ='', horizontal_scrollbar: bool ='', menubar: bool ='', no_scroll_with_mouse: bool ='', flattened_navigation: bool ='', always_use_window_padding: bool ='', resizable_x: bool ='', resizable_y: bool ='', always_auto_resize: bool ='', frame_style: bool ='', auto_resize_x: bool ='', auto_resize_y: bool ='') -> Union[int, str]: +def add_child_window(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', border: bool ='', autosize_x: bool ='', autosize_y: bool ='', no_scrollbar: bool ='', horizontal_scrollbar: bool ='', menubar: bool ='', no_scroll_with_mouse: bool ='', flattened_navigation: bool ='', always_use_window_padding: bool ='', resizable_x: bool ='', resizable_y: bool ='', always_auto_resize: bool ='', frame_style: bool ='', auto_resize_x: bool ='', auto_resize_y: bool ='') -> Union[int, str]: """Adds an embedded child window. Will show scrollbars when items do not fit. About using auto_resize/resizable flags: size measurement for a given axis is only performed when the child window is within visible boundaries, or is just appearing and it won't update its auto-size while clipped. While not perfect, it is a better default behavior as the always-on performance gain is more valuable than the occasional 'resizing after becoming visible again' glitch. You may also use always_auto_resize to force an update even when child window is not in view. However doing so will degrade performance. Remember that combining both auto_resize_x and auto_resize_y defeats purpose of a scrolling region and is NOT recommended.""" ... -def add_clipper(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='') -> Union[int, str]: +def add_clipper(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='') -> Union[int, str]: """Helper to manually clip large list of items. Increases performance by not searching or drawing widgets outside of the clipped region.""" ... -def add_collapsing_header(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', closable: bool ='', default_open: bool ='', open_on_double_click: bool ='', open_on_arrow: bool ='', leaf: bool ='', bullet: bool ='') -> Union[int, str]: +def add_collapsing_header(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', closable: bool ='', default_open: bool ='', open_on_double_click: bool ='', open_on_arrow: bool ='', leaf: bool ='', bullet: bool ='') -> Union[int, str]: """Adds a collapsing header to add items to. Must be closed with the end command.""" ... -def add_color_button(default_value : Union[List[int], Tuple[int, ...]] ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', no_alpha: bool ='', no_border: bool ='', no_drag_drop: bool ='', alpha_preview: int ='', no_tooltip: bool ='') -> Union[int, str]: +def add_color_button(default_value : Union[List[int], Tuple[int, ...]] ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', no_alpha: bool ='', no_border: bool ='', no_drag_drop: bool ='', alpha_preview: int ='', no_tooltip: bool ='') -> Union[int, str]: """Adds a color button.""" ... -def add_color_edit(default_value : Union[List[int], Tuple[int, ...]] ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', no_alpha: bool ='', no_picker: bool ='', no_options: bool ='', no_small_preview: bool ='', no_inputs: bool ='', no_tooltip: bool ='', no_label: bool ='', no_drag_drop: bool ='', alpha_bar: bool ='', alpha_preview: int ='', display_mode: int ='', display_type: int ='', input_mode: int ='') -> Union[int, str]: +def add_color_edit(default_value : Union[List[int], Tuple[int, ...]] ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', no_alpha: bool ='', no_picker: bool ='', no_options: bool ='', no_small_preview: bool ='', no_inputs: bool ='', no_tooltip: bool ='', no_label: bool ='', no_drag_drop: bool ='', alpha_bar: bool ='', alpha_preview: int ='', display_mode: int ='', display_type: int ='', input_mode: int ='') -> Union[int, str]: """Adds an RGBA color editor. Left clicking the small color preview will provide a color picker. Click and draging the small color preview will copy the color to be applied on any other color widget.""" ... -def add_color_picker(default_value : Union[List[int], Tuple[int, ...]] ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', no_alpha: bool ='', no_side_preview: bool ='', no_small_preview: bool ='', no_inputs: bool ='', no_tooltip: bool ='', no_label: bool ='', alpha_bar: bool ='', display_rgb: bool ='', display_hsv: bool ='', display_hex: bool ='', picker_mode: int ='', alpha_preview: int ='', display_type: int ='', input_mode: int ='') -> Union[int, str]: +def add_color_picker(default_value : Union[List[int], Tuple[int, ...]] ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', no_alpha: bool ='', no_side_preview: bool ='', no_small_preview: bool ='', no_inputs: bool ='', no_tooltip: bool ='', no_label: bool ='', alpha_bar: bool ='', display_rgb: bool ='', display_hsv: bool ='', display_hex: bool ='', picker_mode: int ='', alpha_preview: int ='', display_type: int ='', input_mode: int ='') -> Union[int, str]: """Adds an RGB color picker. Right click the color picker for options. Click and drag the color preview to copy the color and drop on any other color widget to apply. Right Click allows the style of the color picker to be changed.""" ... -def add_color_value(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: Union[List[float], Tuple[float, ...]] ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_color_value(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: Union[List[float], Tuple[float, ...]] ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a color value.""" ... -def add_colormap(colors : List[Union[List[int], Tuple[int, ...]]], qualitative : bool, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_colormap(colors : List[Union[List[int], Tuple[int, ...]]], qualitative : bool, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a legend that pairs colors with normalized value 0.0->1.0. Each color will be This is typically used with a heat series. (ex. [[0, 0, 0, 255], [255, 255, 255, 255]] will be mapped to a soft transition from 0.0-1.0)""" ... -def add_colormap_button(default_value : Union[List[int], Tuple[int, ...]] ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='') -> Union[int, str]: +def add_colormap_button(default_value : Union[List[int], Tuple[int, ...]] ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='') -> Union[int, str]: """Adds a button that a color map can be bound to.""" ... -def add_colormap_registry(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='') -> Union[int, str]: +def add_colormap_registry(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='') -> Union[int, str]: """Adds a colormap registry.""" ... -def add_colormap_scale(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', colormap: Union[int, str] ='', min_scale: float ='', max_scale: float ='', format: str ='', reverse_dir: bool ='', mirror: bool ='') -> Union[int, str]: +def add_colormap_scale(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', colormap: Union[int, str] ='', min_scale: float ='', max_scale: float ='', format: str ='', reverse_dir: bool ='', mirror: bool ='') -> Union[int, str]: """Adds a legend that pairs values with colors. This is typically used with a heat series. """ ... -def add_colormap_slider(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='') -> Union[int, str]: +def add_colormap_slider(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='') -> Union[int, str]: """Adds a color slider that a color map can be bound to.""" ... -def add_combo(items : Union[List[str], Tuple[str, ...]] ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: str ='', popup_align_left: bool ='', no_arrow_button: bool ='', no_preview: bool ='', fit_width: bool ='', height_mode: int ='') -> Union[int, str]: +def add_combo(items : Union[List[str], Tuple[str, ...]] ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: str ='', popup_align_left: bool ='', no_arrow_button: bool ='', no_preview: bool ='', fit_width: bool ='', height_mode: int ='') -> Union[int, str]: """Adds a combo dropdown that allows a user to select a single option from a drop down window. All items will be shown as selectables on the dropdown.""" ... -def add_custom_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], channel_count : int, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', callback: Callable ='', show: bool ='', y1: Any ='', y2: Any ='', y3: Any ='', tooltip: bool ='', no_fit: bool ='') -> Union[int, str]: +def add_custom_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], channel_count : int, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', y1: Any ='', y2: Any ='', y3: Any ='', tooltip: bool ='', no_fit: bool ='') -> Union[int, str]: """Adds a custom series to a plot. New in 1.6.""" ... -def add_date_picker(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: dict ='', level: int ='') -> Union[int, str]: +def add_date_picker(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: dict ='', level: int ='') -> Union[int, str]: """Adds a date picker.""" ... -def add_digital_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='') -> Union[int, str]: +def add_digital_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='') -> Union[int, str]: """Adds a digital series to a plot. Digital plots do not respond to y drag or zoom, and are always referenced to the bottom of the plot.""" ... -def add_double4_value(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: Any ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_double4_value(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: Any ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a double value.""" ... -def add_double_value(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: float ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_double_value(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: float ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a double value.""" ... -def add_drag_double(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', format: str ='', speed: float ='', min_value: float ='', max_value: float ='', no_input: bool ='', clamped: bool ='') -> Union[int, str]: +def add_drag_double(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', format: str ='', speed: float ='', min_value: float ='', max_value: float ='', no_input: bool ='', clamped: bool ='') -> Union[int, str]: """Adds drag for a single double value. Useful when drag float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes.""" ... -def add_drag_doublex(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Any ='', size: int ='', format: str ='', speed: float ='', min_value: float ='', max_value: float ='', no_input: bool ='', clamped: bool ='') -> Union[int, str]: +def add_drag_doublex(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Any ='', size: int ='', format: str ='', speed: float ='', min_value: float ='', max_value: float ='', no_input: bool ='', clamped: bool ='') -> Union[int, str]: """Adds drag input for a set of double values up to 4. Useful when drag float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes.""" ... -def add_drag_float(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', format: str ='', speed: float ='', min_value: float ='', max_value: float ='', no_input: bool ='', clamped: bool ='') -> Union[int, str]: +def add_drag_float(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', format: str ='', speed: float ='', min_value: float ='', max_value: float ='', no_input: bool ='', clamped: bool ='') -> Union[int, str]: """Adds drag for a single float value. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes.""" ... -def add_drag_floatx(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[float], Tuple[float, ...]] ='', size: int ='', format: str ='', speed: float ='', min_value: float ='', max_value: float ='', no_input: bool ='', clamped: bool ='') -> Union[int, str]: +def add_drag_floatx(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[float], Tuple[float, ...]] ='', size: int ='', format: str ='', speed: float ='', min_value: float ='', max_value: float ='', no_input: bool ='', clamped: bool ='') -> Union[int, str]: """Adds drag input for a set of float values up to 4. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes.""" ... -def add_drag_int(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: int ='', format: str ='', speed: float ='', min_value: int ='', max_value: int ='', no_input: bool ='', clamped: bool ='') -> Union[int, str]: +def add_drag_int(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: int ='', format: str ='', speed: float ='', min_value: int ='', max_value: int ='', no_input: bool ='', clamped: bool ='') -> Union[int, str]: """Adds drag for a single int value. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes.""" ... -def add_drag_intx(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[int], Tuple[int, ...]] ='', size: int ='', format: str ='', speed: float ='', min_value: int ='', max_value: int ='', no_input: bool ='', clamped: bool ='') -> Union[int, str]: +def add_drag_intx(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[int], Tuple[int, ...]] ='', size: int ='', format: str ='', speed: float ='', min_value: int ='', max_value: int ='', no_input: bool ='', clamped: bool ='') -> Union[int, str]: """Adds drag input for a set of int values up to 4. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes.""" ... -def add_drag_line(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', callback: Callable ='', show: bool ='', default_value: float ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', show_label: bool ='', vertical: bool ='', delayed: bool ='', no_cursor: bool ='', no_fit: bool ='', no_inputs: bool ='') -> Union[int, str]: +def add_drag_line(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', default_value: float ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', show_label: bool ='', vertical: bool ='', delayed: bool ='', no_cursor: bool ='', no_fit: bool ='', no_inputs: bool ='') -> Union[int, str]: """Adds a drag line to a plot.""" ... -def add_drag_payload(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', show: bool ='', drag_data: Any ='', drop_data: Any ='', payload_type: str ='') -> Union[int, str]: +def add_drag_payload(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', show: bool ='', drag_data: Any ='', drop_data: Any ='', payload_type: str ='') -> Union[int, str]: """User data payload for drag and drop operations.""" ... -def add_drag_point(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', callback: Callable ='', show: bool ='', default_value: Any ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', show_label: bool ='', offset: Union[List[float], Tuple[float, ...]] ='', clamped: bool ='', delayed: bool ='', no_cursor: bool ='', no_fit: bool ='', no_inputs: bool ='') -> Union[int, str]: +def add_drag_point(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', default_value: Any ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', show_label: bool ='', offset: Union[List[float], Tuple[float, ...]] ='', clamped: bool ='', delayed: bool ='', no_cursor: bool ='', no_fit: bool ='', no_inputs: bool ='') -> Union[int, str]: """Adds a drag point to a plot.""" ... -def add_drag_rect(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', callback: Callable ='', show: bool ='', default_value: Any ='', color: Union[List[int], Tuple[int, ...]] ='', delayed: bool ='', no_cursor: bool ='', no_fit: bool ='', no_inputs: bool ='') -> Union[int, str]: +def add_drag_rect(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', default_value: Any ='', color: Union[List[int], Tuple[int, ...]] ='', delayed: bool ='', no_cursor: bool ='', no_fit: bool ='', no_inputs: bool ='') -> Union[int, str]: """Adds a drag rectangle to a plot.""" ... -def add_draw_layer(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', perspective_divide: bool ='', depth_clipping: bool ='', cull_mode: int ='') -> Union[int, str]: +def add_draw_layer(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', perspective_divide: bool ='', depth_clipping: bool ='', cull_mode: int ='') -> Union[int, str]: """New in 1.1. Creates a layer useful for grouping drawlist items.""" ... -def add_draw_node(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='') -> Union[int, str]: +def add_draw_node(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='') -> Union[int, str]: """New in 1.1. Creates a drawing node to associate a transformation matrix. Child node matricies will concatenate.""" ... -def add_drawlist(width : int, height : int, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='') -> Union[int, str]: +def add_drawlist(width : int, height : int, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='') -> Union[int, str]: """Adds a drawing canvas.""" ... -def add_dynamic_texture(width : int, height : int, default_value : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_dynamic_texture(width : int, height : int, default_value : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a dynamic texture.""" ... -def add_error_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], negative : Union[List[float], Tuple[float, ...]], positive : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', contribute_to_bounds: bool ='', horizontal: bool ='') -> Union[int, str]: +def add_error_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], negative : Union[List[float], Tuple[float, ...]], positive : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', contribute_to_bounds: bool ='', horizontal: bool ='') -> Union[int, str]: """Adds an error series to a plot.""" ... -def add_file_dialog(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', callback: Callable ='', show: bool ='', default_path: str ='', default_filename: str ='', file_count: int ='', modal: bool ='', directory_selector: bool ='', min_size: Union[List[int], Tuple[int, ...]] ='', max_size: Union[List[int], Tuple[int, ...]] ='', cancel_callback: Callable ='') -> Union[int, str]: +def add_file_dialog(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', callback: Optional[Callable] ='', show: bool ='', default_path: str ='', default_filename: str ='', file_count: int ='', modal: bool ='', directory_selector: bool ='', min_size: Union[List[int], Tuple[int, ...]] ='', max_size: Union[List[int], Tuple[int, ...]] ='', cancel_callback: Optional[Callable] ='') -> Union[int, str]: """Displays a file or directory selector depending on keywords. Displays a file dialog by default. Callback will be ran when the file or directory picker is closed. The app_data arguemnt will be populated with information related to the file and directory as a dictionary.""" ... -def add_file_extension(extension : str, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', custom_text: str ='', color: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: +def add_file_extension(extension : str, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', custom_text: str ='', color: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: """Creates a file extension filter option in the file dialog.""" ... -def add_filter_set(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='') -> Union[int, str]: +def add_filter_set(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='') -> Union[int, str]: """Helper to parse and apply text filters (e.g. aaaaa[, bbbbb][, ccccc])""" ... -def add_float4_value(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: Union[List[float], Tuple[float, ...]] ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_float4_value(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: Union[List[float], Tuple[float, ...]] ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a float4 value.""" ... -def add_float_value(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: float ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_float_value(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: float ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a float value.""" ... -def add_float_vect_value(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: Union[List[float], Tuple[float, ...]] ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_float_vect_value(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: Union[List[float], Tuple[float, ...]] ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a float vect value.""" ... -def add_font(file : str, size : int, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', pixel_snapH: bool ='', pixel_snapV: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_font(file : str, size : int, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', pixel_snapH: bool ='', pixel_snapV: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds font to a font registry.""" ... -def add_font_registry(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='') -> Union[int, str]: +def add_font_registry(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='') -> Union[int, str]: """Adds a font registry.""" ... -def add_group(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', horizontal: bool ='', horizontal_spacing: float ='', xoffset: float ='') -> Union[int, str]: +def add_group(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', horizontal: bool ='', horizontal_spacing: float ='', xoffset: float ='') -> Union[int, str]: """Creates a group that other widgets can belong to. The group allows item commands to be issued for all of its members. Enable property acts in a special way enabling/disabling everything inside the group. (Use mvStyleVar_DisabledAlpha to edit colors within the disabled group.)""" ... -def add_handler_registry(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='') -> Union[int, str]: +def add_handler_registry(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='') -> Union[int, str]: """Adds a handler registry.""" ... -def add_heat_series(x : Union[List[float], Tuple[float, ...]], rows : int, cols : int, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', scale_min: float ='', scale_max: float ='', bounds_min: Any ='', bounds_max: Any ='', format: str ='', contribute_to_bounds: bool ='', col_major: bool ='') -> Union[int, str]: +def add_heat_series(x : Union[List[float], Tuple[float, ...]], rows : int, cols : int, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', scale_min: float ='', scale_max: float ='', bounds_min: Any ='', bounds_max: Any ='', format: str ='', contribute_to_bounds: bool ='', col_major: bool ='') -> Union[int, str]: """Adds a heat series to a plot.""" ... -def add_histogram_series(x : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', bins: int ='', bar_scale: float ='', min_range: float ='', max_range: float ='', cumulative: bool ='', density: bool ='', outliers: bool ='', horizontal: bool ='', contribute_to_bounds: bool ='') -> Union[int, str]: +def add_histogram_series(x : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', bins: int ='', bar_scale: float ='', min_range: float ='', max_range: float ='', cumulative: bool ='', density: bool ='', outliers: bool ='', horizontal: bool ='', contribute_to_bounds: bool ='') -> Union[int, str]: """Adds a histogram series to a plot.""" ... -def add_image(texture_tag : Union[int, str], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', tint_color: Union[List[float], Tuple[float, ...]] ='', border_color: Union[List[float], Tuple[float, ...]] ='', uv_min: Union[List[float], Tuple[float, ...]] ='', uv_max: Union[List[float], Tuple[float, ...]] ='') -> Union[int, str]: +def add_image(texture_tag : Union[int, str], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', tint_color: Union[List[float], Tuple[float, ...]] ='', border_color: Union[List[float], Tuple[float, ...]] ='', uv_min: Union[List[float], Tuple[float, ...]] ='', uv_max: Union[List[float], Tuple[float, ...]] ='') -> Union[int, str]: """Adds an image from a specified texture. uv_min and uv_max represent the normalized texture coordinates of the original image that will be shown. Using range (0.0,0.0)->(1.0,1.0) for texture coordinates will generally display the entire texture.""" ... -def add_image_button(texture_tag : Union[int, str], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', tint_color: Union[List[float], Tuple[float, ...]] ='', background_color: Union[List[float], Tuple[float, ...]] ='', uv_min: Union[List[float], Tuple[float, ...]] ='', uv_max: Union[List[float], Tuple[float, ...]] ='') -> Union[int, str]: +def add_image_button(texture_tag : Union[int, str], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', tint_color: Union[List[float], Tuple[float, ...]] ='', background_color: Union[List[float], Tuple[float, ...]] ='', uv_min: Union[List[float], Tuple[float, ...]] ='', uv_max: Union[List[float], Tuple[float, ...]] ='') -> Union[int, str]: """Adds an button with a texture. uv_min and uv_max represent the normalized texture coordinates of the original image that will be shown. Using range (0.0,0.0)->(1.0,1.0) texture coordinates will generally display the entire texture""" ... -def add_image_series(texture_tag : Union[int, str], bounds_min : Union[List[float], Tuple[float, ...]], bounds_max : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', uv_min: Union[List[float], Tuple[float, ...]] ='', uv_max: Union[List[float], Tuple[float, ...]] ='', tint_color: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: +def add_image_series(texture_tag : Union[int, str], bounds_min : Union[List[float], Tuple[float, ...]], bounds_max : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', uv_min: Union[List[float], Tuple[float, ...]] ='', uv_max: Union[List[float], Tuple[float, ...]] ='', tint_color: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: """Adds an image series to a plot.""" ... -def add_inf_line_series(x : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', horizontal: bool ='') -> Union[int, str]: +def add_inf_line_series(x : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', horizontal: bool ='') -> Union[int, str]: """Adds an infinite line series to a plot.""" ... -def add_input_double(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', format: str ='', min_value: float ='', max_value: float ='', step: float ='', step_fast: float ='', min_clamped: bool ='', max_clamped: bool ='', on_enter: bool ='', readonly: bool ='', accept_empty_input: bool ='', display_empty_value: bool ='') -> Union[int, str]: +def add_input_double(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', format: str ='', min_value: float ='', max_value: float ='', step: float ='', step_fast: float ='', min_clamped: bool ='', max_clamped: bool ='', on_enter: bool ='', readonly: bool ='', accept_empty_input: bool ='', display_empty_value: bool ='') -> Union[int, str]: """Adds input for an double. Useful when input float is not accurate enough. +/- buttons can be activated by setting the value of step.""" ... -def add_input_doublex(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Any ='', format: str ='', min_value: float ='', max_value: float ='', size: int ='', min_clamped: bool ='', max_clamped: bool ='', on_enter: bool ='', readonly: bool ='', accept_empty_input: bool ='', display_empty_value: bool ='') -> Union[int, str]: +def add_input_doublex(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Any ='', format: str ='', min_value: float ='', max_value: float ='', size: int ='', min_clamped: bool ='', max_clamped: bool ='', on_enter: bool ='', readonly: bool ='', accept_empty_input: bool ='', display_empty_value: bool ='') -> Union[int, str]: """Adds multi double input for up to 4 double values. Useful when input float mulit is not accurate enough.""" ... -def add_input_float(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', format: str ='', min_value: float ='', max_value: float ='', step: float ='', step_fast: float ='', min_clamped: bool ='', max_clamped: bool ='', on_enter: bool ='', readonly: bool ='', accept_empty_input: bool ='', display_empty_value: bool ='') -> Union[int, str]: +def add_input_float(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', format: str ='', min_value: float ='', max_value: float ='', step: float ='', step_fast: float ='', min_clamped: bool ='', max_clamped: bool ='', on_enter: bool ='', readonly: bool ='', accept_empty_input: bool ='', display_empty_value: bool ='') -> Union[int, str]: """Adds input for an float. +/- buttons can be activated by setting the value of step.""" ... -def add_input_floatx(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[float], Tuple[float, ...]] ='', format: str ='', min_value: float ='', max_value: float ='', size: int ='', min_clamped: bool ='', max_clamped: bool ='', on_enter: bool ='', readonly: bool ='', accept_empty_input: bool ='', display_empty_value: bool ='') -> Union[int, str]: +def add_input_floatx(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[float], Tuple[float, ...]] ='', format: str ='', min_value: float ='', max_value: float ='', size: int ='', min_clamped: bool ='', max_clamped: bool ='', on_enter: bool ='', readonly: bool ='', accept_empty_input: bool ='', display_empty_value: bool ='') -> Union[int, str]: """Adds multi float input for up to 4 float values.""" ... -def add_input_int(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: int ='', min_value: int ='', max_value: int ='', step: int ='', step_fast: int ='', min_clamped: bool ='', max_clamped: bool ='', on_enter: bool ='', readonly: bool ='', accept_empty_input: bool ='', display_empty_value: bool ='') -> Union[int, str]: +def add_input_int(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: int ='', min_value: int ='', max_value: int ='', step: int ='', step_fast: int ='', min_clamped: bool ='', max_clamped: bool ='', on_enter: bool ='', readonly: bool ='', accept_empty_input: bool ='', display_empty_value: bool ='') -> Union[int, str]: """Adds input for an int. +/- buttons can be activated by setting the value of step.""" ... -def add_input_intx(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[int], Tuple[int, ...]] ='', min_value: int ='', max_value: int ='', size: int ='', min_clamped: bool ='', max_clamped: bool ='', on_enter: bool ='', readonly: bool ='', accept_empty_input: bool ='', display_empty_value: bool ='') -> Union[int, str]: +def add_input_intx(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[int], Tuple[int, ...]] ='', min_value: int ='', max_value: int ='', size: int ='', min_clamped: bool ='', max_clamped: bool ='', on_enter: bool ='', readonly: bool ='', accept_empty_input: bool ='', display_empty_value: bool ='') -> Union[int, str]: """Adds multi int input for up to 4 integer values.""" ... -def add_input_text(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: str ='', hint: str ='', multiline: bool ='', no_spaces: bool ='', uppercase: bool ='', tab_input: bool ='', decimal: bool ='', hexadecimal: bool ='', readonly: bool ='', password: bool ='', scientific: bool ='', on_enter: bool ='', auto_select_all: bool ='', ctrl_enter_for_new_line: bool ='', no_horizontal_scroll: bool ='', always_overwrite: bool ='', no_undo_redo: bool ='', escape_clears_all: bool ='', elide_left: bool ='') -> Union[int, str]: +def add_input_text(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: str ='', hint: str ='', multiline: bool ='', no_spaces: bool ='', uppercase: bool ='', tab_input: bool ='', decimal: bool ='', hexadecimal: bool ='', readonly: bool ='', password: bool ='', scientific: bool ='', on_enter: bool ='', auto_select_all: bool ='', ctrl_enter_for_new_line: bool ='', no_horizontal_scroll: bool ='', always_overwrite: bool ='', no_undo_redo: bool ='', escape_clears_all: bool ='', elide_left: bool ='') -> Union[int, str]: """Adds input for text.""" ... -def add_int4_value(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: Union[List[int], Tuple[int, ...]] ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_int4_value(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: Union[List[int], Tuple[int, ...]] ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a int4 value.""" ... -def add_int_value(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: int ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_int_value(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: int ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a int value.""" ... -def add_item_activated_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='') -> Union[int, str]: +def add_item_activated_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='') -> Union[int, str]: """Adds a activated handler.""" ... -def add_item_active_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='') -> Union[int, str]: +def add_item_active_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='') -> Union[int, str]: """Adds a active handler.""" ... -def add_item_clicked_handler(button : int ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='') -> Union[int, str]: +def add_item_clicked_handler(button : int ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='') -> Union[int, str]: """Adds a clicked handler.""" ... -def add_item_deactivated_after_edit_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='') -> Union[int, str]: +def add_item_deactivated_after_edit_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='') -> Union[int, str]: """Adds a deactivated after edit handler.""" ... -def add_item_deactivated_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='') -> Union[int, str]: +def add_item_deactivated_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='') -> Union[int, str]: """Adds a deactivated handler.""" ... -def add_item_double_clicked_handler(button : int ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='') -> Union[int, str]: +def add_item_double_clicked_handler(button : int ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='') -> Union[int, str]: """Adds a double click handler.""" ... -def add_item_edited_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='') -> Union[int, str]: +def add_item_edited_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='') -> Union[int, str]: """Adds an edited handler.""" ... -def add_item_focus_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='', event_type: int ='') -> Union[int, str]: +def add_item_focus_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', event_type: int ='') -> Union[int, str]: """Adds a focus handler.""" ... -def add_item_handler_registry(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='') -> Union[int, str]: +def add_item_handler_registry(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='') -> Union[int, str]: """Adds an item handler registry.""" ... -def add_item_hover_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='', event_type: int ='') -> Union[int, str]: +def add_item_hover_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', event_type: int ='') -> Union[int, str]: """Adds a hover handler.""" ... -def add_item_resize_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='') -> Union[int, str]: +def add_item_resize_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='') -> Union[int, str]: """Adds a resize handler.""" ... -def add_item_scroll_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='') -> Union[int, str]: +def add_item_scroll_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='') -> Union[int, str]: """Adds a scroll handler.""" ... -def add_item_toggled_open_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='', two_way: bool ='') -> Union[int, str]: +def add_item_toggled_open_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', two_way: bool ='') -> Union[int, str]: """Adds a togged open handler.""" ... -def add_item_visible_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Callable ='', show: bool ='') -> Union[int, str]: +def add_item_visible_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='') -> Union[int, str]: """Adds a visible handler.""" ... -def add_key_down_handler(key : int ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Callable ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_key_down_handler(key : int ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a key down handler.""" ... -def add_key_press_handler(key : int ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Callable ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_key_press_handler(key : int ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a key press handler.""" ... -def add_key_release_handler(key : int ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Callable ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_key_release_handler(key : int ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a key release handler.""" ... -def add_knob_float(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', min_value: float ='', max_value: float ='') -> Union[int, str]: +def add_knob_float(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', min_value: float ='', max_value: float ='') -> Union[int, str]: """Adds a knob that rotates based on change in x mouse position.""" ... -def add_line_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', segments: bool ='', loop: bool ='', skip_nan: bool ='', no_clip: bool ='', shaded: bool ='') -> Union[int, str]: +def add_line_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', segments: bool ='', loop: bool ='', skip_nan: bool ='', no_clip: bool ='', shaded: bool ='') -> Union[int, str]: """Adds a line series to a plot.""" ... -def add_listbox(items : Union[List[str], Tuple[str, ...]] ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: str ='', num_items: int ='') -> Union[int, str]: +def add_listbox(items : Union[List[str], Tuple[str, ...]] ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: str ='', num_items: int ='') -> Union[int, str]: """Adds a listbox. If height is not large enough to show all items a scroll bar will appear.""" ... -def add_loading_indicator(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', style: int ='', circle_count: int ='', speed: float ='', radius: float ='', thickness: float ='', color: Union[List[int], Tuple[int, ...]] ='', secondary_color: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: +def add_loading_indicator(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', style: int ='', circle_count: int ='', speed: float ='', radius: float ='', thickness: float ='', color: Union[List[int], Tuple[int, ...]] ='', secondary_color: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: """Adds a rotating animated loading symbol.""" ... -def add_menu(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='') -> Union[int, str]: +def add_menu(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='') -> Union[int, str]: """Adds a menu to an existing menu bar.""" ... -def add_menu_bar(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', show: bool ='') -> Union[int, str]: +def add_menu_bar(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', show: bool ='') -> Union[int, str]: """Adds a menu bar to a window.""" ... -def add_menu_item(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: bool ='', shortcut: str ='', check: bool ='') -> Union[int, str]: +def add_menu_item(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: bool ='', shortcut: str ='', check: bool ='') -> Union[int, str]: """Adds a menu item to an existing menu. Menu items act similar to selectables and has a bool value. When placed in a menu the checkmark will reflect its value.""" ... -def add_mouse_click_handler(button : int ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Callable ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_mouse_click_handler(button : int ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a mouse click handler.""" ... -def add_mouse_double_click_handler(button : int ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Callable ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_mouse_double_click_handler(button : int ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a mouse double click handler.""" ... -def add_mouse_down_handler(button : int ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Callable ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_mouse_down_handler(button : int ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a mouse down handler.""" ... -def add_mouse_drag_handler(button : int ='', threshold : float ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Callable ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_mouse_drag_handler(button : int ='', threshold : float ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a mouse drag handler.""" ... -def add_mouse_move_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Callable ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_mouse_move_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a mouse move handler.""" ... -def add_mouse_release_handler(button : int ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Callable ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_mouse_release_handler(button : int ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a mouse release handler.""" ... -def add_mouse_wheel_handler(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Callable ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_mouse_wheel_handler(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a mouse wheel handler.""" ... -def add_node(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', draggable: bool ='') -> Union[int, str]: +def add_node(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', draggable: bool ='') -> Union[int, str]: """Adds a node to a node editor.""" ... -def add_node_attribute(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', attribute_type: int ='', shape: int ='', category: str ='') -> Union[int, str]: +def add_node_attribute(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', attribute_type: int ='', shape: int ='', category: str ='') -> Union[int, str]: """Adds a node attribute to a node.""" ... -def add_node_editor(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', callback: Callable ='', show: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', delink_callback: Callable ='', menubar: bool ='', minimap: bool ='', minimap_location: int ='') -> Union[int, str]: +def add_node_editor(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', delink_callback: Optional[Callable] ='', menubar: bool ='', minimap: bool ='', minimap_location: int ='') -> Union[int, str]: """Adds a node editor.""" ... -def add_node_link(attr_1 : Union[int, str], attr_2 : Union[int, str], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', show: bool ='') -> Union[int, str]: +def add_node_link(attr_1 : Union[int, str], attr_2 : Union[int, str], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', show: bool ='') -> Union[int, str]: """Adds a node link between 2 node attributes.""" ... -def add_pie_series(x : float, y : float, radius : float, values : Union[List[float], Tuple[float, ...]], labels : Union[List[str], Tuple[str, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', format: str ='', angle: float ='', normalize: bool ='', ignore_hidden: bool ='') -> Union[int, str]: +def add_pie_series(x : float, y : float, radius : float, values : Union[List[float], Tuple[float, ...]], labels : Union[List[str], Tuple[str, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', format: str ='', angle: float ='', normalize: bool ='', ignore_hidden: bool ='') -> Union[int, str]: """Adds an pie series to a plot.""" ... -def add_plot(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', no_title: bool ='', no_menus: bool ='', no_box_select: bool ='', no_mouse_pos: bool ='', query: bool ='', query_color: Union[List[float], Tuple[float, ...]] ='', min_query_rects: int ='', max_query_rects: int ='', crosshairs: bool ='', equal_aspects: bool ='', no_inputs: bool ='', no_frame: bool ='', use_local_time: bool ='', use_ISO8601: bool ='', use_24hour_clock: bool ='', pan_button: int ='', pan_mod: int ='', context_menu_button: int ='', fit_button: int ='', box_select_button: int ='', box_select_mod: int ='', box_select_cancel_button: int ='', query_toggle_mod: int ='', horizontal_mod: int ='', vertical_mod: int ='', override_mod: int ='', zoom_mod: int ='', zoom_rate: int ='') -> Union[int, str]: +def add_plot(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', no_title: bool ='', no_menus: bool ='', no_box_select: bool ='', no_mouse_pos: bool ='', query: bool ='', query_color: Union[List[float], Tuple[float, ...]] ='', min_query_rects: int ='', max_query_rects: int ='', crosshairs: bool ='', equal_aspects: bool ='', no_inputs: bool ='', no_frame: bool ='', use_local_time: bool ='', use_ISO8601: bool ='', use_24hour_clock: bool ='', pan_button: int ='', pan_mod: int ='', context_menu_button: int ='', fit_button: int ='', box_select_button: int ='', box_select_mod: int ='', box_select_cancel_button: int ='', query_toggle_mod: int ='', horizontal_mod: int ='', vertical_mod: int ='', override_mod: int ='', zoom_mod: int ='', zoom_rate: float ='') -> Union[int, str]: """Adds a plot which is used to hold series, and can be drawn to with draw commands. For all _mod parameters use mvKey_ModX enums, or mvKey_ModDisabled to disable the modifier.""" ... -def add_plot_annotation(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', default_value: Any ='', offset: Union[List[float], Tuple[float, ...]] ='', color: Union[List[int], Tuple[int, ...]] ='', clamped: bool ='') -> Union[int, str]: +def add_plot_annotation(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', default_value: Any ='', offset: Union[List[float], Tuple[float, ...]] ='', color: Union[List[int], Tuple[int, ...]] ='', clamped: bool ='') -> Union[int, str]: """Adds an annotation to a plot.""" ... -def add_plot_axis(axis : int, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', payload_type: str ='', drop_callback: Callable ='', show: bool ='', no_label: bool ='', no_gridlines: bool ='', no_tick_marks: bool ='', no_tick_labels: bool ='', no_initial_fit: bool ='', no_menus: bool ='', no_side_switch: bool ='', no_highlight: bool ='', opposite: bool ='', foreground_grid: bool ='', tick_format: str ='', scale: int ='', invert: bool ='', auto_fit: bool ='', range_fit: bool ='', pan_stretch: bool ='', lock_min: bool ='', lock_max: bool ='') -> Union[int, str]: +def add_plot_axis(axis : int, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', payload_type: str ='', drop_callback: Optional[Callable] ='', show: bool ='', no_label: bool ='', no_gridlines: bool ='', no_tick_marks: bool ='', no_tick_labels: bool ='', no_initial_fit: bool ='', no_menus: bool ='', no_side_switch: bool ='', no_highlight: bool ='', opposite: bool ='', foreground_grid: bool ='', tick_format: str ='', scale: int ='', invert: bool ='', auto_fit: bool ='', range_fit: bool ='', pan_stretch: bool ='', lock_min: bool ='', lock_max: bool ='') -> Union[int, str]: """Adds an axis to a plot.""" ... -def add_plot_legend(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', payload_type: str ='', drop_callback: Callable ='', show: bool ='', location: int ='', horizontal: bool ='', sort: bool ='', outside: bool ='', no_highlight_item: bool ='', no_highlight_axis: bool ='', no_menus: bool ='', no_buttons: bool ='') -> Union[int, str]: +def add_plot_legend(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', payload_type: str ='', drop_callback: Optional[Callable] ='', show: bool ='', location: int ='', horizontal: bool ='', sort: bool ='', outside: bool ='', no_highlight_item: bool ='', no_highlight_axis: bool ='', no_menus: bool ='', no_buttons: bool ='') -> Union[int, str]: """Adds a plot legend to a plot.""" ... -def add_progress_bar(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', overlay: str ='', default_value: float ='') -> Union[int, str]: +def add_progress_bar(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', overlay: str ='', default_value: float ='') -> Union[int, str]: """Adds a progress bar.""" ... -def add_radio_button(items : Union[List[str], Tuple[str, ...]] ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: str ='', horizontal: bool ='') -> Union[int, str]: +def add_radio_button(items : Union[List[str], Tuple[str, ...]] ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: str ='', horizontal: bool ='') -> Union[int, str]: """Adds a set of radio buttons. If items keyword is empty, nothing will be shown.""" ... -def add_raw_texture(width : int, height : int, default_value : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', format: int ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_raw_texture(width : int, height : int, default_value : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', format: int ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a raw texture.""" ... -def add_scatter_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', no_clip: bool ='') -> Union[int, str]: +def add_scatter_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', no_clip: bool ='') -> Union[int, str]: """Adds a scatter series to a plot.""" ... -def add_selectable(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: bool ='', span_columns: bool ='', disable_popup_close: bool ='', select_on_nav: bool ='') -> Union[int, str]: +def add_selectable(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: bool ='', span_columns: bool ='', disable_popup_close: bool ='', select_on_nav: bool ='') -> Union[int, str]: """Adds a selectable. Similar to a button but can indicate its selected state.""" ... -def add_separator(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: +def add_separator(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: """Adds a horizontal line separator. Use 'label' parameter to add text and mvStyleVar_SeparatorText* elements to style it.""" ... -def add_series_value(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: Any ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_series_value(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: Any ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a plot series value.""" ... -def add_shade_series(x : Union[List[float], Tuple[float, ...]], y1 : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', y2: Any ='') -> Union[int, str]: +def add_shade_series(x : Union[List[float], Tuple[float, ...]], y1 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', y2: Any ='') -> Union[int, str]: """Adds a shade series to a plot.""" ... -def add_simple_plot(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[float], Tuple[float, ...]] ='', overlay: str ='', histogram: bool ='', autosize: bool ='', min_scale: float ='', max_scale: float ='') -> Union[int, str]: +def add_simple_plot(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[float], Tuple[float, ...]] ='', overlay: str ='', histogram: bool ='', autosize: bool ='', min_scale: float ='', max_scale: float ='') -> Union[int, str]: """Adds a simple plot for visualization of a 1 dimensional set of values.""" ... -def add_slider_double(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', vertical: bool ='', no_input: bool ='', clamped: bool ='', min_value: float ='', max_value: float ='', format: str ='') -> Union[int, str]: +def add_slider_double(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', vertical: bool ='', no_input: bool ='', clamped: bool ='', min_value: float ='', max_value: float ='', format: str ='') -> Union[int, str]: """Adds slider for a single double value. Useful when slider float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes.""" ... -def add_slider_doublex(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Any ='', size: int ='', no_input: bool ='', clamped: bool ='', min_value: float ='', max_value: float ='', format: str ='') -> Union[int, str]: +def add_slider_doublex(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Any ='', size: int ='', no_input: bool ='', clamped: bool ='', min_value: float ='', max_value: float ='', format: str ='') -> Union[int, str]: """Adds multi slider for up to 4 double values. Usueful for when multi slide float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes.""" ... -def add_slider_float(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', vertical: bool ='', no_input: bool ='', clamped: bool ='', min_value: float ='', max_value: float ='', format: str ='') -> Union[int, str]: +def add_slider_float(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: float ='', vertical: bool ='', no_input: bool ='', clamped: bool ='', min_value: float ='', max_value: float ='', format: str ='') -> Union[int, str]: """Adds slider for a single float value. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes.""" ... -def add_slider_floatx(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[float], Tuple[float, ...]] ='', size: int ='', no_input: bool ='', clamped: bool ='', min_value: float ='', max_value: float ='', format: str ='') -> Union[int, str]: +def add_slider_floatx(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[float], Tuple[float, ...]] ='', size: int ='', no_input: bool ='', clamped: bool ='', min_value: float ='', max_value: float ='', format: str ='') -> Union[int, str]: """Adds multi slider for up to 4 float values. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes.""" ... -def add_slider_int(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: int ='', vertical: bool ='', no_input: bool ='', clamped: bool ='', min_value: int ='', max_value: int ='', format: str ='') -> Union[int, str]: +def add_slider_int(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: int ='', vertical: bool ='', no_input: bool ='', clamped: bool ='', min_value: int ='', max_value: int ='', format: str ='') -> Union[int, str]: """Adds slider for a single int value. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes.""" ... -def add_slider_intx(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[int], Tuple[int, ...]] ='', size: int ='', no_input: bool ='', clamped: bool ='', min_value: int ='', max_value: int ='', format: str ='') -> Union[int, str]: +def add_slider_intx(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', enabled: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: Union[List[int], Tuple[int, ...]] ='', size: int ='', no_input: bool ='', clamped: bool ='', min_value: int ='', max_value: int ='', format: str ='') -> Union[int, str]: """Adds multi slider for up to 4 int values. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes.""" ... -def add_spacer(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: +def add_spacer(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: """Adds a spacer item that can be used to help with layouts or can be used as a placeholder item.""" ... -def add_stage(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='') -> Union[int, str]: +def add_stage(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='') -> Union[int, str]: """Adds a stage.""" ... -def add_stair_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', pre_step: bool ='', shaded: bool ='') -> Union[int, str]: +def add_stair_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', pre_step: bool ='', shaded: bool ='') -> Union[int, str]: """Adds a stair series to a plot.""" ... -def add_static_texture(width : int, height : int, default_value : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_static_texture(width : int, height : int, default_value : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a static texture.""" ... -def add_stem_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', horizontal: bool ='') -> Union[int, str]: +def add_stem_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', horizontal: bool ='') -> Union[int, str]: """Adds a stem series to a plot.""" ... -def add_string_value(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: str ='', parent: Union[int, str] ='') -> Union[int, str]: +def add_string_value(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', source: Union[int, str] ='', default_value: str ='', parent: Union[int, str] ='') -> Union[int, str]: """Adds a string value.""" ... -def add_subplots(rows : int, columns : int, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', row_ratios: Union[List[float], Tuple[float, ...]] ='', column_ratios: Union[List[float], Tuple[float, ...]] ='', no_title: bool ='', no_menus: bool ='', no_resize: bool ='', no_align: bool ='', share_series: bool ='', link_rows: bool ='', link_columns: bool ='', link_all_x: bool ='', link_all_y: bool ='', column_major: bool ='') -> Union[int, str]: +def add_subplots(rows : int, columns : int, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', row_ratios: Union[List[float], Tuple[float, ...]] ='', column_ratios: Union[List[float], Tuple[float, ...]] ='', no_title: bool ='', no_menus: bool ='', no_resize: bool ='', no_align: bool ='', share_series: bool ='', link_rows: bool ='', link_columns: bool ='', link_all_x: bool ='', link_all_y: bool ='', column_major: bool ='') -> Union[int, str]: """Adds a collection of plots.""" ... -def add_synced_tables(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', filter_key: str ='') -> Union[int, str]: +def add_synced_tables(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', filter_key: str ='') -> Union[int, str]: """Links all tables that are immediate children of this container so that they share their state (mostly column sizes). Other children are rendered as is. This is an experimental feature, use with caution.""" ... -def add_tab(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drop_callback: Callable ='', show: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', closable: bool ='', no_tooltip: bool ='', order_mode: int ='', unsaved_document: bool ='', no_close_with_middle_click: bool ='', no_reorder: bool ='') -> Union[int, str]: +def add_tab(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drop_callback: Optional[Callable] ='', show: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', closable: bool ='', no_tooltip: bool ='', order_mode: int ='', unsaved_document: bool ='', no_close_with_middle_click: bool ='', no_reorder: bool ='') -> Union[int, str]: """Adds a tab to a tab bar.""" ... -def add_tab_bar(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', reorderable: bool ='', tab_list_popup_button: bool ='', no_close_with_middle_click: bool ='', no_scrolling_buttons: bool ='', no_tooltip: bool ='', draw_selected_overline: bool ='') -> Union[int, str]: +def add_tab_bar(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', reorderable: bool ='', tab_list_popup_button: bool ='', no_close_with_middle_click: bool ='', no_scrolling_buttons: bool ='', no_tooltip: bool ='', draw_selected_overline: bool ='') -> Union[int, str]: """Adds a tab bar.""" ... -def add_tab_button(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', no_reorder: bool ='', leading: bool ='', trailing: bool ='', no_tooltip: bool ='', unsaved_document: bool ='') -> Union[int, str]: +def add_tab_button(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', no_reorder: bool ='', leading: bool ='', trailing: bool ='', no_tooltip: bool ='', unsaved_document: bool ='') -> Union[int, str]: """Adds a tab button to a tab bar.""" ... -def add_table(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', header_row: bool ='', clipper: bool ='', inner_width: int ='', policy: int ='', freeze_rows: int ='', freeze_columns: int ='', sort_multi: bool ='', sort_tristate: bool ='', resizable: bool ='', reorderable: bool ='', hideable: bool ='', sortable: bool ='', context_menu_in_body: bool ='', row_background: bool ='', borders_innerH: bool ='', borders_outerH: bool ='', borders_innerV: bool ='', borders_outerV: bool ='', no_host_extendX: bool ='', no_host_extendY: bool ='', no_keep_columns_visible: bool ='', precise_widths: bool ='', no_clip: bool ='', pad_outerX: bool ='', no_pad_outerX: bool ='', no_pad_innerX: bool ='', scrollX: bool ='', scrollY: bool ='', no_saved_settings: bool ='') -> Union[int, str]: +def add_table(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', header_row: bool ='', clipper: bool ='', inner_width: int ='', policy: int ='', freeze_rows: int ='', freeze_columns: int ='', sort_multi: bool ='', sort_tristate: bool ='', resizable: bool ='', reorderable: bool ='', hideable: bool ='', sortable: bool ='', context_menu_in_body: bool ='', row_background: bool ='', borders_innerH: bool ='', borders_outerH: bool ='', borders_innerV: bool ='', borders_outerV: bool ='', no_host_extendX: bool ='', no_host_extendY: bool ='', no_keep_columns_visible: bool ='', precise_widths: bool ='', no_clip: bool ='', pad_outerX: bool ='', no_pad_outerX: bool ='', no_pad_innerX: bool ='', scrollX: bool ='', scrollY: bool ='', no_saved_settings: bool ='') -> Union[int, str]: """Adds a table.""" ... -def add_table_cell(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', height: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', filter_key: str ='') -> Union[int, str]: +def add_table_cell(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', height: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', filter_key: str ='') -> Union[int, str]: """Adds a table.""" ... -def add_table_column(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', enabled: bool ='', init_width_or_weight: float ='', default_hide: bool ='', default_sort: bool ='', width_stretch: bool ='', width_fixed: bool ='', no_resize: bool ='', no_reorder: bool ='', no_hide: bool ='', no_clip: bool ='', no_sort: bool ='', no_sort_ascending: bool ='', no_sort_descending: bool ='', no_header_width: bool ='', prefer_sort_ascending: bool ='', prefer_sort_descending: bool ='', indent_enable: bool ='', indent_disable: bool ='', angled_header: bool ='', no_header_label: bool ='') -> Union[int, str]: +def add_table_column(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', enabled: bool ='', init_width_or_weight: float ='', default_hide: bool ='', default_sort: bool ='', width_stretch: bool ='', width_fixed: bool ='', no_resize: bool ='', no_reorder: bool ='', no_hide: bool ='', no_clip: bool ='', no_sort: bool ='', no_sort_ascending: bool ='', no_sort_descending: bool ='', no_header_width: bool ='', prefer_sort_ascending: bool ='', prefer_sort_descending: bool ='', indent_enable: bool ='', indent_disable: bool ='', angled_header: bool ='', no_header_label: bool ='') -> Union[int, str]: """Adds a table column.""" ... -def add_table_row(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', height: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', filter_key: str ='') -> Union[int, str]: +def add_table_row(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', height: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', filter_key: str ='') -> Union[int, str]: """Adds a table row.""" ... -def add_template_registry(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='') -> Union[int, str]: +def add_template_registry(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='') -> Union[int, str]: """Adds a template registry.""" ... -def add_text(default_value : str ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', wrap: int ='', bullet: bool ='', color: Union[List[int], Tuple[int, ...]] ='', show_label: bool ='') -> Union[int, str]: +def add_text(default_value : str ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', payload_type: str ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', wrap: int ='', bullet: bool ='', color: Union[List[int], Tuple[int, ...]] ='', show_label: bool ='') -> Union[int, str]: """Adds text. Text can have an optional label that will display to the right of the text.""" ... -def add_text_point(x : float, y : float, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', offset: Union[List[float], Tuple[float, ...]] ='', vertical: bool ='') -> Union[int, str]: +def add_text_point(x : float, y : float, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', source: Union[int, str] ='', show: bool ='', offset: Union[List[float], Tuple[float, ...]] ='', vertical: bool ='') -> Union[int, str]: """Adds a label series to a plot. x and y can only have one elements each.""" ... -def add_texture_registry(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='') -> Union[int, str]: +def add_texture_registry(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='') -> Union[int, str]: """Adds a dynamic texture.""" ... -def add_theme(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='') -> Union[int, str]: +def add_theme(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='') -> Union[int, str]: """Adds a theme.""" ... -def add_theme_color(target : int ='', value : Union[List[int], Tuple[int, ...]] ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', category: int ='') -> Union[int, str]: +def add_theme_color(target : int ='', value : Union[List[int], Tuple[int, ...]] ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', category: int ='') -> Union[int, str]: """Adds a theme color.""" ... -def add_theme_component(item_type : int ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', enabled_state: bool ='') -> Union[int, str]: +def add_theme_component(item_type : int ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', enabled_state: bool ='') -> Union[int, str]: """Adds a theme component.""" ... -def add_theme_style(target : int ='', x : float ='', y : float ='', *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', category: int ='') -> Union[int, str]: +def add_theme_style(target : int ='', x : float ='', y : float ='', *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', category: int ='') -> Union[int, str]: """Adds a theme style.""" ... -def add_time_picker(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Callable ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: dict ='', hour24: bool ='') -> Union[int, str]: +def add_time_picker(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', callback: Optional[Callable] ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_value: dict ='', hour24: bool ='') -> Union[int, str]: """Adds a time picker.""" ... -def add_tooltip(parent : Union[int, str], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='', delay: float ='', hide_on_activity: bool ='') -> Union[int, str]: +def add_tooltip(parent : Union[int, str], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='', delay: float ='', hide_on_activity: bool ='') -> Union[int, str]: """Adds a tooltip window.""" ... -def add_tree_node(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drag_callback: Callable ='', drop_callback: Callable ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_open: bool ='', open_on_double_click: bool ='', open_on_arrow: bool ='', leaf: bool ='', bullet: bool ='', selectable: bool ='', span_text_width: bool ='', span_full_width: bool ='', catch_nav_left: bool ='', lines: int ='') -> Union[int, str]: +def add_tree_node(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', before: Union[int, str] ='', payload_type: str ='', drag_callback: Optional[Callable] ='', drop_callback: Optional[Callable] ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', filter_key: str ='', tracked: bool ='', track_offset: float ='', default_open: bool ='', open_on_double_click: bool ='', open_on_arrow: bool ='', leaf: bool ='', bullet: bool ='', selectable: bool ='', span_text_width: bool ='', span_full_width: bool ='', catch_nav_left: bool ='', lines: int ='') -> Union[int, str]: """Adds a tree node to add items to.""" ... -def add_value_registry(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='') -> Union[int, str]: +def add_value_registry(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='') -> Union[int, str]: """Adds a value registry.""" ... -def add_viewport_drawlist(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='', filter_key: str ='', front: bool ='') -> Union[int, str]: +def add_viewport_drawlist(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', show: bool ='', filter_key: str ='', front: bool ='') -> Union[int, str]: """A container that is used to present draw items or layers directly to the viewport. By default this will draw to the back of the viewport. Layers and draw items should be added to this widget as children.""" ... -def add_viewport_menu_bar(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', show: bool ='') -> Union[int, str]: +def add_viewport_menu_bar(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', indent: int ='', parent: Union[int, str] ='', show: bool ='') -> Union[int, str]: """Adds a menubar to the viewport.""" ... -def add_window(*, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', min_size: Union[List[int], Tuple[int, ...]] ='', max_size: Union[List[int], Tuple[int, ...]] ='', menubar: bool ='', collapsed: bool ='', autosize: bool ='', no_resize: bool ='', unsaved_document: bool ='', no_title_bar: bool ='', no_move: bool ='', no_scrollbar: bool ='', no_collapse: bool ='', horizontal_scrollbar: bool ='', no_focus_on_appearing: bool ='', no_bring_to_front_on_focus: bool ='', no_close: bool ='', no_background: bool ='', modal: bool ='', popup: bool ='', no_saved_settings: bool ='', no_open_over_existing_popup: bool ='', no_scroll_with_mouse: bool ='', no_docking: bool ='', copy_contents_shortcut: bool ='', on_close: Callable ='') -> Union[int, str]: +def add_window(*, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', width: int ='', height: int ='', indent: int ='', show: bool ='', pos: Union[List[int], Tuple[int, ...]] ='', min_size: Union[List[int], Tuple[int, ...]] ='', max_size: Union[List[int], Tuple[int, ...]] ='', menubar: bool ='', collapsed: bool ='', autosize: bool ='', no_resize: bool ='', unsaved_document: bool ='', no_title_bar: bool ='', no_move: bool ='', no_scrollbar: bool ='', no_collapse: bool ='', horizontal_scrollbar: bool ='', no_focus_on_appearing: bool ='', no_bring_to_front_on_focus: bool ='', no_close: bool ='', no_background: bool ='', modal: bool ='', popup: bool ='', no_saved_settings: bool ='', no_open_over_existing_popup: bool ='', no_scroll_with_mouse: bool ='', no_docking: bool ='', copy_contents_shortcut: bool ='', on_close: Optional[Callable] ='') -> Union[int, str]: """Creates a new window for following items to be added to.""" ... @@ -655,7 +655,7 @@ def bind_theme(theme : Union[int, str]) -> None: """Binds a global theme.""" ... -def capture_next_item(callback : Callable, *, user_data: Any ='') -> None: +def capture_next_item(callback : Optional[Callable], *, user_data: Any ='') -> None: """Captures the next item.""" ... @@ -731,59 +731,59 @@ def does_item_exist(item : Union[int, str]) -> bool: """Checks if an item exist..""" ... -def draw_arrow(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', size: int ='') -> Union[int, str]: +def draw_arrow(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', size: int ='') -> Union[int, str]: """Adds an arrow.""" ... -def draw_bezier_cubic(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], p4 : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', segments: int ='') -> Union[int, str]: +def draw_bezier_cubic(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], p4 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', segments: int ='') -> Union[int, str]: """Adds a cubic bezier curve.""" ... -def draw_bezier_quadratic(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', segments: int ='') -> Union[int, str]: +def draw_bezier_quadratic(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', segments: int ='') -> Union[int, str]: """Adds a quadratic bezier curve.""" ... -def draw_circle(center : Union[List[float], Tuple[float, ...]], radius : float, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', fill: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', segments: int ='') -> Union[int, str]: +def draw_circle(center : Union[List[float], Tuple[float, ...]], radius : float, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', fill: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', segments: int ='') -> Union[int, str]: """Adds a circle""" ... -def draw_ellipse(pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', fill: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', segments: int ='') -> Union[int, str]: +def draw_ellipse(pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', fill: Union[List[int], Tuple[int, ...]] ='', thickness: float ='', segments: int ='') -> Union[int, str]: """Adds an ellipse.""" ... -def draw_image(texture_tag : Union[int, str], pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', uv_min: Union[List[float], Tuple[float, ...]] ='', uv_max: Union[List[float], Tuple[float, ...]] ='', color: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: +def draw_image(texture_tag : Union[int, str], pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', uv_min: Union[List[float], Tuple[float, ...]] ='', uv_max: Union[List[float], Tuple[float, ...]] ='', color: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: """Adds an image (for a drawing).""" ... -def draw_image_quad(texture_tag : Union[int, str], p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], p4 : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', uv1: Union[List[float], Tuple[float, ...]] ='', uv2: Union[List[float], Tuple[float, ...]] ='', uv3: Union[List[float], Tuple[float, ...]] ='', uv4: Union[List[float], Tuple[float, ...]] ='', color: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: +def draw_image_quad(texture_tag : Union[int, str], p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], p4 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', uv1: Union[List[float], Tuple[float, ...]] ='', uv2: Union[List[float], Tuple[float, ...]] ='', uv3: Union[List[float], Tuple[float, ...]] ='', uv4: Union[List[float], Tuple[float, ...]] ='', color: Union[List[int], Tuple[int, ...]] ='') -> Union[int, str]: """Adds an image (for a drawing).""" ... -def draw_line(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='') -> Union[int, str]: +def draw_line(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='') -> Union[int, str]: """Adds a line.""" ... -def draw_polygon(points : List[List[float]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', fill: Union[List[int], Tuple[int, ...]] ='', thickness: float ='') -> Union[int, str]: +def draw_polygon(points : List[List[float]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', fill: Union[List[int], Tuple[int, ...]] ='', thickness: float ='') -> Union[int, str]: """Adds a polygon.""" ... -def draw_polyline(points : List[List[float]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', closed: bool ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='') -> Union[int, str]: +def draw_polyline(points : List[List[float]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', closed: bool ='', color: Union[List[int], Tuple[int, ...]] ='', thickness: float ='') -> Union[int, str]: """Adds a polyline.""" ... -def draw_quad(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], p4 : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', fill: Union[List[int], Tuple[int, ...]] ='', thickness: float ='') -> Union[int, str]: +def draw_quad(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], p4 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', fill: Union[List[int], Tuple[int, ...]] ='', thickness: float ='') -> Union[int, str]: """Adds a quad.""" ... -def draw_rectangle(pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', fill: Union[List[int], Tuple[int, ...]] ='', multicolor: bool ='', rounding: float ='', thickness: float ='', corner_colors: Any ='') -> Union[int, str]: +def draw_rectangle(pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', fill: Union[List[int], Tuple[int, ...]] ='', multicolor: bool ='', rounding: float ='', thickness: float ='', corner_colors: Any ='') -> Union[int, str]: """Adds a rectangle.""" ... -def draw_text(pos : Union[List[float], Tuple[float, ...]], text : str, *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', size: float ='') -> Union[int, str]: +def draw_text(pos : Union[List[float], Tuple[float, ...]], text : str, *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', size: float ='') -> Union[int, str]: """Adds text (drawlist).""" ... -def draw_triangle(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], *, label: str ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', fill: Union[List[int], Tuple[int, ...]] ='', thickness: float ='') -> Union[int, str]: +def draw_triangle(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] ='', user_data: Any ='', use_internal_label: bool ='', tag: Union[int, str] ='', parent: Union[int, str] ='', before: Union[int, str] ='', show: bool ='', color: Union[List[int], Tuple[int, ...]] ='', fill: Union[List[int], Tuple[int, ...]] ='', thickness: float ='') -> Union[int, str]: """Adds a triangle.""" ... @@ -1059,7 +1059,7 @@ def move_item_up(item : Union[int, str]) -> None: """Moves an item up.""" ... -def output_frame_buffer(file : str ='', *, callback: Callable ='') -> Any: +def output_frame_buffer(file : str ='', *, callback: Optional[Callable] ='') -> Any: """Outputs frame buffer as a png if file is specified or through the second argument of a callback if specified. Render loop must have been started.""" ... @@ -1139,11 +1139,11 @@ def set_clipboard_text(text : str) -> None: """New in 1.3. Sets the clipboard text.""" ... -def set_exit_callback(callback : Callable, *, user_data: Any ='') -> str: +def set_exit_callback(callback : Optional[Callable], *, user_data: Any ='') -> str: """Sets a callback to run on last frame.""" ... -def set_frame_callback(frame : int, callback : Callable, *, user_data: Any ='') -> str: +def set_frame_callback(frame : int, callback : Optional[Callable], *, user_data: Any ='') -> str: """Sets a callback to run on first frame.""" ... @@ -1171,7 +1171,7 @@ def set_value(item : Union[int, str], value : Any) -> None: """Set's an item's value.""" ... -def set_viewport_resize_callback(callback : Callable, *, user_data: Any ='') -> str: +def set_viewport_resize_callback(callback : Optional[Callable], *, user_data: Any ='') -> str: """Sets a callback to run on viewport resize.""" ... diff --git a/dearpygui/_dearpygui_RTD.py b/dearpygui/_dearpygui_RTD.py index 2cd741717..ab4056e7e 100644 --- a/dearpygui/_dearpygui_RTD.py +++ b/dearpygui/_dearpygui_RTD.py @@ -14,7 +14,7 @@ # * Discussions: https://github.com/hoffstadt/DearPyGui/discussions ########################################################## -from typing import List, Any, Callable, Union, Tuple +from typing import List, Any, Callable, Union, Tuple, Iterator, Optional from contextlib import contextmanager import warnings import functools @@ -98,7 +98,7 @@ def start_dearpygui(): raise RuntimeError("Viewport was not created and shown.") while(internal_dpg.is_dearpygui_running()): - internal_dpg.render_dearpygui_frame() + internal_dpg.render_dearpygui_frame() @contextmanager @@ -111,12 +111,12 @@ def mutex(): @contextmanager -def popup(parent: Union[int, str], mousebutton: int = internal_dpg.mvMouseButton_Right, modal: bool=False, tag:Union[int, str]=0, min_size:Union[List[int], Tuple[int, ...]]=[100,100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], no_move: bool=False, no_background: bool=False) -> int: +def popup(parent: Union[int, str], mousebutton: int = internal_dpg.mvMouseButton_Right, modal: bool=False, tag:Union[int, str]=0, min_size:Union[List[int], Tuple[int, ...]]=[100,100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], no_move: bool=False, no_background: bool=False) -> Iterator[Union[int, str]]: """A window that will be displayed when a parent item is hovered and the corresponding mouse button has been clicked. By default a popup will shrink fit the items it contains. This is useful for context windows, and simple modal window popups. When popups are used a modal they have more avaliable settings (i.e. title, resize, width, height) These - can be set by using configure item. - This is a light wrapper over window. For more control over a modal|popup window use a normal window with the modal|popup keyword + can be set by using configure item. + This is a light wrapper over window. For more control over a modal|popup window use a normal window with the modal|popup keyword and set the item handler and mouse events manually. Args: @@ -1312,7 +1312,7 @@ def staging_container(**kwargs): @deprecated("Use: add_spacer(...)") def add_spacing(**kwargs): - """ (deprecated function) Adds vertical spacing. + """ (deprecated function) Adds vertical spacing. Args: label (str, optional): Overrides 'name' as label. @@ -1380,10 +1380,10 @@ def add_same_line(**kwargs): @deprecated("Use: `get_plot_query_rects()`") def is_plot_queried(plot: Union[int, str], **kwargs): - """ (deprecated function) Returns true if the plot is currently being queried. + """ (deprecated function) Returns true if the plot is currently being queried. Args: - plot (Union[int, str]): + plot (Union[int, str]): Returns: bool """ @@ -1395,7 +1395,7 @@ def get_plot_query_area(plot: Union[int, str], **kwargs): """ (deprecated function) Returns the last/current query area of the plot. If no area is available [0, 0, 0, 0] will be returned. Args: - plot (Union[int, str]): + plot (Union[int, str]): Returns: Union[List[float], Tuple[float, ...]] """ @@ -1410,7 +1410,7 @@ def add_hline_series(x, **kwargs): """ (deprecated function) Adds an infinite horizontal line series to a plot. Args: - x (Any): + x (Any): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). @@ -1425,14 +1425,14 @@ def add_hline_series(x, **kwargs): """ return internal_dpg.add_inf_line_series(x, **kwargs, horizontal=True) - + @deprecated("Use: `add_inf_line_series()`") def add_vline_series(x, **kwargs): """ (deprecated function) Adds an infinite vertical line series to a plot. Args: - x (Any): + x (Any): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). @@ -1547,52 +1547,52 @@ def set_start_callback(callback): return internal_dpg.set_frame_callback(3, callback) @deprecated("This call is a no-op because character ranges are now automatic") -def add_font_chars(chars : Union[List[int], Tuple[int, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_font_chars(chars : Union[List[int], Tuple[int, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: """ (deprecated function) Adds specific font characters to a font. Args: - chars (Union[List[int], Tuple[int, ...]]): + chars (Union[List[int], Tuple[int, ...]]): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - id (Union[int, str], optional): (deprecated) + id (Union[int, str], optional): (deprecated) Returns: Union[int, str] """ pass @deprecated("This call is a no-op because character ranges are now automatic") -def add_font_range(first_char : int, last_char : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_font_range(first_char : int, last_char : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: """ (deprecated function) Adds a range of font characters to a font. Args: - first_char (int): - last_char (int): + first_char (int): + last_char (int): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - id (Union[int, str], optional): (deprecated) + id (Union[int, str], optional): (deprecated) Returns: Union[int, str] """ pass @deprecated("This call is a no-op because character ranges are now automatic") -def add_font_range_hint(hint : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_font_range_hint(hint : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: """ (deprecated function) Adds a range of font characters (mvFontRangeHint_ constants). Args: - hint (int): + hint (int): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - id (Union[int, str], optional): (deprecated) + id (Union[int, str], optional): (deprecated) Returns: Union[int, str] """ @@ -1608,7 +1608,7 @@ def child_window(**kwargs): """ Adds an embedded child window. Will show scrollbars when items do not fit. About using auto_resize/resizable flags: size measurement for a given axis is only performed when the child window is within visible boundaries, or is just appearing and it won't update its auto-size while clipped. While not perfect, it is a better default behavior as the always-on performance gain is more valuable than the occasional 'resizing after becoming visible again' glitch. You may also use always_auto_resize to force an update even when child window is not in view. However doing so will degrade performance. Remember that combining both auto_resize_x and auto_resize_y defeats purpose of a scrolling region and is NOT recommended. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1618,7 +1618,7 @@ def child_window(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -1656,7 +1656,7 @@ def clipper(**kwargs): """ Helper to manually clip large list of items. Increases performance by not searching or drawing widgets outside of the clipped region. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1682,7 +1682,7 @@ def collapsing_header(**kwargs): """ Adds a collapsing header to add items to. Must be closed with the end command. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1690,8 +1690,8 @@ def collapsing_header(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -1720,7 +1720,7 @@ def colormap_registry(**kwargs): """ Adds a colormap registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1744,14 +1744,14 @@ def custom_series(x, y, channel_count, **kwargs): x (Any): y (Any): channel_count (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. y1 (Any, optional): y2 (Any, optional): @@ -1774,7 +1774,7 @@ def drag_payload(**kwargs): """ User data payload for drag and drop operations. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1799,7 +1799,7 @@ def draw_layer(**kwargs): """ New in 1.1. Creates a layer useful for grouping drawlist items. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1825,7 +1825,7 @@ def draw_node(**kwargs): """ New in 1.1. Creates a drawing node to associate a transformation matrix. Child node matricies will concatenate. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1850,13 +1850,13 @@ def drawlist(width, height, **kwargs): Args: width (int): height (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -1879,13 +1879,13 @@ def file_dialog(**kwargs): """ Displays a file or directory selector depending on keywords. Displays a file dialog by default. Callback will be ran when the file or directory picker is closed. The app_data arguemnt will be populated with information related to the file and directory as a dictionary. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. width (int, optional): Width of the item. height (int, optional): Height of the item. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. default_path (str, optional): Path that the file dialog will default to when opened. default_filename (str, optional): Default name that will show in the file name input. @@ -1894,7 +1894,7 @@ def file_dialog(**kwargs): directory_selector (bool, optional): Shows only directory/paths as options. Allows selection of directory/paths only. min_size (Union[List[int], Tuple[int, ...]], optional): Minimum window size. max_size (Union[List[int], Tuple[int, ...]], optional): Maximum window size. - cancel_callback (Callable, optional): Callback called when cancel button is clicked. + cancel_callback (Optional[Callable], optional): Callback called when cancel button is clicked. id (Union[int, str], optional): (deprecated) Yields: Union[int, str] @@ -1911,7 +1911,7 @@ def filter_set(**kwargs): """ Helper to parse and apply text filters (e.g. aaaaa[, bbbbb][, ccccc]) Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1939,7 +1939,7 @@ def font(file, size, **kwargs): Args: file (str): size (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1963,7 +1963,7 @@ def font_registry(**kwargs): """ Adds a font registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1985,7 +1985,7 @@ def group(**kwargs): Enable property acts in a special way enabling/disabling everything inside the group. (Use mvStyleVar_DisabledAlpha to edit colors within the disabled group.) Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1995,8 +1995,8 @@ def group(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -2023,7 +2023,7 @@ def handler_registry(**kwargs): """ Adds a handler registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2044,7 +2044,7 @@ def item_handler_registry(**kwargs): """ Adds an item handler registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2065,7 +2065,7 @@ def menu(**kwargs): """ Adds a menu to an existing menu bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2073,7 +2073,7 @@ def menu(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. filter_key (str, optional): Used by filter widget. @@ -2096,7 +2096,7 @@ def menu_bar(**kwargs): """ Adds a menu bar to a window. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2120,15 +2120,15 @@ def node(**kwargs): """ Adds a node to a node editor. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2152,7 +2152,7 @@ def node_attribute(**kwargs): """ Adds a node attribute to a node. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2182,7 +2182,7 @@ def node_editor(**kwargs): """ Adds a node editor. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2190,12 +2190,12 @@ def node_editor(**kwargs): height (int, optional): Height of the item. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. filter_key (str, optional): Used by filter widget. tracked (bool, optional): Scroll tracking track_offset (float, optional): 0.0f:top, 0.5f:center, 1.0f:bottom - delink_callback (Callable, optional): Callback ran when a link is detached. + delink_callback (Optional[Callable], optional): Callback ran when a link is detached. menubar (bool, optional): Shows or hides the menubar. minimap (bool, optional): Shows or hides the Minimap. New in 1.6. minimap_location (int, optional): mvNodeMiniMap_Location_* constants. New in 1.6. @@ -2216,7 +2216,7 @@ def plot(**kwargs): """ Adds a plot which is used to hold series, and can be drawn to with draw commands. For all _mod parameters use mvKey_ModX enums, or mvKey_ModDisabled to disable the modifier. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2226,9 +2226,9 @@ def plot(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2261,7 +2261,7 @@ def plot(**kwargs): vertical_mod (int, optional): expands active box selection/query vertically to plot edge when held override_mod (int, optional): when held, all input is ignored; used to enable axis/plots as DND sources zoom_mod (int, optional): optional modifier that must be held for scroll wheel zooming - zoom_rate (int, optional): zoom rate for scroll (e.g. 0.1f = 10% plot range every scroll click); make negative to invert + zoom_rate (float, optional): zoom rate for scroll (e.g. 0.1f = 10% plot range every scroll click); make negative to invert id (Union[int, str], optional): (deprecated) delay_search (bool, optional): (deprecated)This was used as an optimization hint but is not relevant anymore. no_highlight (bool, optional): (deprecated)Removed because not supported from the backend anymore. To control the highlighting of series use the same argument in `add_plot_legend` @@ -2285,13 +2285,13 @@ def plot_axis(axis, **kwargs): Args: axis (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. no_label (bool, optional): the axis label will not be displayed no_gridlines (bool, optional): no grid lines will be displayed @@ -2329,7 +2329,7 @@ def stage(**kwargs): """ Adds a stage. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2351,7 +2351,7 @@ def subplots(rows, columns, **kwargs): Args: rows (int): columns (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2360,7 +2360,7 @@ def subplots(rows, columns, **kwargs): indent (int, optional): Offsets the widget to the right the specified number multiplied by the indent style. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2395,7 +2395,7 @@ def synced_tables(**kwargs): """ Links all tables that are immediate children of this container so that they share their state (mostly column sizes). Other children are rendered as is. This is an experimental feature, use with caution. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2419,7 +2419,7 @@ def tab(**kwargs): """ Adds a tab to a tab bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2427,7 +2427,7 @@ def tab(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. filter_key (str, optional): Used by filter widget. tracked (bool, optional): Scroll tracking @@ -2455,14 +2455,14 @@ def tab_bar(**kwargs): """ Adds a tab bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. indent (int, optional): Offsets the widget to the right the specified number multiplied by the indent style. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2491,7 +2491,7 @@ def table(**kwargs): """ Adds a table. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2501,7 +2501,7 @@ def table(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2551,7 +2551,7 @@ def table_cell(**kwargs): """ Adds a table. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2576,7 +2576,7 @@ def table_row(**kwargs): """ Adds a table row. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2601,7 +2601,7 @@ def template_registry(**kwargs): """ Adds a template registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2621,7 +2621,7 @@ def texture_registry(**kwargs): """ Adds a dynamic texture. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2642,7 +2642,7 @@ def theme(**kwargs): """ Adds a theme. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2664,7 +2664,7 @@ def theme_component(item_type=0, **kwargs): Args: item_type (int, optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2688,7 +2688,7 @@ def tooltip(parent, **kwargs): Args: parent (Union[int, str]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2711,7 +2711,7 @@ def tree_node(**kwargs): """ Adds a tree node to add items to. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2719,8 +2719,8 @@ def tree_node(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2753,7 +2753,7 @@ def value_registry(**kwargs): """ Adds a value registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2773,7 +2773,7 @@ def viewport_drawlist(**kwargs): """ A container that is used to present draw items or layers directly to the viewport. By default this will draw to the back of the viewport. Layers and draw items should be added to this widget as children. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2797,7 +2797,7 @@ def viewport_menu_bar(**kwargs): """ Adds a menubar to the viewport. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2821,7 +2821,7 @@ def window(**kwargs): """ Creates a new window for following items to be added to. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2853,7 +2853,7 @@ def window(**kwargs): no_scroll_with_mouse (bool, optional): Disable user vertically scrolling with mouse wheel. no_docking (bool, optional): Disable docking of this window copy_contents_shortcut (bool, optional): Experimental. If True, window contents can be copied to clipboard by pressing Ctrl+C. Might be useful for message boxes. - on_close (Callable, optional): Callback ran when window is closed. + on_close (Optional[Callable], optional): Callback ran when window is closed. id (Union[int, str], optional): (deprecated) delay_search (bool, optional): (deprecated)This was used as an optimization hint but is not relevant anymore. Yields: @@ -2876,7 +2876,7 @@ def add_2d_histogram_series(x, y, **kwargs): Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2904,7 +2904,7 @@ def add_3d_slider(**kwargs): """ Adds a 3D box slider. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2915,9 +2915,9 @@ def add_3d_slider(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2956,7 +2956,7 @@ def add_area_series(x, y, **kwargs): Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2977,7 +2977,7 @@ def add_axis_tag(**kwargs): """ Adds custom labels to axes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3002,7 +3002,7 @@ def add_bar_group_series(values, label_ids, group_size, **kwargs): values (Any): label_ids (Union[List[str], Tuple[str, ...]]): Label of each bar in a group group_size (int): Number of bars in a group - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3027,7 +3027,7 @@ def add_bar_series(x, y, **kwargs): Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3048,7 +3048,7 @@ def add_bool_value(**kwargs): """ Adds a bool value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3066,7 +3066,7 @@ def add_button(**kwargs): """ Adds a button. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3076,9 +3076,9 @@ def add_button(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3105,7 +3105,7 @@ def add_candle_series(dates, opens, closes, lows, highs, **kwargs): closes (Any): lows (Any): highs (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3131,7 +3131,7 @@ def add_char_remap(source, target, **kwargs): Args: source (int): target (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3147,7 +3147,7 @@ def add_checkbox(**kwargs): """ Adds a checkbox. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3156,9 +3156,9 @@ def add_checkbox(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3177,7 +3177,7 @@ def add_child_window(**kwargs): """ Adds an embedded child window. Will show scrollbars when items do not fit. About using auto_resize/resizable flags: size measurement for a given axis is only performed when the child window is within visible boundaries, or is just appearing and it won't update its auto-size while clipped. While not perfect, it is a better default behavior as the always-on performance gain is more valuable than the occasional 'resizing after becoming visible again' glitch. You may also use always_auto_resize to force an update even when child window is not in view. However doing so will degrade performance. Remember that combining both auto_resize_x and auto_resize_y defeats purpose of a scrolling region and is NOT recommended. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3187,7 +3187,7 @@ def add_child_window(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -3220,7 +3220,7 @@ def add_clipper(**kwargs): """ Helper to manually clip large list of items. Increases performance by not searching or drawing widgets outside of the clipped region. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3241,7 +3241,7 @@ def add_collapsing_header(**kwargs): """ Adds a collapsing header to add items to. Must be closed with the end command. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3249,8 +3249,8 @@ def add_collapsing_header(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -3275,7 +3275,7 @@ def add_color_button(default_value=(0, 0, 0, 255), **kwargs): Args: default_value (Union[List[int], Tuple[int, ...]], optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3285,9 +3285,9 @@ def add_color_button(default_value=(0, 0, 0, 255), **kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3311,7 +3311,7 @@ def add_color_edit(default_value=(0, 0, 0, 255), **kwargs): Args: default_value (Union[List[int], Tuple[int, ...]], optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3322,9 +3322,9 @@ def add_color_edit(default_value=(0, 0, 0, 255), **kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3356,7 +3356,7 @@ def add_color_picker(default_value=(0, 0, 0, 255), **kwargs): Args: default_value (Union[List[int], Tuple[int, ...]], optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3367,9 +3367,9 @@ def add_color_picker(default_value=(0, 0, 0, 255), **kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3401,7 +3401,7 @@ def add_color_value(**kwargs): """ Adds a color value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3421,7 +3421,7 @@ def add_colormap(colors, qualitative, **kwargs): Args: colors (Any): colors that will be mapped to the normalized value 0.0->1.0 qualitative (bool): Qualitative will create hard transitions for color boundries across the value range when enabled. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3439,7 +3439,7 @@ def add_colormap_button(default_value=(0, 0, 0, 255), **kwargs): Args: default_value (Union[List[int], Tuple[int, ...]], optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3449,9 +3449,9 @@ def add_colormap_button(default_value=(0, 0, 0, 255), **kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3469,7 +3469,7 @@ def add_colormap_registry(**kwargs): """ Adds a colormap registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3485,7 +3485,7 @@ def add_colormap_scale(**kwargs): """ Adds a legend that pairs values with colors. This is typically used with a heat series. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3496,7 +3496,7 @@ def add_colormap_scale(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. colormap (Union[int, str], optional): mvPlotColormap_* constants or mvColorMap uuid from a color map registry @@ -3506,7 +3506,7 @@ def add_colormap_scale(**kwargs): reverse_dir (bool, optional): invert the colormap bar and axis scale (this only affects rendering; if you only want to reverse the scale mapping, make scale_min > scale_max) mirror (bool, optional): render the colormap label and tick labels on the opposite side id (Union[int, str], optional): (deprecated) - drag_callback (Callable, optional): (deprecated) + drag_callback (Optional[Callable], optional): (deprecated) Returns: Union[int, str] """ @@ -3517,7 +3517,7 @@ def add_colormap_slider(**kwargs): """ Adds a color slider that a color map can be bound to. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3527,8 +3527,8 @@ def add_colormap_slider(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -3536,7 +3536,7 @@ def add_colormap_slider(**kwargs): track_offset (float, optional): 0.0f:top, 0.5f:center, 1.0f:bottom default_value (float, optional): id (Union[int, str], optional): (deprecated) - drag_callback (Callable, optional): (deprecated) + drag_callback (Optional[Callable], optional): (deprecated) Returns: Union[int, str] """ @@ -3548,7 +3548,7 @@ def add_combo(items=(), **kwargs): Args: items (Union[List[str], Tuple[str, ...]], optional): A tuple of items to be shown in the drop down window. Can consist of any combination of types but will convert all items to strings to be shown. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3558,9 +3558,9 @@ def add_combo(items=(), **kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3587,14 +3587,14 @@ def add_custom_series(x, y, channel_count, **kwargs): x (Any): y (Any): channel_count (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. y1 (Any, optional): y2 (Any, optional): @@ -3612,7 +3612,7 @@ def add_date_picker(**kwargs): """ Adds a date picker. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3620,9 +3620,9 @@ def add_date_picker(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -3643,7 +3643,7 @@ def add_digital_series(x, y, **kwargs): Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3662,7 +3662,7 @@ def add_double4_value(**kwargs): """ Adds a double value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3680,7 +3680,7 @@ def add_double_value(**kwargs): """ Adds a double value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3698,7 +3698,7 @@ def add_drag_double(**kwargs): """ Adds drag for a single double value. Useful when drag float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3708,9 +3708,9 @@ def add_drag_double(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3735,7 +3735,7 @@ def add_drag_doublex(**kwargs): """ Adds drag input for a set of double values up to 4. Useful when drag float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3745,9 +3745,9 @@ def add_drag_doublex(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3773,7 +3773,7 @@ def add_drag_float(**kwargs): """ Adds drag for a single float value. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3783,9 +3783,9 @@ def add_drag_float(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3810,7 +3810,7 @@ def add_drag_floatx(**kwargs): """ Adds drag input for a set of float values up to 4. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3820,9 +3820,9 @@ def add_drag_floatx(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3848,7 +3848,7 @@ def add_drag_int(**kwargs): """ Adds drag for a single int value. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3858,9 +3858,9 @@ def add_drag_int(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3885,7 +3885,7 @@ def add_drag_intx(**kwargs): """ Adds drag input for a set of int values up to 4. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3895,9 +3895,9 @@ def add_drag_intx(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3923,14 +3923,14 @@ def add_drag_line(**kwargs): """ Adds a drag line to a plot. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. default_value (float, optional): color (Union[List[int], Tuple[int, ...]], optional): @@ -3952,7 +3952,7 @@ def add_drag_payload(**kwargs): """ User data payload for drag and drop operations. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3972,14 +3972,14 @@ def add_drag_point(**kwargs): """ Adds a drag point to a plot. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. default_value (Any, optional): color (Union[List[int], Tuple[int, ...]], optional): @@ -4002,14 +4002,14 @@ def add_drag_rect(**kwargs): """ Adds a drag rectangle to a plot. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. default_value (Any, optional): The coordinates are specified in a sequence of: (xmin, ymin, xmax, ymax) color (Union[List[int], Tuple[int, ...]], optional): @@ -4028,7 +4028,7 @@ def add_draw_layer(**kwargs): """ New in 1.1. Creates a layer useful for grouping drawlist items. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4049,7 +4049,7 @@ def add_draw_node(**kwargs): """ New in 1.1. Creates a drawing node to associate a transformation matrix. Child node matricies will concatenate. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4069,13 +4069,13 @@ def add_drawlist(width, height, **kwargs): Args: width (int): height (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -4096,7 +4096,7 @@ def add_dynamic_texture(width, height, default_value, **kwargs): width (int): height (int): default_value (Union[List[float], Tuple[float, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4116,7 +4116,7 @@ def add_error_series(x, y, negative, positive, **kwargs): y (Any): negative (Any): positive (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4137,13 +4137,13 @@ def add_file_dialog(**kwargs): """ Displays a file or directory selector depending on keywords. Displays a file dialog by default. Callback will be ran when the file or directory picker is closed. The app_data arguemnt will be populated with information related to the file and directory as a dictionary. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. width (int, optional): Width of the item. height (int, optional): Height of the item. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. default_path (str, optional): Path that the file dialog will default to when opened. default_filename (str, optional): Default name that will show in the file name input. @@ -4152,7 +4152,7 @@ def add_file_dialog(**kwargs): directory_selector (bool, optional): Shows only directory/paths as options. Allows selection of directory/paths only. min_size (Union[List[int], Tuple[int, ...]], optional): Minimum window size. max_size (Union[List[int], Tuple[int, ...]], optional): Maximum window size. - cancel_callback (Callable, optional): Callback called when cancel button is clicked. + cancel_callback (Optional[Callable], optional): Callback called when cancel button is clicked. id (Union[int, str], optional): (deprecated) Returns: Union[int, str] @@ -4165,7 +4165,7 @@ def add_file_extension(extension, **kwargs): Args: extension (str): Extension that will show as an when the parent is a file dialog. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4186,7 +4186,7 @@ def add_filter_set(**kwargs): """ Helper to parse and apply text filters (e.g. aaaaa[, bbbbb][, ccccc]) Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4207,7 +4207,7 @@ def add_float4_value(**kwargs): """ Adds a float4 value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4225,7 +4225,7 @@ def add_float_value(**kwargs): """ Adds a float value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4243,7 +4243,7 @@ def add_float_vect_value(**kwargs): """ Adds a float vect value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4263,7 +4263,7 @@ def add_font(file, size, **kwargs): Args: file (str): size (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4282,7 +4282,7 @@ def add_font_registry(**kwargs): """ Adds a font registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4299,7 +4299,7 @@ def add_group(**kwargs): Enable property acts in a special way enabling/disabling everything inside the group. (Use mvStyleVar_DisabledAlpha to edit colors within the disabled group.) Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4309,8 +4309,8 @@ def add_group(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4332,7 +4332,7 @@ def add_handler_registry(**kwargs): """ Adds a handler registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4351,7 +4351,7 @@ def add_heat_series(x, rows, cols, **kwargs): x (Any): rows (int): cols (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4378,7 +4378,7 @@ def add_histogram_series(x, **kwargs): Args: x (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4408,7 +4408,7 @@ def add_image(texture_tag, **kwargs): Args: texture_tag (Union[int, str]): The texture_tag should come from a texture that was added to a texture registry. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4419,8 +4419,8 @@ def add_image(texture_tag, **kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -4442,7 +4442,7 @@ def add_image_button(texture_tag, **kwargs): Args: texture_tag (Union[int, str]): The texture_tag should come from a texture that was added to a texture registry. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4453,9 +4453,9 @@ def add_image_button(texture_tag, **kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4481,7 +4481,7 @@ def add_image_series(texture_tag, bounds_min, bounds_max, **kwargs): texture_tag (Union[int, str]): bounds_min (Any): bounds_max (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4504,7 +4504,7 @@ def add_inf_line_series(x, **kwargs): Args: x (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4524,7 +4524,7 @@ def add_input_double(**kwargs): """ Adds input for an double. Useful when input float is not accurate enough. +/- buttons can be activated by setting the value of step. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4534,9 +4534,9 @@ def add_input_double(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4566,7 +4566,7 @@ def add_input_doublex(**kwargs): """ Adds multi double input for up to 4 double values. Useful when input float mulit is not accurate enough. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4576,9 +4576,9 @@ def add_input_doublex(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4607,7 +4607,7 @@ def add_input_float(**kwargs): """ Adds input for an float. +/- buttons can be activated by setting the value of step. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4617,9 +4617,9 @@ def add_input_float(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4649,7 +4649,7 @@ def add_input_floatx(**kwargs): """ Adds multi float input for up to 4 float values. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4659,9 +4659,9 @@ def add_input_floatx(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4690,7 +4690,7 @@ def add_input_int(**kwargs): """ Adds input for an int. +/- buttons can be activated by setting the value of step. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4700,9 +4700,9 @@ def add_input_int(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4731,7 +4731,7 @@ def add_input_intx(**kwargs): """ Adds multi int input for up to 4 integer values. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4741,9 +4741,9 @@ def add_input_intx(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4771,7 +4771,7 @@ def add_input_text(**kwargs): """ Adds input for text. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4782,9 +4782,9 @@ def add_input_text(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4821,7 +4821,7 @@ def add_int4_value(**kwargs): """ Adds a int4 value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4839,7 +4839,7 @@ def add_int_value(**kwargs): """ Adds a int value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4857,12 +4857,12 @@ def add_item_activated_handler(**kwargs): """ Adds a activated handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -4875,12 +4875,12 @@ def add_item_active_handler(**kwargs): """ Adds a active handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -4894,12 +4894,12 @@ def add_item_clicked_handler(button=-1, **kwargs): Args: button (int, optional): Submits callback for all mouse buttons - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -4912,12 +4912,12 @@ def add_item_deactivated_after_edit_handler(**kwargs): """ Adds a deactivated after edit handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -4930,12 +4930,12 @@ def add_item_deactivated_handler(**kwargs): """ Adds a deactivated handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -4949,12 +4949,12 @@ def add_item_double_clicked_handler(button=-1, **kwargs): Args: button (int, optional): Submits callback for all mouse buttons - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -4967,12 +4967,12 @@ def add_item_edited_handler(**kwargs): """ Adds an edited handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -4985,12 +4985,12 @@ def add_item_focus_handler(**kwargs): """ Adds a focus handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. event_type (int, optional): What kind of events to track: just got focus (mvEventType_Enter), currently having focus (mvEventType_On), lost focus (mvEventType_Leave). Can be a combination of these flags. Defaults to mvEventType_On. id (Union[int, str], optional): (deprecated) @@ -5004,7 +5004,7 @@ def add_item_handler_registry(**kwargs): """ Adds an item handler registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5020,12 +5020,12 @@ def add_item_hover_handler(**kwargs): """ Adds a hover handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. event_type (int, optional): What kind of events to track: mouse-in (mvEventType_Enter), mouse-over (mvEventType_On), mouse-out (mvEventType_Leave). Can be a combination of these flags. Defaults to mouse-over. id (Union[int, str], optional): (deprecated) @@ -5039,12 +5039,12 @@ def add_item_resize_handler(**kwargs): """ Adds a resize handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5057,12 +5057,12 @@ def add_item_scroll_handler(**kwargs): """ Adds a scroll handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5075,12 +5075,12 @@ def add_item_toggled_open_handler(**kwargs): """ Adds a togged open handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. two_way (bool, optional): Trigger on both 'opened' and 'closed' events, i.e. when the 'opened' state is toggled between the two values. If False, some containers will trigger it only on the 'opened' event. id (Union[int, str], optional): (deprecated) @@ -5094,12 +5094,12 @@ def add_item_visible_handler(**kwargs): """ Adds a visible handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5113,11 +5113,11 @@ def add_key_down_handler(key=internal_dpg.mvKey_None, **kwargs): Args: key (int, optional): Submits callback for all keys - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5132,11 +5132,11 @@ def add_key_press_handler(key=internal_dpg.mvKey_None, **kwargs): Args: key (int, optional): Submits callback for all keys - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5151,11 +5151,11 @@ def add_key_release_handler(key=internal_dpg.mvKey_None, **kwargs): Args: key (int, optional): Submits callback for all keys - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5169,7 +5169,7 @@ def add_knob_float(**kwargs): """ Adds a knob that rotates based on change in x mouse position. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5180,9 +5180,9 @@ def add_knob_float(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5205,7 +5205,7 @@ def add_line_series(x, y, **kwargs): Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5230,7 +5230,7 @@ def add_listbox(items=(), **kwargs): Args: items (Union[List[str], Tuple[str, ...]], optional): A tuple of items to be shown in the listbox. Can consist of any combination of types. All items will be displayed as strings. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5240,9 +5240,9 @@ def add_listbox(items=(), **kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5262,7 +5262,7 @@ def add_loading_indicator(**kwargs): """ Adds a rotating animated loading symbol. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5272,7 +5272,7 @@ def add_loading_indicator(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. style (int, optional): mvLoadInd_DottedCircle is rotating dots style, mvLoadInd_Ring is rotating bar style. @@ -5293,7 +5293,7 @@ def add_menu(**kwargs): """ Adds a menu to an existing menu bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5301,7 +5301,7 @@ def add_menu(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. filter_key (str, optional): Used by filter widget. @@ -5319,7 +5319,7 @@ def add_menu_bar(**kwargs): """ Adds a menu bar to a window. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5338,7 +5338,7 @@ def add_menu_item(**kwargs): """ Adds a menu item to an existing menu. Menu items act similar to selectables and has a bool value. When placed in a menu the checkmark will reflect its value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5346,8 +5346,8 @@ def add_menu_item(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. filter_key (str, optional): Used by filter widget. @@ -5357,7 +5357,7 @@ def add_menu_item(**kwargs): shortcut (str, optional): Displays text on the menu item. Typically used to show a shortcut key command. check (bool, optional): Displays a checkmark on the menu item when it is selected and placed in a menu. id (Union[int, str], optional): (deprecated) - drag_callback (Callable, optional): (deprecated) + drag_callback (Optional[Callable], optional): (deprecated) Returns: Union[int, str] """ @@ -5369,11 +5369,11 @@ def add_mouse_click_handler(button=-1, **kwargs): Args: button (int, optional): Submits callback for all mouse buttons - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5388,11 +5388,11 @@ def add_mouse_double_click_handler(button=-1, **kwargs): Args: button (int, optional): Submits callback for all mouse buttons - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5407,11 +5407,11 @@ def add_mouse_down_handler(button=-1, **kwargs): Args: button (int, optional): Submits callback for all mouse buttons - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5427,11 +5427,11 @@ def add_mouse_drag_handler(button=-1, threshold=10.0, **kwargs): Args: button (int, optional): Submits callback for all mouse buttons threshold (float, optional): The threshold the mouse must be dragged before the callback is ran - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5445,11 +5445,11 @@ def add_mouse_move_handler(**kwargs): """ Adds a mouse move handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5464,11 +5464,11 @@ def add_mouse_release_handler(button=-1, **kwargs): Args: button (int, optional): Submits callback for all mouse buttons - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5482,11 +5482,11 @@ def add_mouse_wheel_handler(**kwargs): """ Adds a mouse wheel handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5500,15 +5500,15 @@ def add_node(**kwargs): """ Adds a node to a node editor. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -5527,7 +5527,7 @@ def add_node_attribute(**kwargs): """ Adds a node attribute to a node. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5552,7 +5552,7 @@ def add_node_editor(**kwargs): """ Adds a node editor. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5560,12 +5560,12 @@ def add_node_editor(**kwargs): height (int, optional): Height of the item. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. filter_key (str, optional): Used by filter widget. tracked (bool, optional): Scroll tracking track_offset (float, optional): 0.0f:top, 0.5f:center, 1.0f:bottom - delink_callback (Callable, optional): Callback ran when a link is detached. + delink_callback (Optional[Callable], optional): Callback ran when a link is detached. menubar (bool, optional): Shows or hides the menubar. minimap (bool, optional): Shows or hides the Minimap. New in 1.6. minimap_location (int, optional): mvNodeMiniMap_Location_* constants. New in 1.6. @@ -5583,7 +5583,7 @@ def add_node_link(attr_1, attr_2, **kwargs): Args: attr_1 (Union[int, str]): attr_2 (Union[int, str]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5605,7 +5605,7 @@ def add_pie_series(x, y, radius, values, labels, **kwargs): radius (float): values (Any): labels (Union[List[str], Tuple[str, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5628,7 +5628,7 @@ def add_plot(**kwargs): """ Adds a plot which is used to hold series, and can be drawn to with draw commands. For all _mod parameters use mvKey_ModX enums, or mvKey_ModDisabled to disable the modifier. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5638,9 +5638,9 @@ def add_plot(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -5673,7 +5673,7 @@ def add_plot(**kwargs): vertical_mod (int, optional): expands active box selection/query vertically to plot edge when held override_mod (int, optional): when held, all input is ignored; used to enable axis/plots as DND sources zoom_mod (int, optional): optional modifier that must be held for scroll wheel zooming - zoom_rate (int, optional): zoom rate for scroll (e.g. 0.1f = 10% plot range every scroll click); make negative to invert + zoom_rate (float, optional): zoom rate for scroll (e.g. 0.1f = 10% plot range every scroll click); make negative to invert id (Union[int, str], optional): (deprecated) delay_search (bool, optional): (deprecated)This was used as an optimization hint but is not relevant anymore. no_highlight (bool, optional): (deprecated)Removed because not supported from the backend anymore. To control the highlighting of series use the same argument in `add_plot_legend` @@ -5691,7 +5691,7 @@ def add_plot_annotation(**kwargs): """ Adds an annotation to a plot. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5715,13 +5715,13 @@ def add_plot_axis(axis, **kwargs): Args: axis (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. no_label (bool, optional): the axis label will not be displayed no_gridlines (bool, optional): no grid lines will be displayed @@ -5754,13 +5754,13 @@ def add_plot_legend(**kwargs): """ Adds a plot legend to a plot. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. location (int, optional): location, mvPlot_Location_* horizontal (bool, optional): legend entries will be displayed horizontally @@ -5781,7 +5781,7 @@ def add_progress_bar(**kwargs): """ Adds a progress bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5792,8 +5792,8 @@ def add_progress_bar(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -5813,7 +5813,7 @@ def add_radio_button(items=(), **kwargs): Args: items (Union[List[str], Tuple[str, ...]], optional): A tuple of items to be shown as radio options. Can consist of any combination of types. All types will be shown as strings. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5822,9 +5822,9 @@ def add_radio_button(items=(), **kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5847,7 +5847,7 @@ def add_raw_texture(width, height, default_value, **kwargs): width (int): height (int): default_value (Union[List[float], Tuple[float, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5866,7 +5866,7 @@ def add_scatter_series(x, y, **kwargs): Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5886,7 +5886,7 @@ def add_selectable(**kwargs): """ Adds a selectable. Similar to a button but can indicate its selected state. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5897,9 +5897,9 @@ def add_selectable(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5921,7 +5921,7 @@ def add_separator(**kwargs): """ Adds a horizontal line separator. Use 'label' parameter to add text and mvStyleVar_SeparatorText* elements to style it. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5941,7 +5941,7 @@ def add_series_value(**kwargs): """ Adds a plot series value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5961,7 +5961,7 @@ def add_shade_series(x, y1, **kwargs): Args: x (Any): y1 (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5981,7 +5981,7 @@ def add_simple_plot(**kwargs): """ Adds a simple plot for visualization of a 1 dimensional set of values. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5992,8 +5992,8 @@ def add_simple_plot(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. filter_key (str, optional): Used by filter widget. tracked (bool, optional): Scroll tracking @@ -6015,7 +6015,7 @@ def add_slider_double(**kwargs): """ Adds slider for a single double value. Useful when slider float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6026,9 +6026,9 @@ def add_slider_double(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -6053,7 +6053,7 @@ def add_slider_doublex(**kwargs): """ Adds multi slider for up to 4 double values. Usueful for when multi slide float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6063,9 +6063,9 @@ def add_slider_doublex(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -6090,7 +6090,7 @@ def add_slider_float(**kwargs): """ Adds slider for a single float value. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6101,9 +6101,9 @@ def add_slider_float(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -6128,7 +6128,7 @@ def add_slider_floatx(**kwargs): """ Adds multi slider for up to 4 float values. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6138,9 +6138,9 @@ def add_slider_floatx(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -6165,7 +6165,7 @@ def add_slider_int(**kwargs): """ Adds slider for a single int value. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6176,9 +6176,9 @@ def add_slider_int(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -6203,7 +6203,7 @@ def add_slider_intx(**kwargs): """ Adds multi slider for up to 4 int values. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6213,9 +6213,9 @@ def add_slider_intx(**kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -6240,7 +6240,7 @@ def add_spacer(**kwargs): """ Adds a spacer item that can be used to help with layouts or can be used as a placeholder item. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6262,7 +6262,7 @@ def add_stage(**kwargs): """ Adds a stage. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6279,7 +6279,7 @@ def add_stair_series(x, y, **kwargs): Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6303,7 +6303,7 @@ def add_static_texture(width, height, default_value, **kwargs): width (int): height (int): default_value (Union[List[float], Tuple[float, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6321,7 +6321,7 @@ def add_stem_series(x, y, **kwargs): Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6342,7 +6342,7 @@ def add_string_value(**kwargs): """ Adds a string value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6362,7 +6362,7 @@ def add_subplots(rows, columns, **kwargs): Args: rows (int): columns (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6371,7 +6371,7 @@ def add_subplots(rows, columns, **kwargs): indent (int, optional): Offsets the widget to the right the specified number multiplied by the indent style. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -6401,7 +6401,7 @@ def add_synced_tables(**kwargs): """ Links all tables that are immediate children of this container so that they share their state (mostly column sizes). Other children are rendered as is. This is an experimental feature, use with caution. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6420,7 +6420,7 @@ def add_tab(**kwargs): """ Adds a tab to a tab bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6428,7 +6428,7 @@ def add_tab(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. filter_key (str, optional): Used by filter widget. tracked (bool, optional): Scroll tracking @@ -6451,14 +6451,14 @@ def add_tab_bar(**kwargs): """ Adds a tab bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. indent (int, optional): Offsets the widget to the right the specified number multiplied by the indent style. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -6482,7 +6482,7 @@ def add_tab_button(**kwargs): """ Adds a tab button to a tab bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6490,9 +6490,9 @@ def add_tab_button(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. filter_key (str, optional): Used by filter widget. tracked (bool, optional): Scroll tracking @@ -6513,7 +6513,7 @@ def add_table(**kwargs): """ Adds a table. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6523,7 +6523,7 @@ def add_table(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -6568,7 +6568,7 @@ def add_table_cell(**kwargs): """ Adds a table. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6588,7 +6588,7 @@ def add_table_column(**kwargs): """ Adds a table column. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6627,7 +6627,7 @@ def add_table_row(**kwargs): """ Adds a table row. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6647,7 +6647,7 @@ def add_template_registry(**kwargs): """ Adds a template registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6663,7 +6663,7 @@ def add_text(default_value='', **kwargs): Args: default_value (str, optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6672,8 +6672,8 @@ def add_text(default_value='', **kwargs): before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -6696,7 +6696,7 @@ def add_text_point(x, y, **kwargs): Args: x (float): y (float): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6719,7 +6719,7 @@ def add_texture_registry(**kwargs): """ Adds a dynamic texture. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6735,7 +6735,7 @@ def add_theme(**kwargs): """ Adds a theme. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6753,7 +6753,7 @@ def add_theme_color(target=0, value=(0, 0, 0, 255), **kwargs): Args: target (int, optional): value (Union[List[int], Tuple[int, ...]], optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6771,7 +6771,7 @@ def add_theme_component(item_type=0, **kwargs): Args: item_type (int, optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6792,7 +6792,7 @@ def add_theme_style(target=0, x=1.0, y=-1.0, **kwargs): target (int, optional): x (float, optional): y (float, optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6809,7 +6809,7 @@ def add_time_picker(**kwargs): """ Adds a time picker. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6817,9 +6817,9 @@ def add_time_picker(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -6839,7 +6839,7 @@ def add_tooltip(parent, **kwargs): Args: parent (Union[int, str]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6857,7 +6857,7 @@ def add_tree_node(**kwargs): """ Adds a tree node to add items to. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6865,8 +6865,8 @@ def add_tree_node(**kwargs): parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -6894,7 +6894,7 @@ def add_value_registry(**kwargs): """ Adds a value registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6909,7 +6909,7 @@ def add_viewport_drawlist(**kwargs): """ A container that is used to present draw items or layers directly to the viewport. By default this will draw to the back of the viewport. Layers and draw items should be added to this widget as children. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6928,7 +6928,7 @@ def add_viewport_menu_bar(**kwargs): """ Adds a menubar to the viewport. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6947,7 +6947,7 @@ def add_window(**kwargs): """ Creates a new window for following items to be added to. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6979,7 +6979,7 @@ def add_window(**kwargs): no_scroll_with_mouse (bool, optional): Disable user vertically scrolling with mouse wheel. no_docking (bool, optional): Disable docking of this window copy_contents_shortcut (bool, optional): Experimental. If True, window contents can be copied to clipboard by pressing Ctrl+C. Might be useful for message boxes. - on_close (Callable, optional): Callback ran when window is closed. + on_close (Optional[Callable], optional): Callback ran when window is closed. id (Union[int, str], optional): (deprecated) delay_search (bool, optional): (deprecated)This was used as an optimization hint but is not relevant anymore. Returns: @@ -7074,7 +7074,7 @@ def capture_next_item(callback, **kwargs): """ Captures the next item. Args: - callback (Callable): + callback (Optional[Callable]): user_data (Any, optional): New in 1.3. Optional user data to send to the callback Returns: None @@ -7282,7 +7282,7 @@ def draw_arrow(p1, p2, **kwargs): Args: p1 (Union[List[float], Tuple[float, ...]]): Arrow tip. p2 (Union[List[float], Tuple[float, ...]]): Arrow tail. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7307,7 +7307,7 @@ def draw_bezier_cubic(p1, p2, p3, p4, **kwargs): p2 (Union[List[float], Tuple[float, ...]]): Second point in curve. p3 (Union[List[float], Tuple[float, ...]]): Third point in curve. p4 (Union[List[float], Tuple[float, ...]]): Fourth point in curve. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7331,7 +7331,7 @@ def draw_bezier_quadratic(p1, p2, p3, **kwargs): p1 (Union[List[float], Tuple[float, ...]]): First point in curve. p2 (Union[List[float], Tuple[float, ...]]): Second point in curve. p3 (Union[List[float], Tuple[float, ...]]): Third point in curve. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7354,7 +7354,7 @@ def draw_circle(center, radius, **kwargs): Args: center (Union[List[float], Tuple[float, ...]]): radius (float): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7378,7 +7378,7 @@ def draw_ellipse(pmin, pmax, **kwargs): Args: pmin (Union[List[float], Tuple[float, ...]]): Min point of bounding rectangle. pmax (Union[List[float], Tuple[float, ...]]): Max point of bounding rectangle. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7403,7 +7403,7 @@ def draw_image(texture_tag, pmin, pmax, **kwargs): texture_tag (Union[int, str]): pmin (Union[List[float], Tuple[float, ...]]): Point of to start drawing texture. pmax (Union[List[float], Tuple[float, ...]]): Point to complete drawing texture. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7429,7 +7429,7 @@ def draw_image_quad(texture_tag, p1, p2, p3, p4, **kwargs): p2 (Union[List[float], Tuple[float, ...]]): p3 (Union[List[float], Tuple[float, ...]]): p4 (Union[List[float], Tuple[float, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7454,7 +7454,7 @@ def draw_line(p1, p2, **kwargs): Args: p1 (Union[List[float], Tuple[float, ...]]): Start of line. p2 (Union[List[float], Tuple[float, ...]]): End of line. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7475,7 +7475,7 @@ def draw_polygon(points, **kwargs): Args: points (List[List[float]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7497,7 +7497,7 @@ def draw_polyline(points, **kwargs): Args: points (List[List[float]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7522,7 +7522,7 @@ def draw_quad(p1, p2, p3, p4, **kwargs): p2 (Union[List[float], Tuple[float, ...]]): p3 (Union[List[float], Tuple[float, ...]]): p4 (Union[List[float], Tuple[float, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7545,7 +7545,7 @@ def draw_rectangle(pmin, pmax, **kwargs): Args: pmin (Union[List[float], Tuple[float, ...]]): Min point of bounding rectangle. pmax (Union[List[float], Tuple[float, ...]]): Max point of bounding rectangle. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7575,7 +7575,7 @@ def draw_text(pos, text, **kwargs): Args: pos (Union[List[float], Tuple[float, ...]]): Top left point of bounding text rectangle. text (str): Text to draw. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7598,7 +7598,7 @@ def draw_triangle(p1, p2, p3, **kwargs): p1 (Union[List[float], Tuple[float, ...]]): p2 (Union[List[float], Tuple[float, ...]]): p3 (Union[List[float], Tuple[float, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8359,7 +8359,7 @@ def output_frame_buffer(file='', **kwargs): Args: file (str, optional): - callback (Callable, optional): Callback will return framebuffer as an array through the second arg. + callback (Optional[Callable], optional): Callback will return framebuffer as an array through the second arg. Returns: Any """ @@ -8598,7 +8598,7 @@ def set_exit_callback(callback, **kwargs): """ Sets a callback to run on last frame. Args: - callback (Callable): + callback (Optional[Callable]): user_data (Any, optional): New in 1.3. Optional user data to send to the callback Returns: str @@ -8611,7 +8611,7 @@ def set_frame_callback(frame, callback, **kwargs): Args: frame (int): - callback (Callable): + callback (Optional[Callable]): user_data (Any, optional): New in 1.3. Optional user data to send to the callback Returns: str @@ -8696,7 +8696,7 @@ def set_viewport_resize_callback(callback, **kwargs): """ Sets a callback to run on viewport resize. Args: - callback (Callable): + callback (Optional[Callable]): user_data (Any, optional): New in 1.3. Optional user data to send to the callback Returns: str diff --git a/dearpygui/_deprecated.py b/dearpygui/_deprecated.py index a59110f87..35c3c6c8e 100644 --- a/dearpygui/_deprecated.py +++ b/dearpygui/_deprecated.py @@ -190,7 +190,7 @@ def staging_container(**kwargs): @deprecated("Use: add_spacer(...)") def add_spacing(**kwargs): - """ (deprecated function) Adds vertical spacing. + """ (deprecated function) Adds vertical spacing. Args: label (str, optional): Overrides 'name' as label. @@ -258,10 +258,10 @@ def add_same_line(**kwargs): @deprecated("Use: `get_plot_query_rects()`") def is_plot_queried(plot: Union[int, str], **kwargs): - """ (deprecated function) Returns true if the plot is currently being queried. + """ (deprecated function) Returns true if the plot is currently being queried. Args: - plot (Union[int, str]): + plot (Union[int, str]): Returns: bool """ @@ -273,7 +273,7 @@ def get_plot_query_area(plot: Union[int, str], **kwargs): """ (deprecated function) Returns the last/current query area of the plot. If no area is available [0, 0, 0, 0] will be returned. Args: - plot (Union[int, str]): + plot (Union[int, str]): Returns: Union[List[float], Tuple[float, ...]] """ @@ -288,7 +288,7 @@ def add_hline_series(x, **kwargs): """ (deprecated function) Adds an infinite horizontal line series to a plot. Args: - x (Any): + x (Any): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). @@ -303,14 +303,14 @@ def add_hline_series(x, **kwargs): """ return internal_dpg.add_inf_line_series(x, **kwargs, horizontal=True) - + @deprecated("Use: `add_inf_line_series()`") def add_vline_series(x, **kwargs): """ (deprecated function) Adds an infinite vertical line series to a plot. Args: - x (Any): + x (Any): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). @@ -425,52 +425,52 @@ def set_start_callback(callback): return internal_dpg.set_frame_callback(3, callback) @deprecated("This call is a no-op because character ranges are now automatic") -def add_font_chars(chars : Union[List[int], Tuple[int, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_font_chars(chars : Union[List[int], Tuple[int, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: """ (deprecated function) Adds specific font characters to a font. Args: - chars (Union[List[int], Tuple[int, ...]]): + chars (Union[List[int], Tuple[int, ...]]): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - id (Union[int, str], optional): (deprecated) + id (Union[int, str], optional): (deprecated) Returns: Union[int, str] """ pass @deprecated("This call is a no-op because character ranges are now automatic") -def add_font_range(first_char : int, last_char : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_font_range(first_char : int, last_char : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: """ (deprecated function) Adds a range of font characters to a font. Args: - first_char (int): - last_char (int): + first_char (int): + last_char (int): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - id (Union[int, str], optional): (deprecated) + id (Union[int, str], optional): (deprecated) Returns: Union[int, str] """ pass @deprecated("This call is a no-op because character ranges are now automatic") -def add_font_range_hint(hint : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_font_range_hint(hint : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: """ (deprecated function) Adds a range of font characters (mvFontRangeHint_ constants). Args: - hint (int): + hint (int): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - id (Union[int, str], optional): (deprecated) + id (Union[int, str], optional): (deprecated) Returns: Union[int, str] """ diff --git a/dearpygui/_header.py b/dearpygui/_header.py index 5bcbfff51..bfb8f891b 100644 --- a/dearpygui/_header.py +++ b/dearpygui/_header.py @@ -1,4 +1,4 @@ -from typing import List, Any, Callable, Union, Tuple +from typing import List, Any, Callable, Union, Tuple, Iterator, Optional from contextlib import contextmanager import warnings import functools @@ -82,7 +82,7 @@ def start_dearpygui(): raise RuntimeError("Viewport was not created and shown.") while(internal_dpg.is_dearpygui_running()): - internal_dpg.render_dearpygui_frame() + internal_dpg.render_dearpygui_frame() @contextmanager @@ -95,12 +95,12 @@ def mutex(): @contextmanager -def popup(parent: Union[int, str], mousebutton: int = internal_dpg.mvMouseButton_Right, modal: bool=False, tag:Union[int, str]=0, min_size:Union[List[int], Tuple[int, ...]]=[100,100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], no_move: bool=False, no_background: bool=False) -> int: +def popup(parent: Union[int, str], mousebutton: int = internal_dpg.mvMouseButton_Right, modal: bool=False, tag:Union[int, str]=0, min_size:Union[List[int], Tuple[int, ...]]=[100,100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], no_move: bool=False, no_background: bool=False) -> Iterator[Union[int, str]]: """A window that will be displayed when a parent item is hovered and the corresponding mouse button has been clicked. By default a popup will shrink fit the items it contains. This is useful for context windows, and simple modal window popups. When popups are used a modal they have more avaliable settings (i.e. title, resize, width, height) These - can be set by using configure item. - This is a light wrapper over window. For more control over a modal|popup window use a normal window with the modal|popup keyword + can be set by using configure item. + This is a light wrapper over window. For more control over a modal|popup window use a normal window with the modal|popup keyword and set the item handler and mouse events manually. Args: diff --git a/dearpygui/dearpygui.py b/dearpygui/dearpygui.py index 1e23f10c3..df237a357 100644 --- a/dearpygui/dearpygui.py +++ b/dearpygui/dearpygui.py @@ -14,7 +14,7 @@ # * Discussions: https://github.com/hoffstadt/DearPyGui/discussions ########################################################## -from typing import List, Any, Callable, Union, Tuple +from typing import List, Any, Callable, Union, Tuple, Iterator, Optional from contextlib import contextmanager import warnings import functools @@ -98,7 +98,7 @@ def start_dearpygui(): raise RuntimeError("Viewport was not created and shown.") while(internal_dpg.is_dearpygui_running()): - internal_dpg.render_dearpygui_frame() + internal_dpg.render_dearpygui_frame() @contextmanager @@ -111,12 +111,12 @@ def mutex(): @contextmanager -def popup(parent: Union[int, str], mousebutton: int = internal_dpg.mvMouseButton_Right, modal: bool=False, tag:Union[int, str]=0, min_size:Union[List[int], Tuple[int, ...]]=[100,100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], no_move: bool=False, no_background: bool=False) -> int: +def popup(parent: Union[int, str], mousebutton: int = internal_dpg.mvMouseButton_Right, modal: bool=False, tag:Union[int, str]=0, min_size:Union[List[int], Tuple[int, ...]]=[100,100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], no_move: bool=False, no_background: bool=False) -> Iterator[Union[int, str]]: """A window that will be displayed when a parent item is hovered and the corresponding mouse button has been clicked. By default a popup will shrink fit the items it contains. This is useful for context windows, and simple modal window popups. When popups are used a modal they have more avaliable settings (i.e. title, resize, width, height) These - can be set by using configure item. - This is a light wrapper over window. For more control over a modal|popup window use a normal window with the modal|popup keyword + can be set by using configure item. + This is a light wrapper over window. For more control over a modal|popup window use a normal window with the modal|popup keyword and set the item handler and mouse events manually. Args: @@ -1312,7 +1312,7 @@ def staging_container(**kwargs): @deprecated("Use: add_spacer(...)") def add_spacing(**kwargs): - """ (deprecated function) Adds vertical spacing. + """ (deprecated function) Adds vertical spacing. Args: label (str, optional): Overrides 'name' as label. @@ -1380,10 +1380,10 @@ def add_same_line(**kwargs): @deprecated("Use: `get_plot_query_rects()`") def is_plot_queried(plot: Union[int, str], **kwargs): - """ (deprecated function) Returns true if the plot is currently being queried. + """ (deprecated function) Returns true if the plot is currently being queried. Args: - plot (Union[int, str]): + plot (Union[int, str]): Returns: bool """ @@ -1395,7 +1395,7 @@ def get_plot_query_area(plot: Union[int, str], **kwargs): """ (deprecated function) Returns the last/current query area of the plot. If no area is available [0, 0, 0, 0] will be returned. Args: - plot (Union[int, str]): + plot (Union[int, str]): Returns: Union[List[float], Tuple[float, ...]] """ @@ -1410,7 +1410,7 @@ def add_hline_series(x, **kwargs): """ (deprecated function) Adds an infinite horizontal line series to a plot. Args: - x (Any): + x (Any): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). @@ -1425,14 +1425,14 @@ def add_hline_series(x, **kwargs): """ return internal_dpg.add_inf_line_series(x, **kwargs, horizontal=True) - + @deprecated("Use: `add_inf_line_series()`") def add_vline_series(x, **kwargs): """ (deprecated function) Adds an infinite vertical line series to a plot. Args: - x (Any): + x (Any): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). @@ -1547,52 +1547,52 @@ def set_start_callback(callback): return internal_dpg.set_frame_callback(3, callback) @deprecated("This call is a no-op because character ranges are now automatic") -def add_font_chars(chars : Union[List[int], Tuple[int, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_font_chars(chars : Union[List[int], Tuple[int, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: """ (deprecated function) Adds specific font characters to a font. Args: - chars (Union[List[int], Tuple[int, ...]]): + chars (Union[List[int], Tuple[int, ...]]): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - id (Union[int, str], optional): (deprecated) + id (Union[int, str], optional): (deprecated) Returns: Union[int, str] """ pass @deprecated("This call is a no-op because character ranges are now automatic") -def add_font_range(first_char : int, last_char : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_font_range(first_char : int, last_char : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: """ (deprecated function) Adds a range of font characters to a font. Args: - first_char (int): - last_char (int): + first_char (int): + last_char (int): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - id (Union[int, str], optional): (deprecated) + id (Union[int, str], optional): (deprecated) Returns: Union[int, str] """ pass @deprecated("This call is a no-op because character ranges are now automatic") -def add_font_range_hint(hint : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_font_range_hint(hint : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: """ (deprecated function) Adds a range of font characters (mvFontRangeHint_ constants). Args: - hint (int): + hint (int): label (str, optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - id (Union[int, str], optional): (deprecated) + id (Union[int, str], optional): (deprecated) Returns: Union[int, str] """ @@ -1604,11 +1604,11 @@ def add_font_range_hint(hint : int, *, label: str =None, user_data: Any =None, u @contextmanager -def child_window(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, border: bool =True, autosize_x: bool =False, autosize_y: bool =False, no_scrollbar: bool =False, horizontal_scrollbar: bool =False, menubar: bool =False, no_scroll_with_mouse: bool =False, flattened_navigation: bool =True, always_use_window_padding: bool =False, resizable_x: bool =False, resizable_y: bool =False, always_auto_resize: bool =False, frame_style: bool =False, auto_resize_x: bool =False, auto_resize_y: bool =False, **kwargs) -> Union[int, str]: +def child_window(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, border: bool =True, autosize_x: bool =False, autosize_y: bool =False, no_scrollbar: bool =False, horizontal_scrollbar: bool =False, menubar: bool =False, no_scroll_with_mouse: bool =False, flattened_navigation: bool =True, always_use_window_padding: bool =False, resizable_x: bool =False, resizable_y: bool =False, always_auto_resize: bool =False, frame_style: bool =False, auto_resize_x: bool =False, auto_resize_y: bool =False, **kwargs) -> Iterator[Union[int, str]]: """ Adds an embedded child window. Will show scrollbars when items do not fit. About using auto_resize/resizable flags: size measurement for a given axis is only performed when the child window is within visible boundaries, or is just appearing and it won't update its auto-size while clipped. While not perfect, it is a better default behavior as the always-on performance gain is more valuable than the occasional 'resizing after becoming visible again' glitch. You may also use always_auto_resize to force an update even when child window is not in view. However doing so will degrade performance. Remember that combining both auto_resize_x and auto_resize_y defeats purpose of a scrolling region and is NOT recommended. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1618,7 +1618,7 @@ def child_window(*, label: str =None, user_data: Any =None, use_internal_label: parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -1659,11 +1659,11 @@ def child_window(*, label: str =None, user_data: Any =None, use_internal_label: internal_dpg.pop_container_stack() @contextmanager -def clipper(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def clipper(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, **kwargs) -> Iterator[Union[int, str]]: """ Helper to manually clip large list of items. Increases performance by not searching or drawing widgets outside of the clipped region. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1692,11 +1692,11 @@ def clipper(*, label: str =None, user_data: Any =None, use_internal_label: bool internal_dpg.pop_container_stack() @contextmanager -def collapsing_header(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, closable: bool =False, default_open: bool =False, open_on_double_click: bool =False, open_on_arrow: bool =False, leaf: bool =False, bullet: bool =False, **kwargs) -> Union[int, str]: +def collapsing_header(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, closable: bool =False, default_open: bool =False, open_on_double_click: bool =False, open_on_arrow: bool =False, leaf: bool =False, bullet: bool =False, **kwargs) -> Iterator[Union[int, str]]: """ Adds a collapsing header to add items to. Must be closed with the end command. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1704,8 +1704,8 @@ def collapsing_header(*, label: str =None, user_data: Any =None, use_internal_la parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -1737,11 +1737,11 @@ def collapsing_header(*, label: str =None, user_data: Any =None, use_internal_la internal_dpg.pop_container_stack() @contextmanager -def colormap_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =False, **kwargs) -> Union[int, str]: +def colormap_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =False, **kwargs) -> Iterator[Union[int, str]]: """ Adds a colormap registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1762,21 +1762,21 @@ def colormap_registry(*, label: str =None, user_data: Any =None, use_internal_la internal_dpg.pop_container_stack() @contextmanager -def custom_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], channel_count : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Callable =None, show: bool =True, y1: Any =[], y2: Any =[], y3: Any =[], tooltip: bool =True, no_fit: bool =False, **kwargs) -> Union[int, str]: +def custom_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], channel_count : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, y1: Any =[], y2: Any =[], y3: Any =[], tooltip: bool =True, no_fit: bool =False, **kwargs) -> Iterator[Union[int, str]]: """ Adds a custom series to a plot. New in 1.6. Args: x (Any): y (Any): channel_count (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. y1 (Any, optional): y2 (Any, optional): @@ -1799,11 +1799,11 @@ def custom_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[floa internal_dpg.pop_container_stack() @contextmanager -def drag_payload(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, show: bool =True, drag_data: Any =None, drop_data: Any =None, payload_type: str ='$$DPG_PAYLOAD', **kwargs) -> Union[int, str]: +def drag_payload(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, show: bool =True, drag_data: Any =None, drop_data: Any =None, payload_type: str ='$$DPG_PAYLOAD', **kwargs) -> Iterator[Union[int, str]]: """ User data payload for drag and drop operations. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1828,11 +1828,11 @@ def drag_payload(*, label: str =None, user_data: Any =None, use_internal_label: internal_dpg.pop_container_stack() @contextmanager -def draw_layer(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, perspective_divide: bool =False, depth_clipping: bool =False, cull_mode: int =0, **kwargs) -> Union[int, str]: +def draw_layer(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, perspective_divide: bool =False, depth_clipping: bool =False, cull_mode: int =0, **kwargs) -> Iterator[Union[int, str]]: """ New in 1.1. Creates a layer useful for grouping drawlist items. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1858,11 +1858,11 @@ def draw_layer(*, label: str =None, user_data: Any =None, use_internal_label: bo internal_dpg.pop_container_stack() @contextmanager -def draw_node(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def draw_node(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, **kwargs) -> Iterator[Union[int, str]]: """ New in 1.1. Creates a drawing node to associate a transformation matrix. Child node matricies will concatenate. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1885,19 +1885,19 @@ def draw_node(*, label: str =None, user_data: Any =None, use_internal_label: boo internal_dpg.pop_container_stack() @contextmanager -def drawlist(width : int, height : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, **kwargs) -> Union[int, str]: +def drawlist(width : int, height : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, **kwargs) -> Iterator[Union[int, str]]: """ Adds a drawing canvas. Args: width (int): height (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -1923,17 +1923,17 @@ def drawlist(width : int, height : int, *, label: str =None, user_data: Any =Non internal_dpg.pop_container_stack() @contextmanager -def file_dialog(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, callback: Callable =None, show: bool =True, default_path: str ='', default_filename: str ='.', file_count: int =0, modal: bool =False, directory_selector: bool =False, min_size: Union[List[int], Tuple[int, ...]] =[100, 100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], cancel_callback: Callable =None, **kwargs) -> Union[int, str]: +def file_dialog(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, callback: Optional[Callable] =None, show: bool =True, default_path: str ='', default_filename: str ='.', file_count: int =0, modal: bool =False, directory_selector: bool =False, min_size: Union[List[int], Tuple[int, ...]] =[100, 100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], cancel_callback: Optional[Callable] =None, **kwargs) -> Iterator[Union[int, str]]: """ Displays a file or directory selector depending on keywords. Displays a file dialog by default. Callback will be ran when the file or directory picker is closed. The app_data arguemnt will be populated with information related to the file and directory as a dictionary. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. width (int, optional): Width of the item. height (int, optional): Height of the item. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. default_path (str, optional): Path that the file dialog will default to when opened. default_filename (str, optional): Default name that will show in the file name input. @@ -1942,7 +1942,7 @@ def file_dialog(*, label: str =None, user_data: Any =None, use_internal_label: b directory_selector (bool, optional): Shows only directory/paths as options. Allows selection of directory/paths only. min_size (Union[List[int], Tuple[int, ...]], optional): Minimum window size. max_size (Union[List[int], Tuple[int, ...]], optional): Maximum window size. - cancel_callback (Callable, optional): Callback called when cancel button is clicked. + cancel_callback (Optional[Callable], optional): Callback called when cancel button is clicked. id (Union[int, str], optional): (deprecated) Yields: Union[int, str] @@ -1959,11 +1959,11 @@ def file_dialog(*, label: str =None, user_data: Any =None, use_internal_label: b internal_dpg.pop_container_stack() @contextmanager -def filter_set(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def filter_set(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, **kwargs) -> Iterator[Union[int, str]]: """ Helper to parse and apply text filters (e.g. aaaaa[, bbbbb][, ccccc]) Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -1992,13 +1992,13 @@ def filter_set(*, label: str =None, user_data: Any =None, use_internal_label: bo internal_dpg.pop_container_stack() @contextmanager -def font(file : str, size : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, pixel_snapH: bool =False, pixel_snapV: bool =False, parent: Union[int, str] =internal_dpg.mvReservedUUID_0, **kwargs) -> Union[int, str]: +def font(file : str, size : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, pixel_snapH: bool =False, pixel_snapV: bool =False, parent: Union[int, str] =internal_dpg.mvReservedUUID_0, **kwargs) -> Iterator[Union[int, str]]: """ Adds font to a font registry. Args: file (str): size (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2026,11 +2026,11 @@ def font(file : str, size : int, *, label: str =None, user_data: Any =None, use_ internal_dpg.pop_container_stack() @contextmanager -def font_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def font_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, **kwargs) -> Iterator[Union[int, str]]: """ Adds a font registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2051,12 +2051,12 @@ def font_registry(*, label: str =None, user_data: Any =None, use_internal_label: internal_dpg.pop_container_stack() @contextmanager -def group(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, horizontal: bool =False, horizontal_spacing: float =-1, xoffset: float =0.0, **kwargs) -> Union[int, str]: +def group(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, horizontal: bool =False, horizontal_spacing: float =-1, xoffset: float =0.0, **kwargs) -> Iterator[Union[int, str]]: """ Creates a group that other widgets can belong to. The group allows item commands to be issued for all of its members. Enable property acts in a special way enabling/disabling everything inside the group. (Use mvStyleVar_DisabledAlpha to edit colors within the disabled group.) Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2066,8 +2066,8 @@ def group(*, label: str =None, user_data: Any =None, use_internal_label: bool =T parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -2097,11 +2097,11 @@ def group(*, label: str =None, user_data: Any =None, use_internal_label: bool =T internal_dpg.pop_container_stack() @contextmanager -def handler_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def handler_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, **kwargs) -> Iterator[Union[int, str]]: """ Adds a handler registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2122,11 +2122,11 @@ def handler_registry(*, label: str =None, user_data: Any =None, use_internal_lab internal_dpg.pop_container_stack() @contextmanager -def item_handler_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def item_handler_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, **kwargs) -> Iterator[Union[int, str]]: """ Adds an item handler registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2147,11 +2147,11 @@ def item_handler_registry(*, label: str =None, user_data: Any =None, use_interna internal_dpg.pop_container_stack() @contextmanager -def menu(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Callable =None, show: bool =True, enabled: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, **kwargs) -> Union[int, str]: +def menu(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, **kwargs) -> Iterator[Union[int, str]]: """ Adds a menu to an existing menu bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2159,7 +2159,7 @@ def menu(*, label: str =None, user_data: Any =None, use_internal_label: bool =Tr parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. filter_key (str, optional): Used by filter widget. @@ -2185,11 +2185,11 @@ def menu(*, label: str =None, user_data: Any =None, use_internal_label: bool =Tr internal_dpg.pop_container_stack() @contextmanager -def menu_bar(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def menu_bar(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, show: bool =True, **kwargs) -> Iterator[Union[int, str]]: """ Adds a menu bar to a window. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2216,19 +2216,19 @@ def menu_bar(*, label: str =None, user_data: Any =None, use_internal_label: bool internal_dpg.pop_container_stack() @contextmanager -def node(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, draggable: bool =True, **kwargs) -> Union[int, str]: +def node(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, draggable: bool =True, **kwargs) -> Iterator[Union[int, str]]: """ Adds a node to a node editor. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2255,11 +2255,11 @@ def node(*, label: str =None, user_data: Any =None, use_internal_label: bool =Tr internal_dpg.pop_container_stack() @contextmanager -def node_attribute(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, attribute_type: int =0, shape: int =1, category: str ='general', **kwargs) -> Union[int, str]: +def node_attribute(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, attribute_type: int =0, shape: int =1, category: str ='general', **kwargs) -> Iterator[Union[int, str]]: """ Adds a node attribute to a node. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2289,11 +2289,11 @@ def node_attribute(*, label: str =None, user_data: Any =None, use_internal_label internal_dpg.pop_container_stack() @contextmanager -def node_editor(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Callable =None, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, delink_callback: Callable =None, menubar: bool =False, minimap: bool =False, minimap_location: int =2, **kwargs) -> Union[int, str]: +def node_editor(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, delink_callback: Optional[Callable] =None, menubar: bool =False, minimap: bool =False, minimap_location: int =2, **kwargs) -> Iterator[Union[int, str]]: """ Adds a node editor. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2301,12 +2301,12 @@ def node_editor(*, label: str =None, user_data: Any =None, use_internal_label: b height (int, optional): Height of the item. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. filter_key (str, optional): Used by filter widget. tracked (bool, optional): Scroll tracking track_offset (float, optional): 0.0f:top, 0.5f:center, 1.0f:bottom - delink_callback (Callable, optional): Callback ran when a link is detached. + delink_callback (Optional[Callable], optional): Callback ran when a link is detached. menubar (bool, optional): Shows or hides the menubar. minimap (bool, optional): Shows or hides the Minimap. New in 1.6. minimap_location (int, optional): mvNodeMiniMap_Location_* constants. New in 1.6. @@ -2330,11 +2330,11 @@ def node_editor(*, label: str =None, user_data: Any =None, use_internal_label: b internal_dpg.pop_container_stack() @contextmanager -def plot(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, no_title: bool =False, no_menus: bool =False, no_box_select: bool =False, no_mouse_pos: bool =False, query: bool =False, query_color: Union[List[float], Tuple[float, ...]] =(0, 255, 0, 255), min_query_rects: int =1, max_query_rects: int =1, crosshairs: bool =False, equal_aspects: bool =False, no_inputs: bool =False, no_frame: bool =False, use_local_time: bool =False, use_ISO8601: bool =False, use_24hour_clock: bool =False, pan_button: int =internal_dpg.mvMouseButton_Left, pan_mod: int =internal_dpg.mvKey_None, context_menu_button: int =internal_dpg.mvMouseButton_Right, fit_button: int =internal_dpg.mvMouseButton_Left, box_select_button: int =internal_dpg.mvMouseButton_Right, box_select_mod: int =internal_dpg.mvKey_None, box_select_cancel_button: int =internal_dpg.mvMouseButton_Left, query_toggle_mod: int =internal_dpg.mvKey_ModCtrl, horizontal_mod: int =internal_dpg.mvKey_ModAlt, vertical_mod: int =internal_dpg.mvKey_ModShift, override_mod: int =internal_dpg.mvKey_ModCtrl, zoom_mod: int =internal_dpg.mvKey_None, zoom_rate: int =0.1, **kwargs) -> Union[int, str]: +def plot(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, no_title: bool =False, no_menus: bool =False, no_box_select: bool =False, no_mouse_pos: bool =False, query: bool =False, query_color: Union[List[float], Tuple[float, ...]] =(0, 255, 0, 255), min_query_rects: int =1, max_query_rects: int =1, crosshairs: bool =False, equal_aspects: bool =False, no_inputs: bool =False, no_frame: bool =False, use_local_time: bool =False, use_ISO8601: bool =False, use_24hour_clock: bool =False, pan_button: int =internal_dpg.mvMouseButton_Left, pan_mod: int =internal_dpg.mvKey_None, context_menu_button: int =internal_dpg.mvMouseButton_Right, fit_button: int =internal_dpg.mvMouseButton_Left, box_select_button: int =internal_dpg.mvMouseButton_Right, box_select_mod: int =internal_dpg.mvKey_None, box_select_cancel_button: int =internal_dpg.mvMouseButton_Left, query_toggle_mod: int =internal_dpg.mvKey_ModCtrl, horizontal_mod: int =internal_dpg.mvKey_ModAlt, vertical_mod: int =internal_dpg.mvKey_ModShift, override_mod: int =internal_dpg.mvKey_ModCtrl, zoom_mod: int =internal_dpg.mvKey_None, zoom_rate: float =0.1, **kwargs) -> Iterator[Union[int, str]]: """ Adds a plot which is used to hold series, and can be drawn to with draw commands. For all _mod parameters use mvKey_ModX enums, or mvKey_ModDisabled to disable the modifier. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2344,9 +2344,9 @@ def plot(*, label: str =None, user_data: Any =None, use_internal_label: bool =Tr parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2379,7 +2379,7 @@ def plot(*, label: str =None, user_data: Any =None, use_internal_label: bool =Tr vertical_mod (int, optional): expands active box selection/query vertically to plot edge when held override_mod (int, optional): when held, all input is ignored; used to enable axis/plots as DND sources zoom_mod (int, optional): optional modifier that must be held for scroll wheel zooming - zoom_rate (int, optional): zoom rate for scroll (e.g. 0.1f = 10% plot range every scroll click); make negative to invert + zoom_rate (float, optional): zoom rate for scroll (e.g. 0.1f = 10% plot range every scroll click); make negative to invert id (Union[int, str], optional): (deprecated) delay_search (bool, optional): (deprecated) This was used as an optimization hint but is not relevant anymore. no_highlight (bool, optional): (deprecated) Removed because not supported from the backend anymore. To control the highlighting of series use the same argument in `add_plot_legend` @@ -2425,18 +2425,18 @@ def plot(*, label: str =None, user_data: Any =None, use_internal_label: bool =Tr internal_dpg.pop_container_stack() @contextmanager -def plot_axis(axis : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Callable =None, show: bool =True, no_label: bool =False, no_gridlines: bool =False, no_tick_marks: bool =False, no_tick_labels: bool =False, no_initial_fit: bool =False, no_menus: bool =False, no_side_switch: bool =False, no_highlight: bool =False, opposite: bool =False, foreground_grid: bool =False, tick_format: str ='', scale: int =internal_dpg.mvPlotScale_Linear, invert: bool =False, auto_fit: bool =False, range_fit: bool =False, pan_stretch: bool =False, lock_min: bool =False, lock_max: bool =False, **kwargs) -> Union[int, str]: +def plot_axis(axis : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Optional[Callable] =None, show: bool =True, no_label: bool =False, no_gridlines: bool =False, no_tick_marks: bool =False, no_tick_labels: bool =False, no_initial_fit: bool =False, no_menus: bool =False, no_side_switch: bool =False, no_highlight: bool =False, opposite: bool =False, foreground_grid: bool =False, tick_format: str ='', scale: int =internal_dpg.mvPlotScale_Linear, invert: bool =False, auto_fit: bool =False, range_fit: bool =False, pan_stretch: bool =False, lock_min: bool =False, lock_max: bool =False, **kwargs) -> Iterator[Union[int, str]]: """ Adds an axis to a plot. Args: axis (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. no_label (bool, optional): the axis label will not be displayed no_gridlines (bool, optional): no grid lines will be displayed @@ -2480,11 +2480,11 @@ def plot_axis(axis : int, *, label: str =None, user_data: Any =None, use_interna internal_dpg.pop_container_stack() @contextmanager -def stage(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Union[int, str]: +def stage(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Iterator[Union[int, str]]: """ Adds a stage. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2504,13 +2504,13 @@ def stage(*, label: str =None, user_data: Any =None, use_internal_label: bool =T internal_dpg.pop_container_stack() @contextmanager -def subplots(rows : int, columns : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, row_ratios: Union[List[float], Tuple[float, ...]] =[], column_ratios: Union[List[float], Tuple[float, ...]] =[], no_title: bool =False, no_menus: bool =False, no_resize: bool =False, no_align: bool =False, share_series: bool =False, link_rows: bool =False, link_columns: bool =False, link_all_x: bool =False, link_all_y: bool =False, column_major: bool =False, **kwargs) -> Union[int, str]: +def subplots(rows : int, columns : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, row_ratios: Union[List[float], Tuple[float, ...]] =[], column_ratios: Union[List[float], Tuple[float, ...]] =[], no_title: bool =False, no_menus: bool =False, no_resize: bool =False, no_align: bool =False, share_series: bool =False, link_rows: bool =False, link_columns: bool =False, link_all_x: bool =False, link_all_y: bool =False, column_major: bool =False, **kwargs) -> Iterator[Union[int, str]]: """ Adds a collection of plots. Args: rows (int): columns (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2519,7 +2519,7 @@ def subplots(rows : int, columns : int, *, label: str =None, user_data: Any =Non indent (int, optional): Offsets the widget to the right the specified number multiplied by the indent style. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2557,11 +2557,11 @@ def subplots(rows : int, columns : int, *, label: str =None, user_data: Any =Non internal_dpg.pop_container_stack() @contextmanager -def synced_tables(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', **kwargs) -> Union[int, str]: +def synced_tables(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', **kwargs) -> Iterator[Union[int, str]]: """ Links all tables that are immediate children of this container so that they share their state (mostly column sizes). Other children are rendered as is. This is an experimental feature, use with caution. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2585,11 +2585,11 @@ def synced_tables(*, label: str =None, user_data: Any =None, use_internal_label: internal_dpg.pop_container_stack() @contextmanager -def tab(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Callable =None, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, closable: bool =False, no_tooltip: bool =False, order_mode: int =0, unsaved_document: bool =False, no_close_with_middle_click: bool =False, no_reorder: bool =False, **kwargs) -> Union[int, str]: +def tab(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Optional[Callable] =None, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, closable: bool =False, no_tooltip: bool =False, order_mode: int =0, unsaved_document: bool =False, no_close_with_middle_click: bool =False, no_reorder: bool =False, **kwargs) -> Iterator[Union[int, str]]: """ Adds a tab to a tab bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2597,7 +2597,7 @@ def tab(*, label: str =None, user_data: Any =None, use_internal_label: bool =Tru parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. filter_key (str, optional): Used by filter widget. tracked (bool, optional): Scroll tracking @@ -2628,18 +2628,18 @@ def tab(*, label: str =None, user_data: Any =None, use_internal_label: bool =Tru internal_dpg.pop_container_stack() @contextmanager -def tab_bar(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, reorderable: bool =False, tab_list_popup_button: bool =False, no_close_with_middle_click: bool =False, no_scrolling_buttons: bool =False, no_tooltip: bool =False, draw_selected_overline: bool =False, **kwargs) -> Union[int, str]: +def tab_bar(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, reorderable: bool =False, tab_list_popup_button: bool =False, no_close_with_middle_click: bool =False, no_scrolling_buttons: bool =False, no_tooltip: bool =False, draw_selected_overline: bool =False, **kwargs) -> Iterator[Union[int, str]]: """ Adds a tab bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. indent (int, optional): Offsets the widget to the right the specified number multiplied by the indent style. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2671,11 +2671,11 @@ def tab_bar(*, label: str =None, user_data: Any =None, use_internal_label: bool internal_dpg.pop_container_stack() @contextmanager -def table(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', header_row: bool =True, clipper: bool =False, inner_width: int =0, policy: int =0, freeze_rows: int =0, freeze_columns: int =0, sort_multi: bool =False, sort_tristate: bool =False, resizable: bool =False, reorderable: bool =False, hideable: bool =False, sortable: bool =False, context_menu_in_body: bool =False, row_background: bool =False, borders_innerH: bool =False, borders_outerH: bool =False, borders_innerV: bool =False, borders_outerV: bool =False, no_host_extendX: bool =False, no_host_extendY: bool =False, no_keep_columns_visible: bool =False, precise_widths: bool =False, no_clip: bool =False, pad_outerX: bool =False, no_pad_outerX: bool =False, no_pad_innerX: bool =False, scrollX: bool =False, scrollY: bool =False, no_saved_settings: bool =False, **kwargs) -> Union[int, str]: +def table(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', header_row: bool =True, clipper: bool =False, inner_width: int =0, policy: int =0, freeze_rows: int =0, freeze_columns: int =0, sort_multi: bool =False, sort_tristate: bool =False, resizable: bool =False, reorderable: bool =False, hideable: bool =False, sortable: bool =False, context_menu_in_body: bool =False, row_background: bool =False, borders_innerH: bool =False, borders_outerH: bool =False, borders_innerV: bool =False, borders_outerV: bool =False, no_host_extendX: bool =False, no_host_extendY: bool =False, no_keep_columns_visible: bool =False, precise_widths: bool =False, no_clip: bool =False, pad_outerX: bool =False, no_pad_outerX: bool =False, no_pad_innerX: bool =False, scrollX: bool =False, scrollY: bool =False, no_saved_settings: bool =False, **kwargs) -> Iterator[Union[int, str]]: """ Adds a table. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2685,7 +2685,7 @@ def table(*, label: str =None, user_data: Any =None, use_internal_label: bool =T parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2738,11 +2738,11 @@ def table(*, label: str =None, user_data: Any =None, use_internal_label: bool =T internal_dpg.pop_container_stack() @contextmanager -def table_cell(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', **kwargs) -> Union[int, str]: +def table_cell(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', **kwargs) -> Iterator[Union[int, str]]: """ Adds a table. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2767,11 +2767,11 @@ def table_cell(*, label: str =None, user_data: Any =None, use_internal_label: bo internal_dpg.pop_container_stack() @contextmanager -def table_row(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', **kwargs) -> Union[int, str]: +def table_row(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', **kwargs) -> Iterator[Union[int, str]]: """ Adds a table row. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2796,11 +2796,11 @@ def table_row(*, label: str =None, user_data: Any =None, use_internal_label: boo internal_dpg.pop_container_stack() @contextmanager -def template_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Union[int, str]: +def template_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Iterator[Union[int, str]]: """ Adds a template registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2820,11 +2820,11 @@ def template_registry(*, label: str =None, user_data: Any =None, use_internal_la internal_dpg.pop_container_stack() @contextmanager -def texture_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =False, **kwargs) -> Union[int, str]: +def texture_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =False, **kwargs) -> Iterator[Union[int, str]]: """ Adds a dynamic texture. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2845,11 +2845,11 @@ def texture_registry(*, label: str =None, user_data: Any =None, use_internal_lab internal_dpg.pop_container_stack() @contextmanager -def theme(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Union[int, str]: +def theme(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Iterator[Union[int, str]]: """ Adds a theme. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2874,12 +2874,12 @@ def theme(*, label: str =None, user_data: Any =None, use_internal_label: bool =T internal_dpg.pop_container_stack() @contextmanager -def theme_component(item_type : int =0, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, enabled_state: bool =True, **kwargs) -> Union[int, str]: +def theme_component(item_type : int =0, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, enabled_state: bool =True, **kwargs) -> Iterator[Union[int, str]]: """ Adds a theme component. Args: item_type (int, optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2902,12 +2902,12 @@ def theme_component(item_type : int =0, *, label: str =None, user_data: Any =Non internal_dpg.pop_container_stack() @contextmanager -def tooltip(parent : Union[int, str], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, delay: float =0.0, hide_on_activity: bool =False, **kwargs) -> Union[int, str]: +def tooltip(parent : Union[int, str], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, delay: float =0.0, hide_on_activity: bool =False, **kwargs) -> Iterator[Union[int, str]]: """ Adds a tooltip window. Args: parent (Union[int, str]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2930,11 +2930,11 @@ def tooltip(parent : Union[int, str], *, label: str =None, user_data: Any =None, internal_dpg.pop_container_stack() @contextmanager -def tree_node(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_open: bool =False, open_on_double_click: bool =False, open_on_arrow: bool =False, leaf: bool =False, bullet: bool =False, selectable: bool =False, span_text_width: bool =False, span_full_width: bool =False, catch_nav_left: bool =False, lines: int =internal_dpg.mvTreeLines_None, **kwargs) -> Union[int, str]: +def tree_node(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_open: bool =False, open_on_double_click: bool =False, open_on_arrow: bool =False, leaf: bool =False, bullet: bool =False, selectable: bool =False, span_text_width: bool =False, span_full_width: bool =False, catch_nav_left: bool =False, lines: int =internal_dpg.mvTreeLines_None, **kwargs) -> Iterator[Union[int, str]]: """ Adds a tree node to add items to. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -2942,8 +2942,8 @@ def tree_node(*, label: str =None, user_data: Any =None, use_internal_label: boo parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -2979,11 +2979,11 @@ def tree_node(*, label: str =None, user_data: Any =None, use_internal_label: boo internal_dpg.pop_container_stack() @contextmanager -def value_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Union[int, str]: +def value_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Iterator[Union[int, str]]: """ Adds a value registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3003,11 +3003,11 @@ def value_registry(*, label: str =None, user_data: Any =None, use_internal_label internal_dpg.pop_container_stack() @contextmanager -def viewport_drawlist(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, filter_key: str ='', front: bool =True, **kwargs) -> Union[int, str]: +def viewport_drawlist(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, filter_key: str ='', front: bool =True, **kwargs) -> Iterator[Union[int, str]]: """ A container that is used to present draw items or layers directly to the viewport. By default this will draw to the back of the viewport. Layers and draw items should be added to this widget as children. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3034,11 +3034,11 @@ def viewport_drawlist(*, label: str =None, user_data: Any =None, use_internal_la internal_dpg.pop_container_stack() @contextmanager -def viewport_menu_bar(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def viewport_menu_bar(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, show: bool =True, **kwargs) -> Iterator[Union[int, str]]: """ Adds a menubar to the viewport. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3065,11 +3065,11 @@ def viewport_menu_bar(*, label: str =None, user_data: Any =None, use_internal_la internal_dpg.pop_container_stack() @contextmanager -def window(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], min_size: Union[List[int], Tuple[int, ...]] =[100, 100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], menubar: bool =False, collapsed: bool =False, autosize: bool =False, no_resize: bool =False, unsaved_document: bool =False, no_title_bar: bool =False, no_move: bool =False, no_scrollbar: bool =False, no_collapse: bool =False, horizontal_scrollbar: bool =False, no_focus_on_appearing: bool =False, no_bring_to_front_on_focus: bool =False, no_close: bool =False, no_background: bool =False, modal: bool =False, popup: bool =False, no_saved_settings: bool =False, no_open_over_existing_popup: bool =True, no_scroll_with_mouse: bool =False, no_docking: bool =False, copy_contents_shortcut: bool =False, on_close: Callable =None, **kwargs) -> Union[int, str]: +def window(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], min_size: Union[List[int], Tuple[int, ...]] =[100, 100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], menubar: bool =False, collapsed: bool =False, autosize: bool =False, no_resize: bool =False, unsaved_document: bool =False, no_title_bar: bool =False, no_move: bool =False, no_scrollbar: bool =False, no_collapse: bool =False, horizontal_scrollbar: bool =False, no_focus_on_appearing: bool =False, no_bring_to_front_on_focus: bool =False, no_close: bool =False, no_background: bool =False, modal: bool =False, popup: bool =False, no_saved_settings: bool =False, no_open_over_existing_popup: bool =True, no_scroll_with_mouse: bool =False, no_docking: bool =False, copy_contents_shortcut: bool =False, on_close: Optional[Callable] =None, **kwargs) -> Iterator[Union[int, str]]: """ Creates a new window for following items to be added to. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3101,7 +3101,7 @@ def window(*, label: str =None, user_data: Any =None, use_internal_label: bool = no_scroll_with_mouse (bool, optional): Disable user vertically scrolling with mouse wheel. no_docking (bool, optional): Disable docking of this window copy_contents_shortcut (bool, optional): Experimental. If True, window contents can be copied to clipboard by pressing Ctrl+C. Might be useful for message boxes. - on_close (Callable, optional): Callback ran when window is closed. + on_close (Optional[Callable], optional): Callback ran when window is closed. id (Union[int, str], optional): (deprecated) delay_search (bool, optional): (deprecated) This was used as an optimization hint but is not relevant anymore. Yields: @@ -3125,13 +3125,13 @@ def window(*, label: str =None, user_data: Any =None, use_internal_label: bool = # Core Wrappings ########################################################## -def add_2d_histogram_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, xbins: int =-1, ybins: int =-1, xmin_range: float =0.0, xmax_range: float =0.0, ymin_range: float =0.0, ymax_range: float =0.0, density: bool =False, outliers: bool =False, col_major: bool =False, **kwargs) -> Union[int, str]: +def add_2d_histogram_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, xbins: int =-1, ybins: int =-1, xmin_range: float =0.0, xmax_range: float =0.0, ymin_range: float =0.0, ymax_range: float =0.0, density: bool =False, outliers: bool =False, col_major: bool =False, **kwargs) -> Union[int, str]: """ Adds a 2d histogram series. Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3159,11 +3159,11 @@ def add_2d_histogram_series(x : Union[List[float], Tuple[float, ...]], y : Union return internal_dpg.add_2d_histogram_series(x, y, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, xbins=xbins, ybins=ybins, xmin_range=xmin_range, xmax_range=xmax_range, ymin_range=ymin_range, ymax_range=ymax_range, density=density, outliers=outliers, col_major=col_major, **kwargs) -def add_3d_slider(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[float], Tuple[float, ...]] =(0.0, 0.0, 0.0, 0.0), max_x: float =100.0, max_y: float =100.0, max_z: float =100.0, min_x: float =0.0, min_y: float =0.0, min_z: float =0.0, scale: float =1.0, **kwargs) -> Union[int, str]: +def add_3d_slider(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[float], Tuple[float, ...]] =(0.0, 0.0, 0.0, 0.0), max_x: float =100.0, max_y: float =100.0, max_z: float =100.0, min_x: float =0.0, min_y: float =0.0, min_z: float =0.0, scale: float =1.0, **kwargs) -> Union[int, str]: """ Adds a 3D box slider. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3174,9 +3174,9 @@ def add_3d_slider(*, label: str =None, user_data: Any =None, use_internal_label: before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -3213,13 +3213,13 @@ def add_alias(alias : str, item : Union[int, str], **kwargs) -> None: return internal_dpg.add_alias(alias, item, **kwargs) -def add_area_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), contribute_to_bounds: bool =True, **kwargs) -> Union[int, str]: +def add_area_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), contribute_to_bounds: bool =True, **kwargs) -> Union[int, str]: """ Adds an area series to a plot. Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3240,11 +3240,11 @@ def add_area_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[fl return internal_dpg.add_area_series(x, y, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, fill=fill, contribute_to_bounds=contribute_to_bounds, **kwargs) -def add_axis_tag(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, default_value: float =0.0, color: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), auto_rounding: bool =False, **kwargs) -> Union[int, str]: +def add_axis_tag(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, default_value: float =0.0, color: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), auto_rounding: bool =False, **kwargs) -> Union[int, str]: """ Adds custom labels to axes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3266,14 +3266,14 @@ def add_axis_tag(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_axis_tag(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, default_value=default_value, color=color, auto_rounding=auto_rounding, **kwargs) -def add_bar_group_series(values : Union[List[float], Tuple[float, ...]], label_ids : Union[List[str], Tuple[str, ...]], group_size : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, group_width: float =0.67, shift: int =0, horizontal: bool =False, stacked: bool =False, **kwargs) -> Union[int, str]: +def add_bar_group_series(values : Union[List[float], Tuple[float, ...]], label_ids : Union[List[str], Tuple[str, ...]], group_size : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, group_width: float =0.67, shift: int =0, horizontal: bool =False, stacked: bool =False, **kwargs) -> Union[int, str]: """ Adds a bar groups series to a plot. Args: values (Any): label_ids (Union[List[str], Tuple[str, ...]]): Label of each bar in a group group_size (int): Number of bars in a group - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3296,13 +3296,13 @@ def add_bar_group_series(values : Union[List[float], Tuple[float, ...]], label_i return internal_dpg.add_bar_group_series(values, label_ids, group_size, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, group_width=group_width, shift=shift, horizontal=horizontal, stacked=stacked, **kwargs) -def add_bar_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, weight: float =1.0, horizontal: bool =False, **kwargs) -> Union[int, str]: +def add_bar_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, weight: float =1.0, horizontal: bool =False, **kwargs) -> Union[int, str]: """ Adds a bar series to a plot. Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3323,11 +3323,11 @@ def add_bar_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[flo return internal_dpg.add_bar_series(x, y, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, weight=weight, horizontal=horizontal, **kwargs) -def add_bool_value(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: bool =False, parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: +def add_bool_value(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: bool =False, parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: """ Adds a bool value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3345,11 +3345,11 @@ def add_bool_value(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_bool_value(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, source=source, default_value=default_value, parent=parent, **kwargs) -def add_button(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, small: bool =False, arrow: bool =False, direction: int =0, repeat: bool =False, **kwargs) -> Union[int, str]: +def add_button(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, small: bool =False, arrow: bool =False, direction: int =0, repeat: bool =False, **kwargs) -> Union[int, str]: """ Adds a button. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3359,9 +3359,9 @@ def add_button(*, label: str =None, user_data: Any =None, use_internal_label: bo parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3383,7 +3383,7 @@ def add_button(*, label: str =None, user_data: Any =None, use_internal_label: bo return internal_dpg.add_button(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, small=small, arrow=arrow, direction=direction, repeat=repeat, **kwargs) -def add_candle_series(dates : Union[List[float], Tuple[float, ...]], opens : Union[List[float], Tuple[float, ...]], closes : Union[List[float], Tuple[float, ...]], lows : Union[List[float], Tuple[float, ...]], highs : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, bull_color: Union[List[int], Tuple[int, ...]] =(0, 255, 113, 255), bear_color: Union[List[int], Tuple[int, ...]] =(218, 13, 79, 255), weight: float =0.25, tooltip: bool =True, time_unit: int =5, **kwargs) -> Union[int, str]: +def add_candle_series(dates : Union[List[float], Tuple[float, ...]], opens : Union[List[float], Tuple[float, ...]], closes : Union[List[float], Tuple[float, ...]], lows : Union[List[float], Tuple[float, ...]], highs : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, bull_color: Union[List[int], Tuple[int, ...]] =(0, 255, 113, 255), bear_color: Union[List[int], Tuple[int, ...]] =(218, 13, 79, 255), weight: float =0.25, tooltip: bool =True, time_unit: int =5, **kwargs) -> Union[int, str]: """ Adds a candle series to a plot. Args: @@ -3392,7 +3392,7 @@ def add_candle_series(dates : Union[List[float], Tuple[float, ...]], opens : Uni closes (Any): lows (Any): highs (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3416,13 +3416,13 @@ def add_candle_series(dates : Union[List[float], Tuple[float, ...]], opens : Uni return internal_dpg.add_candle_series(dates, opens, closes, lows, highs, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, bull_color=bull_color, bear_color=bear_color, weight=weight, tooltip=tooltip, time_unit=time_unit, **kwargs) -def add_char_remap(source : int, target : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_char_remap(source : int, target : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, **kwargs) -> Union[int, str]: """ Remaps a character. Args: source (int): target (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3438,11 +3438,11 @@ def add_char_remap(source : int, target : int, *, label: str =None, user_data: A return internal_dpg.add_char_remap(source, target, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, **kwargs) -def add_checkbox(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: bool =False, **kwargs) -> Union[int, str]: +def add_checkbox(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: bool =False, **kwargs) -> Union[int, str]: """ Adds a checkbox. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3451,9 +3451,9 @@ def add_checkbox(*, label: str =None, user_data: Any =None, use_internal_label: before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3472,11 +3472,11 @@ def add_checkbox(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_checkbox(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, **kwargs) -def add_child_window(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, border: bool =True, autosize_x: bool =False, autosize_y: bool =False, no_scrollbar: bool =False, horizontal_scrollbar: bool =False, menubar: bool =False, no_scroll_with_mouse: bool =False, flattened_navigation: bool =True, always_use_window_padding: bool =False, resizable_x: bool =False, resizable_y: bool =False, always_auto_resize: bool =False, frame_style: bool =False, auto_resize_x: bool =False, auto_resize_y: bool =False, **kwargs) -> Union[int, str]: +def add_child_window(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, border: bool =True, autosize_x: bool =False, autosize_y: bool =False, no_scrollbar: bool =False, horizontal_scrollbar: bool =False, menubar: bool =False, no_scroll_with_mouse: bool =False, flattened_navigation: bool =True, always_use_window_padding: bool =False, resizable_x: bool =False, resizable_y: bool =False, always_auto_resize: bool =False, frame_style: bool =False, auto_resize_x: bool =False, auto_resize_y: bool =False, **kwargs) -> Union[int, str]: """ Adds an embedded child window. Will show scrollbars when items do not fit. About using auto_resize/resizable flags: size measurement for a given axis is only performed when the child window is within visible boundaries, or is just appearing and it won't update its auto-size while clipped. While not perfect, it is a better default behavior as the always-on performance gain is more valuable than the occasional 'resizing after becoming visible again' glitch. You may also use always_auto_resize to force an update even when child window is not in view. However doing so will degrade performance. Remember that combining both auto_resize_x and auto_resize_y defeats purpose of a scrolling region and is NOT recommended. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3486,7 +3486,7 @@ def add_child_window(*, label: str =None, user_data: Any =None, use_internal_lab parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -3522,11 +3522,11 @@ def add_child_window(*, label: str =None, user_data: Any =None, use_internal_lab return internal_dpg.add_child_window(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, payload_type=payload_type, drop_callback=drop_callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, border=border, autosize_x=autosize_x, autosize_y=autosize_y, no_scrollbar=no_scrollbar, horizontal_scrollbar=horizontal_scrollbar, menubar=menubar, no_scroll_with_mouse=no_scroll_with_mouse, flattened_navigation=flattened_navigation, always_use_window_padding=always_use_window_padding, resizable_x=resizable_x, resizable_y=resizable_y, always_auto_resize=always_auto_resize, frame_style=frame_style, auto_resize_x=auto_resize_x, auto_resize_y=auto_resize_y, **kwargs) -def add_clipper(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def add_clipper(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: """ Helper to manually clip large list of items. Increases performance by not searching or drawing widgets outside of the clipped region. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3550,11 +3550,11 @@ def add_clipper(*, label: str =None, user_data: Any =None, use_internal_label: b return internal_dpg.add_clipper(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, show=show, **kwargs) -def add_collapsing_header(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, closable: bool =False, default_open: bool =False, open_on_double_click: bool =False, open_on_arrow: bool =False, leaf: bool =False, bullet: bool =False, **kwargs) -> Union[int, str]: +def add_collapsing_header(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, closable: bool =False, default_open: bool =False, open_on_double_click: bool =False, open_on_arrow: bool =False, leaf: bool =False, bullet: bool =False, **kwargs) -> Union[int, str]: """ Adds a collapsing header to add items to. Must be closed with the end command. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3562,8 +3562,8 @@ def add_collapsing_header(*, label: str =None, user_data: Any =None, use_interna parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -3590,12 +3590,12 @@ def add_collapsing_header(*, label: str =None, user_data: Any =None, use_interna return internal_dpg.add_collapsing_header(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, payload_type=payload_type, drag_callback=drag_callback, drop_callback=drop_callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, closable=closable, default_open=default_open, open_on_double_click=open_on_double_click, open_on_arrow=open_on_arrow, leaf=leaf, bullet=bullet, **kwargs) -def add_color_button(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0, 255), *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, no_alpha: bool =False, no_border: bool =False, no_drag_drop: bool =False, alpha_preview: int =internal_dpg.mvColorEdit_AlphaPreviewNone, no_tooltip: bool =False, **kwargs) -> Union[int, str]: +def add_color_button(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0, 255), *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, no_alpha: bool =False, no_border: bool =False, no_drag_drop: bool =False, alpha_preview: int =internal_dpg.mvColorEdit_AlphaPreviewNone, no_tooltip: bool =False, **kwargs) -> Union[int, str]: """ Adds a color button. Args: default_value (Union[List[int], Tuple[int, ...]], optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3605,9 +3605,9 @@ def add_color_button(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0 parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3630,12 +3630,12 @@ def add_color_button(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0 return internal_dpg.add_color_button(default_value, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, no_alpha=no_alpha, no_border=no_border, no_drag_drop=no_drag_drop, alpha_preview=alpha_preview, no_tooltip=no_tooltip, **kwargs) -def add_color_edit(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0, 255), *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, no_alpha: bool =False, no_picker: bool =False, no_options: bool =False, no_small_preview: bool =False, no_inputs: bool =False, no_tooltip: bool =False, no_label: bool =False, no_drag_drop: bool =False, alpha_bar: bool =False, alpha_preview: int =internal_dpg.mvColorEdit_AlphaPreviewNone, display_mode: int =internal_dpg.mvColorEdit_rgb, display_type: int =internal_dpg.mvColorEdit_uint8, input_mode: int =internal_dpg.mvColorEdit_input_rgb, **kwargs) -> Union[int, str]: +def add_color_edit(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0, 255), *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, no_alpha: bool =False, no_picker: bool =False, no_options: bool =False, no_small_preview: bool =False, no_inputs: bool =False, no_tooltip: bool =False, no_label: bool =False, no_drag_drop: bool =False, alpha_bar: bool =False, alpha_preview: int =internal_dpg.mvColorEdit_AlphaPreviewNone, display_mode: int =internal_dpg.mvColorEdit_rgb, display_type: int =internal_dpg.mvColorEdit_uint8, input_mode: int =internal_dpg.mvColorEdit_input_rgb, **kwargs) -> Union[int, str]: """ Adds an RGBA color editor. Left clicking the small color preview will provide a color picker. Click and draging the small color preview will copy the color to be applied on any other color widget. Args: default_value (Union[List[int], Tuple[int, ...]], optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3646,9 +3646,9 @@ def add_color_edit(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0, before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3679,12 +3679,12 @@ def add_color_edit(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0, return internal_dpg.add_color_edit(default_value, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, no_alpha=no_alpha, no_picker=no_picker, no_options=no_options, no_small_preview=no_small_preview, no_inputs=no_inputs, no_tooltip=no_tooltip, no_label=no_label, no_drag_drop=no_drag_drop, alpha_bar=alpha_bar, alpha_preview=alpha_preview, display_mode=display_mode, display_type=display_type, input_mode=input_mode, **kwargs) -def add_color_picker(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0, 255), *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, no_alpha: bool =False, no_side_preview: bool =False, no_small_preview: bool =False, no_inputs: bool =False, no_tooltip: bool =False, no_label: bool =False, alpha_bar: bool =False, display_rgb: bool =False, display_hsv: bool =False, display_hex: bool =False, picker_mode: int =internal_dpg.mvColorPicker_bar, alpha_preview: int =internal_dpg.mvColorEdit_AlphaPreviewNone, display_type: int =internal_dpg.mvColorEdit_uint8, input_mode: int =internal_dpg.mvColorEdit_input_rgb, **kwargs) -> Union[int, str]: +def add_color_picker(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0, 255), *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, no_alpha: bool =False, no_side_preview: bool =False, no_small_preview: bool =False, no_inputs: bool =False, no_tooltip: bool =False, no_label: bool =False, alpha_bar: bool =False, display_rgb: bool =False, display_hsv: bool =False, display_hex: bool =False, picker_mode: int =internal_dpg.mvColorPicker_bar, alpha_preview: int =internal_dpg.mvColorEdit_AlphaPreviewNone, display_type: int =internal_dpg.mvColorEdit_uint8, input_mode: int =internal_dpg.mvColorEdit_input_rgb, **kwargs) -> Union[int, str]: """ Adds an RGB color picker. Right click the color picker for options. Click and drag the color preview to copy the color and drop on any other color widget to apply. Right Click allows the style of the color picker to be changed. Args: default_value (Union[List[int], Tuple[int, ...]], optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3695,9 +3695,9 @@ def add_color_picker(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0 before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3729,11 +3729,11 @@ def add_color_picker(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0 return internal_dpg.add_color_picker(default_value, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, no_alpha=no_alpha, no_side_preview=no_side_preview, no_small_preview=no_small_preview, no_inputs=no_inputs, no_tooltip=no_tooltip, no_label=no_label, alpha_bar=alpha_bar, display_rgb=display_rgb, display_hsv=display_hsv, display_hex=display_hex, picker_mode=picker_mode, alpha_preview=alpha_preview, display_type=display_type, input_mode=input_mode, **kwargs) -def add_color_value(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: Union[List[float], Tuple[float, ...]] =(0.0, 0.0, 0.0, 0.0), parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: +def add_color_value(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: Union[List[float], Tuple[float, ...]] =(0.0, 0.0, 0.0, 0.0), parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: """ Adds a color value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3751,13 +3751,13 @@ def add_color_value(*, label: str =None, user_data: Any =None, use_internal_labe return internal_dpg.add_color_value(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, source=source, default_value=default_value, parent=parent, **kwargs) -def add_colormap(colors : List[Union[List[int], Tuple[int, ...]]], qualitative : bool, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_4, **kwargs) -> Union[int, str]: +def add_colormap(colors : List[Union[List[int], Tuple[int, ...]]], qualitative : bool, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_4, **kwargs) -> Union[int, str]: """ Adds a legend that pairs colors with normalized value 0.0->1.0. Each color will be This is typically used with a heat series. (ex. [[0, 0, 0, 255], [255, 255, 255, 255]] will be mapped to a soft transition from 0.0-1.0) Args: colors (Any): colors that will be mapped to the normalized value 0.0->1.0 qualitative (bool): Qualitative will create hard transitions for color boundries across the value range when enabled. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3774,12 +3774,12 @@ def add_colormap(colors : List[Union[List[int], Tuple[int, ...]]], qualitative : return internal_dpg.add_colormap(colors, qualitative, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, show=show, parent=parent, **kwargs) -def add_colormap_button(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0, 255), *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, **kwargs) -> Union[int, str]: +def add_colormap_button(default_value : Union[List[int], Tuple[int, ...]] =(0, 0, 0, 255), *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, **kwargs) -> Union[int, str]: """ Adds a button that a color map can be bound to. Args: default_value (Union[List[int], Tuple[int, ...]], optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3789,9 +3789,9 @@ def add_colormap_button(default_value : Union[List[int], Tuple[int, ...]] =(0, 0 parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3809,11 +3809,11 @@ def add_colormap_button(default_value : Union[List[int], Tuple[int, ...]] =(0, 0 return internal_dpg.add_colormap_button(default_value, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, **kwargs) -def add_colormap_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =False, **kwargs) -> Union[int, str]: +def add_colormap_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =False, **kwargs) -> Union[int, str]: """ Adds a colormap registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3829,11 +3829,11 @@ def add_colormap_registry(*, label: str =None, user_data: Any =None, use_interna return internal_dpg.add_colormap_registry(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, show=show, **kwargs) -def add_colormap_scale(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], colormap: Union[int, str] =0, min_scale: float =0.0, max_scale: float =1.0, format: str ='%g', reverse_dir: bool =False, mirror: bool =False, **kwargs) -> Union[int, str]: +def add_colormap_scale(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], colormap: Union[int, str] =0, min_scale: float =0.0, max_scale: float =1.0, format: str ='%g', reverse_dir: bool =False, mirror: bool =False, **kwargs) -> Union[int, str]: """ Adds a legend that pairs values with colors. This is typically used with a heat series. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3844,7 +3844,7 @@ def add_colormap_scale(*, label: str =None, user_data: Any =None, use_internal_l before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. colormap (Union[int, str], optional): mvPlotColormap_* constants or mvColorMap uuid from a color map registry @@ -3854,7 +3854,7 @@ def add_colormap_scale(*, label: str =None, user_data: Any =None, use_internal_l reverse_dir (bool, optional): invert the colormap bar and axis scale (this only affects rendering; if you only want to reverse the scale mapping, make scale_min > scale_max) mirror (bool, optional): render the colormap label and tick labels on the opposite side id (Union[int, str], optional): (deprecated) - drag_callback (Callable, optional): (deprecated) + drag_callback (Optional[Callable], optional): (deprecated) Returns: Union[int, str] """ @@ -3871,11 +3871,11 @@ def add_colormap_scale(*, label: str =None, user_data: Any =None, use_internal_l return internal_dpg.add_colormap_scale(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, drop_callback=drop_callback, show=show, pos=pos, colormap=colormap, min_scale=min_scale, max_scale=max_scale, format=format, reverse_dir=reverse_dir, mirror=mirror, **kwargs) -def add_colormap_slider(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, **kwargs) -> Union[int, str]: +def add_colormap_slider(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, **kwargs) -> Union[int, str]: """ Adds a color slider that a color map can be bound to. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3885,8 +3885,8 @@ def add_colormap_slider(*, label: str =None, user_data: Any =None, use_internal_ parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -3894,7 +3894,7 @@ def add_colormap_slider(*, label: str =None, user_data: Any =None, use_internal_ track_offset (float, optional): 0.0f:top, 0.5f:center, 1.0f:bottom default_value (float, optional): id (Union[int, str], optional): (deprecated) - drag_callback (Callable, optional): (deprecated) + drag_callback (Optional[Callable], optional): (deprecated) Returns: Union[int, str] """ @@ -3911,12 +3911,12 @@ def add_colormap_slider(*, label: str =None, user_data: Any =None, use_internal_ return internal_dpg.add_colormap_slider(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, payload_type=payload_type, callback=callback, drop_callback=drop_callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, **kwargs) -def add_combo(items : Union[List[str], Tuple[str, ...]] =(), *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: str ='', popup_align_left: bool =False, no_arrow_button: bool =False, no_preview: bool =False, fit_width: bool =False, height_mode: int =1, **kwargs) -> Union[int, str]: +def add_combo(items : Union[List[str], Tuple[str, ...]] =(), *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: str ='', popup_align_left: bool =False, no_arrow_button: bool =False, no_preview: bool =False, fit_width: bool =False, height_mode: int =1, **kwargs) -> Union[int, str]: """ Adds a combo dropdown that allows a user to select a single option from a drop down window. All items will be shown as selectables on the dropdown. Args: items (Union[List[str], Tuple[str, ...]], optional): A tuple of items to be shown in the drop down window. Can consist of any combination of types but will convert all items to strings to be shown. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3926,9 +3926,9 @@ def add_combo(items : Union[List[str], Tuple[str, ...]] =(), *, label: str =None before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -3952,21 +3952,21 @@ def add_combo(items : Union[List[str], Tuple[str, ...]] =(), *, label: str =None return internal_dpg.add_combo(items, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, popup_align_left=popup_align_left, no_arrow_button=no_arrow_button, no_preview=no_preview, fit_width=fit_width, height_mode=height_mode, **kwargs) -def add_custom_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], channel_count : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Callable =None, show: bool =True, y1: Any =[], y2: Any =[], y3: Any =[], tooltip: bool =True, no_fit: bool =False, **kwargs) -> Union[int, str]: +def add_custom_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], channel_count : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, y1: Any =[], y2: Any =[], y3: Any =[], tooltip: bool =True, no_fit: bool =False, **kwargs) -> Union[int, str]: """ Adds a custom series to a plot. New in 1.6. Args: x (Any): y (Any): channel_count (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. y1 (Any, optional): y2 (Any, optional): @@ -3984,11 +3984,11 @@ def add_custom_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[ return internal_dpg.add_custom_series(x, y, channel_count, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, callback=callback, show=show, y1=y1, y2=y2, y3=y3, tooltip=tooltip, no_fit=no_fit, **kwargs) -def add_date_picker(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: dict ={'month_day': 14, 'year':20, 'month':5}, level: int =0, **kwargs) -> Union[int, str]: +def add_date_picker(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: dict ={'month_day': 14, 'year':20, 'month':5}, level: int =0, **kwargs) -> Union[int, str]: """ Adds a date picker. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -3996,9 +3996,9 @@ def add_date_picker(*, label: str =None, user_data: Any =None, use_internal_labe parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -4017,13 +4017,13 @@ def add_date_picker(*, label: str =None, user_data: Any =None, use_internal_labe return internal_dpg.add_date_picker(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, level=level, **kwargs) -def add_digital_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def add_digital_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a digital series to a plot. Digital plots do not respond to y drag or zoom, and are always referenced to the bottom of the plot. Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4042,11 +4042,11 @@ def add_digital_series(x : Union[List[float], Tuple[float, ...]], y : Union[List return internal_dpg.add_digital_series(x, y, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, **kwargs) -def add_double4_value(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: Any =(0.0, 0.0, 0.0, 0.0), parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: +def add_double4_value(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: Any =(0.0, 0.0, 0.0, 0.0), parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: """ Adds a double value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4064,11 +4064,11 @@ def add_double4_value(*, label: str =None, user_data: Any =None, use_internal_la return internal_dpg.add_double4_value(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, source=source, default_value=default_value, parent=parent, **kwargs) -def add_double_value(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: float =0.0, parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: +def add_double_value(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: float =0.0, parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: """ Adds a double value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4086,11 +4086,11 @@ def add_double_value(*, label: str =None, user_data: Any =None, use_internal_lab return internal_dpg.add_double_value(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, source=source, default_value=default_value, parent=parent, **kwargs) -def add_drag_double(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, format: str ='%0.3f', speed: float =1.0, min_value: float =0.0, max_value: float =100.0, no_input: bool =False, clamped: bool =False, **kwargs) -> Union[int, str]: +def add_drag_double(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, format: str ='%0.3f', speed: float =1.0, min_value: float =0.0, max_value: float =100.0, no_input: bool =False, clamped: bool =False, **kwargs) -> Union[int, str]: """ Adds drag for a single double value. Useful when drag float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4100,9 +4100,9 @@ def add_drag_double(*, label: str =None, user_data: Any =None, use_internal_labe before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4127,11 +4127,11 @@ def add_drag_double(*, label: str =None, user_data: Any =None, use_internal_labe return internal_dpg.add_drag_double(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, format=format, speed=speed, min_value=min_value, max_value=max_value, no_input=no_input, clamped=clamped, **kwargs) -def add_drag_doublex(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Any =(0.0, 0.0, 0.0, 0.0), size: int =4, format: str ='%0.3f', speed: float =1.0, min_value: float =0.0, max_value: float =100.0, no_input: bool =False, clamped: bool =False, **kwargs) -> Union[int, str]: +def add_drag_doublex(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Any =(0.0, 0.0, 0.0, 0.0), size: int =4, format: str ='%0.3f', speed: float =1.0, min_value: float =0.0, max_value: float =100.0, no_input: bool =False, clamped: bool =False, **kwargs) -> Union[int, str]: """ Adds drag input for a set of double values up to 4. Useful when drag float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4141,9 +4141,9 @@ def add_drag_doublex(*, label: str =None, user_data: Any =None, use_internal_lab before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4169,11 +4169,11 @@ def add_drag_doublex(*, label: str =None, user_data: Any =None, use_internal_lab return internal_dpg.add_drag_doublex(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, size=size, format=format, speed=speed, min_value=min_value, max_value=max_value, no_input=no_input, clamped=clamped, **kwargs) -def add_drag_float(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, format: str ='%0.3f', speed: float =1.0, min_value: float =0.0, max_value: float =100.0, no_input: bool =False, clamped: bool =False, **kwargs) -> Union[int, str]: +def add_drag_float(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, format: str ='%0.3f', speed: float =1.0, min_value: float =0.0, max_value: float =100.0, no_input: bool =False, clamped: bool =False, **kwargs) -> Union[int, str]: """ Adds drag for a single float value. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4183,9 +4183,9 @@ def add_drag_float(*, label: str =None, user_data: Any =None, use_internal_label before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4210,11 +4210,11 @@ def add_drag_float(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_drag_float(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, format=format, speed=speed, min_value=min_value, max_value=max_value, no_input=no_input, clamped=clamped, **kwargs) -def add_drag_floatx(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[float], Tuple[float, ...]] =(0.0, 0.0, 0.0, 0.0), size: int =4, format: str ='%0.3f', speed: float =1.0, min_value: float =0.0, max_value: float =100.0, no_input: bool =False, clamped: bool =False, **kwargs) -> Union[int, str]: +def add_drag_floatx(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[float], Tuple[float, ...]] =(0.0, 0.0, 0.0, 0.0), size: int =4, format: str ='%0.3f', speed: float =1.0, min_value: float =0.0, max_value: float =100.0, no_input: bool =False, clamped: bool =False, **kwargs) -> Union[int, str]: """ Adds drag input for a set of float values up to 4. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4224,9 +4224,9 @@ def add_drag_floatx(*, label: str =None, user_data: Any =None, use_internal_labe before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4252,11 +4252,11 @@ def add_drag_floatx(*, label: str =None, user_data: Any =None, use_internal_labe return internal_dpg.add_drag_floatx(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, size=size, format=format, speed=speed, min_value=min_value, max_value=max_value, no_input=no_input, clamped=clamped, **kwargs) -def add_drag_int(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: int =0, format: str ='%d', speed: float =1.0, min_value: int =0, max_value: int =100, no_input: bool =False, clamped: bool =False, **kwargs) -> Union[int, str]: +def add_drag_int(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: int =0, format: str ='%d', speed: float =1.0, min_value: int =0, max_value: int =100, no_input: bool =False, clamped: bool =False, **kwargs) -> Union[int, str]: """ Adds drag for a single int value. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4266,9 +4266,9 @@ def add_drag_int(*, label: str =None, user_data: Any =None, use_internal_label: before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4293,11 +4293,11 @@ def add_drag_int(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_drag_int(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, format=format, speed=speed, min_value=min_value, max_value=max_value, no_input=no_input, clamped=clamped, **kwargs) -def add_drag_intx(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[int], Tuple[int, ...]] =(0, 0, 0, 0), size: int =4, format: str ='%d', speed: float =1.0, min_value: int =0, max_value: int =100, no_input: bool =False, clamped: bool =False, **kwargs) -> Union[int, str]: +def add_drag_intx(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[int], Tuple[int, ...]] =(0, 0, 0, 0), size: int =4, format: str ='%d', speed: float =1.0, min_value: int =0, max_value: int =100, no_input: bool =False, clamped: bool =False, **kwargs) -> Union[int, str]: """ Adds drag input for a set of int values up to 4. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4307,9 +4307,9 @@ def add_drag_intx(*, label: str =None, user_data: Any =None, use_internal_label: before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4335,18 +4335,18 @@ def add_drag_intx(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_drag_intx(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, size=size, format=format, speed=speed, min_value=min_value, max_value=max_value, no_input=no_input, clamped=clamped, **kwargs) -def add_drag_line(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Callable =None, show: bool =True, default_value: float =0.0, color: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, show_label: bool =True, vertical: bool =True, delayed: bool =False, no_cursor: bool =False, no_fit: bool =False, no_inputs: bool =False, **kwargs) -> Union[int, str]: +def add_drag_line(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, default_value: float =0.0, color: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, show_label: bool =True, vertical: bool =True, delayed: bool =False, no_cursor: bool =False, no_fit: bool =False, no_inputs: bool =False, **kwargs) -> Union[int, str]: """ Adds a drag line to a plot. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. default_value (float, optional): color (Union[List[int], Tuple[int, ...]], optional): @@ -4368,11 +4368,11 @@ def add_drag_line(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_drag_line(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, callback=callback, show=show, default_value=default_value, color=color, thickness=thickness, show_label=show_label, vertical=vertical, delayed=delayed, no_cursor=no_cursor, no_fit=no_fit, no_inputs=no_inputs, **kwargs) -def add_drag_payload(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, show: bool =True, drag_data: Any =None, drop_data: Any =None, payload_type: str ='$$DPG_PAYLOAD', **kwargs) -> Union[int, str]: +def add_drag_payload(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, show: bool =True, drag_data: Any =None, drop_data: Any =None, payload_type: str ='$$DPG_PAYLOAD', **kwargs) -> Union[int, str]: """ User data payload for drag and drop operations. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4392,18 +4392,18 @@ def add_drag_payload(*, label: str =None, user_data: Any =None, use_internal_lab return internal_dpg.add_drag_payload(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, show=show, drag_data=drag_data, drop_data=drop_data, payload_type=payload_type, **kwargs) -def add_drag_point(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Callable =None, show: bool =True, default_value: Any =(0.0, 0.0), color: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, show_label: bool =True, offset: Union[List[float], Tuple[float, ...]] =(16.0, 8.0), clamped: bool =True, delayed: bool =False, no_cursor: bool =False, no_fit: bool =False, no_inputs: bool =False, **kwargs) -> Union[int, str]: +def add_drag_point(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, default_value: Any =(0.0, 0.0), color: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, show_label: bool =True, offset: Union[List[float], Tuple[float, ...]] =(16.0, 8.0), clamped: bool =True, delayed: bool =False, no_cursor: bool =False, no_fit: bool =False, no_inputs: bool =False, **kwargs) -> Union[int, str]: """ Adds a drag point to a plot. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. default_value (Any, optional): color (Union[List[int], Tuple[int, ...]], optional): @@ -4426,18 +4426,18 @@ def add_drag_point(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_drag_point(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, callback=callback, show=show, default_value=default_value, color=color, thickness=thickness, show_label=show_label, offset=offset, clamped=clamped, delayed=delayed, no_cursor=no_cursor, no_fit=no_fit, no_inputs=no_inputs, **kwargs) -def add_drag_rect(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Callable =None, show: bool =True, default_value: Any =(0.0, 0.0, 0.0, 0.0), color: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), delayed: bool =False, no_cursor: bool =False, no_fit: bool =False, no_inputs: bool =False, **kwargs) -> Union[int, str]: +def add_drag_rect(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, default_value: Any =(0.0, 0.0, 0.0, 0.0), color: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), delayed: bool =False, no_cursor: bool =False, no_fit: bool =False, no_inputs: bool =False, **kwargs) -> Union[int, str]: """ Adds a drag rectangle to a plot. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. default_value (Any, optional): The coordinates are specified in a sequence of: (xmin, ymin, xmax, ymax) color (Union[List[int], Tuple[int, ...]], optional): @@ -4456,11 +4456,11 @@ def add_drag_rect(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_drag_rect(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, callback=callback, show=show, default_value=default_value, color=color, delayed=delayed, no_cursor=no_cursor, no_fit=no_fit, no_inputs=no_inputs, **kwargs) -def add_draw_layer(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, perspective_divide: bool =False, depth_clipping: bool =False, cull_mode: int =0, **kwargs) -> Union[int, str]: +def add_draw_layer(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, perspective_divide: bool =False, depth_clipping: bool =False, cull_mode: int =0, **kwargs) -> Union[int, str]: """ New in 1.1. Creates a layer useful for grouping drawlist items. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4481,11 +4481,11 @@ def add_draw_layer(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_draw_layer(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, perspective_divide=perspective_divide, depth_clipping=depth_clipping, cull_mode=cull_mode, **kwargs) -def add_draw_node(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def add_draw_node(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: """ New in 1.1. Creates a drawing node to associate a transformation matrix. Child node matricies will concatenate. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4503,19 +4503,19 @@ def add_draw_node(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_draw_node(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, **kwargs) -def add_drawlist(width : int, height : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, **kwargs) -> Union[int, str]: +def add_drawlist(width : int, height : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, **kwargs) -> Union[int, str]: """ Adds a drawing canvas. Args: width (int): height (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -4536,14 +4536,14 @@ def add_drawlist(width : int, height : int, *, label: str =None, user_data: Any return internal_dpg.add_drawlist(width, height, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, callback=callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, **kwargs) -def add_dynamic_texture(width : int, height : int, default_value : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =internal_dpg.mvReservedUUID_2, **kwargs) -> Union[int, str]: +def add_dynamic_texture(width : int, height : int, default_value : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =internal_dpg.mvReservedUUID_2, **kwargs) -> Union[int, str]: """ Adds a dynamic texture. Args: width (int): height (int): default_value (Union[List[float], Tuple[float, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4559,7 +4559,7 @@ def add_dynamic_texture(width : int, height : int, default_value : Union[List[fl return internal_dpg.add_dynamic_texture(width, height, default_value, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, **kwargs) -def add_error_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], negative : Union[List[float], Tuple[float, ...]], positive : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, contribute_to_bounds: bool =True, horizontal: bool =False, **kwargs) -> Union[int, str]: +def add_error_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], negative : Union[List[float], Tuple[float, ...]], positive : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, contribute_to_bounds: bool =True, horizontal: bool =False, **kwargs) -> Union[int, str]: """ Adds an error series to a plot. Args: @@ -4567,7 +4567,7 @@ def add_error_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[f y (Any): negative (Any): positive (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4588,17 +4588,17 @@ def add_error_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[f return internal_dpg.add_error_series(x, y, negative, positive, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, contribute_to_bounds=contribute_to_bounds, horizontal=horizontal, **kwargs) -def add_file_dialog(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, callback: Callable =None, show: bool =True, default_path: str ='', default_filename: str ='.', file_count: int =0, modal: bool =False, directory_selector: bool =False, min_size: Union[List[int], Tuple[int, ...]] =[100, 100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], cancel_callback: Callable =None, **kwargs) -> Union[int, str]: +def add_file_dialog(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, callback: Optional[Callable] =None, show: bool =True, default_path: str ='', default_filename: str ='.', file_count: int =0, modal: bool =False, directory_selector: bool =False, min_size: Union[List[int], Tuple[int, ...]] =[100, 100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], cancel_callback: Optional[Callable] =None, **kwargs) -> Union[int, str]: """ Displays a file or directory selector depending on keywords. Displays a file dialog by default. Callback will be ran when the file or directory picker is closed. The app_data arguemnt will be populated with information related to the file and directory as a dictionary. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. width (int, optional): Width of the item. height (int, optional): Height of the item. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. default_path (str, optional): Path that the file dialog will default to when opened. default_filename (str, optional): Default name that will show in the file name input. @@ -4607,7 +4607,7 @@ def add_file_dialog(*, label: str =None, user_data: Any =None, use_internal_labe directory_selector (bool, optional): Shows only directory/paths as options. Allows selection of directory/paths only. min_size (Union[List[int], Tuple[int, ...]], optional): Minimum window size. max_size (Union[List[int], Tuple[int, ...]], optional): Maximum window size. - cancel_callback (Callable, optional): Callback called when cancel button is clicked. + cancel_callback (Optional[Callable], optional): Callback called when cancel button is clicked. id (Union[int, str], optional): (deprecated) Returns: Union[int, str] @@ -4619,12 +4619,12 @@ def add_file_dialog(*, label: str =None, user_data: Any =None, use_internal_labe return internal_dpg.add_file_dialog(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, callback=callback, show=show, default_path=default_path, default_filename=default_filename, file_count=file_count, modal=modal, directory_selector=directory_selector, min_size=min_size, max_size=max_size, cancel_callback=cancel_callback, **kwargs) -def add_file_extension(extension : str, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, custom_text: str ='', color: Union[List[int], Tuple[int, ...]] =(-255, 0, 0, 255), **kwargs) -> Union[int, str]: +def add_file_extension(extension : str, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, custom_text: str ='', color: Union[List[int], Tuple[int, ...]] =(-255, 0, 0, 255), **kwargs) -> Union[int, str]: """ Creates a file extension filter option in the file dialog. Args: extension (str): Extension that will show as an when the parent is a file dialog. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4645,11 +4645,11 @@ def add_file_extension(extension : str, *, label: str =None, user_data: Any =Non return internal_dpg.add_file_extension(extension, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, parent=parent, before=before, custom_text=custom_text, color=color, **kwargs) -def add_filter_set(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def add_filter_set(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: """ Helper to parse and apply text filters (e.g. aaaaa[, bbbbb][, ccccc]) Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4673,11 +4673,11 @@ def add_filter_set(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_filter_set(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, show=show, **kwargs) -def add_float4_value(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: Union[List[float], Tuple[float, ...]] =(0.0, 0.0, 0.0, 0.0), parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: +def add_float4_value(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: Union[List[float], Tuple[float, ...]] =(0.0, 0.0, 0.0, 0.0), parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: """ Adds a float4 value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4695,11 +4695,11 @@ def add_float4_value(*, label: str =None, user_data: Any =None, use_internal_lab return internal_dpg.add_float4_value(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, source=source, default_value=default_value, parent=parent, **kwargs) -def add_float_value(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: float =0.0, parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: +def add_float_value(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: float =0.0, parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: """ Adds a float value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4717,11 +4717,11 @@ def add_float_value(*, label: str =None, user_data: Any =None, use_internal_labe return internal_dpg.add_float_value(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, source=source, default_value=default_value, parent=parent, **kwargs) -def add_float_vect_value(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: Union[List[float], Tuple[float, ...]] =(), parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: +def add_float_vect_value(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: Union[List[float], Tuple[float, ...]] =(), parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: """ Adds a float vect value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4739,13 +4739,13 @@ def add_float_vect_value(*, label: str =None, user_data: Any =None, use_internal return internal_dpg.add_float_vect_value(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, source=source, default_value=default_value, parent=parent, **kwargs) -def add_font(file : str, size : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, pixel_snapH: bool =False, pixel_snapV: bool =False, parent: Union[int, str] =internal_dpg.mvReservedUUID_0, **kwargs) -> Union[int, str]: +def add_font(file : str, size : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, pixel_snapH: bool =False, pixel_snapV: bool =False, parent: Union[int, str] =internal_dpg.mvReservedUUID_0, **kwargs) -> Union[int, str]: """ Adds font to a font registry. Args: file (str): size (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4770,11 +4770,11 @@ def add_font(file : str, size : int, *, label: str =None, user_data: Any =None, return internal_dpg.add_font(file, size, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, pixel_snapH=pixel_snapH, pixel_snapV=pixel_snapV, parent=parent, **kwargs) -def add_font_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def add_font_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a font registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4790,12 +4790,12 @@ def add_font_registry(*, label: str =None, user_data: Any =None, use_internal_la return internal_dpg.add_font_registry(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, show=show, **kwargs) -def add_group(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, horizontal: bool =False, horizontal_spacing: float =-1, xoffset: float =0.0, **kwargs) -> Union[int, str]: +def add_group(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, horizontal: bool =False, horizontal_spacing: float =-1, xoffset: float =0.0, **kwargs) -> Union[int, str]: """ Creates a group that other widgets can belong to. The group allows item commands to be issued for all of its members. Enable property acts in a special way enabling/disabling everything inside the group. (Use mvStyleVar_DisabledAlpha to edit colors within the disabled group.) Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4805,8 +4805,8 @@ def add_group(*, label: str =None, user_data: Any =None, use_internal_label: boo parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -4831,11 +4831,11 @@ def add_group(*, label: str =None, user_data: Any =None, use_internal_label: boo return internal_dpg.add_group(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, payload_type=payload_type, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, horizontal=horizontal, horizontal_spacing=horizontal_spacing, xoffset=xoffset, **kwargs) -def add_handler_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def add_handler_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a handler registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4851,14 +4851,14 @@ def add_handler_registry(*, label: str =None, user_data: Any =None, use_internal return internal_dpg.add_handler_registry(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, show=show, **kwargs) -def add_heat_series(x : Union[List[float], Tuple[float, ...]], rows : int, cols : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, scale_min: float =0.0, scale_max: float =1.0, bounds_min: Any =(0.0, 0.0), bounds_max: Any =(1.0, 1.0), format: str ='%0.1f', contribute_to_bounds: bool =True, col_major: bool =False, **kwargs) -> Union[int, str]: +def add_heat_series(x : Union[List[float], Tuple[float, ...]], rows : int, cols : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, scale_min: float =0.0, scale_max: float =1.0, bounds_min: Any =(0.0, 0.0), bounds_max: Any =(1.0, 1.0), format: str ='%0.1f', contribute_to_bounds: bool =True, col_major: bool =False, **kwargs) -> Union[int, str]: """ Adds a heat series to a plot. Args: x (Any): rows (int): cols (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4884,12 +4884,12 @@ def add_heat_series(x : Union[List[float], Tuple[float, ...]], rows : int, cols return internal_dpg.add_heat_series(x, rows, cols, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, scale_min=scale_min, scale_max=scale_max, bounds_min=bounds_min, bounds_max=bounds_max, format=format, contribute_to_bounds=contribute_to_bounds, col_major=col_major, **kwargs) -def add_histogram_series(x : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, bins: int =-1, bar_scale: float =1.0, min_range: float =0.0, max_range: float =0.0, cumulative: bool =False, density: bool =False, outliers: bool =True, horizontal: bool =False, contribute_to_bounds: bool =True, **kwargs) -> Union[int, str]: +def add_histogram_series(x : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, bins: int =-1, bar_scale: float =1.0, min_range: float =0.0, max_range: float =0.0, cumulative: bool =False, density: bool =False, outliers: bool =True, horizontal: bool =False, contribute_to_bounds: bool =True, **kwargs) -> Union[int, str]: """ Adds a histogram series to a plot. Args: x (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4922,12 +4922,12 @@ def add_histogram_series(x : Union[List[float], Tuple[float, ...]], *, label: st return internal_dpg.add_histogram_series(x, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, bins=bins, bar_scale=bar_scale, min_range=min_range, max_range=max_range, cumulative=cumulative, density=density, outliers=outliers, horizontal=horizontal, contribute_to_bounds=contribute_to_bounds, **kwargs) -def add_image(texture_tag : Union[int, str], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, tint_color: Union[List[float], Tuple[float, ...]] =(255, 255, 255, 255), border_color: Union[List[float], Tuple[float, ...]] =(0, 0, 0, 0), uv_min: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), uv_max: Union[List[float], Tuple[float, ...]] =(1.0, 1.0), **kwargs) -> Union[int, str]: +def add_image(texture_tag : Union[int, str], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, tint_color: Union[List[float], Tuple[float, ...]] =(255, 255, 255, 255), border_color: Union[List[float], Tuple[float, ...]] =(0, 0, 0, 0), uv_min: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), uv_max: Union[List[float], Tuple[float, ...]] =(1.0, 1.0), **kwargs) -> Union[int, str]: """ Adds an image from a specified texture. uv_min and uv_max represent the normalized texture coordinates of the original image that will be shown. Using range (0.0,0.0)->(1.0,1.0) for texture coordinates will generally display the entire texture. Args: texture_tag (Union[int, str]): The texture_tag should come from a texture that was added to a texture registry. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4938,8 +4938,8 @@ def add_image(texture_tag : Union[int, str], *, label: str =None, user_data: Any before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -4960,12 +4960,12 @@ def add_image(texture_tag : Union[int, str], *, label: str =None, user_data: Any return internal_dpg.add_image(texture_tag, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, drag_callback=drag_callback, drop_callback=drop_callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, tint_color=tint_color, border_color=border_color, uv_min=uv_min, uv_max=uv_max, **kwargs) -def add_image_button(texture_tag : Union[int, str], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, tint_color: Union[List[float], Tuple[float, ...]] =(255, 255, 255, 255), background_color: Union[List[float], Tuple[float, ...]] =(0, 0, 0, 0), uv_min: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), uv_max: Union[List[float], Tuple[float, ...]] =(1.0, 1.0), **kwargs) -> Union[int, str]: +def add_image_button(texture_tag : Union[int, str], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, tint_color: Union[List[float], Tuple[float, ...]] =(255, 255, 255, 255), background_color: Union[List[float], Tuple[float, ...]] =(0, 0, 0, 0), uv_min: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), uv_max: Union[List[float], Tuple[float, ...]] =(1.0, 1.0), **kwargs) -> Union[int, str]: """ Adds an button with a texture. uv_min and uv_max represent the normalized texture coordinates of the original image that will be shown. Using range (0.0,0.0)->(1.0,1.0) texture coordinates will generally display the entire texture Args: texture_tag (Union[int, str]): The texture_tag should come from a texture that was added to a texture registry. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -4976,9 +4976,9 @@ def add_image_button(texture_tag : Union[int, str], *, label: str =None, user_da before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5004,14 +5004,14 @@ def add_image_button(texture_tag : Union[int, str], *, label: str =None, user_da return internal_dpg.add_image_button(texture_tag, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, tint_color=tint_color, background_color=background_color, uv_min=uv_min, uv_max=uv_max, **kwargs) -def add_image_series(texture_tag : Union[int, str], bounds_min : Union[List[float], Tuple[float, ...]], bounds_max : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, uv_min: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), uv_max: Union[List[float], Tuple[float, ...]] =(1.0, 1.0), tint_color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), **kwargs) -> Union[int, str]: +def add_image_series(texture_tag : Union[int, str], bounds_min : Union[List[float], Tuple[float, ...]], bounds_max : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, uv_min: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), uv_max: Union[List[float], Tuple[float, ...]] =(1.0, 1.0), tint_color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), **kwargs) -> Union[int, str]: """ Adds an image series to a plot. Args: texture_tag (Union[int, str]): bounds_min (Any): bounds_max (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5033,12 +5033,12 @@ def add_image_series(texture_tag : Union[int, str], bounds_min : Union[List[floa return internal_dpg.add_image_series(texture_tag, bounds_min, bounds_max, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, uv_min=uv_min, uv_max=uv_max, tint_color=tint_color, **kwargs) -def add_inf_line_series(x : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, horizontal: bool =False, **kwargs) -> Union[int, str]: +def add_inf_line_series(x : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, horizontal: bool =False, **kwargs) -> Union[int, str]: """ Adds an infinite line series to a plot. Args: x (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5058,11 +5058,11 @@ def add_inf_line_series(x : Union[List[float], Tuple[float, ...]], *, label: str return internal_dpg.add_inf_line_series(x, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, horizontal=horizontal, **kwargs) -def add_input_double(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, format: str ='%.3f', min_value: float =0.0, max_value: float =100.0, step: float =0.1, step_fast: float =1.0, min_clamped: bool =False, max_clamped: bool =False, on_enter: bool =False, readonly: bool =False, accept_empty_input: bool =False, display_empty_value: bool =False, **kwargs) -> Union[int, str]: +def add_input_double(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, format: str ='%.3f', min_value: float =0.0, max_value: float =100.0, step: float =0.1, step_fast: float =1.0, min_clamped: bool =False, max_clamped: bool =False, on_enter: bool =False, readonly: bool =False, accept_empty_input: bool =False, display_empty_value: bool =False, **kwargs) -> Union[int, str]: """ Adds input for an double. Useful when input float is not accurate enough. +/- buttons can be activated by setting the value of step. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5072,9 +5072,9 @@ def add_input_double(*, label: str =None, user_data: Any =None, use_internal_lab before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5104,11 +5104,11 @@ def add_input_double(*, label: str =None, user_data: Any =None, use_internal_lab return internal_dpg.add_input_double(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, format=format, min_value=min_value, max_value=max_value, step=step, step_fast=step_fast, min_clamped=min_clamped, max_clamped=max_clamped, on_enter=on_enter, readonly=readonly, accept_empty_input=accept_empty_input, display_empty_value=display_empty_value, **kwargs) -def add_input_doublex(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Any =(0.0, 0.0, 0.0, 0.0), format: str ='%.3f', min_value: float =0.0, max_value: float =100.0, size: int =4, min_clamped: bool =False, max_clamped: bool =False, on_enter: bool =False, readonly: bool =False, accept_empty_input: bool =False, display_empty_value: bool =False, **kwargs) -> Union[int, str]: +def add_input_doublex(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Any =(0.0, 0.0, 0.0, 0.0), format: str ='%.3f', min_value: float =0.0, max_value: float =100.0, size: int =4, min_clamped: bool =False, max_clamped: bool =False, on_enter: bool =False, readonly: bool =False, accept_empty_input: bool =False, display_empty_value: bool =False, **kwargs) -> Union[int, str]: """ Adds multi double input for up to 4 double values. Useful when input float mulit is not accurate enough. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5118,9 +5118,9 @@ def add_input_doublex(*, label: str =None, user_data: Any =None, use_internal_la before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5149,11 +5149,11 @@ def add_input_doublex(*, label: str =None, user_data: Any =None, use_internal_la return internal_dpg.add_input_doublex(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, format=format, min_value=min_value, max_value=max_value, size=size, min_clamped=min_clamped, max_clamped=max_clamped, on_enter=on_enter, readonly=readonly, accept_empty_input=accept_empty_input, display_empty_value=display_empty_value, **kwargs) -def add_input_float(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, format: str ='%.3f', min_value: float =0.0, max_value: float =100.0, step: float =0.1, step_fast: float =1.0, min_clamped: bool =False, max_clamped: bool =False, on_enter: bool =False, readonly: bool =False, accept_empty_input: bool =False, display_empty_value: bool =False, **kwargs) -> Union[int, str]: +def add_input_float(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, format: str ='%.3f', min_value: float =0.0, max_value: float =100.0, step: float =0.1, step_fast: float =1.0, min_clamped: bool =False, max_clamped: bool =False, on_enter: bool =False, readonly: bool =False, accept_empty_input: bool =False, display_empty_value: bool =False, **kwargs) -> Union[int, str]: """ Adds input for an float. +/- buttons can be activated by setting the value of step. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5163,9 +5163,9 @@ def add_input_float(*, label: str =None, user_data: Any =None, use_internal_labe before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5195,11 +5195,11 @@ def add_input_float(*, label: str =None, user_data: Any =None, use_internal_labe return internal_dpg.add_input_float(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, format=format, min_value=min_value, max_value=max_value, step=step, step_fast=step_fast, min_clamped=min_clamped, max_clamped=max_clamped, on_enter=on_enter, readonly=readonly, accept_empty_input=accept_empty_input, display_empty_value=display_empty_value, **kwargs) -def add_input_floatx(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[float], Tuple[float, ...]] =(0.0, 0.0, 0.0, 0.0), format: str ='%.3f', min_value: float =0.0, max_value: float =100.0, size: int =4, min_clamped: bool =False, max_clamped: bool =False, on_enter: bool =False, readonly: bool =False, accept_empty_input: bool =False, display_empty_value: bool =False, **kwargs) -> Union[int, str]: +def add_input_floatx(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[float], Tuple[float, ...]] =(0.0, 0.0, 0.0, 0.0), format: str ='%.3f', min_value: float =0.0, max_value: float =100.0, size: int =4, min_clamped: bool =False, max_clamped: bool =False, on_enter: bool =False, readonly: bool =False, accept_empty_input: bool =False, display_empty_value: bool =False, **kwargs) -> Union[int, str]: """ Adds multi float input for up to 4 float values. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5209,9 +5209,9 @@ def add_input_floatx(*, label: str =None, user_data: Any =None, use_internal_lab before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5240,11 +5240,11 @@ def add_input_floatx(*, label: str =None, user_data: Any =None, use_internal_lab return internal_dpg.add_input_floatx(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, format=format, min_value=min_value, max_value=max_value, size=size, min_clamped=min_clamped, max_clamped=max_clamped, on_enter=on_enter, readonly=readonly, accept_empty_input=accept_empty_input, display_empty_value=display_empty_value, **kwargs) -def add_input_int(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: int =0, min_value: int =0, max_value: int =100, step: int =1, step_fast: int =100, min_clamped: bool =False, max_clamped: bool =False, on_enter: bool =False, readonly: bool =False, accept_empty_input: bool =False, display_empty_value: bool =False, **kwargs) -> Union[int, str]: +def add_input_int(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: int =0, min_value: int =0, max_value: int =100, step: int =1, step_fast: int =100, min_clamped: bool =False, max_clamped: bool =False, on_enter: bool =False, readonly: bool =False, accept_empty_input: bool =False, display_empty_value: bool =False, **kwargs) -> Union[int, str]: """ Adds input for an int. +/- buttons can be activated by setting the value of step. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5254,9 +5254,9 @@ def add_input_int(*, label: str =None, user_data: Any =None, use_internal_label: before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5285,11 +5285,11 @@ def add_input_int(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_input_int(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, min_value=min_value, max_value=max_value, step=step, step_fast=step_fast, min_clamped=min_clamped, max_clamped=max_clamped, on_enter=on_enter, readonly=readonly, accept_empty_input=accept_empty_input, display_empty_value=display_empty_value, **kwargs) -def add_input_intx(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[int], Tuple[int, ...]] =(0, 0, 0, 0), min_value: int =0, max_value: int =100, size: int =4, min_clamped: bool =False, max_clamped: bool =False, on_enter: bool =False, readonly: bool =False, accept_empty_input: bool =False, display_empty_value: bool =False, **kwargs) -> Union[int, str]: +def add_input_intx(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[int], Tuple[int, ...]] =(0, 0, 0, 0), min_value: int =0, max_value: int =100, size: int =4, min_clamped: bool =False, max_clamped: bool =False, on_enter: bool =False, readonly: bool =False, accept_empty_input: bool =False, display_empty_value: bool =False, **kwargs) -> Union[int, str]: """ Adds multi int input for up to 4 integer values. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5299,9 +5299,9 @@ def add_input_intx(*, label: str =None, user_data: Any =None, use_internal_label before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5329,11 +5329,11 @@ def add_input_intx(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_input_intx(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, min_value=min_value, max_value=max_value, size=size, min_clamped=min_clamped, max_clamped=max_clamped, on_enter=on_enter, readonly=readonly, accept_empty_input=accept_empty_input, display_empty_value=display_empty_value, **kwargs) -def add_input_text(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: str ='', hint: str ='', multiline: bool =False, no_spaces: bool =False, uppercase: bool =False, tab_input: bool =False, decimal: bool =False, hexadecimal: bool =False, readonly: bool =False, password: bool =False, scientific: bool =False, on_enter: bool =False, auto_select_all: bool =False, ctrl_enter_for_new_line: bool =False, no_horizontal_scroll: bool =False, always_overwrite: bool =False, no_undo_redo: bool =False, escape_clears_all: bool =False, elide_left: bool =False, **kwargs) -> Union[int, str]: +def add_input_text(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: str ='', hint: str ='', multiline: bool =False, no_spaces: bool =False, uppercase: bool =False, tab_input: bool =False, decimal: bool =False, hexadecimal: bool =False, readonly: bool =False, password: bool =False, scientific: bool =False, on_enter: bool =False, auto_select_all: bool =False, ctrl_enter_for_new_line: bool =False, no_horizontal_scroll: bool =False, always_overwrite: bool =False, no_undo_redo: bool =False, escape_clears_all: bool =False, elide_left: bool =False, **kwargs) -> Union[int, str]: """ Adds input for text. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5344,9 +5344,9 @@ def add_input_text(*, label: str =None, user_data: Any =None, use_internal_label before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5383,11 +5383,11 @@ def add_input_text(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_input_text(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, hint=hint, multiline=multiline, no_spaces=no_spaces, uppercase=uppercase, tab_input=tab_input, decimal=decimal, hexadecimal=hexadecimal, readonly=readonly, password=password, scientific=scientific, on_enter=on_enter, auto_select_all=auto_select_all, ctrl_enter_for_new_line=ctrl_enter_for_new_line, no_horizontal_scroll=no_horizontal_scroll, always_overwrite=always_overwrite, no_undo_redo=no_undo_redo, escape_clears_all=escape_clears_all, elide_left=elide_left, **kwargs) -def add_int4_value(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: Union[List[int], Tuple[int, ...]] =(0, 0, 0, 0), parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: +def add_int4_value(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: Union[List[int], Tuple[int, ...]] =(0, 0, 0, 0), parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: """ Adds a int4 value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5405,11 +5405,11 @@ def add_int4_value(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_int4_value(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, source=source, default_value=default_value, parent=parent, **kwargs) -def add_int_value(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: int =0, parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: +def add_int_value(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: int =0, parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: """ Adds a int value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5427,16 +5427,16 @@ def add_int_value(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_int_value(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, source=source, default_value=default_value, parent=parent, **kwargs) -def add_item_activated_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, **kwargs) -> Union[int, str]: +def add_item_activated_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a activated handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5449,16 +5449,16 @@ def add_item_activated_handler(*, label: str =None, user_data: Any =None, use_in return internal_dpg.add_item_activated_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, **kwargs) -def add_item_active_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, **kwargs) -> Union[int, str]: +def add_item_active_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a active handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5471,17 +5471,17 @@ def add_item_active_handler(*, label: str =None, user_data: Any =None, use_inter return internal_dpg.add_item_active_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, **kwargs) -def add_item_clicked_handler(button : int =-1, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, **kwargs) -> Union[int, str]: +def add_item_clicked_handler(button : int =-1, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a clicked handler. Args: button (int, optional): Submits callback for all mouse buttons - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5494,16 +5494,16 @@ def add_item_clicked_handler(button : int =-1, *, label: str =None, user_data: A return internal_dpg.add_item_clicked_handler(button, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, **kwargs) -def add_item_deactivated_after_edit_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, **kwargs) -> Union[int, str]: +def add_item_deactivated_after_edit_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a deactivated after edit handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5516,16 +5516,16 @@ def add_item_deactivated_after_edit_handler(*, label: str =None, user_data: Any return internal_dpg.add_item_deactivated_after_edit_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, **kwargs) -def add_item_deactivated_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, **kwargs) -> Union[int, str]: +def add_item_deactivated_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a deactivated handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5538,17 +5538,17 @@ def add_item_deactivated_handler(*, label: str =None, user_data: Any =None, use_ return internal_dpg.add_item_deactivated_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, **kwargs) -def add_item_double_clicked_handler(button : int =-1, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, **kwargs) -> Union[int, str]: +def add_item_double_clicked_handler(button : int =-1, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a double click handler. Args: button (int, optional): Submits callback for all mouse buttons - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5561,16 +5561,16 @@ def add_item_double_clicked_handler(button : int =-1, *, label: str =None, user_ return internal_dpg.add_item_double_clicked_handler(button, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, **kwargs) -def add_item_edited_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, **kwargs) -> Union[int, str]: +def add_item_edited_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, **kwargs) -> Union[int, str]: """ Adds an edited handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5583,16 +5583,16 @@ def add_item_edited_handler(*, label: str =None, user_data: Any =None, use_inter return internal_dpg.add_item_edited_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, **kwargs) -def add_item_focus_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, event_type: int =None, **kwargs) -> Union[int, str]: +def add_item_focus_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, event_type: int =internal_dpg.mvEventType_On, **kwargs) -> Union[int, str]: """ Adds a focus handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. event_type (int, optional): What kind of events to track: just got focus (mvEventType_Enter), currently having focus (mvEventType_On), lost focus (mvEventType_Leave). Can be a combination of these flags. Defaults to mvEventType_On. id (Union[int, str], optional): (deprecated) @@ -5606,11 +5606,11 @@ def add_item_focus_handler(*, label: str =None, user_data: Any =None, use_intern return internal_dpg.add_item_focus_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, event_type=event_type, **kwargs) -def add_item_handler_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def add_item_handler_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: """ Adds an item handler registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5626,16 +5626,16 @@ def add_item_handler_registry(*, label: str =None, user_data: Any =None, use_int return internal_dpg.add_item_handler_registry(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, show=show, **kwargs) -def add_item_hover_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, event_type: int =None, **kwargs) -> Union[int, str]: +def add_item_hover_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, event_type: int =internal_dpg.mvEventType_On, **kwargs) -> Union[int, str]: """ Adds a hover handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. event_type (int, optional): What kind of events to track: mouse-in (mvEventType_Enter), mouse-over (mvEventType_On), mouse-out (mvEventType_Leave). Can be a combination of these flags. Defaults to mouse-over. id (Union[int, str], optional): (deprecated) @@ -5649,16 +5649,16 @@ def add_item_hover_handler(*, label: str =None, user_data: Any =None, use_intern return internal_dpg.add_item_hover_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, event_type=event_type, **kwargs) -def add_item_resize_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, **kwargs) -> Union[int, str]: +def add_item_resize_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a resize handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5671,16 +5671,16 @@ def add_item_resize_handler(*, label: str =None, user_data: Any =None, use_inter return internal_dpg.add_item_resize_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, **kwargs) -def add_item_scroll_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, **kwargs) -> Union[int, str]: +def add_item_scroll_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a scroll handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5693,16 +5693,16 @@ def add_item_scroll_handler(*, label: str =None, user_data: Any =None, use_inter return internal_dpg.add_item_scroll_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, **kwargs) -def add_item_toggled_open_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, two_way: bool =False, **kwargs) -> Union[int, str]: +def add_item_toggled_open_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, two_way: bool =False, **kwargs) -> Union[int, str]: """ Adds a togged open handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. two_way (bool, optional): Trigger on both 'opened' and 'closed' events, i.e. when the 'opened' state is toggled between the two values. If False, some containers will trigger it only on the 'opened' event. id (Union[int, str], optional): (deprecated) @@ -5716,16 +5716,16 @@ def add_item_toggled_open_handler(*, label: str =None, user_data: Any =None, use return internal_dpg.add_item_toggled_open_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, two_way=two_way, **kwargs) -def add_item_visible_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Callable =None, show: bool =True, **kwargs) -> Union[int, str]: +def add_item_visible_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a visible handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. id (Union[int, str], optional): (deprecated) Returns: @@ -5738,16 +5738,16 @@ def add_item_visible_handler(*, label: str =None, user_data: Any =None, use_inte return internal_dpg.add_item_visible_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, callback=callback, show=show, **kwargs) -def add_key_down_handler(key : int =internal_dpg.mvKey_None, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Callable =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: +def add_key_down_handler(key : int =internal_dpg.mvKey_None, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: """ Adds a key down handler. Args: key (int, optional): Submits callback for all keys - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5761,16 +5761,16 @@ def add_key_down_handler(key : int =internal_dpg.mvKey_None, *, label: str =None return internal_dpg.add_key_down_handler(key, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, callback=callback, show=show, parent=parent, **kwargs) -def add_key_press_handler(key : int =internal_dpg.mvKey_None, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Callable =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: +def add_key_press_handler(key : int =internal_dpg.mvKey_None, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: """ Adds a key press handler. Args: key (int, optional): Submits callback for all keys - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5784,16 +5784,16 @@ def add_key_press_handler(key : int =internal_dpg.mvKey_None, *, label: str =Non return internal_dpg.add_key_press_handler(key, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, callback=callback, show=show, parent=parent, **kwargs) -def add_key_release_handler(key : int =internal_dpg.mvKey_None, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Callable =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: +def add_key_release_handler(key : int =internal_dpg.mvKey_None, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: """ Adds a key release handler. Args: key (int, optional): Submits callback for all keys - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -5807,11 +5807,11 @@ def add_key_release_handler(key : int =internal_dpg.mvKey_None, *, label: str =N return internal_dpg.add_key_release_handler(key, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, callback=callback, show=show, parent=parent, **kwargs) -def add_knob_float(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, min_value: float =0.0, max_value: float =100.0, **kwargs) -> Union[int, str]: +def add_knob_float(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, min_value: float =0.0, max_value: float =100.0, **kwargs) -> Union[int, str]: """ Adds a knob that rotates based on change in x mouse position. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5822,9 +5822,9 @@ def add_knob_float(*, label: str =None, user_data: Any =None, use_internal_label before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5845,13 +5845,13 @@ def add_knob_float(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_knob_float(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, min_value=min_value, max_value=max_value, **kwargs) -def add_line_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, segments: bool =False, loop: bool =False, skip_nan: bool =False, no_clip: bool =False, shaded: bool =False, **kwargs) -> Union[int, str]: +def add_line_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, segments: bool =False, loop: bool =False, skip_nan: bool =False, no_clip: bool =False, shaded: bool =False, **kwargs) -> Union[int, str]: """ Adds a line series to a plot. Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5875,12 +5875,12 @@ def add_line_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[fl return internal_dpg.add_line_series(x, y, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, segments=segments, loop=loop, skip_nan=skip_nan, no_clip=no_clip, shaded=shaded, **kwargs) -def add_listbox(items : Union[List[str], Tuple[str, ...]] =(), *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: str ='', num_items: int =3, **kwargs) -> Union[int, str]: +def add_listbox(items : Union[List[str], Tuple[str, ...]] =(), *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: str ='', num_items: int =3, **kwargs) -> Union[int, str]: """ Adds a listbox. If height is not large enough to show all items a scroll bar will appear. Args: items (Union[List[str], Tuple[str, ...]], optional): A tuple of items to be shown in the listbox. Can consist of any combination of types. All items will be displayed as strings. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5890,9 +5890,9 @@ def add_listbox(items : Union[List[str], Tuple[str, ...]] =(), *, label: str =No before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -5912,11 +5912,11 @@ def add_listbox(items : Union[List[str], Tuple[str, ...]] =(), *, label: str =No return internal_dpg.add_listbox(items, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, num_items=num_items, **kwargs) -def add_loading_indicator(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], style: int =0, circle_count: int =8, speed: float =1.0, radius: float =3.0, thickness: float =1.0, color: Union[List[int], Tuple[int, ...]] =None, secondary_color: Union[List[int], Tuple[int, ...]] =None, **kwargs) -> Union[int, str]: +def add_loading_indicator(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], style: int =0, circle_count: int =8, speed: float =1.0, radius: float =3.0, thickness: float =1.0, color: Union[List[int], Tuple[int, ...]] =None, secondary_color: Union[List[int], Tuple[int, ...]] =None, **kwargs) -> Union[int, str]: """ Adds a rotating animated loading symbol. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5926,7 +5926,7 @@ def add_loading_indicator(*, label: str =None, user_data: Any =None, use_interna parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. style (int, optional): mvLoadInd_DottedCircle is rotating dots style, mvLoadInd_Ring is rotating bar style. @@ -5947,11 +5947,11 @@ def add_loading_indicator(*, label: str =None, user_data: Any =None, use_interna return internal_dpg.add_loading_indicator(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, payload_type=payload_type, drop_callback=drop_callback, show=show, pos=pos, style=style, circle_count=circle_count, speed=speed, radius=radius, thickness=thickness, color=color, secondary_color=secondary_color, **kwargs) -def add_menu(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Callable =None, show: bool =True, enabled: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, **kwargs) -> Union[int, str]: +def add_menu(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, **kwargs) -> Union[int, str]: """ Adds a menu to an existing menu bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -5959,7 +5959,7 @@ def add_menu(*, label: str =None, user_data: Any =None, use_internal_label: bool parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. filter_key (str, optional): Used by filter widget. @@ -5980,11 +5980,11 @@ def add_menu(*, label: str =None, user_data: Any =None, use_internal_label: bool return internal_dpg.add_menu(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, payload_type=payload_type, drop_callback=drop_callback, show=show, enabled=enabled, filter_key=filter_key, tracked=tracked, track_offset=track_offset, **kwargs) -def add_menu_bar(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def add_menu_bar(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a menu bar to a window. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6006,11 +6006,11 @@ def add_menu_bar(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_menu_bar(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, show=show, **kwargs) -def add_menu_item(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: bool =False, shortcut: str ='', check: bool =False, **kwargs) -> Union[int, str]: +def add_menu_item(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: bool =False, shortcut: str ='', check: bool =False, **kwargs) -> Union[int, str]: """ Adds a menu item to an existing menu. Menu items act similar to selectables and has a bool value. When placed in a menu the checkmark will reflect its value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6018,8 +6018,8 @@ def add_menu_item(*, label: str =None, user_data: Any =None, use_internal_label: parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. filter_key (str, optional): Used by filter widget. @@ -6029,7 +6029,7 @@ def add_menu_item(*, label: str =None, user_data: Any =None, use_internal_label: shortcut (str, optional): Displays text on the menu item. Typically used to show a shortcut key command. check (bool, optional): Displays a checkmark on the menu item when it is selected and placed in a menu. id (Union[int, str], optional): (deprecated) - drag_callback (Callable, optional): (deprecated) + drag_callback (Optional[Callable], optional): (deprecated) Returns: Union[int, str] """ @@ -6046,16 +6046,16 @@ def add_menu_item(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_menu_item(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, payload_type=payload_type, callback=callback, drop_callback=drop_callback, show=show, enabled=enabled, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, shortcut=shortcut, check=check, **kwargs) -def add_mouse_click_handler(button : int =-1, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Callable =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: +def add_mouse_click_handler(button : int =-1, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: """ Adds a mouse click handler. Args: button (int, optional): Submits callback for all mouse buttons - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -6069,16 +6069,16 @@ def add_mouse_click_handler(button : int =-1, *, label: str =None, user_data: An return internal_dpg.add_mouse_click_handler(button, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, callback=callback, show=show, parent=parent, **kwargs) -def add_mouse_double_click_handler(button : int =-1, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Callable =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: +def add_mouse_double_click_handler(button : int =-1, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: """ Adds a mouse double click handler. Args: button (int, optional): Submits callback for all mouse buttons - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -6092,16 +6092,16 @@ def add_mouse_double_click_handler(button : int =-1, *, label: str =None, user_d return internal_dpg.add_mouse_double_click_handler(button, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, callback=callback, show=show, parent=parent, **kwargs) -def add_mouse_down_handler(button : int =-1, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Callable =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: +def add_mouse_down_handler(button : int =-1, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: """ Adds a mouse down handler. Args: button (int, optional): Submits callback for all mouse buttons - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -6115,17 +6115,17 @@ def add_mouse_down_handler(button : int =-1, *, label: str =None, user_data: Any return internal_dpg.add_mouse_down_handler(button, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, callback=callback, show=show, parent=parent, **kwargs) -def add_mouse_drag_handler(button : int =-1, threshold : float =10.0, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Callable =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: +def add_mouse_drag_handler(button : int =-1, threshold : float =10.0, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: """ Adds a mouse drag handler. Args: button (int, optional): Submits callback for all mouse buttons threshold (float, optional): The threshold the mouse must be dragged before the callback is ran - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -6139,15 +6139,15 @@ def add_mouse_drag_handler(button : int =-1, threshold : float =10.0, *, label: return internal_dpg.add_mouse_drag_handler(button, threshold, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, callback=callback, show=show, parent=parent, **kwargs) -def add_mouse_move_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Callable =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: +def add_mouse_move_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: """ Adds a mouse move handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -6161,16 +6161,16 @@ def add_mouse_move_handler(*, label: str =None, user_data: Any =None, use_intern return internal_dpg.add_mouse_move_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, callback=callback, show=show, parent=parent, **kwargs) -def add_mouse_release_handler(button : int =-1, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Callable =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: +def add_mouse_release_handler(button : int =-1, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: """ Adds a mouse release handler. Args: button (int, optional): Submits callback for all mouse buttons - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -6184,15 +6184,15 @@ def add_mouse_release_handler(button : int =-1, *, label: str =None, user_data: return internal_dpg.add_mouse_release_handler(button, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, callback=callback, show=show, parent=parent, **kwargs) -def add_mouse_wheel_handler(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Callable =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: +def add_mouse_wheel_handler(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, parent: Union[int, str] =internal_dpg.mvReservedUUID_1, **kwargs) -> Union[int, str]: """ Adds a mouse wheel handler. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) id (Union[int, str], optional): (deprecated) @@ -6206,19 +6206,19 @@ def add_mouse_wheel_handler(*, label: str =None, user_data: Any =None, use_inter return internal_dpg.add_mouse_wheel_handler(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, callback=callback, show=show, parent=parent, **kwargs) -def add_node(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, draggable: bool =True, **kwargs) -> Union[int, str]: +def add_node(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, draggable: bool =True, **kwargs) -> Union[int, str]: """ Adds a node to a node editor. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -6240,11 +6240,11 @@ def add_node(*, label: str =None, user_data: Any =None, use_internal_label: bool return internal_dpg.add_node(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, payload_type=payload_type, drag_callback=drag_callback, drop_callback=drop_callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, draggable=draggable, **kwargs) -def add_node_attribute(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, attribute_type: int =0, shape: int =1, category: str ='general', **kwargs) -> Union[int, str]: +def add_node_attribute(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, attribute_type: int =0, shape: int =1, category: str ='general', **kwargs) -> Union[int, str]: """ Adds a node attribute to a node. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6269,11 +6269,11 @@ def add_node_attribute(*, label: str =None, user_data: Any =None, use_internal_l return internal_dpg.add_node_attribute(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, show=show, filter_key=filter_key, tracked=tracked, track_offset=track_offset, attribute_type=attribute_type, shape=shape, category=category, **kwargs) -def add_node_editor(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Callable =None, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, delink_callback: Callable =None, menubar: bool =False, minimap: bool =False, minimap_location: int =2, **kwargs) -> Union[int, str]: +def add_node_editor(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, delink_callback: Optional[Callable] =None, menubar: bool =False, minimap: bool =False, minimap_location: int =2, **kwargs) -> Union[int, str]: """ Adds a node editor. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6281,12 +6281,12 @@ def add_node_editor(*, label: str =None, user_data: Any =None, use_internal_labe height (int, optional): Height of the item. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. filter_key (str, optional): Used by filter widget. tracked (bool, optional): Scroll tracking track_offset (float, optional): 0.0f:top, 0.5f:center, 1.0f:bottom - delink_callback (Callable, optional): Callback ran when a link is detached. + delink_callback (Optional[Callable], optional): Callback ran when a link is detached. menubar (bool, optional): Shows or hides the menubar. minimap (bool, optional): Shows or hides the Minimap. New in 1.6. minimap_location (int, optional): mvNodeMiniMap_Location_* constants. New in 1.6. @@ -6305,13 +6305,13 @@ def add_node_editor(*, label: str =None, user_data: Any =None, use_internal_labe return internal_dpg.add_node_editor(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, parent=parent, before=before, callback=callback, show=show, filter_key=filter_key, tracked=tracked, track_offset=track_offset, delink_callback=delink_callback, menubar=menubar, minimap=minimap, minimap_location=minimap_location, **kwargs) -def add_node_link(attr_1 : Union[int, str], attr_2 : Union[int, str], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def add_node_link(attr_1 : Union[int, str], attr_2 : Union[int, str], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a node link between 2 node attributes. Args: attr_1 (Union[int, str]): attr_2 (Union[int, str]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6328,7 +6328,7 @@ def add_node_link(attr_1 : Union[int, str], attr_2 : Union[int, str], *, label: return internal_dpg.add_node_link(attr_1, attr_2, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, show=show, **kwargs) -def add_pie_series(x : float, y : float, radius : float, values : Union[List[float], Tuple[float, ...]], labels : Union[List[str], Tuple[str, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, format: str ='%0.2f', angle: float =90.0, normalize: bool =False, ignore_hidden: bool =False, **kwargs) -> Union[int, str]: +def add_pie_series(x : float, y : float, radius : float, values : Union[List[float], Tuple[float, ...]], labels : Union[List[str], Tuple[str, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, format: str ='%0.2f', angle: float =90.0, normalize: bool =False, ignore_hidden: bool =False, **kwargs) -> Union[int, str]: """ Adds an pie series to a plot. Args: @@ -6337,7 +6337,7 @@ def add_pie_series(x : float, y : float, radius : float, values : Union[List[flo radius (float): values (Any): labels (Union[List[str], Tuple[str, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6360,11 +6360,11 @@ def add_pie_series(x : float, y : float, radius : float, values : Union[List[flo return internal_dpg.add_pie_series(x, y, radius, values, labels, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, format=format, angle=angle, normalize=normalize, ignore_hidden=ignore_hidden, **kwargs) -def add_plot(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, no_title: bool =False, no_menus: bool =False, no_box_select: bool =False, no_mouse_pos: bool =False, query: bool =False, query_color: Union[List[float], Tuple[float, ...]] =(0, 255, 0, 255), min_query_rects: int =1, max_query_rects: int =1, crosshairs: bool =False, equal_aspects: bool =False, no_inputs: bool =False, no_frame: bool =False, use_local_time: bool =False, use_ISO8601: bool =False, use_24hour_clock: bool =False, pan_button: int =internal_dpg.mvMouseButton_Left, pan_mod: int =internal_dpg.mvKey_None, context_menu_button: int =internal_dpg.mvMouseButton_Right, fit_button: int =internal_dpg.mvMouseButton_Left, box_select_button: int =internal_dpg.mvMouseButton_Right, box_select_mod: int =internal_dpg.mvKey_None, box_select_cancel_button: int =internal_dpg.mvMouseButton_Left, query_toggle_mod: int =internal_dpg.mvKey_ModCtrl, horizontal_mod: int =internal_dpg.mvKey_ModAlt, vertical_mod: int =internal_dpg.mvKey_ModShift, override_mod: int =internal_dpg.mvKey_ModCtrl, zoom_mod: int =internal_dpg.mvKey_None, zoom_rate: int =0.1, **kwargs) -> Union[int, str]: +def add_plot(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, no_title: bool =False, no_menus: bool =False, no_box_select: bool =False, no_mouse_pos: bool =False, query: bool =False, query_color: Union[List[float], Tuple[float, ...]] =(0, 255, 0, 255), min_query_rects: int =1, max_query_rects: int =1, crosshairs: bool =False, equal_aspects: bool =False, no_inputs: bool =False, no_frame: bool =False, use_local_time: bool =False, use_ISO8601: bool =False, use_24hour_clock: bool =False, pan_button: int =internal_dpg.mvMouseButton_Left, pan_mod: int =internal_dpg.mvKey_None, context_menu_button: int =internal_dpg.mvMouseButton_Right, fit_button: int =internal_dpg.mvMouseButton_Left, box_select_button: int =internal_dpg.mvMouseButton_Right, box_select_mod: int =internal_dpg.mvKey_None, box_select_cancel_button: int =internal_dpg.mvMouseButton_Left, query_toggle_mod: int =internal_dpg.mvKey_ModCtrl, horizontal_mod: int =internal_dpg.mvKey_ModAlt, vertical_mod: int =internal_dpg.mvKey_ModShift, override_mod: int =internal_dpg.mvKey_ModCtrl, zoom_mod: int =internal_dpg.mvKey_None, zoom_rate: float =0.1, **kwargs) -> Union[int, str]: """ Adds a plot which is used to hold series, and can be drawn to with draw commands. For all _mod parameters use mvKey_ModX enums, or mvKey_ModDisabled to disable the modifier. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6374,9 +6374,9 @@ def add_plot(*, label: str =None, user_data: Any =None, use_internal_label: bool parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -6409,7 +6409,7 @@ def add_plot(*, label: str =None, user_data: Any =None, use_internal_label: bool vertical_mod (int, optional): expands active box selection/query vertically to plot edge when held override_mod (int, optional): when held, all input is ignored; used to enable axis/plots as DND sources zoom_mod (int, optional): optional modifier that must be held for scroll wheel zooming - zoom_rate (int, optional): zoom rate for scroll (e.g. 0.1f = 10% plot range every scroll click); make negative to invert + zoom_rate (float, optional): zoom rate for scroll (e.g. 0.1f = 10% plot range every scroll click); make negative to invert id (Union[int, str], optional): (deprecated) delay_search (bool, optional): (deprecated) This was used as an optimization hint but is not relevant anymore. no_highlight (bool, optional): (deprecated) Removed because not supported from the backend anymore. To control the highlighting of series use the same argument in `add_plot_legend` @@ -6460,11 +6460,11 @@ def add_plot(*, label: str =None, user_data: Any =None, use_internal_label: bool return internal_dpg.add_plot(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, no_title=no_title, no_menus=no_menus, no_box_select=no_box_select, no_mouse_pos=no_mouse_pos, query=query, query_color=query_color, min_query_rects=min_query_rects, max_query_rects=max_query_rects, crosshairs=crosshairs, equal_aspects=equal_aspects, no_inputs=no_inputs, no_frame=no_frame, use_local_time=use_local_time, use_ISO8601=use_ISO8601, use_24hour_clock=use_24hour_clock, pan_button=pan_button, pan_mod=pan_mod, context_menu_button=context_menu_button, fit_button=fit_button, box_select_button=box_select_button, box_select_mod=box_select_mod, box_select_cancel_button=box_select_cancel_button, query_toggle_mod=query_toggle_mod, horizontal_mod=horizontal_mod, vertical_mod=vertical_mod, override_mod=override_mod, zoom_mod=zoom_mod, zoom_rate=zoom_rate, **kwargs) -def add_plot_annotation(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, default_value: Any =(0.0, 0.0), offset: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), color: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), clamped: bool =True, **kwargs) -> Union[int, str]: +def add_plot_annotation(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, default_value: Any =(0.0, 0.0), offset: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), color: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), clamped: bool =True, **kwargs) -> Union[int, str]: """ Adds an annotation to a plot. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6487,18 +6487,18 @@ def add_plot_annotation(*, label: str =None, user_data: Any =None, use_internal_ return internal_dpg.add_plot_annotation(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, default_value=default_value, offset=offset, color=color, clamped=clamped, **kwargs) -def add_plot_axis(axis : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Callable =None, show: bool =True, no_label: bool =False, no_gridlines: bool =False, no_tick_marks: bool =False, no_tick_labels: bool =False, no_initial_fit: bool =False, no_menus: bool =False, no_side_switch: bool =False, no_highlight: bool =False, opposite: bool =False, foreground_grid: bool =False, tick_format: str ='', scale: int =internal_dpg.mvPlotScale_Linear, invert: bool =False, auto_fit: bool =False, range_fit: bool =False, pan_stretch: bool =False, lock_min: bool =False, lock_max: bool =False, **kwargs) -> Union[int, str]: +def add_plot_axis(axis : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Optional[Callable] =None, show: bool =True, no_label: bool =False, no_gridlines: bool =False, no_tick_marks: bool =False, no_tick_labels: bool =False, no_initial_fit: bool =False, no_menus: bool =False, no_side_switch: bool =False, no_highlight: bool =False, opposite: bool =False, foreground_grid: bool =False, tick_format: str ='', scale: int =internal_dpg.mvPlotScale_Linear, invert: bool =False, auto_fit: bool =False, range_fit: bool =False, pan_stretch: bool =False, lock_min: bool =False, lock_max: bool =False, **kwargs) -> Union[int, str]: """ Adds an axis to a plot. Args: axis (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. no_label (bool, optional): the axis label will not be displayed no_gridlines (bool, optional): no grid lines will be displayed @@ -6537,17 +6537,17 @@ def add_plot_axis(axis : int, *, label: str =None, user_data: Any =None, use_int return internal_dpg.add_plot_axis(axis, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, payload_type=payload_type, drop_callback=drop_callback, show=show, no_label=no_label, no_gridlines=no_gridlines, no_tick_marks=no_tick_marks, no_tick_labels=no_tick_labels, no_initial_fit=no_initial_fit, no_menus=no_menus, no_side_switch=no_side_switch, no_highlight=no_highlight, opposite=opposite, foreground_grid=foreground_grid, tick_format=tick_format, scale=scale, invert=invert, auto_fit=auto_fit, range_fit=range_fit, pan_stretch=pan_stretch, lock_min=lock_min, lock_max=lock_max, **kwargs) -def add_plot_legend(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Callable =None, show: bool =True, location: int =5, horizontal: bool =False, sort: bool =False, outside: bool =False, no_highlight_item: bool =False, no_highlight_axis: bool =False, no_menus: bool =False, no_buttons: bool =False, **kwargs) -> Union[int, str]: +def add_plot_legend(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Optional[Callable] =None, show: bool =True, location: int =5, horizontal: bool =False, sort: bool =False, outside: bool =False, no_highlight_item: bool =False, no_highlight_axis: bool =False, no_menus: bool =False, no_buttons: bool =False, **kwargs) -> Union[int, str]: """ Adds a plot legend to a plot. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. location (int, optional): location, mvPlot_Location_* horizontal (bool, optional): legend entries will be displayed horizontally @@ -6568,11 +6568,11 @@ def add_plot_legend(*, label: str =None, user_data: Any =None, use_internal_labe return internal_dpg.add_plot_legend(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, payload_type=payload_type, drop_callback=drop_callback, show=show, location=location, horizontal=horizontal, sort=sort, outside=outside, no_highlight_item=no_highlight_item, no_highlight_axis=no_highlight_axis, no_menus=no_menus, no_buttons=no_buttons, **kwargs) -def add_progress_bar(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, overlay: str ='', default_value: float =0.0, **kwargs) -> Union[int, str]: +def add_progress_bar(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, overlay: str ='', default_value: float =0.0, **kwargs) -> Union[int, str]: """ Adds a progress bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6583,8 +6583,8 @@ def add_progress_bar(*, label: str =None, user_data: Any =None, use_internal_lab before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -6603,12 +6603,12 @@ def add_progress_bar(*, label: str =None, user_data: Any =None, use_internal_lab return internal_dpg.add_progress_bar(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, drag_callback=drag_callback, drop_callback=drop_callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, overlay=overlay, default_value=default_value, **kwargs) -def add_radio_button(items : Union[List[str], Tuple[str, ...]] =(), *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: str ='', horizontal: bool =False, **kwargs) -> Union[int, str]: +def add_radio_button(items : Union[List[str], Tuple[str, ...]] =(), *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: str ='', horizontal: bool =False, **kwargs) -> Union[int, str]: """ Adds a set of radio buttons. If items keyword is empty, nothing will be shown. Args: items (Union[List[str], Tuple[str, ...]], optional): A tuple of items to be shown as radio options. Can consist of any combination of types. All types will be shown as strings. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6617,9 +6617,9 @@ def add_radio_button(items : Union[List[str], Tuple[str, ...]] =(), *, label: st before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -6639,14 +6639,14 @@ def add_radio_button(items : Union[List[str], Tuple[str, ...]] =(), *, label: st return internal_dpg.add_radio_button(items, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, horizontal=horizontal, **kwargs) -def add_raw_texture(width : int, height : int, default_value : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, format: int =internal_dpg.mvFormat_Float_rgba, parent: Union[int, str] =internal_dpg.mvReservedUUID_2, **kwargs) -> Union[int, str]: +def add_raw_texture(width : int, height : int, default_value : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, format: int =internal_dpg.mvFormat_Float_rgba, parent: Union[int, str] =internal_dpg.mvReservedUUID_2, **kwargs) -> Union[int, str]: """ Adds a raw texture. Args: width (int): height (int): default_value (Union[List[float], Tuple[float, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6663,13 +6663,13 @@ def add_raw_texture(width : int, height : int, default_value : Union[List[float] return internal_dpg.add_raw_texture(width, height, default_value, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, format=format, parent=parent, **kwargs) -def add_scatter_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, no_clip: bool =False, **kwargs) -> Union[int, str]: +def add_scatter_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, no_clip: bool =False, **kwargs) -> Union[int, str]: """ Adds a scatter series to a plot. Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6689,11 +6689,11 @@ def add_scatter_series(x : Union[List[float], Tuple[float, ...]], y : Union[List return internal_dpg.add_scatter_series(x, y, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, no_clip=no_clip, **kwargs) -def add_selectable(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: bool =False, span_columns: bool =False, disable_popup_close: bool =False, select_on_nav: bool =False, **kwargs) -> Union[int, str]: +def add_selectable(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: bool =False, span_columns: bool =False, disable_popup_close: bool =False, select_on_nav: bool =False, **kwargs) -> Union[int, str]: """ Adds a selectable. Similar to a button but can indicate its selected state. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6704,9 +6704,9 @@ def add_selectable(*, label: str =None, user_data: Any =None, use_internal_label before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -6728,11 +6728,11 @@ def add_selectable(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_selectable(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, span_columns=span_columns, disable_popup_close=disable_popup_close, select_on_nav=select_on_nav, **kwargs) -def add_separator(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], **kwargs) -> Union[int, str]: +def add_separator(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], **kwargs) -> Union[int, str]: """ Adds a horizontal line separator. Use 'label' parameter to add text and mvStyleVar_SeparatorText* elements to style it. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6752,11 +6752,11 @@ def add_separator(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_separator(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, show=show, pos=pos, **kwargs) -def add_series_value(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: Any =(), parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: +def add_series_value(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: Any =(), parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: """ Adds a plot series value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6774,13 +6774,13 @@ def add_series_value(*, label: str =None, user_data: Any =None, use_internal_lab return internal_dpg.add_series_value(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, source=source, default_value=default_value, parent=parent, **kwargs) -def add_shade_series(x : Union[List[float], Tuple[float, ...]], y1 : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, y2: Any =[], **kwargs) -> Union[int, str]: +def add_shade_series(x : Union[List[float], Tuple[float, ...]], y1 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, y2: Any =[], **kwargs) -> Union[int, str]: """ Adds a shade series to a plot. Args: x (Any): y1 (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6800,11 +6800,11 @@ def add_shade_series(x : Union[List[float], Tuple[float, ...]], y1 : Union[List[ return internal_dpg.add_shade_series(x, y1, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, y2=y2, **kwargs) -def add_simple_plot(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[float], Tuple[float, ...]] =(), overlay: str ='', histogram: bool =False, autosize: bool =True, min_scale: float =0.0, max_scale: float =0.0, **kwargs) -> Union[int, str]: +def add_simple_plot(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[float], Tuple[float, ...]] =(), overlay: str ='', histogram: bool =False, autosize: bool =True, min_scale: float =0.0, max_scale: float =0.0, **kwargs) -> Union[int, str]: """ Adds a simple plot for visualization of a 1 dimensional set of values. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6815,8 +6815,8 @@ def add_simple_plot(*, label: str =None, user_data: Any =None, use_internal_labe before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. filter_key (str, optional): Used by filter widget. tracked (bool, optional): Scroll tracking @@ -6838,11 +6838,11 @@ def add_simple_plot(*, label: str =None, user_data: Any =None, use_internal_labe return internal_dpg.add_simple_plot(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, drag_callback=drag_callback, drop_callback=drop_callback, show=show, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, overlay=overlay, histogram=histogram, autosize=autosize, min_scale=min_scale, max_scale=max_scale, **kwargs) -def add_slider_double(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, vertical: bool =False, no_input: bool =False, clamped: bool =False, min_value: float =0.0, max_value: float =100.0, format: str ='%.3f', **kwargs) -> Union[int, str]: +def add_slider_double(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, vertical: bool =False, no_input: bool =False, clamped: bool =False, min_value: float =0.0, max_value: float =100.0, format: str ='%.3f', **kwargs) -> Union[int, str]: """ Adds slider for a single double value. Useful when slider float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6853,9 +6853,9 @@ def add_slider_double(*, label: str =None, user_data: Any =None, use_internal_la before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -6880,11 +6880,11 @@ def add_slider_double(*, label: str =None, user_data: Any =None, use_internal_la return internal_dpg.add_slider_double(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, vertical=vertical, no_input=no_input, clamped=clamped, min_value=min_value, max_value=max_value, format=format, **kwargs) -def add_slider_doublex(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Any =(0.0, 0.0, 0.0, 0.0), size: int =4, no_input: bool =False, clamped: bool =False, min_value: float =0.0, max_value: float =100.0, format: str ='%.3f', **kwargs) -> Union[int, str]: +def add_slider_doublex(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Any =(0.0, 0.0, 0.0, 0.0), size: int =4, no_input: bool =False, clamped: bool =False, min_value: float =0.0, max_value: float =100.0, format: str ='%.3f', **kwargs) -> Union[int, str]: """ Adds multi slider for up to 4 double values. Usueful for when multi slide float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6894,9 +6894,9 @@ def add_slider_doublex(*, label: str =None, user_data: Any =None, use_internal_l before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -6921,11 +6921,11 @@ def add_slider_doublex(*, label: str =None, user_data: Any =None, use_internal_l return internal_dpg.add_slider_doublex(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, size=size, no_input=no_input, clamped=clamped, min_value=min_value, max_value=max_value, format=format, **kwargs) -def add_slider_float(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, vertical: bool =False, no_input: bool =False, clamped: bool =False, min_value: float =0.0, max_value: float =100.0, format: str ='%.3f', **kwargs) -> Union[int, str]: +def add_slider_float(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: float =0.0, vertical: bool =False, no_input: bool =False, clamped: bool =False, min_value: float =0.0, max_value: float =100.0, format: str ='%.3f', **kwargs) -> Union[int, str]: """ Adds slider for a single float value. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6936,9 +6936,9 @@ def add_slider_float(*, label: str =None, user_data: Any =None, use_internal_lab before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -6963,11 +6963,11 @@ def add_slider_float(*, label: str =None, user_data: Any =None, use_internal_lab return internal_dpg.add_slider_float(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, vertical=vertical, no_input=no_input, clamped=clamped, min_value=min_value, max_value=max_value, format=format, **kwargs) -def add_slider_floatx(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[float], Tuple[float, ...]] =(0.0, 0.0, 0.0, 0.0), size: int =4, no_input: bool =False, clamped: bool =False, min_value: float =0.0, max_value: float =100.0, format: str ='%.3f', **kwargs) -> Union[int, str]: +def add_slider_floatx(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[float], Tuple[float, ...]] =(0.0, 0.0, 0.0, 0.0), size: int =4, no_input: bool =False, clamped: bool =False, min_value: float =0.0, max_value: float =100.0, format: str ='%.3f', **kwargs) -> Union[int, str]: """ Adds multi slider for up to 4 float values. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -6977,9 +6977,9 @@ def add_slider_floatx(*, label: str =None, user_data: Any =None, use_internal_la before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -7004,11 +7004,11 @@ def add_slider_floatx(*, label: str =None, user_data: Any =None, use_internal_la return internal_dpg.add_slider_floatx(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, size=size, no_input=no_input, clamped=clamped, min_value=min_value, max_value=max_value, format=format, **kwargs) -def add_slider_int(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: int =0, vertical: bool =False, no_input: bool =False, clamped: bool =False, min_value: int =0, max_value: int =100, format: str ='%d', **kwargs) -> Union[int, str]: +def add_slider_int(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: int =0, vertical: bool =False, no_input: bool =False, clamped: bool =False, min_value: int =0, max_value: int =100, format: str ='%d', **kwargs) -> Union[int, str]: """ Adds slider for a single int value. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7019,9 +7019,9 @@ def add_slider_int(*, label: str =None, user_data: Any =None, use_internal_label before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -7046,11 +7046,11 @@ def add_slider_int(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_slider_int(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, vertical=vertical, no_input=no_input, clamped=clamped, min_value=min_value, max_value=max_value, format=format, **kwargs) -def add_slider_intx(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[int], Tuple[int, ...]] =(0, 0, 0, 0), size: int =4, no_input: bool =False, clamped: bool =False, min_value: int =0, max_value: int =100, format: str ='%d', **kwargs) -> Union[int, str]: +def add_slider_intx(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, enabled: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: Union[List[int], Tuple[int, ...]] =(0, 0, 0, 0), size: int =4, no_input: bool =False, clamped: bool =False, min_value: int =0, max_value: int =100, format: str ='%d', **kwargs) -> Union[int, str]: """ Adds multi slider for up to 4 int values. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7060,9 +7060,9 @@ def add_slider_intx(*, label: str =None, user_data: Any =None, use_internal_labe before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. enabled (bool, optional): Turns off functionality of widget and applies the disabled theme. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. @@ -7087,11 +7087,11 @@ def add_slider_intx(*, label: str =None, user_data: Any =None, use_internal_labe return internal_dpg.add_slider_intx(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, enabled=enabled, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, size=size, no_input=no_input, clamped=clamped, min_value=min_value, max_value=max_value, format=format, **kwargs) -def add_spacer(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], **kwargs) -> Union[int, str]: +def add_spacer(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], **kwargs) -> Union[int, str]: """ Adds a spacer item that can be used to help with layouts or can be used as a placeholder item. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7113,11 +7113,11 @@ def add_spacer(*, label: str =None, user_data: Any =None, use_internal_label: bo return internal_dpg.add_spacer(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, show=show, pos=pos, **kwargs) -def add_stage(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_stage(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Union[int, str]: """ Adds a stage. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7132,13 +7132,13 @@ def add_stage(*, label: str =None, user_data: Any =None, use_internal_label: boo return internal_dpg.add_stage(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, **kwargs) -def add_stair_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, pre_step: bool =False, shaded: bool =False, **kwargs) -> Union[int, str]: +def add_stair_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, pre_step: bool =False, shaded: bool =False, **kwargs) -> Union[int, str]: """ Adds a stair series to a plot. Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7159,14 +7159,14 @@ def add_stair_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[f return internal_dpg.add_stair_series(x, y, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, pre_step=pre_step, shaded=shaded, **kwargs) -def add_static_texture(width : int, height : int, default_value : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =internal_dpg.mvReservedUUID_2, **kwargs) -> Union[int, str]: +def add_static_texture(width : int, height : int, default_value : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =internal_dpg.mvReservedUUID_2, **kwargs) -> Union[int, str]: """ Adds a static texture. Args: width (int): height (int): default_value (Union[List[float], Tuple[float, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7182,13 +7182,13 @@ def add_static_texture(width : int, height : int, default_value : Union[List[flo return internal_dpg.add_static_texture(width, height, default_value, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, **kwargs) -def add_stem_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, horizontal: bool =False, **kwargs) -> Union[int, str]: +def add_stem_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, horizontal: bool =False, **kwargs) -> Union[int, str]: """ Adds a stem series to a plot. Args: x (Any): y (Any): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7209,11 +7209,11 @@ def add_stem_series(x : Union[List[float], Tuple[float, ...]], y : Union[List[fl return internal_dpg.add_stem_series(x, y, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, source=source, show=show, horizontal=horizontal, **kwargs) -def add_string_value(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: str ='', parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: +def add_string_value(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, source: Union[int, str] =0, default_value: str ='', parent: Union[int, str] =internal_dpg.mvReservedUUID_3, **kwargs) -> Union[int, str]: """ Adds a string value. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7231,13 +7231,13 @@ def add_string_value(*, label: str =None, user_data: Any =None, use_internal_lab return internal_dpg.add_string_value(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, source=source, default_value=default_value, parent=parent, **kwargs) -def add_subplots(rows : int, columns : int, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, row_ratios: Union[List[float], Tuple[float, ...]] =[], column_ratios: Union[List[float], Tuple[float, ...]] =[], no_title: bool =False, no_menus: bool =False, no_resize: bool =False, no_align: bool =False, share_series: bool =False, link_rows: bool =False, link_columns: bool =False, link_all_x: bool =False, link_all_y: bool =False, column_major: bool =False, **kwargs) -> Union[int, str]: +def add_subplots(rows : int, columns : int, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, row_ratios: Union[List[float], Tuple[float, ...]] =[], column_ratios: Union[List[float], Tuple[float, ...]] =[], no_title: bool =False, no_menus: bool =False, no_resize: bool =False, no_align: bool =False, share_series: bool =False, link_rows: bool =False, link_columns: bool =False, link_all_x: bool =False, link_all_y: bool =False, column_major: bool =False, **kwargs) -> Union[int, str]: """ Adds a collection of plots. Args: rows (int): columns (int): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7246,7 +7246,7 @@ def add_subplots(rows : int, columns : int, *, label: str =None, user_data: Any indent (int, optional): Offsets the widget to the right the specified number multiplied by the indent style. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -7279,11 +7279,11 @@ def add_subplots(rows : int, columns : int, *, label: str =None, user_data: Any return internal_dpg.add_subplots(rows, columns, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, callback=callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, row_ratios=row_ratios, column_ratios=column_ratios, no_title=no_title, no_menus=no_menus, no_resize=no_resize, no_align=no_align, share_series=share_series, link_rows=link_rows, link_columns=link_columns, link_all_x=link_all_x, link_all_y=link_all_y, column_major=column_major, **kwargs) -def add_synced_tables(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', **kwargs) -> Union[int, str]: +def add_synced_tables(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', **kwargs) -> Union[int, str]: """ Links all tables that are immediate children of this container so that they share their state (mostly column sizes). Other children are rendered as is. This is an experimental feature, use with caution. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7302,11 +7302,11 @@ def add_synced_tables(*, label: str =None, user_data: Any =None, use_internal_la return internal_dpg.add_synced_tables(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, filter_key=filter_key, **kwargs) -def add_tab(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Callable =None, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, closable: bool =False, no_tooltip: bool =False, order_mode: int =0, unsaved_document: bool =False, no_close_with_middle_click: bool =False, no_reorder: bool =False, **kwargs) -> Union[int, str]: +def add_tab(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drop_callback: Optional[Callable] =None, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, closable: bool =False, no_tooltip: bool =False, order_mode: int =0, unsaved_document: bool =False, no_close_with_middle_click: bool =False, no_reorder: bool =False, **kwargs) -> Union[int, str]: """ Adds a tab to a tab bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7314,7 +7314,7 @@ def add_tab(*, label: str =None, user_data: Any =None, use_internal_label: bool parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. filter_key (str, optional): Used by filter widget. tracked (bool, optional): Scroll tracking @@ -7340,18 +7340,18 @@ def add_tab(*, label: str =None, user_data: Any =None, use_internal_label: bool return internal_dpg.add_tab(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, payload_type=payload_type, drop_callback=drop_callback, show=show, filter_key=filter_key, tracked=tracked, track_offset=track_offset, closable=closable, no_tooltip=no_tooltip, order_mode=order_mode, unsaved_document=unsaved_document, no_close_with_middle_click=no_close_with_middle_click, no_reorder=no_reorder, **kwargs) -def add_tab_bar(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, reorderable: bool =False, tab_list_popup_button: bool =False, no_close_with_middle_click: bool =False, no_scrolling_buttons: bool =False, no_tooltip: bool =False, draw_selected_overline: bool =False, **kwargs) -> Union[int, str]: +def add_tab_bar(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, reorderable: bool =False, tab_list_popup_button: bool =False, no_close_with_middle_click: bool =False, no_scrolling_buttons: bool =False, no_tooltip: bool =False, draw_selected_overline: bool =False, **kwargs) -> Union[int, str]: """ Adds a tab bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. indent (int, optional): Offsets the widget to the right the specified number multiplied by the indent style. parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -7378,11 +7378,11 @@ def add_tab_bar(*, label: str =None, user_data: Any =None, use_internal_label: b return internal_dpg.add_tab_bar(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, callback=callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, reorderable=reorderable, tab_list_popup_button=tab_list_popup_button, no_close_with_middle_click=no_close_with_middle_click, no_scrolling_buttons=no_scrolling_buttons, no_tooltip=no_tooltip, draw_selected_overline=draw_selected_overline, **kwargs) -def add_tab_button(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, no_reorder: bool =False, leading: bool =False, trailing: bool =False, no_tooltip: bool =False, unsaved_document: bool =False, **kwargs) -> Union[int, str]: +def add_tab_button(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, filter_key: str ='', tracked: bool =False, track_offset: float =0.5, no_reorder: bool =False, leading: bool =False, trailing: bool =False, no_tooltip: bool =False, unsaved_document: bool =False, **kwargs) -> Union[int, str]: """ Adds a tab button to a tab bar. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7390,9 +7390,9 @@ def add_tab_button(*, label: str =None, user_data: Any =None, use_internal_label parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. filter_key (str, optional): Used by filter widget. tracked (bool, optional): Scroll tracking @@ -7413,11 +7413,11 @@ def add_tab_button(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_tab_button(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, filter_key=filter_key, tracked=tracked, track_offset=track_offset, no_reorder=no_reorder, leading=leading, trailing=trailing, no_tooltip=no_tooltip, unsaved_document=unsaved_document, **kwargs) -def add_table(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', header_row: bool =True, clipper: bool =False, inner_width: int =0, policy: int =0, freeze_rows: int =0, freeze_columns: int =0, sort_multi: bool =False, sort_tristate: bool =False, resizable: bool =False, reorderable: bool =False, hideable: bool =False, sortable: bool =False, context_menu_in_body: bool =False, row_background: bool =False, borders_innerH: bool =False, borders_outerH: bool =False, borders_innerV: bool =False, borders_outerV: bool =False, no_host_extendX: bool =False, no_host_extendY: bool =False, no_keep_columns_visible: bool =False, precise_widths: bool =False, no_clip: bool =False, pad_outerX: bool =False, no_pad_outerX: bool =False, no_pad_innerX: bool =False, scrollX: bool =False, scrollY: bool =False, no_saved_settings: bool =False, **kwargs) -> Union[int, str]: +def add_table(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', header_row: bool =True, clipper: bool =False, inner_width: int =0, policy: int =0, freeze_rows: int =0, freeze_columns: int =0, sort_multi: bool =False, sort_tristate: bool =False, resizable: bool =False, reorderable: bool =False, hideable: bool =False, sortable: bool =False, context_menu_in_body: bool =False, row_background: bool =False, borders_innerH: bool =False, borders_outerH: bool =False, borders_innerV: bool =False, borders_outerV: bool =False, no_host_extendX: bool =False, no_host_extendY: bool =False, no_keep_columns_visible: bool =False, precise_widths: bool =False, no_clip: bool =False, pad_outerX: bool =False, no_pad_outerX: bool =False, no_pad_innerX: bool =False, scrollX: bool =False, scrollY: bool =False, no_saved_settings: bool =False, **kwargs) -> Union[int, str]: """ Adds a table. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7427,7 +7427,7 @@ def add_table(*, label: str =None, user_data: Any =None, use_internal_label: boo parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. - callback (Callable, optional): Registers a callback. + callback (Optional[Callable], optional): Registers a callback. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -7475,11 +7475,11 @@ def add_table(*, label: str =None, user_data: Any =None, use_internal_label: boo return internal_dpg.add_table(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, height=height, indent=indent, parent=parent, before=before, source=source, callback=callback, show=show, pos=pos, filter_key=filter_key, header_row=header_row, clipper=clipper, inner_width=inner_width, policy=policy, freeze_rows=freeze_rows, freeze_columns=freeze_columns, sort_multi=sort_multi, sort_tristate=sort_tristate, resizable=resizable, reorderable=reorderable, hideable=hideable, sortable=sortable, context_menu_in_body=context_menu_in_body, row_background=row_background, borders_innerH=borders_innerH, borders_outerH=borders_outerH, borders_innerV=borders_innerV, borders_outerV=borders_outerV, no_host_extendX=no_host_extendX, no_host_extendY=no_host_extendY, no_keep_columns_visible=no_keep_columns_visible, precise_widths=precise_widths, no_clip=no_clip, pad_outerX=pad_outerX, no_pad_outerX=no_pad_outerX, no_pad_innerX=no_pad_innerX, scrollX=scrollX, scrollY=scrollY, no_saved_settings=no_saved_settings, **kwargs) -def add_table_cell(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', **kwargs) -> Union[int, str]: +def add_table_cell(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', **kwargs) -> Union[int, str]: """ Adds a table. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7499,11 +7499,11 @@ def add_table_cell(*, label: str =None, user_data: Any =None, use_internal_label return internal_dpg.add_table_cell(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, height=height, parent=parent, before=before, show=show, filter_key=filter_key, **kwargs) -def add_table_column(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, enabled: bool =True, init_width_or_weight: float =0.0, default_hide: bool =False, default_sort: bool =False, width_stretch: bool =False, width_fixed: bool =False, no_resize: bool =False, no_reorder: bool =False, no_hide: bool =False, no_clip: bool =False, no_sort: bool =False, no_sort_ascending: bool =False, no_sort_descending: bool =False, no_header_width: bool =False, prefer_sort_ascending: bool =True, prefer_sort_descending: bool =False, indent_enable: bool =False, indent_disable: bool =False, angled_header: bool =False, no_header_label: bool =False, **kwargs) -> Union[int, str]: +def add_table_column(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, enabled: bool =True, init_width_or_weight: float =0.0, default_hide: bool =False, default_sort: bool =False, width_stretch: bool =False, width_fixed: bool =False, no_resize: bool =False, no_reorder: bool =False, no_hide: bool =False, no_clip: bool =False, no_sort: bool =False, no_sort_ascending: bool =False, no_sort_descending: bool =False, no_header_width: bool =False, prefer_sort_ascending: bool =True, prefer_sort_descending: bool =False, indent_enable: bool =False, indent_disable: bool =False, angled_header: bool =False, no_header_label: bool =False, **kwargs) -> Union[int, str]: """ Adds a table column. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7542,11 +7542,11 @@ def add_table_column(*, label: str =None, user_data: Any =None, use_internal_lab return internal_dpg.add_table_column(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, width=width, parent=parent, before=before, show=show, enabled=enabled, init_width_or_weight=init_width_or_weight, default_hide=default_hide, default_sort=default_sort, width_stretch=width_stretch, width_fixed=width_fixed, no_resize=no_resize, no_reorder=no_reorder, no_hide=no_hide, no_clip=no_clip, no_sort=no_sort, no_sort_ascending=no_sort_ascending, no_sort_descending=no_sort_descending, no_header_width=no_header_width, prefer_sort_ascending=prefer_sort_ascending, prefer_sort_descending=prefer_sort_descending, indent_enable=indent_enable, indent_disable=indent_disable, angled_header=angled_header, no_header_label=no_header_label, **kwargs) -def add_table_row(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', **kwargs) -> Union[int, str]: +def add_table_row(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, height: int =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, filter_key: str ='', **kwargs) -> Union[int, str]: """ Adds a table row. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7566,11 +7566,11 @@ def add_table_row(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_table_row(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, height=height, parent=parent, before=before, show=show, filter_key=filter_key, **kwargs) -def add_template_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_template_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Union[int, str]: """ Adds a template registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7585,12 +7585,12 @@ def add_template_registry(*, label: str =None, user_data: Any =None, use_interna return internal_dpg.add_template_registry(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, **kwargs) -def add_text(default_value : str ='', *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, wrap: int =-1, bullet: bool =False, color: Union[List[int], Tuple[int, ...]] =(-255, 0, 0, 255), show_label: bool =False, **kwargs) -> Union[int, str]: +def add_text(default_value : str ='', *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, wrap: int =-1, bullet: bool =False, color: Union[List[int], Tuple[int, ...]] =(-255, 0, 0, 255), show_label: bool =False, **kwargs) -> Union[int, str]: """ Adds text. Text can have an optional label that will display to the right of the text. Args: default_value (str, optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7599,8 +7599,8 @@ def add_text(default_value : str ='', *, label: str =None, user_data: Any =None, before (Union[int, str], optional): This item will be displayed before the specified item in the parent. source (Union[int, str], optional): Overrides 'id' as value storage key. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -7621,13 +7621,13 @@ def add_text(default_value : str ='', *, label: str =None, user_data: Any =None, return internal_dpg.add_text(default_value, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, source=source, payload_type=payload_type, drag_callback=drag_callback, drop_callback=drop_callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, wrap=wrap, bullet=bullet, color=color, show_label=show_label, **kwargs) -def add_text_point(x : float, y : float, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, offset: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), vertical: bool =False, **kwargs) -> Union[int, str]: +def add_text_point(x : float, y : float, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, source: Union[int, str] =0, show: bool =True, offset: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), vertical: bool =False, **kwargs) -> Union[int, str]: """ Adds a label series to a plot. x and y can only have one elements each. Args: x (float): y (float): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7656,11 +7656,11 @@ def add_text_point(x : float, y : float, *, label: str =None, user_data: Any =No return internal_dpg.add_text_point(x, y, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, source=source, show=show, offset=offset, vertical=vertical, **kwargs) -def add_texture_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =False, **kwargs) -> Union[int, str]: +def add_texture_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =False, **kwargs) -> Union[int, str]: """ Adds a dynamic texture. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7676,11 +7676,11 @@ def add_texture_registry(*, label: str =None, user_data: Any =None, use_internal return internal_dpg.add_texture_registry(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, show=show, **kwargs) -def add_theme(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_theme(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Union[int, str]: """ Adds a theme. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7702,13 +7702,13 @@ def add_theme(*, label: str =None, user_data: Any =None, use_internal_label: boo return internal_dpg.add_theme(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, **kwargs) -def add_theme_color(target : int =0, value : Union[List[int], Tuple[int, ...]] =(0, 0, 0, 255), *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, category: int =0, **kwargs) -> Union[int, str]: +def add_theme_color(target : int =0, value : Union[List[int], Tuple[int, ...]] =(0, 0, 0, 255), *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, category: int =0, **kwargs) -> Union[int, str]: """ Adds a theme color. Args: target (int, optional): value (Union[List[int], Tuple[int, ...]], optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7725,12 +7725,12 @@ def add_theme_color(target : int =0, value : Union[List[int], Tuple[int, ...]] = return internal_dpg.add_theme_color(target, value, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, category=category, **kwargs) -def add_theme_component(item_type : int =0, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, enabled_state: bool =True, **kwargs) -> Union[int, str]: +def add_theme_component(item_type : int =0, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, enabled_state: bool =True, **kwargs) -> Union[int, str]: """ Adds a theme component. Args: item_type (int, optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7748,14 +7748,14 @@ def add_theme_component(item_type : int =0, *, label: str =None, user_data: Any return internal_dpg.add_theme_component(item_type, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, enabled_state=enabled_state, **kwargs) -def add_theme_style(target : int =0, x : float =1.0, y : float =-1.0, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, category: int =0, **kwargs) -> Union[int, str]: +def add_theme_style(target : int =0, x : float =1.0, y : float =-1.0, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, category: int =0, **kwargs) -> Union[int, str]: """ Adds a theme style. Args: target (int, optional): x (float, optional): y (float, optional): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7772,11 +7772,11 @@ def add_theme_style(target : int =0, x : float =1.0, y : float =-1.0, *, label: return internal_dpg.add_theme_style(target, x, y, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, category=category, **kwargs) -def add_time_picker(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Callable =None, drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: dict ={'hour': 14, 'min': 32, 'sec': 23}, hour24: bool =False, **kwargs) -> Union[int, str]: +def add_time_picker(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', callback: Optional[Callable] =None, drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_value: dict ={'hour': 14, 'min': 32, 'sec': 23}, hour24: bool =False, **kwargs) -> Union[int, str]: """ Adds a time picker. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7784,9 +7784,9 @@ def add_time_picker(*, label: str =None, user_data: Any =None, use_internal_labe parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - callback (Callable, optional): Registers a callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + callback (Optional[Callable], optional): Registers a callback. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -7805,12 +7805,12 @@ def add_time_picker(*, label: str =None, user_data: Any =None, use_internal_labe return internal_dpg.add_time_picker(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, payload_type=payload_type, callback=callback, drag_callback=drag_callback, drop_callback=drop_callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_value=default_value, hour24=hour24, **kwargs) -def add_tooltip(parent : Union[int, str], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, delay: float =0.0, hide_on_activity: bool =False, **kwargs) -> Union[int, str]: +def add_tooltip(parent : Union[int, str], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, delay: float =0.0, hide_on_activity: bool =False, **kwargs) -> Union[int, str]: """ Adds a tooltip window. Args: parent (Union[int, str]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7828,11 +7828,11 @@ def add_tooltip(parent : Union[int, str], *, label: str =None, user_data: Any =N return internal_dpg.add_tooltip(parent, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, show=show, delay=delay, hide_on_activity=hide_on_activity, **kwargs) -def add_tree_node(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Callable =None, drop_callback: Callable =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_open: bool =False, open_on_double_click: bool =False, open_on_arrow: bool =False, leaf: bool =False, bullet: bool =False, selectable: bool =False, span_text_width: bool =False, span_full_width: bool =False, catch_nav_left: bool =False, lines: int =internal_dpg.mvTreeLines_None, **kwargs) -> Union[int, str]: +def add_tree_node(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, before: Union[int, str] =0, payload_type: str ='$$DPG_PAYLOAD', drag_callback: Optional[Callable] =None, drop_callback: Optional[Callable] =None, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], filter_key: str ='', tracked: bool =False, track_offset: float =0.5, default_open: bool =False, open_on_double_click: bool =False, open_on_arrow: bool =False, leaf: bool =False, bullet: bool =False, selectable: bool =False, span_text_width: bool =False, span_full_width: bool =False, catch_nav_left: bool =False, lines: int =internal_dpg.mvTreeLines_None, **kwargs) -> Union[int, str]: """ Adds a tree node to add items to. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7840,8 +7840,8 @@ def add_tree_node(*, label: str =None, user_data: Any =None, use_internal_label: parent (Union[int, str], optional): Parent to add this item to. (runtime adding) before (Union[int, str], optional): This item will be displayed before the specified item in the parent. payload_type (str, optional): Sender string type must be the same as the target for the target to run the payload_callback. - drag_callback (Callable, optional): Registers a drag callback for drag and drop. - drop_callback (Callable, optional): Registers a drop callback for drag and drop. + drag_callback (Optional[Callable], optional): Registers a drag callback for drag and drop. + drop_callback (Optional[Callable], optional): Registers a drop callback for drag and drop. show (bool, optional): Attempt to render widget. pos (Union[List[int], Tuple[int, ...]], optional): Places the item relative to window coordinates, [0,0] is top left. filter_key (str, optional): Used by filter widget. @@ -7872,11 +7872,11 @@ def add_tree_node(*, label: str =None, user_data: Any =None, use_internal_label: return internal_dpg.add_tree_node(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, before=before, payload_type=payload_type, drag_callback=drag_callback, drop_callback=drop_callback, show=show, pos=pos, filter_key=filter_key, tracked=tracked, track_offset=track_offset, default_open=default_open, open_on_double_click=open_on_double_click, open_on_arrow=open_on_arrow, leaf=leaf, bullet=bullet, selectable=selectable, span_text_width=span_text_width, span_full_width=span_full_width, catch_nav_left=catch_nav_left, lines=lines, **kwargs) -def add_value_registry(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Union[int, str]: +def add_value_registry(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, **kwargs) -> Union[int, str]: """ Adds a value registry. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7891,11 +7891,11 @@ def add_value_registry(*, label: str =None, user_data: Any =None, use_internal_l return internal_dpg.add_value_registry(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, **kwargs) -def add_viewport_drawlist(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, filter_key: str ='', front: bool =True, **kwargs) -> Union[int, str]: +def add_viewport_drawlist(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, show: bool =True, filter_key: str ='', front: bool =True, **kwargs) -> Union[int, str]: """ A container that is used to present draw items or layers directly to the viewport. By default this will draw to the back of the viewport. Layers and draw items should be added to this widget as children. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7917,11 +7917,11 @@ def add_viewport_drawlist(*, label: str =None, user_data: Any =None, use_interna return internal_dpg.add_viewport_drawlist(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, show=show, filter_key=filter_key, front=front, **kwargs) -def add_viewport_menu_bar(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: +def add_viewport_menu_bar(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, indent: int =-1, parent: Union[int, str] =0, show: bool =True, **kwargs) -> Union[int, str]: """ Adds a menubar to the viewport. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7943,11 +7943,11 @@ def add_viewport_menu_bar(*, label: str =None, user_data: Any =None, use_interna return internal_dpg.add_viewport_menu_bar(label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, indent=indent, parent=parent, show=show, **kwargs) -def add_window(*, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], min_size: Union[List[int], Tuple[int, ...]] =[100, 100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], menubar: bool =False, collapsed: bool =False, autosize: bool =False, no_resize: bool =False, unsaved_document: bool =False, no_title_bar: bool =False, no_move: bool =False, no_scrollbar: bool =False, no_collapse: bool =False, horizontal_scrollbar: bool =False, no_focus_on_appearing: bool =False, no_bring_to_front_on_focus: bool =False, no_close: bool =False, no_background: bool =False, modal: bool =False, popup: bool =False, no_saved_settings: bool =False, no_open_over_existing_popup: bool =True, no_scroll_with_mouse: bool =False, no_docking: bool =False, copy_contents_shortcut: bool =False, on_close: Callable =None, **kwargs) -> Union[int, str]: +def add_window(*, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, width: int =0, height: int =0, indent: int =-1, show: bool =True, pos: Union[List[int], Tuple[int, ...]] =[], min_size: Union[List[int], Tuple[int, ...]] =[100, 100], max_size: Union[List[int], Tuple[int, ...]] =[30000, 30000], menubar: bool =False, collapsed: bool =False, autosize: bool =False, no_resize: bool =False, unsaved_document: bool =False, no_title_bar: bool =False, no_move: bool =False, no_scrollbar: bool =False, no_collapse: bool =False, horizontal_scrollbar: bool =False, no_focus_on_appearing: bool =False, no_bring_to_front_on_focus: bool =False, no_close: bool =False, no_background: bool =False, modal: bool =False, popup: bool =False, no_saved_settings: bool =False, no_open_over_existing_popup: bool =True, no_scroll_with_mouse: bool =False, no_docking: bool =False, copy_contents_shortcut: bool =False, on_close: Optional[Callable] =None, **kwargs) -> Union[int, str]: """ Creates a new window for following items to be added to. Args: - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -7979,7 +7979,7 @@ def add_window(*, label: str =None, user_data: Any =None, use_internal_label: bo no_scroll_with_mouse (bool, optional): Disable user vertically scrolling with mouse wheel. no_docking (bool, optional): Disable docking of this window copy_contents_shortcut (bool, optional): Experimental. If True, window contents can be copied to clipboard by pressing Ctrl+C. Might be useful for message boxes. - on_close (Callable, optional): Callback ran when window is closed. + on_close (Optional[Callable], optional): Callback ran when window is closed. id (Union[int, str], optional): (deprecated) delay_search (bool, optional): (deprecated) This was used as an optimization hint but is not relevant anymore. Returns: @@ -8077,11 +8077,11 @@ def bind_theme(theme : Union[int, str], **kwargs) -> None: return internal_dpg.bind_theme(theme, **kwargs) -def capture_next_item(callback : Callable, *, user_data: Any =None, **kwargs) -> None: +def capture_next_item(callback : Optional[Callable], *, user_data: Any =None, **kwargs) -> None: """ Captures the next item. Args: - callback (Callable): + callback (Optional[Callable]): user_data (Any, optional): New in 1.3. Optional user data to send to the callback Returns: None @@ -8283,13 +8283,13 @@ def does_item_exist(item : Union[int, str], **kwargs) -> bool: return internal_dpg.does_item_exist(item, **kwargs) -def draw_arrow(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), thickness: float =1.0, size: int =4, **kwargs) -> Union[int, str]: +def draw_arrow(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), thickness: float =1.0, size: int =4, **kwargs) -> Union[int, str]: """ Adds an arrow. Args: p1 (Union[List[float], Tuple[float, ...]]): Arrow tip. p2 (Union[List[float], Tuple[float, ...]]): Arrow tail. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8310,7 +8310,7 @@ def draw_arrow(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float return internal_dpg.draw_arrow(p1, p2, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, color=color, thickness=thickness, size=size, **kwargs) -def draw_bezier_cubic(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], p4 : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), thickness: float =1.0, segments: int =0, **kwargs) -> Union[int, str]: +def draw_bezier_cubic(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], p4 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), thickness: float =1.0, segments: int =0, **kwargs) -> Union[int, str]: """ Adds a cubic bezier curve. Args: @@ -8318,7 +8318,7 @@ def draw_bezier_cubic(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[Lis p2 (Union[List[float], Tuple[float, ...]]): Second point in curve. p3 (Union[List[float], Tuple[float, ...]]): Third point in curve. p4 (Union[List[float], Tuple[float, ...]]): Fourth point in curve. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8339,14 +8339,14 @@ def draw_bezier_cubic(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[Lis return internal_dpg.draw_bezier_cubic(p1, p2, p3, p4, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, color=color, thickness=thickness, segments=segments, **kwargs) -def draw_bezier_quadratic(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), thickness: float =1.0, segments: int =0, **kwargs) -> Union[int, str]: +def draw_bezier_quadratic(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), thickness: float =1.0, segments: int =0, **kwargs) -> Union[int, str]: """ Adds a quadratic bezier curve. Args: p1 (Union[List[float], Tuple[float, ...]]): First point in curve. p2 (Union[List[float], Tuple[float, ...]]): Second point in curve. p3 (Union[List[float], Tuple[float, ...]]): Third point in curve. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8367,13 +8367,13 @@ def draw_bezier_quadratic(p1 : Union[List[float], Tuple[float, ...]], p2 : Union return internal_dpg.draw_bezier_quadratic(p1, p2, p3, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, color=color, thickness=thickness, segments=segments, **kwargs) -def draw_circle(center : Union[List[float], Tuple[float, ...]], radius : float, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, segments: int =0, **kwargs) -> Union[int, str]: +def draw_circle(center : Union[List[float], Tuple[float, ...]], radius : float, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, segments: int =0, **kwargs) -> Union[int, str]: """ Adds a circle Args: center (Union[List[float], Tuple[float, ...]]): radius (float): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8395,13 +8395,13 @@ def draw_circle(center : Union[List[float], Tuple[float, ...]], radius : float, return internal_dpg.draw_circle(center, radius, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, color=color, fill=fill, thickness=thickness, segments=segments, **kwargs) -def draw_ellipse(pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, segments: int =32, **kwargs) -> Union[int, str]: +def draw_ellipse(pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, segments: int =32, **kwargs) -> Union[int, str]: """ Adds an ellipse. Args: pmin (Union[List[float], Tuple[float, ...]]): Min point of bounding rectangle. pmax (Union[List[float], Tuple[float, ...]]): Max point of bounding rectangle. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8423,14 +8423,14 @@ def draw_ellipse(pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List return internal_dpg.draw_ellipse(pmin, pmax, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, color=color, fill=fill, thickness=thickness, segments=segments, **kwargs) -def draw_image(texture_tag : Union[int, str], pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, uv_min: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), uv_max: Union[List[float], Tuple[float, ...]] =(1.0, 1.0), color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), **kwargs) -> Union[int, str]: +def draw_image(texture_tag : Union[int, str], pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, uv_min: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), uv_max: Union[List[float], Tuple[float, ...]] =(1.0, 1.0), color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), **kwargs) -> Union[int, str]: """ Adds an image (for a drawing). Args: texture_tag (Union[int, str]): pmin (Union[List[float], Tuple[float, ...]]): Point of to start drawing texture. pmax (Union[List[float], Tuple[float, ...]]): Point to complete drawing texture. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8451,7 +8451,7 @@ def draw_image(texture_tag : Union[int, str], pmin : Union[List[float], Tuple[fl return internal_dpg.draw_image(texture_tag, pmin, pmax, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, uv_min=uv_min, uv_max=uv_max, color=color, **kwargs) -def draw_image_quad(texture_tag : Union[int, str], p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], p4 : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, uv1: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), uv2: Union[List[float], Tuple[float, ...]] =(1.0, 0.0), uv3: Union[List[float], Tuple[float, ...]] =(1.0, 1.0), uv4: Union[List[float], Tuple[float, ...]] =(0.0, 1.0), color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), **kwargs) -> Union[int, str]: +def draw_image_quad(texture_tag : Union[int, str], p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], p4 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, uv1: Union[List[float], Tuple[float, ...]] =(0.0, 0.0), uv2: Union[List[float], Tuple[float, ...]] =(1.0, 0.0), uv3: Union[List[float], Tuple[float, ...]] =(1.0, 1.0), uv4: Union[List[float], Tuple[float, ...]] =(0.0, 1.0), color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), **kwargs) -> Union[int, str]: """ Adds an image (for a drawing). Args: @@ -8460,7 +8460,7 @@ def draw_image_quad(texture_tag : Union[int, str], p1 : Union[List[float], Tuple p2 (Union[List[float], Tuple[float, ...]]): p3 (Union[List[float], Tuple[float, ...]]): p4 (Union[List[float], Tuple[float, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8483,13 +8483,13 @@ def draw_image_quad(texture_tag : Union[int, str], p1 : Union[List[float], Tuple return internal_dpg.draw_image_quad(texture_tag, p1, p2, p3, p4, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, uv1=uv1, uv2=uv2, uv3=uv3, uv4=uv4, color=color, **kwargs) -def draw_line(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), thickness: float =1.0, **kwargs) -> Union[int, str]: +def draw_line(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), thickness: float =1.0, **kwargs) -> Union[int, str]: """ Adds a line. Args: p1 (Union[List[float], Tuple[float, ...]]): Start of line. p2 (Union[List[float], Tuple[float, ...]]): End of line. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8509,12 +8509,12 @@ def draw_line(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float] return internal_dpg.draw_line(p1, p2, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, color=color, thickness=thickness, **kwargs) -def draw_polygon(points : List[List[float]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, **kwargs) -> Union[int, str]: +def draw_polygon(points : List[List[float]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, **kwargs) -> Union[int, str]: """ Adds a polygon. Args: points (List[List[float]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8535,12 +8535,12 @@ def draw_polygon(points : List[List[float]], *, label: str =None, user_data: Any return internal_dpg.draw_polygon(points, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, color=color, fill=fill, thickness=thickness, **kwargs) -def draw_polyline(points : List[List[float]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, closed: bool =False, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), thickness: float =1.0, **kwargs) -> Union[int, str]: +def draw_polyline(points : List[List[float]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, closed: bool =False, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), thickness: float =1.0, **kwargs) -> Union[int, str]: """ Adds a polyline. Args: points (List[List[float]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8561,7 +8561,7 @@ def draw_polyline(points : List[List[float]], *, label: str =None, user_data: An return internal_dpg.draw_polyline(points, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, closed=closed, color=color, thickness=thickness, **kwargs) -def draw_quad(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], p4 : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, **kwargs) -> Union[int, str]: +def draw_quad(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], p4 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, **kwargs) -> Union[int, str]: """ Adds a quad. Args: @@ -8569,7 +8569,7 @@ def draw_quad(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float] p2 (Union[List[float], Tuple[float, ...]]): p3 (Union[List[float], Tuple[float, ...]]): p4 (Union[List[float], Tuple[float, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8590,13 +8590,13 @@ def draw_quad(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float] return internal_dpg.draw_quad(p1, p2, p3, p4, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, color=color, fill=fill, thickness=thickness, **kwargs) -def draw_rectangle(pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), multicolor: bool =False, rounding: float =0.0, thickness: float =1.0, corner_colors: Any =None, **kwargs) -> Union[int, str]: +def draw_rectangle(pmin : Union[List[float], Tuple[float, ...]], pmax : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), multicolor: bool =False, rounding: float =0.0, thickness: float =1.0, corner_colors: Any =None, **kwargs) -> Union[int, str]: """ Adds a rectangle. Args: pmin (Union[List[float], Tuple[float, ...]]): Min point of bounding rectangle. pmax (Union[List[float], Tuple[float, ...]]): Max point of bounding rectangle. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8636,13 +8636,13 @@ def draw_rectangle(pmin : Union[List[float], Tuple[float, ...]], pmax : Union[Li return internal_dpg.draw_rectangle(pmin, pmax, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, color=color, fill=fill, multicolor=multicolor, rounding=rounding, thickness=thickness, corner_colors=corner_colors, **kwargs) -def draw_text(pos : Union[List[float], Tuple[float, ...]], text : str, *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), size: float =10.0, **kwargs) -> Union[int, str]: +def draw_text(pos : Union[List[float], Tuple[float, ...]], text : str, *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), size: float =10.0, **kwargs) -> Union[int, str]: """ Adds text (drawlist). Args: pos (Union[List[float], Tuple[float, ...]]): Top left point of bounding text rectangle. text (str): Text to draw. - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -8662,14 +8662,14 @@ def draw_text(pos : Union[List[float], Tuple[float, ...]], text : str, *, label: return internal_dpg.draw_text(pos, text, label=label, user_data=user_data, use_internal_label=use_internal_label, tag=tag, parent=parent, before=before, show=show, color=color, size=size, **kwargs) -def draw_triangle(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], *, label: str =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, **kwargs) -> Union[int, str]: +def draw_triangle(p1 : Union[List[float], Tuple[float, ...]], p2 : Union[List[float], Tuple[float, ...]], p3 : Union[List[float], Tuple[float, ...]], *, label: Optional[str] =None, user_data: Any =None, use_internal_label: bool =True, tag: Union[int, str] =0, parent: Union[int, str] =0, before: Union[int, str] =0, show: bool =True, color: Union[List[int], Tuple[int, ...]] =(255, 255, 255, 255), fill: Union[List[int], Tuple[int, ...]] =(0, 0, 0, -255), thickness: float =1.0, **kwargs) -> Union[int, str]: """ Adds a triangle. Args: p1 (Union[List[float], Tuple[float, ...]]): p2 (Union[List[float], Tuple[float, ...]]): p3 (Union[List[float], Tuple[float, ...]]): - label (str, optional): Overrides 'name' as label. + label (Optional[str], optional): Overrides 'name' as label. user_data (Any, optional): User data for callbacks use_internal_label (bool, optional): Use generated internal label instead of user specified (appends ### uuid). tag (Union[int, str], optional): Unique id used to programmatically refer to the item.If label is unused this will be the label. @@ -9429,12 +9429,12 @@ def move_item_up(item : Union[int, str], **kwargs) -> None: return internal_dpg.move_item_up(item, **kwargs) -def output_frame_buffer(file : str ='', *, callback: Callable =None, **kwargs) -> Any: +def output_frame_buffer(file : str ='', *, callback: Optional[Callable] =None, **kwargs) -> Any: """ Outputs frame buffer as a png if file is specified or through the second argument of a callback if specified. Render loop must have been started. Args: file (str, optional): - callback (Callable, optional): Callback will return framebuffer as an array through the second arg. + callback (Optional[Callable], optional): Callback will return framebuffer as an array through the second arg. Returns: Any """ @@ -9669,11 +9669,11 @@ def set_clipboard_text(text : str, **kwargs) -> None: return internal_dpg.set_clipboard_text(text, **kwargs) -def set_exit_callback(callback : Callable, *, user_data: Any =None, **kwargs) -> str: +def set_exit_callback(callback : Optional[Callable], *, user_data: Any =None, **kwargs) -> str: """ Sets a callback to run on last frame. Args: - callback (Callable): + callback (Optional[Callable]): user_data (Any, optional): New in 1.3. Optional user data to send to the callback Returns: str @@ -9681,12 +9681,12 @@ def set_exit_callback(callback : Callable, *, user_data: Any =None, **kwargs) -> return internal_dpg.set_exit_callback(callback, user_data=user_data, **kwargs) -def set_frame_callback(frame : int, callback : Callable, *, user_data: Any =None, **kwargs) -> str: +def set_frame_callback(frame : int, callback : Optional[Callable], *, user_data: Any =None, **kwargs) -> str: """ Sets a callback to run on first frame. Args: frame (int): - callback (Callable): + callback (Optional[Callable]): user_data (Any, optional): New in 1.3. Optional user data to send to the callback Returns: str @@ -9767,11 +9767,11 @@ def set_value(item : Union[int, str], value : Any, **kwargs) -> None: return internal_dpg.set_value(item, value, **kwargs) -def set_viewport_resize_callback(callback : Callable, *, user_data: Any =None, **kwargs) -> str: +def set_viewport_resize_callback(callback : Optional[Callable], *, user_data: Any =None, **kwargs) -> str: """ Sets a callback to run on viewport resize. Args: - callback (Callable): + callback (Optional[Callable]): user_data (Any, optional): New in 1.3. Optional user data to send to the callback Returns: str diff --git a/src/mvAppItem.cpp b/src/mvAppItem.cpp index 10fd1b73d..4eb0c58c5 100644 --- a/src/mvAppItem.cpp +++ b/src/mvAppItem.cpp @@ -134,7 +134,7 @@ void mvAppItem::submitCallback(ImGuiKey app_data) submitCallbackEx([=]() { return ToPyInt(app_data); }); } -void +void mvAppItem::handleKeywordArgs(PyObject* dict, const std::string& parser) { if (dict == nullptr) @@ -185,7 +185,7 @@ mvAppItem::handleKeywordArgs(PyObject* dict, const std::string& parser) } } if (PyObject* item = PyDict_GetItemString(dict, "indent")) config.indent = (f32)ToInt(item); - if (PyObject* item = PyDict_GetItemString(dict, "show")) + if (PyObject* item = PyDict_GetItemString(dict, "show")) { config.show = ToBool(item); if (config.show) @@ -254,13 +254,13 @@ mvAppItem::handleKeywordArgs(PyObject* dict, const std::string& parser) handleSpecificKeywordArgs(dict); } -void +void mvAppItem::setDataSource(mvUUID value) { - config.source = value; + config.source = value; } -void +void mvAppItem::handleImmediateScroll() { if (!((config.scrollXFlags | config.scrollYFlags) & mvSetScrollFlags_Now)) @@ -271,7 +271,7 @@ mvAppItem::handleImmediateScroll() ImGui::SetNextWindowScroll(scroll); } -void +void mvAppItem::handleDelayedScroll() { if (config.scrollXFlags & mvSetScrollFlags_Delayed) @@ -983,7 +983,7 @@ DearPyGui::GetApplicableState(mvAppItemType type) return applicableState; } -int +int DearPyGui::GetEntityDesciptionFlags(mvAppItemType type) { switch (type) @@ -1150,7 +1150,7 @@ DearPyGui::GetEntityValueType(mvAppItemType type) case mvAppItemType::mvSliderFloat: case mvAppItemType::mvInputFloat: case mvAppItemType::mvDragFloat: return StorageValueTypes::Float; - + case mvAppItemType::mvFloat4Value: case mvAppItemType::mvThemeStyle: @@ -1183,7 +1183,7 @@ DearPyGui::GetEntityValueType(mvAppItemType type) case mvAppItemType::mvSelectable: case mvAppItemType::mvMenuItem: case mvAppItemType::mvCheckbox: return StorageValueTypes::Bool; - + case mvAppItemType::mvSeriesValue: case mvAppItemType::mv2dHistogramSeries: case mvAppItemType::mvAreaSeries: @@ -1211,7 +1211,7 @@ DearPyGui::GetEntityValueType(mvAppItemType type) case mvAppItemType::mvInputDouble: case mvAppItemType::mvSliderDouble: case mvAppItemType::mvDragLine: return StorageValueTypes::Double; - + case mvAppItemType::mvDouble4Value: case mvAppItemType::mvDragDoubleMulti: case mvAppItemType::mvInputDoubleMulti: @@ -1228,7 +1228,7 @@ DearPyGui::GetEntityValueType(mvAppItemType type) } } -const char* +const char* DearPyGui::GetEntityTypeString(mvAppItemType type) { #define X(el) "mvAppItemType::" #el, @@ -1253,7 +1253,7 @@ DearPyGui::CreateEntity(mvAppItemType type, mvUUID id) #undef X } -const std::vector>& +const std::vector>& DearPyGui::GetAllowableParents(mvAppItemType type) { @@ -1987,7 +1987,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds input for text."; break; } - case mvAppItemType::mvRadioButton: + case mvAppItemType::mvRadioButton: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -2014,7 +2014,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) break; } - case mvAppItemType::mvTabBar: + case mvAppItemType::mvTabBar: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -2700,7 +2700,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvSeparator: + case mvAppItemType::mvSeparator: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -2714,7 +2714,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds a horizontal line separator. Use 'label' parameter to add text and mvStyleVar_SeparatorText* elements to style it."; break; } - case mvAppItemType::mvListbox: + case mvAppItemType::mvListbox: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -2742,7 +2742,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds a listbox. If height is not large enough to show all items a scroll bar will appear."; break; } - case mvAppItemType::mvText: + case mvAppItemType::mvText: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -2768,7 +2768,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds text. Text can have an optional label that will display to the right of the text."; break; } - case mvAppItemType::mvPlot: + case mvAppItemType::mvPlot: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -2822,7 +2822,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) args.push_back({ mvPyDataType::Integer, "vertical_mod", mvArgType::KEYWORD_ARG, "internal_dpg.mvKey_ModShift", "expands active box selection/query vertically to plot edge when held" }); args.push_back({ mvPyDataType::Integer, "override_mod", mvArgType::KEYWORD_ARG, "internal_dpg.mvKey_ModCtrl", "when held, all input is ignored; used to enable axis/plots as DND sources" }); args.push_back({ mvPyDataType::Integer, "zoom_mod", mvArgType::KEYWORD_ARG, "internal_dpg.mvKey_None", "optional modifier that must be held for scroll wheel zooming" }); - args.push_back({ mvPyDataType::Integer, "zoom_rate", mvArgType::KEYWORD_ARG, "0.1", "zoom rate for scroll (e.g. 0.1f = 10% plot range every scroll click); make negative to invert" }); + args.push_back({ mvPyDataType::Float, "zoom_rate", mvArgType::KEYWORD_ARG, "0.1", "zoom rate for scroll (e.g. 0.1f = 10% plot range every scroll click); make negative to invert" }); args.push_back({ mvPyDataType::Integer, "query_button", mvArgType::DEPRECATED_REMOVE_KEYWORD_ARG, "0", "This refers to the old way of querying of ImPlot, now replaced with `DragRect()`" }); args.push_back({ mvPyDataType::Integer, "query_mod", mvArgType::DEPRECATED_REMOVE_KEYWORD_ARG, "internal_dpg.mvKey_None", "This refers to the old way of querying of ImPlot, now replaced with `DragRect()`" }); @@ -2882,7 +2882,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvWindowAppItem: + case mvAppItemType::mvWindowAppItem: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -2926,7 +2926,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvSelectable: + case mvAppItemType::mvSelectable: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -2955,7 +2955,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds a selectable. Similar to a button but can indicate its selected state."; break; } - case mvAppItemType::mvTreeNode: + case mvAppItemType::mvTreeNode: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -2997,7 +2997,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvProgressBar: + case mvAppItemType::mvProgressBar: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3022,7 +3022,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds a progress bar."; break; } - case mvAppItemType::mvSpacer: + case mvAppItemType::mvSpacer: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3038,7 +3038,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds a spacer item that can be used to help with layouts or can be used as a placeholder item."; break; } - case mvAppItemType::mvImageButton: + case mvAppItemType::mvImageButton: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3070,7 +3070,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Textures" }; break; } - case mvAppItemType::mvTimePicker: + case mvAppItemType::mvTimePicker: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3093,7 +3093,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds a time picker."; break; } - case mvAppItemType::mvDatePicker: + case mvAppItemType::mvDatePicker: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3116,7 +3116,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds a date picker."; break; } - case mvAppItemType::mvColorButton: + case mvAppItemType::mvColorButton: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3147,7 +3147,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Colors" }; break; } - case mvAppItemType::mvFileDialog: + case mvAppItemType::mvFileDialog: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3171,7 +3171,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvTabButton: + case mvAppItemType::mvTabButton: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3196,7 +3196,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds a tab button to a tab bar."; break; } - case mvAppItemType::mvDrawNode: + case mvAppItemType::mvDrawNode: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3210,7 +3210,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvNodeEditor: + case mvAppItemType::mvNodeEditor: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3235,7 +3235,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvNode: + case mvAppItemType::mvNode: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3258,7 +3258,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvNodeAttribute: + case mvAppItemType::mvNodeAttribute: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3279,7 +3279,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvTable: + case mvAppItemType::mvTable: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3331,7 +3331,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvTableColumn: + case mvAppItemType::mvTableColumn: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3366,7 +3366,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Tables", "Widgets" }; break; } - case mvAppItemType::mvTableRow: + case mvAppItemType::mvTableRow: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3381,7 +3381,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvSyncedTables: + case mvAppItemType::mvSyncedTables: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3391,7 +3391,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) MV_PARSER_ARG_SHOW) ); - setup.about = + setup.about = "Links all tables that are immediate children of this container so that they share " "their state (mostly column sizes). Other children are rendered as is. This is " "an experimental feature, use with caution."; @@ -3399,7 +3399,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvDrawLine: + case mvAppItemType::mvDrawLine: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3417,7 +3417,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawArrow: + case mvAppItemType::mvDrawArrow: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3436,7 +3436,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawTriangle: + case mvAppItemType::mvDrawTriangle: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3456,7 +3456,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawImageQuad: + case mvAppItemType::mvDrawImageQuad: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3480,7 +3480,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawCircle: + case mvAppItemType::mvDrawCircle: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3500,7 +3500,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawEllipse: + case mvAppItemType::mvDrawEllipse: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3520,7 +3520,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawBezierCubic: + case mvAppItemType::mvDrawBezierCubic: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3541,7 +3541,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawBezierQuadratic: + case mvAppItemType::mvDrawBezierQuadratic: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3561,7 +3561,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawQuad: + case mvAppItemType::mvDrawQuad: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3582,7 +3582,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawRect: + case mvAppItemType::mvDrawRect: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3608,7 +3608,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawText: + case mvAppItemType::mvDrawText: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3626,7 +3626,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawPolygon: + case mvAppItemType::mvDrawPolygon: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3644,7 +3644,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawPolyline: + case mvAppItemType::mvDrawPolyline: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3662,7 +3662,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets" }; break; } - case mvAppItemType::mvDrawImage: + case mvAppItemType::mvDrawImage: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3682,7 +3682,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Drawlist", "Widgets", "Textures" }; break; } - case mvAppItemType::mvDragFloatMulti: + case mvAppItemType::mvDragFloatMulti: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3748,7 +3748,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets" }; break; } - case mvAppItemType::mvDragIntMulti: + case mvAppItemType::mvDragIntMulti: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3780,7 +3780,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds drag input for a set of int values up to 4. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the drag. Use clamped keyword to also apply limits to the direct entry modes."; break; } - case mvAppItemType::mvSliderFloatMulti: + case mvAppItemType::mvSliderFloatMulti: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3842,7 +3842,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds multi slider for up to 4 double values. Usueful for when multi slide float is not accurate enough. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes."; break; } - case mvAppItemType::mvSliderIntMulti: + case mvAppItemType::mvSliderIntMulti: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3873,7 +3873,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds multi slider for up to 4 int values. Directly entry can be done with double click or CTRL+Click. Min and Max alone are a soft limit for the slider. Use clamped keyword to also apply limits to the direct entry modes."; break; } - case mvAppItemType::mvInputIntMulti: + case mvAppItemType::mvInputIntMulti: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3907,7 +3907,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds multi int input for up to 4 integer values."; break; } - case mvAppItemType::mvInputFloatMulti: + case mvAppItemType::mvInputFloatMulti: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -3977,7 +3977,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds multi double input for up to 4 double values. Useful when input float mulit is not accurate enough."; break; } - case mvAppItemType::mvDragPoint: + case mvAppItemType::mvDragPoint: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4004,7 +4004,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) break; } - case mvAppItemType::mvDragRect: + case mvAppItemType::mvDragRect: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4027,7 +4027,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) break; } - case mvAppItemType::mvDragLine: + case mvAppItemType::mvDragLine: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4052,7 +4052,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Widgets" }; break; } - case mvAppItemType::mvAnnotation: + case mvAppItemType::mvAnnotation: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4071,7 +4071,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Widgets" }; break; } - case mvAppItemType::mvAxisTag: + case mvAppItemType::mvAxisTag: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4089,7 +4089,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Widgets" }; break; } - case mvAppItemType::mvLineSeries: + case mvAppItemType::mvLineSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4111,7 +4111,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvScatterSeries: + case mvAppItemType::mvScatterSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4129,7 +4129,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvStemSeries: + case mvAppItemType::mvStemSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4148,7 +4148,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvStairSeries: + case mvAppItemType::mvStairSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4167,7 +4167,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvBarSeries: + case mvAppItemType::mvBarSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4186,7 +4186,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvBarGroupSeries: + case mvAppItemType::mvBarGroupSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4208,7 +4208,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvErrorSeries: + case mvAppItemType::mvErrorSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4229,7 +4229,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvInfLineSeries: + case mvAppItemType::mvInfLineSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4246,7 +4246,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvHeatSeries: + case mvAppItemType::mvHeatSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4271,7 +4271,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvImageSeries: + case mvAppItemType::mvImageSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4292,7 +4292,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets", "Textures" }; break; } - case mvAppItemType::mvPieSeries: + case mvAppItemType::mvPieSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4316,7 +4316,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvShadeSeries: + case mvAppItemType::mvShadeSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4334,7 +4334,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvLabelSeries: + case mvAppItemType::mvLabelSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4355,7 +4355,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvDigitalSeries: + case mvAppItemType::mvDigitalSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4372,7 +4372,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvHistogramSeries: + case mvAppItemType::mvHistogramSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4398,7 +4398,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mv2dHistogramSeries: + case mvAppItemType::mv2dHistogramSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4424,7 +4424,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvCandleSeries: + case mvAppItemType::mvCandleSeries: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4493,7 +4493,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Containers", "Widgets" }; break; } - case mvAppItemType::mvColorMapScale: + case mvAppItemType::mvColorMapScale: { AddCommonArgs(args, (CommonParserArgs)( @@ -4522,7 +4522,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Colors" }; break; } - case mvAppItemType::mvSlider3D: + case mvAppItemType::mvSlider3D: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4554,7 +4554,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds a 3D box slider."; break; } - case mvAppItemType::mvKnobFloat: + case mvAppItemType::mvKnobFloat: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4582,7 +4582,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds a knob that rotates based on change in x mouse position."; break; } - case mvAppItemType::mvLoadingIndicator: + case mvAppItemType::mvLoadingIndicator: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4608,7 +4608,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Adds a rotating animated loading symbol."; break; } - case mvAppItemType::mvNodeLink: + case mvAppItemType::mvNodeLink: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4623,7 +4623,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Node Editor", "Widgets" }; break; } - case mvAppItemType::mvTextureRegistry: + case mvAppItemType::mvTextureRegistry: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID) @@ -4636,7 +4636,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvStaticTexture: + case mvAppItemType::mvStaticTexture: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID) @@ -4651,7 +4651,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Textures", "Widgets" }; break; } - case mvAppItemType::mvDynamicTexture: + case mvAppItemType::mvDynamicTexture: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID) @@ -4666,7 +4666,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Textures", "Widgets" }; break; } - case mvAppItemType::mvStage: + case mvAppItemType::mvStage: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID) @@ -4677,7 +4677,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvDrawLayer: + case mvAppItemType::mvDrawLayer: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4695,7 +4695,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvViewportDrawlist: + case mvAppItemType::mvViewportDrawlist: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4711,7 +4711,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvFileExtension: + case mvAppItemType::mvFileExtension: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4729,7 +4729,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "File Dialog" }; break; } - case mvAppItemType::mvPlotLegend: + case mvAppItemType::mvPlotLegend: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4752,7 +4752,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Plotting", "Widgets" }; break; } - case mvAppItemType::mvPlotAxis: + case mvAppItemType::mvPlotAxis: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4790,7 +4790,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvHandlerRegistry: + case mvAppItemType::mvHandlerRegistry: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4802,7 +4802,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvKeyDownHandler: + case mvAppItemType::mvKeyDownHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4817,7 +4817,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Events", "Widgets" }; break; } - case mvAppItemType::mvKeyPressHandler: + case mvAppItemType::mvKeyPressHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4832,7 +4832,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Events", "Widgets" }; break; } - case mvAppItemType::mvKeyReleaseHandler: + case mvAppItemType::mvKeyReleaseHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4847,7 +4847,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Events", "Widgets" }; break; } - case mvAppItemType::mvMouseMoveHandler: + case mvAppItemType::mvMouseMoveHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4860,7 +4860,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Events", "Widgets" }; break; } - case mvAppItemType::mvMouseWheelHandler: + case mvAppItemType::mvMouseWheelHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4873,7 +4873,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Events", "Widgets" }; break; } - case mvAppItemType::mvMouseClickHandler: + case mvAppItemType::mvMouseClickHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4888,7 +4888,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Events", "Widgets" }; break; } - case mvAppItemType::mvMouseDoubleClickHandler: + case mvAppItemType::mvMouseDoubleClickHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4903,7 +4903,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Events", "Widgets" }; break; } - case mvAppItemType::mvMouseDownHandler: + case mvAppItemType::mvMouseDownHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4918,7 +4918,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Events", "Widgets" }; break; } - case mvAppItemType::mvMouseReleaseHandler: + case mvAppItemType::mvMouseReleaseHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4933,7 +4933,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Events", "Widgets" }; break; } - case mvAppItemType::mvMouseDragHandler: + case mvAppItemType::mvMouseDragHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4949,7 +4949,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Events", "Widgets" }; break; } - case mvAppItemType::mvHoverHandler: + case mvAppItemType::mvHoverHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4958,13 +4958,13 @@ DearPyGui::GetEntityParser(mvAppItemType type) MV_PARSER_ARG_CALLBACK) ); - args.push_back({ mvPyDataType::Integer, "event_type", mvArgType::KEYWORD_ARG, "None", "What kind of events to track: mouse-in (mvEventType_Enter), mouse-over (mvEventType_On), mouse-out (mvEventType_Leave). Can be a combination of these flags. Defaults to mouse-over." }); + args.push_back({ mvPyDataType::Integer, "event_type", mvArgType::KEYWORD_ARG, "internal_dpg.mvEventType_On", "What kind of events to track: mouse-in (mvEventType_Enter), mouse-over (mvEventType_On), mouse-out (mvEventType_Leave). Can be a combination of these flags. Defaults to mouse-over." }); setup.about = "Adds a hover handler."; setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvActiveHandler: + case mvAppItemType::mvActiveHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4977,7 +4977,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvFocusHandler: + case mvAppItemType::mvFocusHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -4986,13 +4986,13 @@ DearPyGui::GetEntityParser(mvAppItemType type) MV_PARSER_ARG_CALLBACK) ); - args.push_back({ mvPyDataType::Integer, "event_type", mvArgType::KEYWORD_ARG, "None", "What kind of events to track: just got focus (mvEventType_Enter), currently having focus (mvEventType_On), lost focus (mvEventType_Leave). Can be a combination of these flags. Defaults to mvEventType_On." }); + args.push_back({ mvPyDataType::Integer, "event_type", mvArgType::KEYWORD_ARG, "internal_dpg.mvEventType_On", "What kind of events to track: just got focus (mvEventType_Enter), currently having focus (mvEventType_On), lost focus (mvEventType_Leave). Can be a combination of these flags. Defaults to mvEventType_On." }); setup.about = "Adds a focus handler."; setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvVisibleHandler: + case mvAppItemType::mvVisibleHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5005,7 +5005,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvEditedHandler: + case mvAppItemType::mvEditedHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5018,7 +5018,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvActivatedHandler: + case mvAppItemType::mvActivatedHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5031,7 +5031,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvDeactivatedHandler: + case mvAppItemType::mvDeactivatedHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5044,7 +5044,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvDeactivatedAfterEditHandler: + case mvAppItemType::mvDeactivatedAfterEditHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5057,7 +5057,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvToggledOpenHandler: + case mvAppItemType::mvToggledOpenHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5072,7 +5072,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvClickedHandler: + case mvAppItemType::mvClickedHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5087,7 +5087,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvDoubleClickedHandler: + case mvAppItemType::mvDoubleClickedHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5102,7 +5102,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvDragPayload: + case mvAppItemType::mvDragPayload: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5119,7 +5119,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvResizeHandler: + case mvAppItemType::mvResizeHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5132,7 +5132,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvScrollHandler: + case mvAppItemType::mvScrollHandler: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5145,7 +5145,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Events" }; break; } - case mvAppItemType::mvFont: + case mvAppItemType::mvFont: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID) @@ -5163,7 +5163,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvFontRegistry: + case mvAppItemType::mvFontRegistry: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5175,7 +5175,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvTheme: + case mvAppItemType::mvTheme: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID) @@ -5188,7 +5188,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvThemeColor: + case mvAppItemType::mvThemeColor: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5203,7 +5203,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Themes" }; break; } - case mvAppItemType::mvThemeStyle: + case mvAppItemType::mvThemeStyle: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5219,7 +5219,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Themes" }; break; } - case mvAppItemType::mvThemeComponent: + case mvAppItemType::mvThemeComponent: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5235,7 +5235,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvCharRemap: + case mvAppItemType::mvCharRemap: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5249,7 +5249,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.about = "Remaps a character."; break; } - case mvAppItemType::mvValueRegistry: + case mvAppItemType::mvValueRegistry: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID) @@ -5260,7 +5260,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvIntValue: + case mvAppItemType::mvIntValue: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5274,7 +5274,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Values" }; break; } - case mvAppItemType::mvFloatValue: + case mvAppItemType::mvFloatValue: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5288,7 +5288,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Values" }; break; } - case mvAppItemType::mvFloat4Value: + case mvAppItemType::mvFloat4Value: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5302,7 +5302,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Values" }; break; } - case mvAppItemType::mvInt4Value: + case mvAppItemType::mvInt4Value: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5316,7 +5316,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Values" }; break; } - case mvAppItemType::mvBoolValue: + case mvAppItemType::mvBoolValue: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5330,7 +5330,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Values" }; break; } - case mvAppItemType::mvStringValue: + case mvAppItemType::mvStringValue: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5344,7 +5344,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Values" }; break; } - case mvAppItemType::mvDoubleValue: + case mvAppItemType::mvDoubleValue: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5358,7 +5358,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Values" }; break; } - case mvAppItemType::mvDouble4Value: + case mvAppItemType::mvDouble4Value: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5372,7 +5372,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Values" }; break; } - case mvAppItemType::mvColorValue: + case mvAppItemType::mvColorValue: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5386,7 +5386,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Values" }; break; } - case mvAppItemType::mvFloatVectValue: + case mvAppItemType::mvFloatVectValue: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5400,7 +5400,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Values" }; break; } - case mvAppItemType::mvSeriesValue: + case mvAppItemType::mvSeriesValue: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5414,7 +5414,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Values" }; break; } - case mvAppItemType::mvRawTexture: + case mvAppItemType::mvRawTexture: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID) @@ -5430,7 +5430,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Textures", "Widgets" }; break; } - case mvAppItemType::mvSubPlots: + case mvAppItemType::mvSubPlots: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5469,7 +5469,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvColorMap: + case mvAppItemType::mvColorMap: { AddCommonArgs(args, (CommonParserArgs)( @@ -5485,7 +5485,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Colors" }; break; } - case mvAppItemType::mvColorMapRegistry: + case mvAppItemType::mvColorMapRegistry: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID) @@ -5498,7 +5498,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvColorMapButton: + case mvAppItemType::mvColorMapButton: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5524,7 +5524,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Colors" }; break; } - case mvAppItemType::mvColorMapSlider: + case mvAppItemType::mvColorMapSlider: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5549,7 +5549,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.category = { "Widgets", "Colors" }; break; } - case mvAppItemType::mvTemplateRegistry: + case mvAppItemType::mvTemplateRegistry: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID) @@ -5560,7 +5560,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvTableCell: + case mvAppItemType::mvTableCell: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5576,7 +5576,7 @@ DearPyGui::GetEntityParser(mvAppItemType type) setup.createContextManager = true; break; } - case mvAppItemType::mvItemHandlerRegistry: + case mvAppItemType::mvItemHandlerRegistry: { AddCommonArgs(args, (CommonParserArgs)( MV_PARSER_ARG_ID | @@ -5644,7 +5644,7 @@ DearPyGui::OnChildAdded(mvAppItem* item, std::shared_ptr child) default: return; } } - + void DearPyGui::OnChildRemoved(mvAppItem* item, std::shared_ptr child) { diff --git a/src/mvPyUtils.cpp b/src/mvPyUtils.cpp index 7fac6d492..a48f83c98 100644 --- a/src/mvPyUtils.cpp +++ b/src/mvPyUtils.cpp @@ -1927,6 +1927,7 @@ PythonDataTypeString(mvPyDataType type) switch (type) { case mvPyDataType::String: return " : str"; + case mvPyDataType::OptionalString: return " : Optional[str]"; case mvPyDataType::UUID: return " : Union[int, str]"; case mvPyDataType::Integer: return " : int"; case mvPyDataType::Long: return " : int"; @@ -1938,7 +1939,7 @@ PythonDataTypeString(mvPyDataType type) case mvPyDataType::DoubleList: return " : Union[List[float], Tuple[float, ...]]"; case mvPyDataType::IntList: return " : Union[List[int], Tuple[int, ...]]"; case mvPyDataType::UUIDList: return " : Union[List[int], Tuple[int, ...]]"; - case mvPyDataType::Callable: return " : Callable"; + case mvPyDataType::Callable: return " : Optional[Callable]"; case mvPyDataType::Dict: return " : dict"; case mvPyDataType::ListAny: return " : List[Any]"; case mvPyDataType::ListListInt: return " : List[Union[List[int], Tuple[int, ...]]]"; @@ -1955,23 +1956,24 @@ PythonDataTypeActual(mvPyDataType type) { switch (type) { - case mvPyDataType::String: return "str"; - case mvPyDataType::UUID: return "Union[int, str]"; - case mvPyDataType::Integer: return "int"; - case mvPyDataType::Long: return "int"; - case mvPyDataType::Float: return "float"; - case mvPyDataType::Double: return "float"; - case mvPyDataType::Bool: return "bool"; - case mvPyDataType::StringList: return "Union[List[str], Tuple[str, ...]]"; - case mvPyDataType::FloatList: return "Union[List[float], Tuple[float, ...]]"; - case mvPyDataType::IntList: return "Union[List[int], Tuple[int, ...]]"; - case mvPyDataType::UUIDList: return "Union[List[int], Tuple[int, ...]]"; - case mvPyDataType::Callable: return "Callable"; - case mvPyDataType::Dict: return "dict"; - case mvPyDataType::ListFloatList: return "List[List[float]]"; - case mvPyDataType::ListStrList: return "List[List[str]]"; - case mvPyDataType::None: return "None"; - case mvPyDataType::Object: return "Any"; + case mvPyDataType::String: return "str"; + case mvPyDataType::OptionalString: return "Optional[str]"; + case mvPyDataType::UUID: return "Union[int, str]"; + case mvPyDataType::Integer: return "int"; + case mvPyDataType::Long: return "int"; + case mvPyDataType::Float: return "float"; + case mvPyDataType::Double: return "float"; + case mvPyDataType::Bool: return "bool"; + case mvPyDataType::StringList: return "Union[List[str], Tuple[str, ...]]"; + case mvPyDataType::FloatList: return "Union[List[float], Tuple[float, ...]]"; + case mvPyDataType::IntList: return "Union[List[int], Tuple[int, ...]]"; + case mvPyDataType::UUIDList: return "Union[List[int], Tuple[int, ...]]"; + case mvPyDataType::Callable: return "Optional[Callable]"; + case mvPyDataType::Dict: return "dict"; + case mvPyDataType::ListFloatList: return "List[List[float]]"; + case mvPyDataType::ListStrList: return "List[List[str]]"; + case mvPyDataType::None: return "None"; + case mvPyDataType::Object: return "Any"; default: return "Any"; } } @@ -2255,7 +2257,7 @@ GenerateStubFile(const std::string& directory) std::ofstream stub; stub.open(directory + "/_dearpygui.pyi"); - stub << "from typing import List, Any, Callable, Union, Tuple\n"; + stub << "from typing import List, Any, Callable, Union, Tuple, Optional\n"; stub << "from dearpygui._dearpygui import *\n\n"; stub << "##########################################################\n"; stub << "# This file is generated automatically by mvPythonParser #\n"; @@ -2515,7 +2517,7 @@ GenerateContextsFile(std::ofstream& stream) stream << "**kwargs) -> "; else stream << ", **kwargs) -> "; - stream << PythonDataTypeActual(parser.second.returnType) << ":"; + stream << "Iterator[" << PythonDataTypeActual(parser.second.returnType) << "]" << ":"; stream << "\n\t\"\"\"\t " << parser.second.about.c_str(); @@ -3355,7 +3357,7 @@ AddCommonArgs(std::vector& args, CommonParserArgs argsFlags { args.push_back({ mvPyDataType::UUID, "id", mvArgType::DEPRECATED_RENAME_KEYWORD_ARG, "0", "", "tag" }); - args.push_back({ mvPyDataType::String, "label", mvArgType::KEYWORD_ARG, "None", "Overrides 'name' as label." }); + args.push_back({ mvPyDataType::OptionalString, "label", mvArgType::KEYWORD_ARG, "None", "Overrides 'name' as label." }); args.push_back({ mvPyDataType::Object, "user_data", mvArgType::KEYWORD_ARG, "None", "User data for callbacks" }); args.push_back({ mvPyDataType::Bool, "use_internal_label", mvArgType::KEYWORD_ARG, "True", "Use generated internal label instead of user specified (appends ### uuid)." }); diff --git a/src/mvPyUtils.h b/src/mvPyUtils.h index 9f050aefb..7c2cbe92d 100644 --- a/src/mvPyUtils.h +++ b/src/mvPyUtils.h @@ -238,7 +238,7 @@ std::vector> ToVectPairStringFloat(PyObject* enum class mvPyDataType { None = 0, - Integer, Float, Double, String, Bool, Object, Callable, Dict, + Integer, Float, Double, String, OptionalString, Bool, Object, Callable, Dict, IntList, FloatList, DoubleList, StringList, ListAny, ListListInt, ListFloatList, ListDoubleList, ListStrList, UUID, UUIDList, Long,