dearpygui.dearpygui

dearpygui.dearpygui.add_2d_histogram_series(x, y, **kwargs)[source]

Adds a 2d histogram series.

Parameters
  • x (Any) –

  • y (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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • xbins (int, optional) –

  • ybins (int, optional) –

  • xmin_range (float, optional) –

  • xmax_range (float, optional) –

  • ymin_range (float, optional) –

  • ymax_range (float, optional) –

  • density (bool, optional) –

  • outliers (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_3d_slider(**kwargs)[source]

Adds a 3D box slider.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • default_value (Union[List[float], Tuple[float, ...]], optional) –

  • max_x (float, optional) – Applies upper limit to slider.

  • max_y (float, optional) – Applies upper limit to slider.

  • max_z (float, optional) – Applies upper limit to slider.

  • min_x (float, optional) – Applies lower limit to slider.

  • min_y (float, optional) – Applies lower limit to slider.

  • min_z (float, optional) – Applies lower limit to slider.

  • scale (float, optional) – Size of the widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_activated_handler(parent, **kwargs)[source]

deprecated function

dearpygui.dearpygui.add_active_handler(parent, **kwargs)[source]

deprecated function

dearpygui.dearpygui.add_alias(alias, item)[source]

Adds an alias.

Parameters
  • alias (str) –

  • item (Union[int, str]) –

Returns

None

dearpygui.dearpygui.add_area_series(x, y, **kwargs)[source]

Adds an area series to a plot.

Parameters
  • x (Any) –

  • y (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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • fill (Union[List[int], Tuple[int, ...]], optional) –

  • contribute_to_bounds (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_bar_series(x, y, **kwargs)[source]

Adds a bar series to a plot.

Parameters
  • x (Any) –

  • y (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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • weight (float, optional) –

  • horizontal (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_bool_value(**kwargs)[source]

Adds a bool value.

Parameters
  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • default_value (bool, optional) –

  • parent (Union[int, str], optional) – Parent to add this item to. (runtime adding)

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_button(**kwargs)[source]

Adds a button.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • small (bool, optional) – Shrinks the size of the button to the text of the label it contains. Useful for embedding in text.

  • arrow (bool, optional) – Displays an arrow in place of the text string. This requires the direction keyword.

  • direction (int, optional) – Sets the cardinal direction for the arrow buy using constants mvDir_Left, mvDir_Up, mvDir_Down, mvDir_Right, mvDir_None. Arrow keyword must be set to True.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_candle_series(dates, opens, closes, lows, highs, **kwargs)[source]

Adds a candle series to a plot.

Parameters
  • dates (Any) –

  • opens (Any) –

  • closes (Any) –

  • lows (Any) –

  • highs (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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • bull_color (Union[List[int], Tuple[int, ...]], optional) –

  • bear_color (Union[List[int], Tuple[int, ...]], optional) –

  • weight (float, optional) –

  • tooltip (bool, optional) –

  • time_unit (int, optional) – mvTimeUnit_* constants. Default mvTimeUnit_Day.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_char_remap(source, target, **kwargs)[source]

Remaps a character.

Parameters
  • source (int) –

  • target (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)

Returns

Union[int, str]

dearpygui.dearpygui.add_checkbox(**kwargs)[source]

Adds a checkbox.

Parameters
  • 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.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (bool, optional) – Sets the default value of the checkmark

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_child(**kwargs)[source]

(deprecated function) Adds an embedded child window. Will show scrollbars when items do not fit.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • border (bool, optional) – Shows/Hides the border around the sides.

  • autosize_x (bool, optional) – Autosize the window to its parents size in x.

  • autosize_y (bool, optional) – Autosize the window to its parents size in y.

  • no_scrollbar (bool, optional) – Disable scrollbars (window can still scroll with mouse or programmatically).

  • horizontal_scrollbar (bool, optional) – Allow horizontal scrollbar to appear (off by default).

  • menubar (bool, optional) – Shows/Hides the menubar at the top.

Returns

Union[int, str]

dearpygui.dearpygui.add_child_window(**kwargs)[source]

Adds an embedded child window. Will show scrollbars when items do not fit.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • border (bool, optional) – Shows/Hides the border around the sides.

  • autosize_x (bool, optional) – Autosize the window to its parents size in x.

  • autosize_y (bool, optional) – Autosize the window to its parents size in y.

  • no_scrollbar (bool, optional) – Disable scrollbars (window can still scroll with mouse or programmatically).

  • horizontal_scrollbar (bool, optional) – Allow horizontal scrollbar to appear (off by default).

  • menubar (bool, optional) – Shows/Hides the menubar at the top.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_clicked_handler(parent, button=- 1, **kwargs)[source]

deprecated function

dearpygui.dearpygui.add_clipper(**kwargs)[source]

Helper to manually clip large list of items. Increases performance by not searching or drawing widgets outside of the clipped region.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_collapsing_header(**kwargs)[source]

Adds a collapsing header to add items to. Must be closed with the end command.

Parameters
  • 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.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • closable (bool, optional) – Adds the ability to hide this widget by pressing the (x) in the top right of widget.

  • default_open (bool, optional) – Sets the collapseable header open by default.

  • open_on_double_click (bool, optional) – Need double-click to open node.

  • open_on_arrow (bool, optional) – Only open when clicking on the arrow part.

  • leaf (bool, optional) – No collapsing, no arrow (use as a convenience for leaf nodes).

  • bullet (bool, optional) – Display a bullet instead of arrow.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_color_button(default_value=(0, 0, 0, 255), **kwargs)[source]

Adds a color button.

Parameters
  • default_value (Union[List[int], Tuple[int, ...]], optional) –

  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • no_alpha (bool, optional) – Removes the displayed slider that can change alpha channel.

  • no_border (bool, optional) – Disable border around the image.

  • no_drag_drop (bool, optional) – Disable ability to drag and drop small preview (color square) to apply colors to other items.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_color_edit(default_value=(0, 0, 0, 255), **kwargs)[source]

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.

Parameters
  • default_value (Union[List[int], Tuple[int, ...]], optional) –

  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • no_alpha (bool, optional) – Removes the displayed slider that can change alpha channel.

  • no_picker (bool, optional) – Disable picker popup when color square is clicked.

  • no_options (bool, optional) – Disable toggling options menu when right-clicking on inputs/small preview.

  • no_small_preview (bool, optional) – Disable colored square preview next to the inputs. (e.g. to show only the inputs). This only displays if the side preview is not shown.

  • no_inputs (bool, optional) – Disable inputs sliders/text widgets. (e.g. to show only the small preview colored square)

  • no_tooltip (bool, optional) – Disable tooltip when hovering the preview.

  • no_label (bool, optional) – Disable display of inline text label.

  • no_drag_drop (bool, optional) – Disable ability to drag and drop small preview (color square) to apply colors to other items.

  • alpha_bar (bool, optional) – Show vertical alpha bar/gradient in picker.

  • alpha_preview (int, optional) – mvColorEdit_AlphaPreviewNone, mvColorEdit_AlphaPreview, or mvColorEdit_AlphaPreviewHalf

  • display_mode (int, optional) – mvColorEdit_rgb, mvColorEdit_hsv, or mvColorEdit_hex

  • display_type (int, optional) – mvColorEdit_uint8 or mvColorEdit_float

  • input_mode (int, optional) – mvColorEdit_input_rgb or mvColorEdit_input_hsv

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_color_picker(default_value=(0, 0, 0, 255), **kwargs)[source]

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.

Parameters
  • default_value (Union[List[int], Tuple[int, ...]], optional) –

  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • no_alpha (bool, optional) – Removes the displayed slider that can change alpha channel.

  • no_side_preview (bool, optional) – Disable bigger color preview on right side of the picker, use small colored square preview instead , unless small preview is also hidden.

  • no_small_preview (bool, optional) – Disable colored square preview next to the inputs. (e.g. to show only the inputs). This only displays if the side preview is not shown.

  • no_inputs (bool, optional) – Disable inputs sliders/text widgets. (e.g. to show only the small preview colored square)

  • no_tooltip (bool, optional) – Disable tooltip when hovering the preview.

  • no_label (bool, optional) – Disable display of inline text label.

  • alpha_bar (bool, optional) – Show vertical alpha bar/gradient in picker.

  • display_rgb (bool, optional) – Override _display_ type among RGB/HSV/Hex.

  • display_hsv (bool, optional) – Override _display_ type among RGB/HSV/Hex.

  • display_hex (bool, optional) – Override _display_ type among RGB/HSV/Hex.

  • picker_mode (int, optional) – mvColorPicker_bar or mvColorPicker_wheel

  • alpha_preview (int, optional) – mvColorEdit_AlphaPreviewNone, mvColorEdit_AlphaPreview, or mvColorEdit_AlphaPreviewHalf

  • display_type (int, optional) – mvColorEdit_uint8 or mvColorEdit_float

  • input_mode (int, optional) – mvColorEdit_input_rgb or mvColorEdit_input_hsv

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_color_value(**kwargs)[source]

Adds a color value.

Parameters
  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • default_value (Union[List[float], Tuple[float, ...]], optional) –

  • parent (Union[int, str], optional) – Parent to add this item to. (runtime adding)

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_colormap(colors, qualitative, **kwargs)[source]

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)

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### uuid).

  • tag (Union[int, str], optional) – Unique id used to programmatically refer to the item.If label is unused this will be the label.

  • 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)

Returns

Union[int, str]

dearpygui.dearpygui.add_colormap_button(default_value=(0, 0, 0, 255), **kwargs)[source]

Adds a button that a color map can be bound to.

Parameters
  • default_value (Union[List[int], Tuple[int, ...]], optional) –

  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_colormap_registry(**kwargs)[source]

Adds a colormap registry.

Parameters
  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_colormap_scale(**kwargs)[source]

Adds a legend that pairs values with colors. This is typically used with a heat series.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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

  • min_scale (float, optional) – Sets the min number of the color scale. Typically is the same as the min scale from the heat series.

  • max_scale (float, optional) – Sets the max number of the color scale. Typically is the same as the max scale from the heat series.

  • id (Union[int, str], optional) – (deprecated)

  • drag_callback (Callable, optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_colormap_slider(**kwargs)[source]

Adds a color slider that a color map can be bound to.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • tracked (bool, optional) – Scroll tracking

  • 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)

Returns

Union[int, str]

dearpygui.dearpygui.add_combo(items=(), **kwargs)[source]

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.

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (str, optional) – Sets a selected item from the drop down by specifying the string value.

  • popup_align_left (bool, optional) – Align the contents on the popup toward the left.

  • no_arrow_button (bool, optional) – Display the preview box without the square arrow button indicating dropdown activity.

  • no_preview (bool, optional) – Display only the square arrow button and not the selected value.

  • height_mode (int, optional) – Controlls the number of items shown in the dropdown by the constants mvComboHeight_Small, mvComboHeight_Regular, mvComboHeight_Large, mvComboHeight_Largest

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_custom_series(x, y, channel_count, **kwargs)[source]

Adds a custom series to a plot. New in 1.6.

Parameters
  • x (Any) –

  • y (Any) –

  • channel_count (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)

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • y1 (Any, optional) –

  • y2 (Any, optional) –

  • y3 (Any, optional) –

  • tooltip (bool, optional) – Show tooltip when plot is hovered.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_date_picker(**kwargs)[source]

Adds a data picker.

Parameters
  • 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.

  • 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.

  • 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.

  • 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.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • default_value (dict, optional) –

  • level (int, optional) – Use avaliable constants. mvDatePickerLevel_Day, mvDatePickerLevel_Month, mvDatePickerLevel_Year

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_deactivated_after_edit_handler(parent, **kwargs)[source]

deprecated function

dearpygui.dearpygui.add_deactivated_handler(parent, **kwargs)[source]

deprecated function

dearpygui.dearpygui.add_double4_value(**kwargs)[source]

Adds a double value.

Parameters
  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • default_value (Any, optional) –

  • parent (Union[int, str], optional) – Parent to add this item to. (runtime adding)

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_double_value(**kwargs)[source]

Adds a double value.

Parameters
  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • default_value (float, optional) –

  • parent (Union[int, str], optional) – Parent to add this item to. (runtime adding)

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_drag_double(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (float, optional) –

  • format (str, optional) – Determines the format the float will be displayed as use python string formatting.

  • speed (float, optional) – Sets the sensitivity the float will be modified while dragging.

  • min_value (float, optional) – Applies a limit only to draging entry only.

  • max_value (float, optional) – Applies a limit only to draging entry only.

  • no_input (bool, optional) – Disable direct entry methods or Enter key allowing to input text directly into the widget.

  • clamped (bool, optional) – Applies the min and max limits to direct entry methods also such as double click and CTRL+Click.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_drag_doublex(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (Any, optional) –

  • size (int, optional) – Number of doubles to be displayed.

  • format (str, optional) – Determines the format the float will be displayed as use python string formatting.

  • speed (float, optional) – Sets the sensitivity the float will be modified while dragging.

  • min_value (float, optional) – Applies a limit only to draging entry only.

  • max_value (float, optional) – Applies a limit only to draging entry only.

  • no_input (bool, optional) – Disable direct entry methods or Enter key allowing to input text directly into the widget.

  • clamped (bool, optional) – Applies the min and max limits to direct entry methods also such as double click and CTRL+Click.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_drag_float(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (float, optional) –

  • format (str, optional) – Determines the format the float will be displayed as use python string formatting.

  • speed (float, optional) – Sets the sensitivity the float will be modified while dragging.

  • min_value (float, optional) – Applies a limit only to draging entry only.

  • max_value (float, optional) – Applies a limit only to draging entry only.

  • no_input (bool, optional) – Disable direct entry methods or Enter key allowing to input text directly into the widget.

  • clamped (bool, optional) – Applies the min and max limits to direct entry methods also such as double click and CTRL+Click.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_drag_floatx(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (Union[List[float], Tuple[float, ...]], optional) –

  • size (int, optional) – Number of floats to be displayed.

  • format (str, optional) – Determines the format the float will be displayed as use python string formatting.

  • speed (float, optional) – Sets the sensitivity the float will be modified while dragging.

  • min_value (float, optional) – Applies a limit only to draging entry only.

  • max_value (float, optional) – Applies a limit only to draging entry only.

  • no_input (bool, optional) – Disable direct entry methods or Enter key allowing to input text directly into the widget.

  • clamped (bool, optional) – Applies the min and max limits to direct entry methods also such as double click and CTRL+Click.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_drag_int(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (int, optional) –

  • format (str, optional) – Determines the format the float will be displayed as use python string formatting.

  • speed (float, optional) – Sets the sensitivity the float will be modified while dragging.

  • min_value (int, optional) – Applies a limit only to draging entry only.

  • max_value (int, optional) – Applies a limit only to draging entry only.

  • no_input (bool, optional) – Disable direct entry methods or Enter key allowing to input text directly into the widget.

  • clamped (bool, optional) – Applies the min and max limits to direct entry methods also such as double click and CTRL+Click.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_drag_intx(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (Union[List[int], Tuple[int, ...]], optional) –

  • size (int, optional) – Number of ints to be displayed.

  • format (str, optional) – Determines the format the int will be displayed as use python string formatting.

  • speed (float, optional) – Sets the sensitivity the float will be modified while dragging.

  • min_value (int, optional) – Applies a limit only to draging entry only.

  • max_value (int, optional) – Applies a limit only to draging entry only.

  • no_input (bool, optional) – Disable direct entry methods or Enter key allowing to input text directly into the widget.

  • clamped (bool, optional) – Applies the min and max limits to direct entry methods also such as double click and CTRL+Click.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_drag_line(**kwargs)[source]

Adds a drag line to a plot.

Parameters
  • 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)

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • default_value (Any, optional) –

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • thickness (float, optional) –

  • show_label (bool, optional) –

  • vertical (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_drag_payload(**kwargs)[source]

User data payload for drag and drop operations.

Parameters
  • 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)

  • show (bool, optional) – Attempt to render widget.

  • drag_data (Any, optional) – Drag data

  • drop_data (Any, optional) – Drop data

  • payload_type (str, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_drag_point(**kwargs)[source]

Adds a drag point to a plot.

Parameters
  • 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)

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • default_value (Any, optional) –

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • thickness (float, optional) –

  • show_label (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_draw_layer(**kwargs)[source]

New in 1.1. Creates a layer useful for grouping drawlist items.

Parameters
  • 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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • show (bool, optional) – Attempt to render widget.

  • perspective_divide (bool, optional) – New in 1.1. apply perspective divide

  • depth_clipping (bool, optional) – New in 1.1. apply depth clipping

  • cull_mode (int, optional) – New in 1.1. culling mode, mvCullMode_* constants. Only works with triangles currently.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_draw_node(**kwargs)[source]

New in 1.1. Creates a drawing node to associate a transformation matrix. Child node matricies will concatenate.

Parameters
  • 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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_drawlist(width, height, **kwargs)[source]

Adds a drawing canvas.

Parameters
  • width (int) –

  • height (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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • callback (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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_dummy(**kwargs)[source]

(deprecated function) Adds a spacer or ‘dummy’ object.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

Returns

Union[int, str]

dearpygui.dearpygui.add_dynamic_texture(width, height, default_value, **kwargs)[source]

Adds a dynamic texture.

Parameters
  • width (int) –

  • height (int) –

  • default_value (Union[List[float], Tuple[float, ...]]) –

  • 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)

Returns

Union[int, str]

dearpygui.dearpygui.add_edited_handler(parent, **kwargs)[source]

deprecated function

dearpygui.dearpygui.add_error_series(x, y, negative, positive, **kwargs)[source]

Adds an error series to a plot.

Parameters
  • x (Any) –

  • y (Any) –

  • negative (Any) –

  • positive (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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • contribute_to_bounds (bool, optional) –

  • horizontal (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_file_dialog(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • callback (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.

  • file_count (int, optional) – Number of visible files in the dialog.

  • modal (bool, optional) – Forces user interaction with the file selector.

  • 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.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_file_extension(extension, **kwargs)[source]

Creates a file extension filter option in the file dialog.

Parameters
  • extension (str) – Extension that will show as an when the parent is a file dialog.

  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • custom_text (str, optional) – Replaces the displayed text in the drop down for this extension.

  • color (Union[List[int], Tuple[int, ...]], optional) – Color for the text that will be shown with specified extensions.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_filter_set(**kwargs)[source]

Helper to parse and apply text filters (e.g. aaaaa[, bbbbb][, ccccc])

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_float4_value(**kwargs)[source]

Adds a float4 value.

Parameters
  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • default_value (Union[List[float], Tuple[float, ...]], optional) –

  • parent (Union[int, str], optional) – Parent to add this item to. (runtime adding)

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_float_value(**kwargs)[source]

Adds a float value.

Parameters
  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • default_value (float, optional) –

  • parent (Union[int, str], optional) – Parent to add this item to. (runtime adding)

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_float_vect_value(**kwargs)[source]

Adds a float vect value.

Parameters
  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • default_value (Union[List[float], Tuple[float, ...]], optional) –

  • parent (Union[int, str], optional) – Parent to add this item to. (runtime adding)

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_focus_handler(parent, **kwargs)[source]

deprecated function

dearpygui.dearpygui.add_font(file, size, **kwargs)[source]

Adds font to a font registry.

Parameters
  • file (str) –

  • size (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)

  • default_font (bool, optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_font_chars(chars, **kwargs)[source]

Adds specific font characters to a font.

Parameters
  • 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)

Returns

Union[int, str]

dearpygui.dearpygui.add_font_range(first_char, last_char, **kwargs)[source]

Adds a range of font characters to a font.

Parameters
  • 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)

Returns

Union[int, str]

dearpygui.dearpygui.add_font_range_hint(hint, **kwargs)[source]

Adds a range of font characters (mvFontRangeHint_ constants).

Parameters
  • 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)

Returns

Union[int, str]

dearpygui.dearpygui.add_font_registry(**kwargs)[source]

Adds a font registry.

Parameters
  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_group(**kwargs)[source]

Creates a group that other widgets can belong to. The group allows item commands to be issued for all of its members.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • horizontal (bool, optional) – Forces child widgets to be added in a horizontal layout.

  • horizontal_spacing (float, optional) – Spacing for the horizontal layout.

  • xoffset (float, optional) – Offset from containing window x item location within group.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_handler_registry(**kwargs)[source]

Adds a handler registry.

Parameters
  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_heat_series(x, rows, cols, **kwargs)[source]

Adds a heat series to a plot.

Parameters
  • x (Any) –

  • rows (int) –

  • cols (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)

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • scale_min (float, optional) – Sets the color scale min. Typically paired with the color scale widget scale_min.

  • scale_max (float, optional) – Sets the color scale max. Typically paired with the color scale widget scale_max.

  • bounds_min (Any, optional) –

  • bounds_max (Any, optional) –

  • format (str, optional) –

  • contribute_to_bounds (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_histogram_series(x, **kwargs)[source]

Adds a histogram series to a plot.

Parameters
  • 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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • bins (int, optional) –

  • bar_scale (float, optional) –

  • min_range (float, optional) –

  • max_range (float, optional) –

  • cumlative (bool, optional) –

  • density (bool, optional) –

  • outliers (bool, optional) –

  • contribute_to_bounds (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_hline_series(x, **kwargs)[source]

Adds an infinite horizontal line series to a plot.

Parameters
  • 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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_hover_handler(parent, **kwargs)[source]

deprecated function

dearpygui.dearpygui.add_image(texture_tag, **kwargs)[source]

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.

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • 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.

  • 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.

  • 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.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • tint_color (Union[List[float], Tuple[float, ...]], optional) – Applies a color tint to the entire texture.

  • border_color (Union[List[float], Tuple[float, ...]], optional) – Displays a border of the specified color around the texture. If the theme style has turned off the border it will not be shown.

  • uv_min (Union[List[float], Tuple[float, ...]], optional) – Normalized texture coordinates min point.

  • uv_max (Union[List[float], Tuple[float, ...]], optional) – Normalized texture coordinates max point.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_image_button(texture_tag, **kwargs)[source]

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

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • 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.

  • 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.

  • 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.

  • 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

  • frame_padding (int, optional) – Empty space around the outside of the texture. Button will show around the texture.

  • tint_color (Union[List[float], Tuple[float, ...]], optional) – Applies a color tint to the entire texture.

  • background_color (Union[List[float], Tuple[float, ...]], optional) – Displays a border of the specified color around the texture.

  • uv_min (Union[List[float], Tuple[float, ...]], optional) – Normalized texture coordinates min point.

  • uv_max (Union[List[float], Tuple[float, ...]], optional) – Normalized texture coordinates max point.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_image_series(texture_tag, bounds_min, bounds_max, **kwargs)[source]

Adds an image series to a plot.

Parameters
  • texture_tag (Union[int, str]) –

  • bounds_min (Any) –

  • bounds_max (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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • uv_min (Union[List[float], Tuple[float, ...]], optional) – normalized texture coordinates

  • uv_max (Union[List[float], Tuple[float, ...]], optional) – normalized texture coordinates

  • tint_color (Union[List[int], Tuple[int, ...]], optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_input_double(**kwargs)[source]

Adds input for an double. Useful when input float is not accurate enough. +/- buttons can be activated by setting the value of step.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (float, optional) –

  • format (str, optional) – Determines the format the float will be displayed as use python string formatting.

  • min_value (float, optional) – Value for lower limit of input. By default this limits the step buttons. Use min_clamped to limit manual input.

  • max_value (float, optional) – Value for upper limit of input. By default this limits the step buttons. Use max_clamped to limit manual input.

  • step (float, optional) – Increment to change value by when the step buttons are pressed. Setting this and step_fast to a value of 0 or less will turn off step buttons.

  • step_fast (float, optional) – Increment to change value by when ctrl + step buttons are pressed. Setting this and step to a value of 0 or less will turn off step buttons.

  • min_clamped (bool, optional) – Activates and deactivates the enforcment of min_value.

  • max_clamped (bool, optional) – Activates and deactivates the enforcment of max_value.

  • on_enter (bool, optional) – Only runs callback on enter key press.

  • readonly (bool, optional) – Activates read only mode where no text can be input but text can still be highlighted.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_input_doublex(**kwargs)[source]

Adds multi double input for up to 4 double values. Useful when input float mulit is not accurate enough.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (Any, optional) –

  • format (str, optional) – Determines the format the float will be displayed as use python string formatting.

  • min_value (float, optional) – Value for lower limit of input for each cell. Use min_clamped to turn on.

  • max_value (float, optional) – Value for upper limit of input for each cell. Use max_clamped to turn on.

  • size (int, optional) – Number of components displayed for input.

  • min_clamped (bool, optional) – Activates and deactivates the enforcment of min_value.

  • max_clamped (bool, optional) – Activates and deactivates the enforcment of max_value.

  • on_enter (bool, optional) – Only runs callback on enter key press.

  • readonly (bool, optional) – Activates read only mode where no text can be input but text can still be highlighted.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_input_float(**kwargs)[source]

Adds input for an float. +/- buttons can be activated by setting the value of step.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (float, optional) –

  • format (str, optional) – Determines the format the float will be displayed as use python string formatting.

  • min_value (float, optional) – Value for lower limit of input. By default this limits the step buttons. Use min_clamped to limit manual input.

  • max_value (float, optional) – Value for upper limit of input. By default this limits the step buttons. Use max_clamped to limit manual input.

  • step (float, optional) – Increment to change value by when the step buttons are pressed. Setting this and step_fast to a value of 0 or less will turn off step buttons.

  • step_fast (float, optional) – Increment to change value by when ctrl + step buttons are pressed. Setting this and step to a value of 0 or less will turn off step buttons.

  • min_clamped (bool, optional) – Activates and deactivates the enforcment of min_value.

  • max_clamped (bool, optional) – Activates and deactivates the enforcment of max_value.

  • on_enter (bool, optional) – Only runs callback on enter key press.

  • readonly (bool, optional) – Activates read only mode where no text can be input but text can still be highlighted.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_input_floatx(**kwargs)[source]

Adds multi float input for up to 4 float values.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (Union[List[float], Tuple[float, ...]], optional) –

  • format (str, optional) – Determines the format the float will be displayed as use python string formatting.

  • min_value (float, optional) – Value for lower limit of input for each cell. Use min_clamped to turn on.

  • max_value (float, optional) – Value for upper limit of input for each cell. Use max_clamped to turn on.

  • size (int, optional) – Number of components displayed for input.

  • min_clamped (bool, optional) – Activates and deactivates the enforcment of min_value.

  • max_clamped (bool, optional) – Activates and deactivates the enforcment of max_value.

  • on_enter (bool, optional) – Only runs callback on enter key press.

  • readonly (bool, optional) – Activates read only mode where no text can be input but text can still be highlighted.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_input_int(**kwargs)[source]

Adds input for an int. +/- buttons can be activated by setting the value of step.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (int, optional) –

  • min_value (int, optional) – Value for lower limit of input. By default this limits the step buttons. Use min_clamped to limit manual input.

  • max_value (int, optional) – Value for upper limit of input. By default this limits the step buttons. Use max_clamped to limit manual input.

  • step (int, optional) – Increment to change value by when the step buttons are pressed. Setting this and step_fast to a value of 0 or less will turn off step buttons.

  • step_fast (int, optional) – Increment to change value by when ctrl + step buttons are pressed. Setting this and step to a value of 0 or less will turn off step buttons.

  • min_clamped (bool, optional) – Activates and deactivates the enforcment of min_value.

  • max_clamped (bool, optional) – Activates and deactivates the enforcment of max_value.

  • on_enter (bool, optional) – Only runs callback on enter key press.

  • readonly (bool, optional) – Activates read only mode where no text can be input but text can still be highlighted.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_input_intx(**kwargs)[source]

Adds multi int input for up to 4 integer values.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (Union[List[int], Tuple[int, ...]], optional) –

  • min_value (int, optional) – Value for lower limit of input for each cell. Use min_clamped to turn on.

  • max_value (int, optional) – Value for upper limit of input for each cell. Use max_clamped to turn on.

  • size (int, optional) – Number of components displayed for input.

  • min_clamped (bool, optional) – Activates and deactivates the enforcment of min_value.

  • max_clamped (bool, optional) – Activates and deactivates the enforcment of max_value.

  • on_enter (bool, optional) – Only runs callback on enter.

  • readonly (bool, optional) – Activates read only mode where no text can be input but text can still be highlighted.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_input_text(**kwargs)[source]

Adds input for text.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (str, optional) –

  • hint (str, optional) – Displayed only when value is an empty string. Will reappear if input value is set to empty string. Will not show if default value is anything other than default empty string.

  • multiline (bool, optional) – Allows for multiline text input.

  • no_spaces (bool, optional) – Filter out spaces and tabs.

  • uppercase (bool, optional) – Automatically make all inputs uppercase.

  • tab_input (bool, optional) – Allows tabs to be input into the string value instead of changing item focus.

  • decimal (bool, optional) – Only allow characters 0123456789.+-*/

  • hexadecimal (bool, optional) – Only allow characters 0123456789ABCDEFabcdef

  • readonly (bool, optional) – Activates read only mode where no text can be input but text can still be highlighted.

  • password (bool, optional) – Display all input characters as ‘*’.

  • scientific (bool, optional) – Only allow characters 0123456789.+-*/eE (Scientific notation input)

  • on_enter (bool, optional) – Only runs callback on enter key press.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_int4_value(**kwargs)[source]

Adds a int4 value.

Parameters
  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • default_value (Union[List[int], Tuple[int, ...]], optional) –

  • parent (Union[int, str], optional) – Parent to add this item to. (runtime adding)

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_int_value(**kwargs)[source]

Adds a int value.

Parameters
  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • default_value (int, optional) –

  • parent (Union[int, str], optional) – Parent to add this item to. (runtime adding)

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_item_activated_handler(**kwargs)[source]

Adds a activated handler.

Parameters
  • 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)

  • callback (Callable, optional) – Registers a callback.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_item_active_handler(**kwargs)[source]

Adds a active handler.

Parameters
  • 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)

  • callback (Callable, optional) – Registers a callback.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_item_clicked_handler(button=- 1, **kwargs)[source]

Adds a clicked handler.

Parameters
  • button (int, optional) – Submits callback for all mouse buttons

  • 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)

  • callback (Callable, optional) – Registers a callback.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_item_deactivated_after_edit_handler(**kwargs)[source]

Adds a deactivated after edit handler.

Parameters
  • 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)

  • callback (Callable, optional) – Registers a callback.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_item_deactivated_handler(**kwargs)[source]

Adds a deactivated handler.

Parameters
  • 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)

  • callback (Callable, optional) – Registers a callback.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_item_edited_handler(**kwargs)[source]

Adds an edited handler.

Parameters
  • 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)

  • callback (Callable, optional) – Registers a callback.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_item_focus_handler(**kwargs)[source]

Adds a focus handler.

Parameters
  • 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)

  • callback (Callable, optional) – Registers a callback.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_item_handler_registry(**kwargs)[source]

Adds an item handler registry.

Parameters
  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_item_hover_handler(**kwargs)[source]

Adds a hover handler.

Parameters
  • 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)

  • callback (Callable, optional) – Registers a callback.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_item_resize_handler(**kwargs)[source]

Adds a resize handler.

Parameters
  • 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)

  • callback (Callable, optional) – Registers a callback.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_item_toggled_open_handler(**kwargs)[source]

Adds a togged open handler.

Parameters
  • 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)

  • callback (Callable, optional) – Registers a callback.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_item_visible_handler(**kwargs)[source]

Adds a visible handler.

Parameters
  • 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)

  • callback (Callable, optional) – Registers a callback.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_key_down_handler(key=- 1, **kwargs)[source]

Adds a key down handler.

Parameters
  • key (int, optional) – Submits callback for all keys

  • 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.

  • callback (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)

Returns

Union[int, str]

dearpygui.dearpygui.add_key_press_handler(key=- 1, **kwargs)[source]

Adds a key press handler.

Parameters
  • key (int, optional) – Submits callback for all keys

  • 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.

  • callback (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)

Returns

Union[int, str]

dearpygui.dearpygui.add_key_release_handler(key=- 1, **kwargs)[source]

Adds a key release handler.

Parameters
  • key (int, optional) – Submits callback for all keys

  • 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.

  • callback (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)

Returns

Union[int, str]

dearpygui.dearpygui.add_knob_float(**kwargs)[source]

Adds a knob that rotates based on change in x mouse position.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (float, optional) –

  • min_value (float, optional) – Applies lower limit to value.

  • max_value (float, optional) – Applies upper limit to value.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_line_series(x, y, **kwargs)[source]

Adds a line series to a plot.

Parameters
  • x (Any) –

  • y (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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_listbox(items=(), **kwargs)[source]

Adds a listbox. If height is not large enough to show all items a scroll bar will appear.

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (str, optional) – String value fo the item that will be selected by default.

  • num_items (int, optional) – Expands the height of the listbox to show specified number of items.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_loading_indicator(**kwargs)[source]

Adds a rotating animated loading symbol.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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) – 0 is rotating dots style, 1 is rotating bar style.

  • circle_count (int, optional) – Number of dots show if dots or size of circle if circle.

  • speed (float, optional) – Speed the anamation will rotate.

  • radius (float, optional) – Radius size of the loading indicator.

  • thickness (float, optional) – Thickness of the circles or line.

  • color (Union[List[int], Tuple[int, ...]], optional) – Color of the growing center circle.

  • secondary_color (Union[List[int], Tuple[int, ...]], optional) – Background of the dots in dot mode.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_menu(**kwargs)[source]

Adds a menu to an existing menu bar.

Parameters
  • 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.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_menu_bar(**kwargs)[source]

Adds a menu bar to a window.

Parameters
  • 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.

  • 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)

  • show (bool, optional) – Attempt to render widget.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_menu_item(**kwargs)[source]

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.

Parameters
  • 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.

  • 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.

  • 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.

  • 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.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • default_value (bool, optional) – This value also controls the checkmark when shown.

  • 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)

Returns

Union[int, str]

dearpygui.dearpygui.add_mouse_click_handler(button=- 1, **kwargs)[source]

Adds a mouse click handler.

Parameters
  • button (int, optional) – Submits callback for all mouse buttons

  • 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.

  • callback (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)

Returns

Union[int, str]

dearpygui.dearpygui.add_mouse_double_click_handler(button=- 1, **kwargs)[source]

Adds a mouse double click handler.

Parameters
  • button (int, optional) – Submits callback for all mouse buttons

  • 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.

  • callback (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)

Returns

Union[int, str]

dearpygui.dearpygui.add_mouse_down_handler(button=- 1, **kwargs)[source]

Adds a mouse down handler.

Parameters
  • button (int, optional) – Submits callback for all mouse buttons

  • 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.

  • callback (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)

Returns

Union[int, str]

dearpygui.dearpygui.add_mouse_drag_handler(button=- 1, threshold=10.0, **kwargs)[source]

Adds a mouse drag handler.

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • 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)

Returns

Union[int, str]

dearpygui.dearpygui.add_mouse_move_handler(**kwargs)[source]

Adds a mouse move handler.

Parameters
  • 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.

  • callback (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)

Returns

Union[int, str]

dearpygui.dearpygui.add_mouse_release_handler(button=- 1, **kwargs)[source]

Adds a mouse release handler.

Parameters
  • button (int, optional) – Submits callback for all mouse buttons

  • 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.

  • callback (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)

Returns

Union[int, str]

dearpygui.dearpygui.add_mouse_wheel_handler(**kwargs)[source]

Adds a mouse wheel handler.

Parameters
  • 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.

  • callback (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)

Returns

Union[int, str]

dearpygui.dearpygui.add_node(**kwargs)[source]

Adds a node to a node editor.

Parameters
  • 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)

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • draggable (bool, optional) – Allow node to be draggable.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_node_attribute(**kwargs)[source]

Adds a node attribute to a node.

Parameters
  • 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.

  • 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.

  • 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

  • attribute_type (int, optional) – mvNode_Attr_Input, mvNode_Attr_Output, or mvNode_Attr_Static.

  • shape (int, optional) – Pin shape.

  • category (str, optional) – Category

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_node_editor(**kwargs)[source]

Adds a node editor.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • filter_key (str, optional) – Used by filter widget.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • 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.

  • 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.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

Adds a node link between 2 node attributes.

Parameters
  • attr_1 (Union[int, str]) –

  • attr_2 (Union[int, str]) –

  • 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)

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_pie_series(x, y, radius, values, labels, **kwargs)[source]

Adds an pie series to a plot.

Parameters
  • x (float) –

  • y (float) –

  • radius (float) –

  • values (Any) –

  • labels (Union[List[str], Tuple[str, ...]]) –

  • 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)

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • format (str, optional) –

  • angle (float, optional) –

  • normalize (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_plot(**kwargs)[source]

Adds a plot which is used to hold series, and can be drawn to with draw commands.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • no_title (bool, optional) –

  • no_menus (bool, optional) –

  • no_box_select (bool, optional) –

  • no_mouse_pos (bool, optional) –

  • no_highlight (bool, optional) –

  • no_child (bool, optional) –

  • query (bool, optional) –

  • crosshairs (bool, optional) –

  • anti_aliased (bool, optional) –

  • equal_aspects (bool, optional) –

  • pan_button (int, optional) – enables panning when held

  • pan_mod (int, optional) – optional modifier that must be held for panning

  • fit_button (int, optional) – fits visible data when double clicked

  • context_menu_button (int, optional) – opens plot context menu (if enabled) when clicked

  • box_select_button (int, optional) – begins box selection when pressed and confirms selection when released

  • box_select_mod (int, optional) – begins box selection when pressed and confirms selection when released

  • box_select_cancel_button (int, optional) – cancels active box selection when pressed

  • query_button (int, optional) – begins query selection when pressed and end query selection when released

  • query_mod (int, optional) – optional modifier that must be held for query selection

  • query_toggle_mod (int, optional) – when held, active box selections turn into queries

  • horizontal_mod (int, optional) – expands active box selection/query horizontally to plot edge when held

  • vertical_mod (int, optional) – expands active box selection/query vertically to plot edge when held

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_plot_annotation(**kwargs)[source]

Adds an annotation to a plot.

Parameters
  • 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)

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • default_value (Any, optional) –

  • offset (Union[List[float], Tuple[float, ...]], optional) –

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • clamped (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_plot_axis(axis, **kwargs)[source]

Adds an axis to a plot.

Parameters
  • axis (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)

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • no_gridlines (bool, optional) –

  • no_tick_marks (bool, optional) –

  • no_tick_labels (bool, optional) –

  • log_scale (bool, optional) –

  • invert (bool, optional) –

  • lock_min (bool, optional) –

  • lock_max (bool, optional) –

  • time (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_plot_legend(**kwargs)[source]

Adds a plot legend to a plot.

Parameters
  • 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)

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • location (int, optional) – location, mvPlot_Location_*

  • horizontal (bool, optional) –

  • outside (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_progress_bar(**kwargs)[source]

Adds a progress bar.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • overlay (str, optional) – Overlayed text onto the bar that typically used to display the value of the progress.

  • default_value (float, optional) – Normalized value to fill the bar from 0.0 to 1.0.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_radio_button(items=(), **kwargs)[source]

Adds a set of radio buttons. If items keyword is empty, nothing will be shown.

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • 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.

  • 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.

  • 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

  • default_value (str, optional) – Default selected radio option. Set by using the string value of the item.

  • horizontal (bool, optional) – Displays the radio options horizontally.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_raw_texture(width, height, default_value, **kwargs)[source]

Adds a raw texture.

Parameters
  • width (int) –

  • height (int) –

  • default_value (Union[List[float], Tuple[float, ...]]) –

  • 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.

  • format (int, optional) – Data format.

  • parent (Union[int, str], optional) – Parent to add this item to. (runtime adding)

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_resize_handler(parent, **kwargs)[source]

deprecated function

dearpygui.dearpygui.add_same_line(**kwargs)[source]

deprecated function

dearpygui.dearpygui.add_scatter_series(x, y, **kwargs)[source]

Adds a scatter series to a plot.

Parameters
  • x (Any) –

  • y (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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_selectable(**kwargs)[source]

Adds a selectable. Similar to a button but can indicate its selected state.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (bool, optional) –

  • span_columns (bool, optional) – Forces the selectable to span the width of all columns if placed in a table.

  • disable_popup_close (bool, optional) – Disable closing a modal or popup window.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_separator(**kwargs)[source]

Adds a horizontal line separator.

Parameters
  • 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.

  • 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.

  • 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.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_series_value(**kwargs)[source]

Adds a plot series value.

Parameters
  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • default_value (Any, optional) –

  • parent (Union[int, str], optional) – Parent to add this item to. (runtime adding)

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_shade_series(x, y1, **kwargs)[source]

Adds a shade series to a plot.

Parameters
  • x (Any) –

  • y1 (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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • y2 (Any, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_simple_plot(**kwargs)[source]

Adds a simple plot for visualization of a 1 dimensional set of values.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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

  • default_value (Union[List[float], Tuple[float, ...]], optional) –

  • overlay (str, optional) – overlays text (similar to a plot title)

  • histogram (bool, optional) –

  • autosize (bool, optional) –

  • min_scale (float, optional) –

  • max_scale (float, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_slider_double(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (float, optional) –

  • vertical (bool, optional) – Sets orientation of the slidebar and slider to vertical.

  • no_input (bool, optional) – Disable direct entry methods double-click or ctrl+click or Enter key allowing to input text directly into the item.

  • clamped (bool, optional) – Applies the min and max limits to direct entry methods also such as double click and CTRL+Click.

  • min_value (float, optional) – Applies a limit only to sliding entry only.

  • max_value (float, optional) – Applies a limit only to sliding entry only.

  • format (str, optional) – Determines the format the float will be displayed as use python string formatting.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_slider_doublex(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (Any, optional) –

  • size (int, optional) – Number of doubles to be displayed.

  • no_input (bool, optional) – Disable direct entry methods double-click or ctrl+click or Enter key allowing to input text directly into the item.

  • clamped (bool, optional) – Applies the min and max limits to direct entry methods also such as double click and CTRL+Click.

  • min_value (float, optional) – Applies a limit only to sliding entry only.

  • max_value (float, optional) – Applies a limit only to sliding entry only.

  • format (str, optional) – Determines the format the int will be displayed as use python string formatting.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_slider_float(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (float, optional) –

  • vertical (bool, optional) – Sets orientation of the slidebar and slider to vertical.

  • no_input (bool, optional) – Disable direct entry methods double-click or ctrl+click or Enter key allowing to input text directly into the item.

  • clamped (bool, optional) – Applies the min and max limits to direct entry methods also such as double click and CTRL+Click.

  • min_value (float, optional) – Applies a limit only to sliding entry only.

  • max_value (float, optional) – Applies a limit only to sliding entry only.

  • format (str, optional) – Determines the format the float will be displayed as use python string formatting.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_slider_floatx(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (Union[List[float], Tuple[float, ...]], optional) –

  • size (int, optional) – Number of floats to be displayed.

  • no_input (bool, optional) – Disable direct entry methods double-click or ctrl+click or Enter key allowing to input text directly into the item.

  • clamped (bool, optional) – Applies the min and max limits to direct entry methods also such as double click and CTRL+Click.

  • min_value (float, optional) – Applies a limit only to sliding entry only.

  • max_value (float, optional) – Applies a limit only to sliding entry only.

  • format (str, optional) – Determines the format the int will be displayed as use python string formatting.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_slider_int(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (int, optional) –

  • vertical (bool, optional) – Sets orientation of the slidebar and slider to vertical.

  • no_input (bool, optional) – Disable direct entry methods double-click or ctrl+click or Enter key allowing to input text directly into the item.

  • clamped (bool, optional) – Applies the min and max limits to direct entry methods also such as double click and CTRL+Click.

  • min_value (int, optional) – Applies a limit only to sliding entry only.

  • max_value (int, optional) – Applies a limit only to sliding entry only.

  • format (str, optional) – Determines the format the int will be displayed as use python string formatting.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_slider_intx(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • 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

  • default_value (Union[List[int], Tuple[int, ...]], optional) –

  • size (int, optional) – Number of ints to be displayed.

  • no_input (bool, optional) – Disable direct entry methods double-click or ctrl+click or Enter key allowing to input text directly into the item.

  • clamped (bool, optional) – Applies the min and max limits to direct entry methods also such as double click and CTRL+Click.

  • min_value (int, optional) – Applies a limit only to sliding entry only.

  • max_value (int, optional) – Applies a limit only to sliding entry only.

  • format (str, optional) – Determines the format the int will be displayed as use python string formatting.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_spacer(**kwargs)[source]

Adds a spacer item that can be used to help with layouts or can be used as a placeholder item.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_spacing(**kwargs)[source]

(deprecated function) Adds vertical spacing.

Parameters
  • 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.

  • 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.

  • 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.

  • count (int, optional) – Number of spacings to add the size is dependant on the curret style.

Returns

Union[int, str]

dearpygui.dearpygui.add_stage(**kwargs)[source]

Adds a stage.

Parameters
  • 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.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_staging_container(**kwargs)[source]

deprecated function

dearpygui.dearpygui.add_stair_series(x, y, **kwargs)[source]

Adds a stair series to a plot.

Parameters
  • x (Any) –

  • y (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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_static_texture(width, height, default_value, **kwargs)[source]

Adds a static texture.

Parameters
  • width (int) –

  • height (int) –

  • default_value (Union[List[float], Tuple[float, ...]]) –

  • 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)

Returns

Union[int, str]

dearpygui.dearpygui.add_stem_series(x, y, **kwargs)[source]

Adds a stem series to a plot.

Parameters
  • x (Any) –

  • y (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).

  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_string_value(**kwargs)[source]

Adds a string value.

Parameters
  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • default_value (str, optional) –

  • parent (Union[int, str], optional) – Parent to add this item to. (runtime adding)

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_subplots(rows, columns, **kwargs)[source]

Adds a collection of plots.

Parameters
  • rows (int) –

  • columns (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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • row_ratios (Union[List[float], Tuple[float, ...]], optional) –

  • column_ratios (Union[List[float], Tuple[float, ...]], optional) –

  • no_title (bool, optional) –

  • no_menus (bool, optional) – the user will not be able to open context menus with right-click

  • no_resize (bool, optional) – resize splitters between subplot cells will be not be provided

  • no_align (bool, optional) – subplot edges will not be aligned vertically or horizontally

  • link_rows (bool, optional) – link the y-axis limits of all plots in each row (does not apply auxiliary y-axes)

  • link_columns (bool, optional) – link the x-axis limits of all plots in each column

  • link_all_x (bool, optional) – link the x-axis limits in every plot in the subplot

  • link_all_y (bool, optional) – link the y-axis limits in every plot in the subplot (does not apply to auxiliary y-axes)

  • column_major (bool, optional) – subplots are added in column major order instead of the default row major order

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_tab(**kwargs)[source]

Adds a tab to a tab bar.

Parameters
  • 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.

  • 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.

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • filter_key (str, optional) – Used by filter widget.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • closable (bool, optional) – Creates a button on the tab that can hide the tab.

  • no_tooltip (bool, optional) – Disable tooltip for the given tab.

  • order_mode (bool, optional) – set using a constant: mvTabOrder_Reorderable: allows reordering, mvTabOrder_Fixed: fixed ordering, mvTabOrder_Leading: adds tab to front, mvTabOrder_Trailing: adds tab to back

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_tab_bar(**kwargs)[source]

Adds a tab bar.

Parameters
  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • reorderable (bool, optional) – Allows for the user to change the order of the tabs.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_tab_button(**kwargs)[source]

Adds a tab button to a tab bar.

Parameters
  • 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.

  • 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.

  • 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.

  • 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

  • no_reorder (bool, optional) – Disable reordering this tab or having another tab cross over this tab. Fixes the position of this tab in relation to the order of neighboring tabs at start.

  • leading (bool, optional) – Enforce the tab position to the left of the tab bar (after the tab list popup button).

  • trailing (bool, optional) – Enforce the tab position to the right of the tab bar (before the scrolling buttons).

  • no_tooltip (bool, optional) – Disable tooltip for the given tab.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_table(**kwargs)[source]

Adds a table.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • callback (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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • header_row (bool, optional) – show headers at the top of the columns

  • clipper (bool, optional) – Use clipper (rows must be same height).

  • inner_width (int, optional) –

  • policy (int, optional) –

  • freeze_rows (int, optional) –

  • freeze_columns (int, optional) –

  • sort_multi (bool, optional) – Hold shift when clicking headers to sort on multiple column.

  • sort_tristate (bool, optional) – Allow no sorting, disable default sorting.

  • resizable (bool, optional) – Enable resizing columns

  • reorderable (bool, optional) – Enable reordering columns in header row (need calling TableSetupColumn() + TableHeadersRow() to display headers)

  • hideable (bool, optional) – Enable hiding/disabling columns in context menu.

  • sortable (bool, optional) – Enable sorting. Call TableGetSortSpecs() to obtain sort specs. Also see ImGuiTableFlags_SortMulti and ImGuiTableFlags_SortTristate.

  • context_menu_in_body (bool, optional) – Right-click on columns body/contents will display table context menu. By default it is available in TableHeadersRow().

  • row_background (bool, optional) – Set each RowBg color with ImGuiCol_TableRowBg or ImGuiCol_TableRowBgAlt (equivalent of calling TableSetBgColor with ImGuiTableBgFlags_RowBg0 on each row manually)

  • borders_innerH (bool, optional) – Draw horizontal borders between rows.

  • borders_outerH (bool, optional) – Draw horizontal borders at the top and bottom.

  • borders_innerV (bool, optional) – Draw vertical borders between columns.

  • borders_outerV (bool, optional) – Draw vertical borders on the left and right sides.

  • no_host_extendX (bool, optional) – Make outer width auto-fit to columns, overriding outer_size.x value. Only available when ScrollX/ScrollY are disabled and Stretch columns are not used.

  • no_host_extendY (bool, optional) – Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY are disabled. Data below the limit will be clipped and not visible.

  • no_keep_columns_visible (bool, optional) – Disable keeping column always minimally visible when ScrollX is off and table gets too small. Not recommended if columns are resizable.

  • precise_widths (bool, optional) – Disable distributing remainder width to stretched columns (width allocation on a 100-wide table with 3 columns: Without this flag: 33,33,34. With this flag: 33,33,33). With larger number of columns, resizing will appear to be less smooth.

  • no_clip (bool, optional) – Disable clipping rectangle for every individual columns.

  • pad_outerX (bool, optional) – Default if BordersOuterV is on. Enable outer-most padding. Generally desirable if you have headers.

  • no_pad_outerX (bool, optional) – Default if BordersOuterV is off. Disable outer-most padding.

  • no_pad_innerX (bool, optional) – Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off).

  • scrollX (bool, optional) – Enable horizontal scrolling. Require ‘outer_size’ parameter of BeginTable() to specify the container size. Changes default sizing policy. Because this create a child window, ScrollY is currently generally recommended when using ScrollX.

  • scrollY (bool, optional) – Enable vertical scrolling.

  • no_saved_settings (bool, optional) – Never load/save settings in .ini file.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_table_cell(**kwargs)[source]

Adds a table.

Parameters
  • 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.

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • filter_key (str, optional) – Used by filter widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_table_column(**kwargs)[source]

Adds a table column.

Parameters
  • 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.

  • width (int, optional) – Width 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.

  • show (bool, optional) – Attempt to render widget.

  • enabled (bool, optional) – Turns off functionality of widget and applies the disabled theme.

  • init_width_or_weight (float, optional) –

  • default_hide (bool, optional) – Default as a hidden/disabled column.

  • default_sort (bool, optional) – Default as a sorting column.

  • width_stretch (bool, optional) – Column will stretch. Preferable with horizontal scrolling disabled (default if table sizing policy is _SizingStretchSame or _SizingStretchProp).

  • width_fixed (bool, optional) – Column will not stretch. Preferable with horizontal scrolling enabled (default if table sizing policy is _SizingFixedFit and table is resizable).

  • no_resize (bool, optional) – Disable manual resizing.

  • no_reorder (bool, optional) – Disable manual reordering this column, this will also prevent other columns from crossing over this column.

  • no_hide (bool, optional) – Disable ability to hide/disable this column.

  • no_clip (bool, optional) – Disable clipping for this column (all NoClip columns will render in a same draw command).

  • no_sort (bool, optional) – Disable ability to sort on this field (even if ImGuiTableFlags_Sortable is set on the table).

  • no_sort_ascending (bool, optional) – Disable ability to sort in the ascending direction.

  • no_sort_descending (bool, optional) – Disable ability to sort in the descending direction.

  • no_header_width (bool, optional) – Disable header text width contribution to automatic column width.

  • prefer_sort_ascending (bool, optional) – Make the initial sort direction Ascending when first sorting on this column (default).

  • prefer_sort_descending (bool, optional) – Make the initial sort direction Descending when first sorting on this column.

  • indent_enable (bool, optional) – Use current Indent value when entering cell (default for column 0).

  • indent_disable (bool, optional) – Ignore current Indent value when entering cell (default for columns > 0). Indentation changes _within_ the cell will still be honored.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_table_next_column(**kwargs)[source]

deprecated function

dearpygui.dearpygui.add_table_row(**kwargs)[source]

Adds a table row.

Parameters
  • 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.

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • filter_key (str, optional) – Used by filter widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_template_registry(**kwargs)[source]

Adds a template registry.

Parameters
  • 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.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_text(default_value='', **kwargs)[source]

Adds text. Text can have an optional label that will display to the right of the text.

Parameters
  • default_value (str, optional) –

  • 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.

  • 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.

  • 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.

  • 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.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • wrap (int, optional) – Number of pixels from the start of the item until wrapping starts.

  • bullet (bool, optional) – Places a bullet to the left of the text.

  • color (Union[List[int], Tuple[int, ...]], optional) – Color of the text (rgba).

  • show_label (bool, optional) – Displays the label to the right of the text.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_text_point(x, y, **kwargs)[source]

Adds a label series to a plot.

Parameters
  • x (float) –

  • y (float) –

  • 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)

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • x_offset (int, optional) –

  • y_offset (int, optional) –

  • vertical (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_texture_registry(**kwargs)[source]

Adds a dynamic texture.

Parameters
  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_theme(**kwargs)[source]

Adds a theme.

Parameters
  • 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.

  • id (Union[int, str], optional) – (deprecated)

  • default_theme (bool, optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_theme_color(target=0, value=(0, 0, 0, 255), **kwargs)[source]

Adds a theme color.

Parameters
  • target (int, optional) –

  • value (Union[List[int], Tuple[int, ...]], optional) –

  • 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)

  • category (int, optional) – Options include mvThemeCat_Core, mvThemeCat_Plots, mvThemeCat_Nodes.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_theme_component(item_type=0, **kwargs)[source]

Adds a theme component.

Parameters
  • item_type (int, optional) –

  • 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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • enabled_state (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_theme_style(target=0, x=1.0, y=- 1.0, **kwargs)[source]

Adds a theme style.

Parameters
  • target (int, optional) –

  • x (float, optional) –

  • y (float, optional) –

  • 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)

  • category (int, optional) – Options include mvThemeCat_Core, mvThemeCat_Plots, mvThemeCat_Nodes.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_time_picker(**kwargs)[source]

Adds a time picker.

Parameters
  • 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.

  • 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.

  • 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.

  • 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.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • default_value (dict, optional) –

  • hour24 (bool, optional) – Show 24 hour clock instead of 12 hour.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_toggled_open_handler(parent, **kwargs)[source]

deprecated function

dearpygui.dearpygui.add_tooltip(parent, **kwargs)[source]

Adds a tooltip window.

Parameters
  • parent (Union[int, str]) –

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_tree_node(**kwargs)[source]

Adds a tree node to add items to.

Parameters
  • 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.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • default_open (bool, optional) – Sets the tree node open by default.

  • open_on_double_click (bool, optional) – Need double-click to open node.

  • open_on_arrow (bool, optional) – Only open when clicking on the arrow part.

  • leaf (bool, optional) – No collapsing, no arrow (use as a convenience for leaf nodes).

  • bullet (bool, optional) – Display a bullet instead of arrow.

  • selectable (bool, optional) – Makes the tree selectable.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_value_registry(**kwargs)[source]

Adds a value registry.

Parameters
  • 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.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_viewport_drawlist(**kwargs)[source]

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.

Parameters
  • 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.

  • show (bool, optional) – Attempt to render widget.

  • filter_key (str, optional) – Used by filter widget.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • front (bool, optional) – Draws to the front of the view port instead of the back.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_viewport_menu_bar(**kwargs)[source]

Adds a menubar to the viewport.

Parameters
  • 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.

  • 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)

  • show (bool, optional) – Attempt to render widget.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_visible_handler(parent, **kwargs)[source]

deprecated function

dearpygui.dearpygui.add_vline_series(x, **kwargs)[source]

Adds an infinite vertical line series to a plot.

Parameters
  • 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).

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.add_window(**kwargs)[source]

Creates a new window for following items to be added to.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • indent (int, optional) – Offsets the widget to the right the specified number multiplied by the indent style.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • min_size (Union[List[int], Tuple[int, ...]], optional) – Minimum window size.

  • max_size (Union[List[int], Tuple[int, ...]], optional) – Maximum window size.

  • menubar (bool, optional) – Shows or hides the menubar.

  • collapsed (bool, optional) – Collapse the window.

  • autosize (bool, optional) – Autosized the window to fit it’s items.

  • no_resize (bool, optional) – Allows for the window size to be changed or fixed.

  • no_title_bar (bool, optional) – Title name for the title bar of the window.

  • no_move (bool, optional) – Allows for the window’s position to be changed or fixed.

  • no_scrollbar (bool, optional) – Disable scrollbars. (window can still scroll with mouse or programmatically)

  • no_collapse (bool, optional) – Disable user collapsing window by double-clicking on it.

  • horizontal_scrollbar (bool, optional) – Allow horizontal scrollbar to appear. (off by default)

  • no_focus_on_appearing (bool, optional) – Disable taking focus when transitioning from hidden to visible state.

  • no_bring_to_front_on_focus (bool, optional) – Disable bringing window to front when taking focus. (e.g. clicking on it or programmatically giving it focus)

  • no_close (bool, optional) – Disable user closing the window by removing the close button.

  • no_background (bool, optional) – Sets Background and border alpha to transparent.

  • modal (bool, optional) – Fills area behind window according to the theme and disables user ability to interact with anything except the window.

  • popup (bool, optional) – Fills area behind window according to the theme, removes title bar, collapse and close. Window can be closed by selecting area in the background behind the window.

  • no_saved_settings (bool, optional) – Never load/save settings in .ini file.

  • no_open_over_existing_popup (bool, optional) – Don’t open if there’s already a popup

  • on_close (Callable, optional) – Callback ran when window is closed.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.apply_transform(item, transform)[source]

New in 1.1. Applies a transformation matrix to a layer.

Parameters
  • item (Union[int, str]) – Drawing node to apply transform to.

  • transform (Any) – Transformation matrix.

Returns

None

dearpygui.dearpygui.bind_colormap(item, source)[source]

Sets the color map for widgets that accept it.

Parameters
  • item (Union[int, str]) – item that the color map will be applied to

  • source (Union[int, str]) – The colormap tag. This should come from a colormap that was added to a colormap registry. Built in color maps are accessible through their corresponding constants mvPlotColormap_Twilight, mvPlotColormap_***

Returns

None

dearpygui.dearpygui.bind_font(font)[source]

Binds a global font.

Parameters

font (Union[int, str]) –

Returns

Union[int, str]

dearpygui.dearpygui.bind_item_font(item, font)[source]

Sets an item’s font.

Parameters
  • item (Union[int, str]) –

  • font (Union[int, str]) –

Returns

None

dearpygui.dearpygui.bind_item_handler_registry(item, handler_registry)[source]

Binds an item handler registry to an item.

Parameters
  • item (Union[int, str]) –

  • handler_registry (Union[int, str]) –

Returns

None

dearpygui.dearpygui.bind_item_theme(item, theme)[source]

Binds a theme to an item.

Parameters
  • item (Union[int, str]) –

  • theme (Union[int, str]) –

Returns

None

dearpygui.dearpygui.bind_template_registry(template_registry)[source]

Binds a global template registry.

Parameters

template_registry (Union[int, str]) –

Returns

None

dearpygui.dearpygui.bind_theme(theme)[source]

Binds a global theme.

Parameters

theme (Union[int, str]) –

Returns

None

dearpygui.dearpygui.capture_next_item(callback, **kwargs)[source]

Captures the next item.

Parameters
  • callback (Callable) –

  • user_data (Any, optional) – New in 1.3. Optional user data to send to the callback

Returns

None

dearpygui.dearpygui.child(**kwargs)[source]

(deprecated function) Adds an embedded child window. Will show scrollbars when items do not fit.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • border (bool, optional) – Shows/Hides the border around the sides.

  • autosize_x (bool, optional) – Autosize the window to its parents size in x.

  • autosize_y (bool, optional) – Autosize the window to its parents size in y.

  • no_scrollbar (bool, optional) – Disable scrollbars (window can still scroll with mouse or programmatically).

  • horizontal_scrollbar (bool, optional) – Allow horizontal scrollbar to appear (off by default).

  • menubar (bool, optional) – Shows/Hides the menubar at the top.

Yields

Union[int, str]

dearpygui.dearpygui.child_window(**kwargs)[source]

Adds an embedded child window. Will show scrollbars when items do not fit.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • border (bool, optional) – Shows/Hides the border around the sides.

  • autosize_x (bool, optional) – Autosize the window to its parents size in x.

  • autosize_y (bool, optional) – Autosize the window to its parents size in y.

  • no_scrollbar (bool, optional) – Disable scrollbars (window can still scroll with mouse or programmatically).

  • horizontal_scrollbar (bool, optional) – Allow horizontal scrollbar to appear (off by default).

  • menubar (bool, optional) – Shows/Hides the menubar at the top.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.cleanup_dearpygui()[source]

deprecated function

Clears a node editor’s selected links.

Parameters

node_editor (Union[int, str]) –

Returns

None

dearpygui.dearpygui.clear_selected_nodes(node_editor)[source]

Clears a node editor’s selected nodes.

Parameters

node_editor (Union[int, str]) –

Returns

None

dearpygui.dearpygui.clipper(**kwargs)[source]

Helper to manually clip large list of items. Increases performance by not searching or drawing widgets outside of the clipped region.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.collapsing_header(**kwargs)[source]

Adds a collapsing header to add items to. Must be closed with the end command.

Parameters
  • 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.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • closable (bool, optional) – Adds the ability to hide this widget by pressing the (x) in the top right of widget.

  • default_open (bool, optional) – Sets the collapseable header open by default.

  • open_on_double_click (bool, optional) – Need double-click to open node.

  • open_on_arrow (bool, optional) – Only open when clicking on the arrow part.

  • leaf (bool, optional) – No collapsing, no arrow (use as a convenience for leaf nodes).

  • bullet (bool, optional) – Display a bullet instead of arrow.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.colormap_registry(**kwargs)[source]

Adds a colormap registry.

Parameters
  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.configure_app(**kwargs) None[source]

Configures an item after creation.

dearpygui.dearpygui.configure_item(item: Union[int, str], **kwargs) None[source]

Configures an item after creation.

dearpygui.dearpygui.configure_viewport(item: Union[int, str], **kwargs) None[source]

Configures a viewport after creation.

dearpygui.dearpygui.create_context()[source]

Creates the Dear PyGui context.

Args: :returns: None

dearpygui.dearpygui.create_fps_matrix(eye, pitch, yaw)[source]

New in 1.1. Create a ‘first person shooter’ matrix.

Parameters
  • eye (Union[List[float], Tuple[float, ...]]) – eye position

  • pitch (float) – pitch (in radians)

  • yaw (float) – yaw (in radians)

Returns

Any

dearpygui.dearpygui.create_lookat_matrix(eye, target, up)[source]

New in 1.1. Creates a ‘Look at matrix’.

Parameters
  • eye (Union[List[float], Tuple[float, ...]]) – eye position

  • target (Union[List[float], Tuple[float, ...]]) – target position

  • up (Union[List[float], Tuple[float, ...]]) – up vector

Returns

Any

dearpygui.dearpygui.create_orthographic_matrix(left, right, bottom, top, zNear, zFar)[source]

New in 1.1. Creates an orthographic matrix.

Parameters
  • left (float) – left plane

  • right (float) – right plane

  • bottom (float) – bottom plane

  • top (float) – top plane

  • zNear (float) – Near clipping plane.

  • zFar (float) – Far clipping plane.

Returns

Any

dearpygui.dearpygui.create_perspective_matrix(fov, aspect, zNear, zFar)[source]

New in 1.1. Creates a perspective matrix.

Parameters
  • fov (float) – Field of view (in radians)

  • aspect (float) – Aspect ratio (width/height)

  • zNear (float) – Near clipping plane.

  • zFar (float) – Far clipping plane.

Returns

Any

dearpygui.dearpygui.create_rotation_matrix(angle, axis)[source]

New in 1.1. Applies a transformation matrix to a layer.

Parameters
  • angle (float) – angle to rotate

  • axis (Union[List[float], Tuple[float, ...]]) – axis to rotate around

Returns

Any

dearpygui.dearpygui.create_scale_matrix(scales)[source]

New in 1.1. Applies a transformation matrix to a layer.

Parameters

scales (Union[List[float], Tuple[float, ...]]) – scale values per axis

Returns

Any

dearpygui.dearpygui.create_translation_matrix(translation)[source]

New in 1.1. Creates a translation matrix.

Parameters

translation (Union[List[float], Tuple[float, ...]]) – translation vector

Returns

Any

dearpygui.dearpygui.create_viewport(**kwargs)[source]

Creates a viewport. Viewports are required.

Parameters
  • title (str, optional) – Sets the title of the viewport.

  • small_icon (str, optional) – Sets the small icon that is found in the viewport’s decorator bar. Must be *.ico on windows and either *.ico or ***.png on mac.

  • large_icon (str, optional) – Sets the large icon that is found in the task bar while the app is running. Must be *.ico on windows and either *.ico or ***.png on mac.

  • width (int, optional) – Sets the width of the drawable space on the viewport. Does not inclue the border.

  • height (int, optional) – Sets the height of the drawable space on the viewport. Does not inclue the border or decorator bar.

  • x_pos (int, optional) – Sets x position the viewport will be drawn in screen coordinates.

  • y_pos (int, optional) – Sets y position the viewport will be drawn in screen coordinates.

  • min_width (int, optional) – Applies a minimuim limit to the width of the viewport.

  • max_width (int, optional) – Applies a maximum limit to the width of the viewport.

  • min_height (int, optional) – Applies a minimuim limit to the height of the viewport.

  • max_height (int, optional) – Applies a maximum limit to the height of the viewport.

  • resizable (bool, optional) – Enables and Disables user ability to resize the viewport.

  • vsync (bool, optional) – Enables and Disables the renderloop vsync limit. vsync frame value is set by refresh rate of display.

  • always_on_top (bool, optional) – Forces the viewport to always be drawn ontop of all other viewports.

  • decorated (bool, optional) – Enabled and disabled the decorator bar at the top of the viewport.

  • clear_color (Union[List[float], Tuple[float, ...]], optional) – Sets the color of the back of the viewport.

Returns

None

dearpygui.dearpygui.custom_series(x, y, channel_count, **kwargs)[source]

Adds a custom series to a plot. New in 1.6.

Parameters
  • x (Any) –

  • y (Any) –

  • channel_count (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)

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • y1 (Any, optional) –

  • y2 (Any, optional) –

  • y3 (Any, optional) –

  • tooltip (bool, optional) – Show tooltip when plot is hovered.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.delete_item(item, **kwargs)[source]

Deletes an item..

Parameters
  • item (Union[int, str]) –

  • children_only (bool, optional) –

  • slot (int, optional) –

Returns

None

dearpygui.dearpygui.deprecated(reason)[source]
dearpygui.dearpygui.destroy_context()[source]

Destroys the Dear PyGui context.

Args: :returns: None

dearpygui.dearpygui.disable_item(item: Union[int, str])[source]

Disables the item.

Parameters

**item – Item to disable.

Returns

None

dearpygui.dearpygui.does_alias_exist(alias)[source]

Checks if an alias exist.

Parameters

alias (str) –

Returns

bool

dearpygui.dearpygui.does_item_exist(item)[source]

Checks if an item exist..

Parameters

item (Union[int, str]) –

Returns

bool

dearpygui.dearpygui.drag_payload(**kwargs)[source]

User data payload for drag and drop operations.

Parameters
  • 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)

  • show (bool, optional) – Attempt to render widget.

  • drag_data (Any, optional) – Drag data

  • drop_data (Any, optional) – Drop data

  • payload_type (str, optional) –

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.draw_arrow(p1, p2, **kwargs)[source]

Adds an arrow.

Parameters
  • p1 (Union[List[float], Tuple[float, ...]]) – Arrow tip.

  • p2 (Union[List[float], Tuple[float, ...]]) – Arrow tail.

  • 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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • show (bool, optional) – Attempt to render widget.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • thickness (float, optional) –

  • size (int, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_bezier_cubic(p1, p2, p3, p4, **kwargs)[source]

Adds a cubic bezier curve.

Parameters
  • 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.

  • p4 (Union[List[float], Tuple[float, ...]]) – Fourth point in curve.

  • 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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • show (bool, optional) – Attempt to render widget.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • thickness (float, optional) –

  • segments (int, optional) – Number of segments to approximate bezier curve.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_bezier_quadratic(p1, p2, p3, **kwargs)[source]

Adds a quadratic bezier curve.

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • show (bool, optional) – Attempt to render widget.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • thickness (float, optional) –

  • segments (int, optional) – Number of segments to approximate bezier curve.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_circle(center, radius, **kwargs)[source]

Adds a circle

Parameters
  • center (Union[List[float], Tuple[float, ...]]) –

  • radius (float) –

  • 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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • show (bool, optional) – Attempt to render widget.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • fill (Union[List[int], Tuple[int, ...]], optional) –

  • thickness (float, optional) –

  • segments (int, optional) – Number of segments to approximate circle.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_ellipse(pmin, pmax, **kwargs)[source]

Adds an ellipse.

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • show (bool, optional) – Attempt to render widget.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • fill (Union[List[int], Tuple[int, ...]], optional) –

  • thickness (float, optional) –

  • segments (int, optional) – Number of segments to approximate bezier curve.

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_image(texture_tag, pmin, pmax, **kwargs)[source]

Adds an image (for a drawing).

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • show (bool, optional) – Attempt to render widget.

  • uv_min (Union[List[float], Tuple[float, ...]], optional) – Normalized coordinates on texture that will be drawn.

  • uv_max (Union[List[float], Tuple[float, ...]], optional) – Normalized coordinates on texture that will be drawn.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_image_quad(texture_tag, p1, p2, p3, p4, **kwargs)[source]

Adds an image (for a drawing).

Parameters
  • 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, optional) – Overrides ‘name’ as label.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • show (bool, optional) – Attempt to render widget.

  • uv1 (Union[List[float], Tuple[float, ...]], optional) – Normalized coordinates on texture that will be drawn.

  • uv2 (Union[List[float], Tuple[float, ...]], optional) – Normalized coordinates on texture that will be drawn.

  • uv3 (Union[List[float], Tuple[float, ...]], optional) – Normalized coordinates on texture that will be drawn.

  • uv4 (Union[List[float], Tuple[float, ...]], optional) – Normalized coordinates on texture that will be drawn.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_layer(**kwargs)[source]

New in 1.1. Creates a layer useful for grouping drawlist items.

Parameters
  • 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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • show (bool, optional) – Attempt to render widget.

  • perspective_divide (bool, optional) – New in 1.1. apply perspective divide

  • depth_clipping (bool, optional) – New in 1.1. apply depth clipping

  • cull_mode (int, optional) – New in 1.1. culling mode, mvCullMode_* constants. Only works with triangles currently.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.draw_line(p1, p2, **kwargs)[source]

Adds a line.

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • show (bool, optional) – Attempt to render widget.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • thickness (float, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_node(**kwargs)[source]

New in 1.1. Creates a drawing node to associate a transformation matrix. Child node matricies will concatenate.

Parameters
  • 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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.draw_polygon(points, **kwargs)[source]

Adds a polygon.

Parameters
  • points (List[List[float]]) –

  • 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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • show (bool, optional) – Attempt to render widget.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • fill (Union[List[int], Tuple[int, ...]], optional) –

  • thickness (float, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_polyline(points, **kwargs)[source]

Adds a polyline.

Parameters
  • points (List[List[float]]) –

  • 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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • show (bool, optional) – Attempt to render widget.

  • closed (bool, optional) – Will close the polyline by returning to the first point.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • thickness (float, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_quad(p1, p2, p3, p4, **kwargs)[source]

Adds a quad.

Parameters
  • 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, optional) – Overrides ‘name’ as label.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • show (bool, optional) – Attempt to render widget.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • fill (Union[List[int], Tuple[int, ...]], optional) –

  • thickness (float, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_rectangle(pmin, pmax, **kwargs)[source]

Adds a rectangle.

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • show (bool, optional) – Attempt to render widget.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • color_upper_left (Union[List[int], Tuple[int, ...]], optional) – ‘multicolor’ must be set to ‘True’

  • color_upper_right (Union[List[int], Tuple[int, ...]], optional) – ‘multicolor’ must be set to ‘True’

  • color_bottom_right (Union[List[int], Tuple[int, ...]], optional) – ‘multicolor’ must be set to ‘True’

  • color_bottom_left (Union[List[int], Tuple[int, ...]], optional) – ‘multicolor’ must be set to ‘True’

  • fill (Union[List[int], Tuple[int, ...]], optional) –

  • multicolor (bool, optional) –

  • rounding (float, optional) – Number of pixels of the radius that will round the corners of the rectangle. Note: doesn’t work with multicolor

  • thickness (float, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_text(pos, text, **kwargs)[source]

Adds text (drawlist).

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • show (bool, optional) – Attempt to render widget.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • size (float, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.draw_triangle(p1, p2, p3, **kwargs)[source]

Adds a triangle.

Parameters
  • 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.

  • user_data (Any, optional) – User data for callbacks

  • use_internal_label (bool, optional) – Use generated internal label instead of user specified (appends ### 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.

  • show (bool, optional) – Attempt to render widget.

  • color (Union[List[int], Tuple[int, ...]], optional) –

  • fill (Union[List[int], Tuple[int, ...]], optional) –

  • thickness (float, optional) –

  • id (Union[int, str], optional) – (deprecated)

Returns

Union[int, str]

dearpygui.dearpygui.drawlist(width, height, **kwargs)[source]

Adds a drawing canvas.

Parameters
  • width (int) –

  • height (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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • callback (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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.empty_container_stack()[source]

Emptyes the container stack.

Args: :returns: None

dearpygui.dearpygui.enable_docking(dock_space=False)[source]

deprecated function

dearpygui.dearpygui.enable_item(item: Union[int, str])[source]

Enables the item.

Parameters

**item – Item to enable.

Returns

None

dearpygui.dearpygui.file_dialog(**kwargs)[source]

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.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • callback (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.

  • file_count (int, optional) – Number of visible files in the dialog.

  • modal (bool, optional) – Forces user interaction with the file selector.

  • 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.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.filter_set(**kwargs)[source]

Helper to parse and apply text filters (e.g. aaaaa[, bbbbb][, ccccc])

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.fit_axis_data(axis)[source]

Sets the axis boundaries max/min in the data series currently on the plot.

Parameters

axis (Union[int, str]) –

Returns

None

dearpygui.dearpygui.focus_item(item)[source]

Focuses an item.

Parameters

item (Union[int, str]) –

Returns

None

dearpygui.dearpygui.font(file, size, **kwargs)[source]

Adds font to a font registry.

Parameters
  • file (str) –

  • size (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)

  • default_font (bool, optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.font_registry(**kwargs)[source]

Adds a font registry.

Parameters
  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.generate_uuid()[source]

Generate a new UUID.

Args: :returns: Union[int, str]

dearpygui.dearpygui.get_active_window()[source]

Returns the active window.

Args: :returns: Union[int, str]

dearpygui.dearpygui.get_alias_id(alias)[source]

Returns the ID associated with an alias.

Parameters

alias (str) –

Returns

Union[int, str]

dearpygui.dearpygui.get_aliases()[source]

Returns all aliases.

Args: :returns: Union[List[str], Tuple[str, …]]

dearpygui.dearpygui.get_all_items()[source]

Returns all items.

Args: :returns: Union[List[int], Tuple[int, …]]

dearpygui.dearpygui.get_app_configuration()[source]

Returns app configuration.

Args: :returns: dict

dearpygui.dearpygui.get_available_content_region(item: Union[int, str]) List[int][source]

Returns item’s available content region.

Returns

position

dearpygui.dearpygui.get_axis_limits(axis)[source]

Get the specified axis limits.

Parameters

axis (Union[int, str]) –

Returns

Union[List[float], Tuple[float, …]]

dearpygui.dearpygui.get_callback_queue()[source]

New in 1.2. Returns and clears callback queue.

Args: :returns: Any

dearpygui.dearpygui.get_clipboard_text()[source]

New in 1.3. Gets the clipboard text.

Args: :returns: str

dearpygui.dearpygui.get_colormap_color(colormap, index)[source]

Returns a color from a colormap given an index >= 0. (ex. 0 will be the first color in the color list of the color map) Modulo will be performed against the number of items in the color list.

Parameters
  • colormap (Union[int, str]) – The colormap tag. This should come from a colormap that was added to a colormap registry. Built in color maps are accessible through their corresponding constants mvPlotColormap_Twilight, mvPlotColormap_***

  • index (int) – Desired position of the color in the colors list value of the colormap being quiered

Returns

Union[List[int], Tuple[int, …]]

dearpygui.dearpygui.get_dearpygui_version()[source]

return Dear PyGui Version

dearpygui.dearpygui.get_delta_time()[source]

Returns time since last frame.

Args: :returns: float

dearpygui.dearpygui.get_drawing_mouse_pos()[source]

Returns mouse position in drawing.

Args: :returns: Union[List[int], Tuple[int, …]]

dearpygui.dearpygui.get_file_dialog_info(file_dialog)[source]

Returns information related to the file dialog. Typically used while the file dialog is in use to query data about the state or info related to the file dialog.

Parameters

file_dialog (Union[int, str]) –

Returns

dict

dearpygui.dearpygui.get_frame_count()[source]

Returns frame count.

Args: :returns: int

dearpygui.dearpygui.get_frame_rate()[source]

Returns the average frame rate across 120 frames.

Args: :returns: float

dearpygui.dearpygui.get_global_font_scale()[source]

Returns global font scale.

Args: :returns: float

dearpygui.dearpygui.get_item_alias(item)[source]

Returns an item’s alias.

Parameters

item (Union[int, str]) –

Returns

str

dearpygui.dearpygui.get_item_callback(item: Union[int, str]) Optional[Callable][source]

Gets the item’s callback.

Returns

callback as a callable or None

dearpygui.dearpygui.get_item_children(item: Union[int, str], slot: int = - 1) Optional[Union[dict, List[int]]][source]

Provides access to the item’s children slots.

Returns

A 2-D tuple of children slots ex. ((child_slot_1),(child_slot_2),(child_slot_3),…) or a single slot if slot is used.

dearpygui.dearpygui.get_item_configuration(item)[source]

Returns an item’s configuration.

Parameters

item (Union[int, str]) –

Returns

dict

dearpygui.dearpygui.get_item_disabled_theme(item: Union[int, str]) int[source]

Gets the item’s disabled theme.

Returns

theme’s uuid

dearpygui.dearpygui.get_item_drag_callback(item: Union[int, str]) Optional[Callable][source]

Gets the item’s drag callback.

Returns

callback as a callable or None

dearpygui.dearpygui.get_item_drop_callback(item: Union[int, str]) Optional[Callable][source]

Gets the item’s drop callback.

Returns

callback as a callable or None

dearpygui.dearpygui.get_item_filter_key(item: Union[int, str]) Optional[str][source]

Gets the item’s filter key.

Returns

filter key as a string or None

dearpygui.dearpygui.get_item_font(item: Union[int, str]) int[source]

Gets the item’s font.

Returns

font’s uuid

dearpygui.dearpygui.get_item_height(item: Union[int, str]) Optional[int][source]

Gets the item’s height.

Returns

height as a int or None

dearpygui.dearpygui.get_item_indent(item: Union[int, str]) Optional[int][source]

Gets the item’s indent.

Returns

indent as a int or None

dearpygui.dearpygui.get_item_info(item)[source]

Returns an item’s information.

Parameters

item (Union[int, str]) –

Returns

dict

dearpygui.dearpygui.get_item_label(item: Union[int, str]) Optional[str][source]

Gets the item’s label.

Returns

label as a string or None

dearpygui.dearpygui.get_item_parent(item: Union[int, str]) Optional[int][source]

Gets the item’s parent.

Returns

parent as a int or None

dearpygui.dearpygui.get_item_pos(item: Union[int, str]) List[int][source]

Returns item’s position.

Returns

position

dearpygui.dearpygui.get_item_rect_max(item: Union[int, str]) List[int][source]

Returns item’s maximum content region.

Returns

position

dearpygui.dearpygui.get_item_rect_min(item: Union[int, str]) List[int][source]

Returns item’s minimum content region.

Returns

position

dearpygui.dearpygui.get_item_rect_size(item: Union[int, str]) List[int][source]

Returns item’s available content region.

Returns

position

dearpygui.dearpygui.get_item_slot(item: Union[int, str]) Optional[int][source]

Returns an item’s target slot.

Returns

slot as a int

dearpygui.dearpygui.get_item_source(item: Union[int, str]) Optional[str][source]

Gets the item’s source.

Returns

source as a string or None

dearpygui.dearpygui.get_item_state(item)[source]

Returns an item’s state.

Parameters

item (Union[int, str]) –

Returns

dict

dearpygui.dearpygui.get_item_theme(item: Union[int, str]) int[source]

Gets the item’s theme.

Returns

theme’s uuid

dearpygui.dearpygui.get_item_track_offset(item: Union[int, str]) Optional[float][source]

Gets the item’s track offset.

Returns

track offset as a int or None

dearpygui.dearpygui.get_item_type(item: Union[int, str]) str[source]

Gets the item’s type.

Returns

type as a string or None

dearpygui.dearpygui.get_item_types()[source]

Returns an item types.

Args: :returns: dict

dearpygui.dearpygui.get_item_user_data(item: Union[int, str]) Optional[Any][source]

Gets the item’s callback data.

Returns

callback data as a python object or None

dearpygui.dearpygui.get_item_width(item: Union[int, str]) Optional[int][source]

Gets the item’s width.

Returns

width as a int or None

dearpygui.dearpygui.get_major_version()[source]

return Dear PyGui Major Version

dearpygui.dearpygui.get_minor_version()[source]

return Dear PyGui Minor Version

dearpygui.dearpygui.get_mouse_drag_delta()[source]

Returns mouse drag delta.

Args: :returns: float

dearpygui.dearpygui.get_mouse_pos(**kwargs)[source]

Returns mouse position.

Parameters

local (bool, optional) –

Returns

Union[List[int], Tuple[int, …]]

dearpygui.dearpygui.get_platform()[source]

New in 1.6. Returns platform constant.

Args: :returns: int

dearpygui.dearpygui.get_plot_mouse_pos()[source]

Returns mouse position in plot.

Args: :returns: Union[List[int], Tuple[int, …]]

dearpygui.dearpygui.get_plot_query_area(plot)[source]

Returns the last/current query area of the plot. (Requires plot ‘query’ kwarg to be enabled)

Parameters

plot (Union[int, str]) –

Returns

Union[List[float], Tuple[float, …]]

Returns a node editor’s selected links.

Parameters

node_editor (Union[int, str]) –

Returns

List[List[str]]

dearpygui.dearpygui.get_selected_nodes(node_editor)[source]

Returns a node editor’s selected nodes.

Parameters

node_editor (Union[int, str]) –

Returns

Union[List[int], Tuple[int, …]]

dearpygui.dearpygui.get_text_size(text, **kwargs)[source]

Returns width/height of text with specified font (must occur after 1st frame).

Parameters
  • text (str) –

  • wrap_width (float, optional) – Wrap width to use (-1.0 turns wrap off).

  • font (Union[int, str], optional) – Font to use.

Returns

Union[List[float], Tuple[float, …]]

dearpygui.dearpygui.get_total_time()[source]

Returns total time since Dear PyGui has started.

Args: :returns: float

dearpygui.dearpygui.get_value(item)[source]

Returns an item’s value.

Parameters

item (Union[int, str]) –

Returns

Any

dearpygui.dearpygui.get_values(items)[source]

Returns values of a list of items.

Parameters

items (Union[List[int], Tuple[int, ...]]) –

Returns

Any

dearpygui.dearpygui.get_viewport_clear_color() List[int][source]

Gets the viewport’s clear color.

Returns

List[int]

dearpygui.dearpygui.get_viewport_client_height() int[source]

Gets the viewport’s client height.

Returns

viewport width

dearpygui.dearpygui.get_viewport_client_width() int[source]

Gets the viewport’s client width.

Returns

viewport width

dearpygui.dearpygui.get_viewport_configuration(item)[source]

Returns a viewport’s configuration.

Parameters

item (Union[int, str]) –

Returns

dict

dearpygui.dearpygui.get_viewport_height() int[source]

Gets the viewport’s height.

Returns

int

dearpygui.dearpygui.get_viewport_max_height() int[source]

Gets the viewport’s max width.

Returns

int

dearpygui.dearpygui.get_viewport_max_width() int[source]

Gets the viewport’s max width.

Returns

int

dearpygui.dearpygui.get_viewport_min_height() int[source]

Gets the viewport’s minimum height.

Returns

int

dearpygui.dearpygui.get_viewport_min_width() int[source]

Gets the viewport’s minimum width.

Returns

int

dearpygui.dearpygui.get_viewport_pos() List[float][source]

Gets the viewport’s position.

Returns

viewport position.

dearpygui.dearpygui.get_viewport_title() str[source]

Gets the viewport’s title.

Returns

str

dearpygui.dearpygui.get_viewport_width() int[source]

Gets the viewport’s width.

Returns

viewport width

dearpygui.dearpygui.get_windows()[source]

Returns all windows.

Args: :returns: Union[List[int], Tuple[int, …]]

dearpygui.dearpygui.get_x_scroll(item)[source]

Undocumented

Parameters

item (Union[int, str]) –

Returns

float

dearpygui.dearpygui.get_x_scroll_max(item)[source]

Undocumented

Parameters

item (Union[int, str]) –

Returns

float

dearpygui.dearpygui.get_y_scroll(item)[source]

Undocumented

Parameters

item (Union[int, str]) –

Returns

float

dearpygui.dearpygui.get_y_scroll_max(item)[source]

Undocumented

Parameters

item (Union[int, str]) –

Returns

float

dearpygui.dearpygui.group(**kwargs)[source]

Creates a group that other widgets can belong to. The group allows item commands to be issued for all of its members.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • horizontal (bool, optional) – Forces child widgets to be added in a horizontal layout.

  • horizontal_spacing (float, optional) – Spacing for the horizontal layout.

  • xoffset (float, optional) – Offset from containing window x item location within group.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.handler_registry(**kwargs)[source]

Adds a handler registry.

Parameters
  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.hide_item(item: Union[int, str], *, children_only: bool = False)[source]

Hides the item.

Parameters

**item – Item to hide.

Returns

None

dearpygui.dearpygui.highlight_table_cell(table, row, column, color)[source]

Highlight specified table cell.

Parameters
  • table (Union[int, str]) –

  • row (int) –

  • column (int) –

  • color (Union[List[int], Tuple[int, ...]]) –

Returns

None

dearpygui.dearpygui.highlight_table_column(table, column, color)[source]

Highlight specified table column.

Parameters
  • table (Union[int, str]) –

  • column (int) –

  • color (Union[List[int], Tuple[int, ...]]) –

Returns

None

dearpygui.dearpygui.highlight_table_row(table, row, color)[source]

Highlight specified table row.

Parameters
  • table (Union[int, str]) –

  • row (int) –

  • color (Union[List[int], Tuple[int, ...]]) –

Returns

None

dearpygui.dearpygui.is_dearpygui_running()[source]

Checks if Dear PyGui is running

Args: :returns: bool

dearpygui.dearpygui.is_item_activated(item: Union[int, str]) Optional[bool][source]

Checks if item is activated.

Returns

status as a bool

dearpygui.dearpygui.is_item_active(item: Union[int, str]) Optional[bool][source]

Checks if item is active.

Returns

status as a bool

dearpygui.dearpygui.is_item_clicked(item: Union[int, str]) Optional[bool][source]

Checks if item is clicked.

Returns

status as a bool

dearpygui.dearpygui.is_item_container(item: Union[int, str]) Optional[bool][source]

Checks if item is a container.

Returns

status as a bool

dearpygui.dearpygui.is_item_deactivated(item: Union[int, str]) Optional[bool][source]

Checks if item is deactivated.

Returns

status as a bool

dearpygui.dearpygui.is_item_deactivated_after_edit(item: Union[int, str]) Optional[bool][source]

Checks if item is deactivated_after_edit.

Returns

status as a bool

dearpygui.dearpygui.is_item_edited(item: Union[int, str]) Optional[bool][source]

Checks if item is edited.

Returns

status as a bool

dearpygui.dearpygui.is_item_enabled(item: Union[int, str]) Optional[bool][source]

Checks if item is enabled.

Returns

status as a bool

dearpygui.dearpygui.is_item_focused(item: Union[int, str]) Optional[bool][source]

Checks if item is focused.

Returns

status as a bool

dearpygui.dearpygui.is_item_hovered(item: Union[int, str]) Optional[bool][source]

Checks if item is hovered.

Returns

status as a bool

dearpygui.dearpygui.is_item_left_clicked(item: Union[int, str]) Optional[bool][source]

Checks if item is left clicked.

Returns

status as a bool

dearpygui.dearpygui.is_item_middle_clicked(item: Union[int, str]) Optional[bool][source]

Checks if item is middle clicked.

Returns

status as a bool

dearpygui.dearpygui.is_item_ok(item: Union[int, str]) Optional[bool][source]

Checks if item is ok and can be used.

Returns

status as a bool

dearpygui.dearpygui.is_item_right_clicked(item: Union[int, str]) Optional[bool][source]

Checks if item is right clicked.

Returns

status as a bool

dearpygui.dearpygui.is_item_search_delayed(item: Union[int, str]) Optional[bool][source]

Checks if item is search delayed.

Returns

tracked as a bool or None

dearpygui.dearpygui.is_item_shown(item: Union[int, str]) Optional[bool][source]

Checks if item is shown.

Returns

status as a bool

dearpygui.dearpygui.is_item_toggled_open(item: Union[int, str]) Optional[bool][source]

Checks if item is toggled_open.

Returns

status as a bool

dearpygui.dearpygui.is_item_tracked(item: Union[int, str]) Optional[bool][source]

Checks if item is tracked.

Returns

tracked as a bool or None

dearpygui.dearpygui.is_item_visible(item: Union[int, str]) Optional[bool][source]

Checks if item is visible.

Returns

status as a bool

dearpygui.dearpygui.is_key_down(key)[source]

Checks if key is down.

Parameters

key (int) –

Returns

bool

dearpygui.dearpygui.is_key_pressed(key)[source]

Checks if key is pressed.

Parameters

key (int) –

Returns

bool

dearpygui.dearpygui.is_key_released(key)[source]

Checks if key is released.

Parameters

key (int) –

Returns

bool

dearpygui.dearpygui.is_mouse_button_clicked(button)[source]

Checks if mouse button is clicked.

Parameters

button (int) –

Returns

bool

dearpygui.dearpygui.is_mouse_button_double_clicked(button)[source]

Checks if mouse button is double clicked.

Parameters

button (int) –

Returns

bool

dearpygui.dearpygui.is_mouse_button_down(button)[source]

Checks if mouse button is down.

Parameters

button (int) –

Returns

bool

dearpygui.dearpygui.is_mouse_button_dragging(button, threshold)[source]

Checks if mouse button is down and dragging.

Parameters
  • button (int) –

  • threshold (float) –

Returns

bool

dearpygui.dearpygui.is_mouse_button_released(button)[source]

Checks if mouse button is released.

Parameters

button (int) –

Returns

bool

dearpygui.dearpygui.is_plot_queried(plot)[source]

Returns true if the plot is currently being queried. (Requires plot ‘query’ kwarg to be enabled)

Parameters

plot (Union[int, str]) –

Returns

bool

dearpygui.dearpygui.is_table_cell_highlighted(table, row, column)[source]

Checks if a table cell is highlighted.

Parameters
  • table (Union[int, str]) –

  • row (int) –

  • column (int) –

Returns

bool

dearpygui.dearpygui.is_table_column_highlighted(table, column)[source]

Checks if a table column is highlighted.

Parameters
  • table (Union[int, str]) –

  • column (int) –

Returns

bool

dearpygui.dearpygui.is_table_row_highlighted(table, row)[source]

Checks if a table row is highlighted.

Parameters
  • table (Union[int, str]) –

  • row (int) –

Returns

bool

dearpygui.dearpygui.is_viewport_always_top() bool[source]

Checks the viewport always on top flag.

Returns

bool

dearpygui.dearpygui.is_viewport_created()[source]

deprecated function

dearpygui.dearpygui.is_viewport_decorated() bool[source]

Checks if the viewport is docorated.

Returns

bool

dearpygui.dearpygui.is_viewport_ok()[source]

Checks if a viewport has been created and shown.

Args: :returns: bool

dearpygui.dearpygui.is_viewport_resizable() bool[source]

Checks the viewport resizable flag.

Returns

bool

dearpygui.dearpygui.is_viewport_vsync_on() bool[source]

Checks the viewport vsync flag.

Returns

bool

dearpygui.dearpygui.item_handler_registry(**kwargs)[source]

Adds an item handler registry.

Parameters
  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.last_container()[source]

Returns the last container item added.

Args: :returns: Union[int, str]

dearpygui.dearpygui.last_item()[source]

Returns the last item added.

Args: :returns: Union[int, str]

dearpygui.dearpygui.last_root()[source]

Returns the last root added (registry or window).

Args: :returns: Union[int, str]

dearpygui.dearpygui.load_image(file, **kwargs)[source]

Loads an image. Returns width, height, channels, mvBuffer

Parameters
  • file (str) –

  • gamma (float, optional) – Gamma correction factor. (default is 1.0 to avoid automatic gamma correction on loading.

  • gamma_scale_factor (float, optional) – Gamma scale factor.

Returns

Any

dearpygui.dearpygui.load_init_file(file)[source]

deprecated function

dearpygui.dearpygui.lock_mutex()[source]

Locks render thread mutex.

Args: :returns: None

dearpygui.dearpygui.maximize_viewport()[source]

Maximizes the viewport.

Args: :returns: None

dearpygui.dearpygui.menu(**kwargs)[source]

Adds a menu to an existing menu bar.

Parameters
  • 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.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.menu_bar(**kwargs)[source]

Adds a menu bar to a window.

Parameters
  • 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.

  • 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)

  • show (bool, optional) – Attempt to render widget.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.minimize_viewport()[source]

Minimizes a viewport.

Args: :returns: None

dearpygui.dearpygui.move_item(item, **kwargs)[source]

Moves an item to a new location.

Parameters
  • item (Union[int, str]) –

  • parent (Union[int, str], optional) –

  • before (Union[int, str], optional) –

Returns

None

dearpygui.dearpygui.move_item_down(item)[source]

Moves an item down.

Parameters

item (Union[int, str]) –

Returns

None

dearpygui.dearpygui.move_item_up(item)[source]

Moves an item up.

Parameters

item (Union[int, str]) –

Returns

None

dearpygui.dearpygui.mutex()[source]

Handles locking/unlocking render thread mutex.

dearpygui.dearpygui.node(**kwargs)[source]

Adds a node to a node editor.

Parameters
  • 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)

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • draggable (bool, optional) – Allow node to be draggable.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.node_attribute(**kwargs)[source]

Adds a node attribute to a node.

Parameters
  • 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.

  • 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.

  • 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

  • attribute_type (int, optional) – mvNode_Attr_Input, mvNode_Attr_Output, or mvNode_Attr_Static.

  • shape (int, optional) – Pin shape.

  • category (str, optional) – Category

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.node_editor(**kwargs)[source]

Adds a node editor.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • filter_key (str, optional) – Used by filter widget.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • 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.

  • 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.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.output_frame_buffer(file='', **kwargs)[source]

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.

Parameters
  • file (str, optional) –

  • callback (Callable, optional) – Callback will return framebuffer as an array through the second arg.

Returns

Any

dearpygui.dearpygui.plot(**kwargs)[source]

Adds a plot which is used to hold series, and can be drawn to with draw commands.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • no_title (bool, optional) –

  • no_menus (bool, optional) –

  • no_box_select (bool, optional) –

  • no_mouse_pos (bool, optional) –

  • no_highlight (bool, optional) –

  • no_child (bool, optional) –

  • query (bool, optional) –

  • crosshairs (bool, optional) –

  • anti_aliased (bool, optional) –

  • equal_aspects (bool, optional) –

  • pan_button (int, optional) – enables panning when held

  • pan_mod (int, optional) – optional modifier that must be held for panning

  • fit_button (int, optional) – fits visible data when double clicked

  • context_menu_button (int, optional) – opens plot context menu (if enabled) when clicked

  • box_select_button (int, optional) – begins box selection when pressed and confirms selection when released

  • box_select_mod (int, optional) – begins box selection when pressed and confirms selection when released

  • box_select_cancel_button (int, optional) – cancels active box selection when pressed

  • query_button (int, optional) – begins query selection when pressed and end query selection when released

  • query_mod (int, optional) – optional modifier that must be held for query selection

  • query_toggle_mod (int, optional) – when held, active box selections turn into queries

  • horizontal_mod (int, optional) – expands active box selection/query horizontally to plot edge when held

  • vertical_mod (int, optional) – expands active box selection/query vertically to plot edge when held

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.plot_axis(axis, **kwargs)[source]

Adds an axis to a plot.

Parameters
  • axis (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)

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • no_gridlines (bool, optional) –

  • no_tick_marks (bool, optional) –

  • no_tick_labels (bool, optional) –

  • log_scale (bool, optional) –

  • invert (bool, optional) –

  • lock_min (bool, optional) –

  • lock_max (bool, optional) –

  • time (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.pop_container_stack()[source]

Pops the top item off the parent stack and return its ID.

Args: :returns: Union[int, str]

dearpygui.dearpygui.popup(parent: Union[int, str], mousebutton: int = 0, 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[source]

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 and set the item handler and mouse events manually.

Parameters
  • parent – The UI item that will need to be hovered.

  • **mousebutton – The mouse button that will trigger the window to popup.

  • **modal – Will force the user to interact with the popup.

  • **min_size – New in 1.4. Minimum window size.

  • **max_size – New in 1.4. Maximum window size.

  • **no_move – New in 1.4. Prevents the window from moving based on user input.

  • **no_background – New in 1.4. Sets Background and border alpha to transparent.

Returns

item’s uuid

dearpygui.dearpygui.push_container_stack(item)[source]

Pushes an item onto the container stack.

Parameters

item (Union[int, str]) –

Returns

bool

dearpygui.dearpygui.remove_alias(alias)[source]

Removes an alias.

Parameters

alias (str) –

Returns

None

dearpygui.dearpygui.render_dearpygui_frame()[source]

Render a single Dear PyGui frame.

Args: :returns: None

dearpygui.dearpygui.reorder_items(container, slot, new_order)[source]

Reorders an item’s children.

Parameters
  • container (Union[int, str]) –

  • slot (int) –

  • new_order (Union[List[int], Tuple[int, ...]]) –

Returns

None

dearpygui.dearpygui.reset_axis_ticks(axis)[source]

Removes the manually set axis ticks and applies the default axis ticks

Parameters

axis (Union[int, str]) –

Returns

None

dearpygui.dearpygui.reset_default_theme(item, source)[source]

deprecated function

dearpygui.dearpygui.reset_pos(item)[source]

Resets an item’s position after using ‘set_item_pos’.

Parameters

item (Union[int, str]) –

Returns

None

dearpygui.dearpygui.run_callbacks(jobs)[source]

New in 1.2. Runs callbacks from the callback queue and checks arguments.

dearpygui.dearpygui.sample_colormap(colormap, t)[source]

Returns a color from a colormap given t between 0.0-1.0.

Parameters
  • colormap (Union[int, str]) – The colormap tag. This should come from a colormap that was added to a colormap registry. Built in color maps are accessible through their corresponding constants mvPlotColormap_Twilight, mvPlotColormap_***

  • t (float) – Value of the colormap to sample between 0.0-1.0

Returns

Union[List[int], Tuple[int, …]]

dearpygui.dearpygui.save_image(file, width, height, data, **kwargs)[source]

Saves an image. Possible formats: png, bmp, tga, hdr, jpg.

Parameters
  • file (str) –

  • width (int) –

  • height (int) –

  • data (Any) –

  • components (int, optional) – Number of components (1-4). Default of 4.

  • quality (int, optional) – Stride in bytes (only used for jpg).

Returns

None

dearpygui.dearpygui.save_init_file(file)[source]

Save dpg.ini file.

Parameters

file (str) –

Returns

None

dearpygui.dearpygui.set_axis_limits(axis, ymin, ymax)[source]

Sets limits on the axis for pan and zoom.

Parameters
  • axis (Union[int, str]) –

  • ymin (float) –

  • ymax (float) –

Returns

None

dearpygui.dearpygui.set_axis_limits_auto(axis)[source]

Removes all limits on specified axis.

Parameters

axis (Union[int, str]) –

Returns

None

dearpygui.dearpygui.set_axis_ticks(axis, label_pairs)[source]

Replaces axis ticks with ‘label_pairs’ argument.

Parameters
  • axis (Union[int, str]) –

  • label_pairs (Any) – Tuples of label and value in the form ‘((label, axis_value), (label, axis_value), …)’

Returns

None

dearpygui.dearpygui.set_clip_space(item, top_left_x, top_left_y, width, height, min_depth, max_depth)[source]

New in 1.1. Set the clip space for depth clipping and ‘viewport’ transformation.

Parameters
  • item (Union[int, str]) – draw layer to set clip space

  • top_left_x (float) – angle to rotate

  • top_left_y (float) – angle to rotate

  • width (float) – angle to rotate

  • height (float) – angle to rotate

  • min_depth (float) – angle to rotate

  • max_depth (float) – angle to rotate

Returns

None

dearpygui.dearpygui.set_clipboard_text(text)[source]

New in 1.3. Sets the clipboard text.

Parameters

text (str) –

Returns

None

dearpygui.dearpygui.set_colormap(item, source)[source]

deprecated function

dearpygui.dearpygui.set_exit_callback(callback, **kwargs)[source]

Sets a callback to run on last frame.

Parameters
  • callback (Callable) –

  • user_data (Any, optional) – New in 1.3. Optional user data to send to the callback

Returns

str

dearpygui.dearpygui.set_frame_callback(frame, callback, **kwargs)[source]

Sets a callback to run on first frame.

Parameters
  • frame (int) –

  • callback (Callable) –

  • user_data (Any, optional) – New in 1.3. Optional user data to send to the callback

Returns

str

dearpygui.dearpygui.set_global_font_scale(scale)[source]

Sets global font scale.

Parameters

scale (float) –

Returns

None

dearpygui.dearpygui.set_init_file(file='dpg.ini')[source]

deprecated function

dearpygui.dearpygui.set_item_alias(item, alias)[source]

Sets an item’s alias.

Parameters
  • item (Union[int, str]) –

  • alias (str) –

Returns

None

dearpygui.dearpygui.set_item_callback(item: Union[int, str], callback: Callable)[source]

Sets the item’s callack.

Parameters
  • item – Item the callback will be applied to.

  • callback – Callback to be applied.

Returns

None

dearpygui.dearpygui.set_item_children(item, source, slot)[source]

Sets an item’s children.

Parameters
  • item (Union[int, str]) –

  • source (Union[int, str]) –

  • slot (int) –

Returns

None

dearpygui.dearpygui.set_item_drag_callback(item: Union[int, str], callback: Callable)[source]

Sets the item’s drag callack.

Parameters
  • item – Item the callback will be applied to.

  • callback – Callback to be applied.

Returns

None

dearpygui.dearpygui.set_item_drop_callback(item: Union[int, str], callback: Callable)[source]

Sets the item’s drop callack.

Parameters
  • item – Item the callback will be applied to.

  • callback – Callback to be applied.

Returns

None

dearpygui.dearpygui.set_item_font(item, font)[source]

deprecated function

dearpygui.dearpygui.set_item_height(item: Union[int, str], height: int)[source]

Sets the item’s height.

Parameters
  • item – Item the Height will be applied to.

  • height – Height to be applied.

Returns

None

dearpygui.dearpygui.set_item_indent(item: Union[int, str], indent: int)[source]

Sets the item’s indent.

Parameters
  • item – Item the Height will be applied to.

  • height – Height to be applied.

Returns

None

dearpygui.dearpygui.set_item_label(item: Union[int, str], label: str)[source]

Sets the item’s displayed label, anything after the characters “##” in the name will not be shown.

Parameters
  • item – Item label will be applied to.

  • label – Displayed name to be applied.

Returns

None

dearpygui.dearpygui.set_item_payload_type(item: Union[int, str], payload_type: str)[source]

Sets the item’s payload type.

Parameters
  • item – Item the Height will be applied to.

  • height – Height to be applied.

Returns

None

dearpygui.dearpygui.set_item_pos(item: Union[int, str], pos: List[float])[source]

Sets the item’s position.

Parameters
  • item – Item the absolute position will be applied to.

  • pos – X and Y positions relative to parent of the item.

Returns

None

dearpygui.dearpygui.set_item_source(item: Union[int, str], source: Union[int, str])[source]

Sets the item’s value, to the source’s value. Widget’s value will now be “linked” to source’s value.

Parameters
  • item – Item to me linked.

  • source – Source to link to.

Returns

None

dearpygui.dearpygui.set_item_theme(item, theme)[source]

deprecated function

dearpygui.dearpygui.set_item_track_offset(item: Union[int, str], offset: float)[source]

Sets the item’s track offset.

Parameters
  • item – Item the Height will be applied to.

  • height – Height to be applied.

Returns

None

dearpygui.dearpygui.set_item_type_disabled_theme(item, theme)[source]

deprecated function

dearpygui.dearpygui.set_item_type_theme(item, theme)[source]

deprecated function

dearpygui.dearpygui.set_item_user_data(item: Union[int, str], user_data: Any)[source]

Sets the item’s callack_data to any python object.

Parameters
  • item – Item the callback will be applied to.

  • user_data – Callback_data to be applied.

Returns

None

dearpygui.dearpygui.set_item_width(item: Union[int, str], width: int)[source]

Sets the item’s width.

Parameters
  • item – Item the Width will be applied to.

  • width – Width to be applied.

Returns

None

dearpygui.dearpygui.set_primary_window(window, value)[source]

Sets the primary window.

Parameters
  • window (Union[int, str]) –

  • value (bool) –

Returns

None

dearpygui.dearpygui.set_staging_mode(mode)[source]

deprecated function

dearpygui.dearpygui.set_start_callback(callback)[source]

deprecated function

dearpygui.dearpygui.set_table_row_color(table, row, color)[source]

Set table row color.

Parameters
  • table (Union[int, str]) –

  • row (int) –

  • color (Union[List[int], Tuple[int, ...]]) –

Returns

None

dearpygui.dearpygui.set_value(item, value)[source]

Set’s an item’s value.

Parameters
  • item (Union[int, str]) –

  • value (Any) –

Returns

None

dearpygui.dearpygui.set_viewport_always_top(value: bool)[source]

Sets the viewport always on top.

Returns

None

dearpygui.dearpygui.set_viewport_clear_color(color: List[int])[source]

Sets the viewport’s clear color.

Returns

None

dearpygui.dearpygui.set_viewport_decorated(value: bool)[source]

Sets the viewport to be decorated.

Returns

None

dearpygui.dearpygui.set_viewport_height(height: int)[source]

Sets the viewport’s height.

Returns

None

dearpygui.dearpygui.set_viewport_large_icon(icon: str)[source]

Sets the viewport’s large icon. Must be ico for windows.

Returns

None

dearpygui.dearpygui.set_viewport_max_height(height: int)[source]

Sets the viewport’s max width.

Returns

None

dearpygui.dearpygui.set_viewport_max_width(width: int)[source]

Sets the viewport’s max width.

Returns

None

dearpygui.dearpygui.set_viewport_min_height(height: int)[source]

Sets the viewport’s minimum height.

Returns

None

dearpygui.dearpygui.set_viewport_min_width(width: int)[source]

Sets the viewport’s minimum width.

Returns

None

dearpygui.dearpygui.set_viewport_pos(pos: List[float])[source]

Sets the viewport’s position.

Returns

None

dearpygui.dearpygui.set_viewport_resizable(value: bool)[source]

Sets the viewport resizable.

Returns

None

dearpygui.dearpygui.set_viewport_resize_callback(callback, **kwargs)[source]

Sets a callback to run on viewport resize.

Parameters
  • callback (Callable) –

  • user_data (Any, optional) – New in 1.3. Optional user data to send to the callback

Returns

str

dearpygui.dearpygui.set_viewport_small_icon(icon: str)[source]

Sets the viewport’s small icon. Must be ico for windows.

Returns

None

dearpygui.dearpygui.set_viewport_title(title: str)[source]

Sets the viewport’s title.

Returns

None

dearpygui.dearpygui.set_viewport_vsync(value: bool)[source]

Sets the viewport vsync.

Returns

None

dearpygui.dearpygui.set_viewport_width(width: int)[source]

Sets the viewport’s width.

Returns

None

dearpygui.dearpygui.set_x_scroll(item, value)[source]

Undocumented

Parameters
  • item (Union[int, str]) –

  • value (float) –

Returns

None

dearpygui.dearpygui.set_y_scroll(item, value)[source]

Undocumented

Parameters
  • item (Union[int, str]) –

  • value (float) –

Returns

None

dearpygui.dearpygui.setup_dearpygui()[source]

Sets up Dear PyGui

Parameters

viewport (Union[int, str], optional) – (deprecated)

Returns

None

dearpygui.dearpygui.setup_registries() None[source]

Adds default registries for fonts, handlers, textures, colormaps, and values.

dearpygui.dearpygui.setup_viewport()[source]

deprecated function

dearpygui.dearpygui.show_about() None[source]

Shows the standard about window

Returns

None

dearpygui.dearpygui.show_debug() None[source]

Shows the standard debug window

Returns

None

dearpygui.dearpygui.show_documentation() None[source]

Shows the standard documentation window

Returns

None

dearpygui.dearpygui.show_font_manager() None[source]

Shows the standard documentation window

Returns

None

dearpygui.dearpygui.show_imgui_demo()[source]

Shows the imgui demo.

Args: :returns: None

dearpygui.dearpygui.show_implot_demo()[source]

Shows the implot demo.

Args: :returns: None

dearpygui.dearpygui.show_item(item: Union[int, str])[source]

Shows the item.

Parameters

item – Item to show.

Returns

None

dearpygui.dearpygui.show_item_debug(item)[source]

Shows an item’s debug window

Parameters

item (Union[int, str]) –

Returns

None

dearpygui.dearpygui.show_item_registry() None[source]

Shows the standard documentation window

Returns

None

dearpygui.dearpygui.show_metrics() None[source]

Shows the standard metrics window

Returns

None

dearpygui.dearpygui.show_style_editor() None[source]

Shows the standard style editor window

Returns

None

dearpygui.dearpygui.show_tool(tool)[source]

Shows a built in tool.

Parameters

tool (Union[int, str]) –

Returns

str

dearpygui.dearpygui.show_viewport(**kwargs)[source]

Shows the main viewport.

Parameters
  • minimized (bool, optional) – Sets the state of the viewport to minimized

  • maximized (bool, optional) – Sets the state of the viewport to maximized

  • viewport (Union[int, str], optional) – (deprecated)

Returns

None

dearpygui.dearpygui.split_frame(**kwargs)[source]

Waits one frame.

Parameters

delay (int, optional) – Minimal delay in in milliseconds

Returns

None

dearpygui.dearpygui.stage(**kwargs)[source]

Adds a stage.

Parameters
  • 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.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.staging_container(**kwargs)[source]

deprecated function :param **label: Overrides ‘name’ as label. :type **label: str :param **user_data: User data for callbacks. :type **user_data: Any :param **use_internal_label: Use generated internal label instead of user specified (appends ### uuid). :type **use_internal_label: bool :param **id: Unique id used to programmatically refer to the item.If label is unused this will be the label. :type **id: Union[int, str]

Yields

Union[int, str]

dearpygui.dearpygui.start_dearpygui()[source]

Prepares viewport (if not done already). sets up, cleans up, and runs main event loop.

Returns

None

dearpygui.dearpygui.stop_dearpygui()[source]

Stops Dear PyGui

Args: :returns: None

dearpygui.dearpygui.subplots(rows, columns, **kwargs)[source]

Adds a collection of plots.

Parameters
  • rows (int) –

  • columns (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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • row_ratios (Union[List[float], Tuple[float, ...]], optional) –

  • column_ratios (Union[List[float], Tuple[float, ...]], optional) –

  • no_title (bool, optional) –

  • no_menus (bool, optional) – the user will not be able to open context menus with right-click

  • no_resize (bool, optional) – resize splitters between subplot cells will be not be provided

  • no_align (bool, optional) – subplot edges will not be aligned vertically or horizontally

  • link_rows (bool, optional) – link the y-axis limits of all plots in each row (does not apply auxiliary y-axes)

  • link_columns (bool, optional) – link the x-axis limits of all plots in each column

  • link_all_x (bool, optional) – link the x-axis limits in every plot in the subplot

  • link_all_y (bool, optional) – link the y-axis limits in every plot in the subplot (does not apply to auxiliary y-axes)

  • column_major (bool, optional) – subplots are added in column major order instead of the default row major order

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.tab(**kwargs)[source]

Adds a tab to a tab bar.

Parameters
  • 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.

  • 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.

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • filter_key (str, optional) – Used by filter widget.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • closable (bool, optional) – Creates a button on the tab that can hide the tab.

  • no_tooltip (bool, optional) – Disable tooltip for the given tab.

  • order_mode (bool, optional) – set using a constant: mvTabOrder_Reorderable: allows reordering, mvTabOrder_Fixed: fixed ordering, mvTabOrder_Leading: adds tab to front, mvTabOrder_Trailing: adds tab to back

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.tab_bar(**kwargs)[source]

Adds a tab bar.

Parameters
  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • reorderable (bool, optional) – Allows for the user to change the order of the tabs.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.table(**kwargs)[source]

Adds a table.

Parameters
  • 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.

  • width (int, optional) – Width of the item.

  • height (int, optional) – Height of the item.

  • 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.

  • source (Union[int, str], optional) – Overrides ‘id’ as value storage key.

  • callback (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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • header_row (bool, optional) – show headers at the top of the columns

  • clipper (bool, optional) – Use clipper (rows must be same height).

  • inner_width (int, optional) –

  • policy (int, optional) –

  • freeze_rows (int, optional) –

  • freeze_columns (int, optional) –

  • sort_multi (bool, optional) – Hold shift when clicking headers to sort on multiple column.

  • sort_tristate (bool, optional) – Allow no sorting, disable default sorting.

  • resizable (bool, optional) – Enable resizing columns

  • reorderable (bool, optional) – Enable reordering columns in header row (need calling TableSetupColumn() + TableHeadersRow() to display headers)

  • hideable (bool, optional) – Enable hiding/disabling columns in context menu.

  • sortable (bool, optional) – Enable sorting. Call TableGetSortSpecs() to obtain sort specs. Also see ImGuiTableFlags_SortMulti and ImGuiTableFlags_SortTristate.

  • context_menu_in_body (bool, optional) – Right-click on columns body/contents will display table context menu. By default it is available in TableHeadersRow().

  • row_background (bool, optional) – Set each RowBg color with ImGuiCol_TableRowBg or ImGuiCol_TableRowBgAlt (equivalent of calling TableSetBgColor with ImGuiTableBgFlags_RowBg0 on each row manually)

  • borders_innerH (bool, optional) – Draw horizontal borders between rows.

  • borders_outerH (bool, optional) – Draw horizontal borders at the top and bottom.

  • borders_innerV (bool, optional) – Draw vertical borders between columns.

  • borders_outerV (bool, optional) – Draw vertical borders on the left and right sides.

  • no_host_extendX (bool, optional) – Make outer width auto-fit to columns, overriding outer_size.x value. Only available when ScrollX/ScrollY are disabled and Stretch columns are not used.

  • no_host_extendY (bool, optional) – Make outer height stop exactly at outer_size.y (prevent auto-extending table past the limit). Only available when ScrollX/ScrollY are disabled. Data below the limit will be clipped and not visible.

  • no_keep_columns_visible (bool, optional) – Disable keeping column always minimally visible when ScrollX is off and table gets too small. Not recommended if columns are resizable.

  • precise_widths (bool, optional) – Disable distributing remainder width to stretched columns (width allocation on a 100-wide table with 3 columns: Without this flag: 33,33,34. With this flag: 33,33,33). With larger number of columns, resizing will appear to be less smooth.

  • no_clip (bool, optional) – Disable clipping rectangle for every individual columns.

  • pad_outerX (bool, optional) – Default if BordersOuterV is on. Enable outer-most padding. Generally desirable if you have headers.

  • no_pad_outerX (bool, optional) – Default if BordersOuterV is off. Disable outer-most padding.

  • no_pad_innerX (bool, optional) – Disable inner padding between columns (double inner padding if BordersOuterV is on, single inner padding if BordersOuterV is off).

  • scrollX (bool, optional) – Enable horizontal scrolling. Require ‘outer_size’ parameter of BeginTable() to specify the container size. Changes default sizing policy. Because this create a child window, ScrollY is currently generally recommended when using ScrollX.

  • scrollY (bool, optional) – Enable vertical scrolling.

  • no_saved_settings (bool, optional) – Never load/save settings in .ini file.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.table_cell(**kwargs)[source]

Adds a table.

Parameters
  • 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.

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • filter_key (str, optional) – Used by filter widget.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.table_row(**kwargs)[source]

Adds a table row.

Parameters
  • 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.

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • filter_key (str, optional) – Used by filter widget.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.template_registry(**kwargs)[source]

Adds a template registry.

Parameters
  • 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.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.texture_registry(**kwargs)[source]

Adds a dynamic texture.

Parameters
  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.theme(**kwargs)[source]

Adds a theme.

Parameters
  • 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.

  • id (Union[int, str], optional) – (deprecated)

  • default_theme (bool, optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.theme_component(item_type=0, **kwargs)[source]

Adds a theme component.

Parameters
  • item_type (int, optional) –

  • 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)

  • before (Union[int, str], optional) – This item will be displayed before the specified item in the parent.

  • enabled_state (bool, optional) –

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.toggle_viewport_fullscreen()[source]

Toggle viewport fullscreen mode..

Args: :returns: None

dearpygui.dearpygui.tooltip(parent, **kwargs)[source]

Adds a tooltip window.

Parameters
  • parent (Union[int, str]) –

  • 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.

  • show (bool, optional) – Attempt to render widget.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.top_container_stack()[source]

Returns the item on the top of the container stack.

Args: :returns: Union[int, str]

dearpygui.dearpygui.track_item(item: Union[int, str])[source]

Track item in scroll region.

Parameters
  • item – Item the callback will be applied to.

  • callback – Callback to be applied.

Returns

None

dearpygui.dearpygui.tree_node(**kwargs)[source]

Adds a tree node to add items to.

Parameters
  • 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.

  • 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.

  • 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.

  • 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.

  • delay_search (bool, optional) – Delays searching container for specified items until the end of the app. Possible optimization when a container has many children that are not accessed often.

  • tracked (bool, optional) – Scroll tracking

  • track_offset (float, optional) – 0.0f:top, 0.5f:center, 1.0f:bottom

  • default_open (bool, optional) – Sets the tree node open by default.

  • open_on_double_click (bool, optional) – Need double-click to open node.

  • open_on_arrow (bool, optional) – Only open when clicking on the arrow part.

  • leaf (bool, optional) – No collapsing, no arrow (use as a convenience for leaf nodes).

  • bullet (bool, optional) – Display a bullet instead of arrow.

  • selectable (bool, optional) – Makes the tree selectable.

  • id (Union[int, str], optional) – (deprecated)

Yields

Union[int, str]

dearpygui.dearpygui.unhighlight_table_cell(table, row, column)[source]

Unhighlight specified table cell.

Parameters
  • table (Union[int, str]) –

  • row (int) –

  • column (int) –

Returns

None

dearpygui.dearpygui.unhighlight_table_column(table, column)[source]

Unhighlight specified table column.

Parameters
  • table (Union[int, str]) –

  • column (int) –

Returns

None

dearpygui.dearpygui.unhighlight_table_row(table, row)