Dear PyGui


Module dearpygui.core

Functions

def add_about_window(...)

Creates an about window.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • width : int = -1

  • height : int = -1

  • x_pos : int = 200 x position the window will start at

  • y_pos : int = 200 y position the window will start at

  • autosize : bool = False Autosized the window to fit it's items.

  • no_resize : bool = False Allows for the window size to be changed or fixed

  • no_title_bar : bool = False Title name for the title bar of the window

  • no_move : bool = False Allows for the window's position to be changed or fixed

  • no_scrollbar : bool = False Disable scrollbars (window can still scroll with mouse or programmatically)

  • no_collapse : bool = False Disable user collapsing window by double-clicking on it

  • horizontal_scrollbar : bool = False Allow horizontal scrollbar to appear (off by default).

  • no_focus_on_appearing : bool = False Disable taking focus when transitioning from hidden to visible state

  • no_bring_to_front_on_focus : bool = False Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)

  • no_close : bool = False

  • no_background : bool = False

  • label : str = ''

  • show : bool = True Attempt to render

def add_additional_font(...)

Adds additional font.

Return Type: None

Parameters


  • file : str ttf or otf file

  • Optional Arguments


  • size : float = 13.0

  • glyph_ranges : str = '' options: korean, japanese, chinese_full, chinese_simplified_common, cryillic, thai, vietnamese

  • Keyword Only Arguments


  • custom_glyph_chars : List[int] = ()

  • custom_glyph_ranges : Any = List[List[int]] list of ranges

def add_annotation(...)

Adds an annotation to a plot.

Return Type: None

Parameters


  • plot : str

  • text : str

  • x : float

  • y : float

  • xoffset : float

  • yoffset : float

  • Keyword Only Arguments


  • color : List[float] = (0, 0, 0, -1)

  • clamped : bool = True

  • tag : str = ''

def add_area_series(...)

Adds an area series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • x : List[float]

  • y : List[float]

  • color : List[float]

  • fill : List[float]

  • Keyword Only Arguments


  • weight : float = 1.0

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_bar_series(...)

Adds a bar series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • x : List[float]

  • y : List[float]

  • Keyword Only Arguments


  • weight : float = 1.0

  • horizontal : bool = False

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_button(...)

Adds a button.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • small : bool = False Small button, useful for embedding in text.

  • arrow : bool = False Arrow button, must use with direction

  • direction : int = 0 A cardinal direction

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • width : int = 0

  • height : int = 0

  • label : str = '' Overrides 'name' as label

  • show : bool = True Attempt to render

  • enabled : bool = True

def add_candle_series(...)

Adds a candle series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • date : List[float]

  • opens : List[float]

  • highs : List[float]

  • lows : List[float]

  • closes : List[float]

  • Keyword Only Arguments


  • tooltip : bool = True

  • bull_color : List[float] = (0, 255, 113, 255)

  • bear_color : List[float] = (218, 13, 79, 255)

  • weight : float = 0.25

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_character_remap(...)

Remaps characters.

Return Type: None

Parameters


  • destination : int

  • source : int

def add_checkbox(...)

Adds a checkbox widget.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : int = False

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = '' Overrides 'name' as value storage key

  • label : str = '' Overrides 'name' as label

  • show : bool = True Attempt to render

  • enabled : bool = True

def add_child(...)

Adds an embedded child window. Will show scrollbars when items do not fit. Must be followed by a call to end.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • show : bool = True Attempt to render

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • width : int = 0

  • height : int = 0

  • border : bool = True

  • autosize_x : bool = False Autosize the window to fit it's items in the x.

  • autosize_y : bool = False Autosize the window to fit it's items in the y.

  • no_scrollbar : bool = False Disable scrollbars (window can still scroll with mouse or programmatically)

  • horizontal_scrollbar : bool = False Allow horizontal scrollbar to appear (off by default).

  • menubar : bool = False

def add_collapsing_header(...)

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

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • label : str = ''

  • show : bool = True Attempt to render

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • closable : bool = False

  • default_open : bool = False

  • open_on_double_click : bool = False Need double-click to open node

  • open_on_arrow : bool = False Only open when clicking on the arrow part.

  • leaf : bool = False No collapsing, no arrow (use as a convenience for leaf nodes).

  • bullet : bool = False Display a bullet instead of arrow

def add_color_button(...)

Adds a color button.

Return Type: None

Parameters


  • name : str

  • color : List[float]

  • Keyword Only Arguments


  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • width : int = 0

  • height : int = 0

  • show : bool = True Attemp to render

  • no_alpha : bool = False ignore Alpha component

  • no_border : bool = False disable border (which is enforced by default)

  • no_drag_drop : bool = False disable display of inline text label

def add_color_edit3(...)

Adds an rgb color editing widget. Click and draging the color square will copy the color to be applied on any other color widget.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0, 0, 255)

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • width : int = 0

  • height : int = 0

  • label : str = ''

  • show : bool = True Attempt to render

  • no_alpha : bool = False ignore Alpha component

  • no_picker : bool = False disable picker when clicking on colored square.

  • no_options : bool = False disable toggling options menu when right-clicking on inputs/small preview.

  • no_small_preview : bool = False disable colored square preview next to the inputs. For color pickers this only shows if the side preview is not shown.

  • no_inputs : bool = False disable inputs sliders/text widgets (e.g. to show only the small preview colored square)

  • no_tooltip : bool = False disable tooltip when hovering the preview.

  • no_label : bool = False disable display of inline text label

  • no_drag_drop : bool = False disable display of inline text label

  • alpha_bar : bool = False show vertical alpha bar/gradient in picker.

  • alpha_preview : bool = False display preview as a transparent color over a checkerboard, instead of opaque.

  • alpha_preview_half : bool = False display half opaque / half checkerboard, instead of opaque.

  • display_rgb : bool = False override display type among RGB/HSV/Hex.

  • display_hsv : bool = False override display type among RGB/HSV/Hex.

  • display_hex : bool = False override display type among RGB/HSV/Hex.

  • uint8 : bool = False display values formatted as 0..255

  • floats : bool = False display values formatted as 0.0f..1.0f floats instead of 0..255 integers.

  • input_rgb : bool = False input and output data in RGB format.

  • input_hsv : bool = False input and output data in HSV format.

def add_color_edit4(...)

Adds an rgba color editing widget. Click and draging the color square will copy the color to be applied on any other color widget.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0, 0, 255)

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • width : int = 0

  • height : int = 0

  • label : str = ''

  • show : bool = True Attempt to render

  • no_alpha : bool = False ignore Alpha component

  • no_picker : bool = False disable picker when clicking on colored square.

  • no_options : bool = False disable toggling options menu when right-clicking on inputs/small preview.

  • no_small_preview : bool = False 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 = False disable inputs sliders/text widgets (e.g. to show only the small preview colored square)

  • no_tooltip : bool = False disable tooltip when hovering the preview.

  • no_label : bool = False disable display of inline text label

  • no_drag_drop : bool = False disable display of inline text label

  • alpha_bar : bool = False show vertical alpha bar/gradient in picker.

  • alpha_preview : bool = False display preview as a transparent color over a checkerboard, instead of opaque.

  • alpha_preview_half : bool = False display half opaque / half checkerboard, instead of opaque.

  • display_rgb : bool = False override display type among RGB/HSV/Hex.

  • display_hsv : bool = False override display type among RGB/HSV/Hex.

  • display_hex : bool = False override display type among RGB/HSV/Hex.

  • uint8 : bool = False display values formatted as 0..255

  • floats : bool = False display values formatted as 0.0f..1.0f floats instead of 0..255 integers.

  • input_rgb : bool = False input and output data in RGB format.

  • input_hsv : bool = False input and output data in HSV format.

def add_color_picker3(...)

Adds an rgb color picking widget. Click and draging the color square will copy the color to be applied on any other color widget. Right Click allows the style of the color picker to be changed.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0, 0, 255)

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • width : int = 0

  • height : int = 0

  • label : str = ''

  • show : bool = True Attempt to render

  • no_alpha : bool = False ignore Alpha component

  • no_small_preview : bool = False 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 = False disable inputs sliders/text widgets (e.g. to show only the small preview colored square)

  • no_tooltip : bool = False disable tooltip when hovering the preview.

  • no_label : bool = False disable display of inline text label

  • no_side_preview : bool = False disable bigger color preview on right side of the picker, use small colored square preview instead , unless small preview is also hidden

  • alpha_bar : bool = False show vertical alpha bar/gradient in picker.

  • alpha_preview : bool = False display preview as a transparent color over a checkerboard, instead of opaque.

  • alpha_preview_half : bool = False display half opaque / half checkerboard, instead of opaque.

  • display_rgb : bool = False override display type among RGB/HSV/Hex.

  • display_hsv : bool = False override display type among RGB/HSV/Hex.

  • display_hex : bool = False override display type among RGB/HSV/Hex.

  • uint8 : bool = False display values formatted as 0..255

  • floats : bool = False display values formatted as 0.0f..1.0f floats instead of 0..255 integers.

  • picker_hue_bar : bool = False bar for Hue, rectangle for Sat/Value.

  • picker_hue_wheel : bool = False wheel for Hue, triangle for Sat/Value.

  • input_rgb : bool = False input and output data in RGB format.

  • input_hsv : bool = False input and output data in HSV format.

def add_color_picker4(...)

Adds an rgba color picking widget. Click and draging the color square will copy the color to be applied on any other color widget. Right Click allows the style of the color picker to be changed

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0, 0, 255)

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • width : int = 0

  • height : int = 0

  • label : str = ''

  • show : bool = True Attempt to render

  • no_alpha : bool = False ignore Alpha component

  • no_small_preview : bool = False 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 = False disable inputs sliders/text widgets (e.g. to show only the small preview colored square)

  • no_tooltip : bool = False disable tooltip when hovering the preview.

  • no_label : bool = False disable display of inline text label

  • no_side_preview : bool = False disable bigger color preview on right side of the picker, use small colored square preview instead , unless small preview is also hidden

  • alpha_bar : bool = False show vertical alpha bar/gradient in picker.

  • alpha_preview : bool = False display preview as a transparent color over a checkerboard, instead of opaque.

  • alpha_preview_half : bool = False display half opaque / half checkerboard, instead of opaque.

  • display_rgb : bool = False override display type among RGB/HSV/Hex.

  • display_hsv : bool = False override display type among RGB/HSV/Hex.

  • display_hex : bool = False override display type among RGB/HSV/Hex.

  • uint8 : bool = False display values formatted as 0..255

  • floats : bool = False display values formatted as 0.0f..1.0f floats instead of 0..255 integers.

  • picker_hue_bar : bool = False bar for Hue, rectangle for Sat/Value.

  • picker_hue_wheel : bool = False wheel for Hue, triangle for Sat/Value.

  • input_rgb : bool = False input and output data in RGB format.

  • input_hsv : bool = False input and output data in HSV format.

def add_column(...)

Adds a column to the end of a table.

Return Type: None

Parameters


  • table : str

  • name : str

  • column : List[str]

def add_columns(...)

Sets columns.

Return Type: None

Parameters


  • name : str

  • columns : int

  • Keyword Only Arguments


  • border : bool = True show border

  • show : bool = True Attempt to render

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

def add_combo(...)

Adds a combo.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • items : List[str] = ()

  • default_value : str = ''

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = '' Overrides 'name' as value storage key

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • label : str = '' Overrides 'name' as label

  • show : bool = True Attemp to render

  • popup_align_left : bool = False Align the popup toward the left by default

  • height_small : bool = False Max ~4 items visible

  • height_regular : bool = False Max ~8 items visible (default)

  • height_large : bool = False Max ~20 items visible

  • height_largest : bool = False As many items visible as possible

  • no_arrow_button : bool = False Display on the preview box without the square arrow button

  • no_preview : bool = False Display only a square arrow button

def add_data(...)

Adds data for later retrieval.

Return Type: None

Parameters


  • name : str

  • data : Any

def add_date_picker(...)

Adds a data selector widget.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : dict = {'month_day': 14, 'year':20, 'month':5} data dict

  • level : int = 0 0-day, 1-month, 2-year

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • show : bool = True Attempt to render

def add_debug_window(...)

Creates a debug window.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • width : int = 700

  • height : int = 500

  • x_pos : int = 200 x position the window will start at

  • y_pos : int = 200 y position the window will start at

  • autosize : bool = False Autosized the window to fit it's items.

  • no_resize : bool = False Allows for the window size to be changed or fixed

  • no_title_bar : bool = False Title name for the title bar of the window

  • no_move : bool = False Allows for the window's position to be changed or fixed

  • no_scrollbar : bool = False Disable scrollbars (window can still scroll with mouse or programmatically)

  • no_collapse : bool = False Disable user collapsing window by double-clicking on it

  • horizontal_scrollbar : bool = False Allow horizontal scrollbar to appear (off by default).

  • no_focus_on_appearing : bool = False Disable taking focus when transitioning from hidden to visible state

  • no_bring_to_front_on_focus : bool = False Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)

  • no_close : bool = False

  • no_background : bool = False

  • label : str = ''

  • show : bool = True Attempt to render

def add_doc_window(...)

Creates a documentation window.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • width : int = -1

  • height : int = -1

  • x_pos : int = 200 x position the window will start at

  • y_pos : int = 200 y position the window will start at

  • autosize : bool = True Autosized the window to fit it's items.

  • no_resize : bool = False Allows for the window size to be changed or fixed

  • no_title_bar : bool = False Title name for the title bar of the window

  • no_move : bool = False Allows for the window's position to be changed or fixed

  • no_scrollbar : bool = False Disable scrollbars (window can still scroll with mouse or programmatically)

  • no_collapse : bool = False Disable user collapsing window by double-clicking on it

  • horizontal_scrollbar : bool = False Allow horizontal scrollbar to appear (off by default).

  • no_focus_on_appearing : bool = False Disable taking focus when transitioning from hidden to visible state

  • no_bring_to_front_on_focus : bool = False Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)

  • no_close : bool = False

  • no_background : bool = False

  • label : str = ''

  • show : bool = True Attempt to render

def add_drag_float(...)

Adds drag for a single float value. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : float = 0.0

  • speed : float = 1.0

  • min_value : float = 0.0

  • max_value : float = 100.0

  • format : str = '%0.3f'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_drag_float2(...)

Adds drag for a 2 float values. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[float] = (0.0, 0.0)

  • speed : float = 1.0

  • min_value : float = 0.0

  • max_value : float = 100.0

  • format : str = '%0.3f'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_drag_float3(...)

Adds drag for a 3 float values. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[float] = (0.0, 0.0, 0.0)

  • speed : float = 1.0

  • min_value : float = 0.0

  • max_value : float = 100.0

  • format : str = '%0.3f'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_drag_float4(...)

Adds drag for a 4 float values. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[float] = (0.0, 0.0, 0.0, 0.0)

  • speed : float = 1.0

  • min_value : float = 0.0

  • max_value : float = 100.0

  • format : str = '%0.3f'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_drag_int(...)

Adds drag for a single int value. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : int = 0

  • speed : float = 1.0

  • min_value : int = 0

  • max_value : int = 100

  • format : str = '%d'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_drag_int2(...)

Adds drag for a 2 int values. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0)

  • speed : float = 1.0

  • min_value : int = 0

  • max_value : int = 100

  • format : str = '%d'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_drag_int3(...)

Adds drag for a 3 int values. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0, 0)

  • speed : float = 1.0

  • min_value : int = 0

  • max_value : int = 100

  • format : str = '%d'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_drag_int4(...)

Adds drag for a 4 int values. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0, 0, 0)

  • speed : float = 1.0

  • min_value : int = 0

  • max_value : int = 100

  • format : str = '%d'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_drag_line(...)

Adds a drag line to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • Keyword Only Arguments


  • source : str = ''

  • color : List[float] = (0, 0, 0, -1)

  • thickness : float = -1

  • y_line : bool = False

  • show_label : bool = True

  • callback : Callable = None function to run when line is dragged

  • default_value : float = 0.0

def add_drag_point(...)

Adds a drag point to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • Keyword Only Arguments


  • source : str = ''

  • color : List[float] = (0, 0, 0, -1)

  • radius : float = 4.0

  • show_label : bool = True

  • callback : Callable = None function to run when point is moved

  • default_x : float = 0.0

  • default_y : float = 0.0

def add_drawing(...)

Adds a drawing widget.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • width : int = 0

  • height : int = 0

  • show : bool = True Attempt to render

def add_dummy(...)

Adds a spacer or 'dummy' object.

Return Type: None

Parameters


  • Keyword Only Arguments

  • width : int = 0

  • height : int = 0

  • name : str = 'dummy'

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • show : bool = True Attempt to render

def add_error_series(...)

Adds an error series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • x : List[float]

  • y : List[float]

  • negative : List[float]

  • positive : List[float]

  • Keyword Only Arguments


  • horizontal : bool = False

  • update_bounds : bool = True update plot bounds

  • color : List[float] = (0, 0, 0, -1)

  • axis : int = 0

def add_group(...)

Creates a group that other widgets can belong to. The group allows item commands to be issued for all of its members. Must be closed with the end command.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • show : bool = True Attempt to render

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • width : int = 0

  • horizontal : bool = False

  • horizontal_spacing : float = -1

def add_heat_series(...)

Adds a heat series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • values : List[float]

  • rows : int

  • columns : int

  • scale_min : float

  • scale_max : float

  • Keyword Only Arguments


  • format : str = '%0.1f'

  • bounds_min : List[float] = (0.0, 0.0)

  • bounds_max : List[float] = (1.0, 1.0)

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_hline_series(...)

Adds a infinite horizontal line series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • x : List[float]

  • Keyword Only Arguments


  • color : List[float] = (0, 0, 0, -1)

  • weight : float = 1.0

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_image(...)

Adds an image.uv_min and uv_max represent the normalized texture coordinates of the original image that will be shown.Using(0,0)->(1,1) texture coordinates will generally display the entire texture

Return Type: None

Parameters


  • name : str

  • value : str

  • Keyword Only Arguments


  • tint_color : List[float] = (255, 255, 255, 255)

  • border_color : List[float] = (0, 0, 0, 0)

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = '' data source for shared data

  • width : int = 0

  • height : int = 0

  • uv_min : List[float] = (0.0, 0.0) normalized texture coordinates

  • uv_max : List[float] = (1.0, 1.0) normalized texture coordinates

  • show : bool = True Attempt to render

def add_image_button(...)

Adds an image button.uv_min and uv_max represent the normalized texture coordinates of the original image that will be shown.Using(0,0)->(1,1) texture coordinates will generally display the entire texture

Return Type: None

Parameters


  • name : str

  • value : str

  • Keyword Only Arguments


  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tint_color : List[float] = (255, 255, 255, 255)

  • background_color : List[float] = (0, 0, 0, 0)

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • width : int = 0

  • height : int = 0

  • frame_padding : int = -1

  • uv_min : List[float] = (0.0, 0.0) normalized texture coordinates

  • uv_max : List[float] = (1.0, 1.0) normalized texture coordinates

  • show : bool = True Attempt to render

def add_image_series(...)

Adds a image series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • value : str

  • bounds_min : List[float] bottom left coordinate

  • bounds_max : List[float] top right coordinate

  • Keyword Only Arguments


  • uv_min : List[float] = (0.0, 0.0) normalized texture coordinates

  • uv_max : List[float] = (1.0, 1.0) normalized texture coordinates

  • tint_color : List[int] = (255, 255, 255, 255)

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_indent(...)

Adds an indent to following items. Must be closed with the unindent command.

Return Type: None

Parameters


  • Keyword Only Arguments

  • name : str = 'indent'

  • offset : float = 0.0

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • show : bool = True Attempt to render

def add_input_float(...)

Adds input for float values.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : float = 0.0

  • min_value : float = 0

  • max_value : float = 100

  • min_clamped : bool = False activates and deactivates min_value

  • max_clamped : bool = False activates and deactivates max_value

  • format : str = '%.3f'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • on_enter : bool = False Only runs callback on enter

  • label : str = ''

  • show : bool = True Attempt to render

  • step : float = 0.1

  • step_fast : float = 1.0

  • readonly : bool = False

def add_input_float2(...)

Adds input for 2 float values.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[float] = (0.0, 0.0)

  • min_value : float = 0

  • max_value : float = 100

  • min_clamped : bool = False activates and deactivates min_value

  • max_clamped : bool = False activates and deactivates max_value

  • format : str = '%.3f'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • on_enter : bool = False Only runs callback on enter

  • label : str = ''

  • show : bool = True Attempt to render

  • readonly : bool = False

def add_input_float3(...)

Adds input for 3 float values.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[float] = (0.0, 0.0, 0.0)

  • min_value : float = 0

  • max_value : float = 100

  • min_clamped : bool = False activates and deactivates min_value

  • max_clamped : bool = False activates and deactivates max_value

  • format : str = '%.3f'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • on_enter : bool = False Only runs callback on enter

  • label : str = ''

  • show : bool = True Attempt to render

  • readonly : bool = False

def add_input_float4(...)

Adds input for 4 float values.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[float] = (0.0, 0.0, 0.0, 0.0)

  • min_value : float = 0

  • max_value : float = 100

  • min_clamped : bool = False activates and deactivates min_value

  • max_clamped : bool = False activates and deactivates max_value

  • format : str = '%.3f'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • on_enter : bool = False Only runs callback on enter

  • label : str = ''

  • show : bool = True Attempt to render

  • readonly : bool = False

def add_input_int(...)

Adds input for integer values.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : int = 0

  • min_value : int = 0

  • max_value : int = 100

  • min_clamped : bool = False activates and deactivates min_value

  • max_clamped : bool = False activates and deactivates max_value

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • on_enter : bool = False Only runs callback on enter

  • label : str = ''

  • show : bool = True Attempt to render

  • step : int = 1

  • step_fast : int = 100

  • readonly : bool = False

def add_input_int2(...)

Adds input for 2 integer values.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0)

  • min_value : int = 0

  • max_value : int = 100

  • min_clamped : bool = False activates and deactivates min_value

  • max_clamped : bool = False activates and deactivates max_value

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • on_enter : bool = False Only runs callback on enter

  • label : str = ''

  • show : bool = True Attempt to render

  • readonly : bool = False

def add_input_int3(...)

Adds input for 3 integer values.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0, 0)

  • min_value : int = 0

  • max_value : int = 100

  • min_clamped : bool = False activates and deactivates min_value

  • max_clamped : bool = False activates and deactivates max_value

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • on_enter : bool = False Only runs callback on enter

  • label : str = ''

  • show : bool = True Attempt to render

  • readonly : bool = False

def add_input_int4(...)

Adds input for 4 integer values.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0, 0, 0)

  • min_value : int = 0

  • max_value : int = 100

  • min_clamped : bool = False activates and deactivates min_value

  • max_clamped : bool = False activates and deactivates max_value

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • on_enter : bool = False Only runs callback on enter

  • label : str = ''

  • show : bool = True Attempt to render

  • readonly : bool = False

def add_input_text(...)

Adds input for text values.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : str = ''

  • hint : str = ''

  • multiline : bool = False

  • no_spaces : bool = False Filter out spaces, tabs

  • uppercase : bool = False

  • tab_input : bool = False Allows tabs to be input instead of changing widget focus

  • decimal : bool = False Allow 0123456789.+-*/

  • hexadecimal : bool = False Allow 0123456789ABCDEFabcdef

  • readonly : bool = False

  • password : bool = False Password mode, display all characters as '*'

  • scientific : bool = False Allow 0123456789.+-*/eE (Scientific notation input)

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • height : int = 0

  • on_enter : bool = False Only runs callback on enter

  • label : str = ''

  • show : bool = True Attempt to render

def add_label_text(...)

Adds text with a label. Useful for output values.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : str = ''

  • color : List[float] = (0, 0, 0, -1)

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = '' data source for shared data

  • label : str = ''

  • show : bool = True Attempt to render

def add_line_series(...)

Adds a line series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • x : List[float]

  • y : List[float]

  • Keyword Only Arguments


  • color : List[float] = (0, 0, 0, -1)

  • weight : float = 1.0

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_listbox(...)

Adds a listbox.

Return Type: None

Parameters


  • name : str Name of the listbox

  • Keyword Only Arguments


  • items : List[str] = ()

  • default_value : int = 0

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • num_items : int = 3 number of items to show

  • label : str = ''

  • show : bool = True Attempt to render

def add_logger(...)

Adds a logging widget.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • log_level : int = 1

  • auto_scroll : bool = True auto scroll

  • auto_scroll_button : bool = True show auto scroll button

  • clear_button : bool = True show clear button

  • copy_button : bool = True show copy button

  • filter : bool = True show filter

  • width : int = 0

  • height : int = 0

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • show : bool = True Attempt to render

  • autosize_x : bool = False

  • autosize_y : bool = False

def add_managed_columns(...)

Adds managed columns.

Return Type: None

Parameters


  • name : str

  • columns : int

  • Keyword Only Arguments


  • border : bool = True show border

  • show : bool = True Attempt to render

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

def add_menu(...)

Adds a menu to an existing menu bar. Must be followed by a call to end.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • label : str = ''

  • show : bool = True Attempt to render

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • enabled : bool = True

def add_menu_bar(...)

Adds a menu bar to a window. Must be followed by a call to end.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • show : bool = True Attempt to render

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

def add_menu_item(...)

Adds a menu item to an existing menu.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • shortcut : str = '' Adds a shortcut

  • check : bool = False Makes menu with checkmarks.

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • label : str = ''

  • show : bool = True Attempt to render

  • enabled : bool = True

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

def add_metrics_window(...)

Creates a metrics window.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • width : int = 700

  • height : int = 500

  • x_pos : int = 200 x position the window will start at

  • y_pos : int = 200 y position the window will start at

  • autosize : bool = False Autosized the window to fit it's items.

  • no_resize : bool = False Allows for the window size to be changed or fixed

  • no_title_bar : bool = False Title name for the title bar of the window

  • no_move : bool = False Allows for the window's position to be changed or fixed

  • no_scrollbar : bool = False Disable scrollbars (window can still scroll with mouse or programmatically)

  • no_collapse : bool = False Disable user collapsing window by double-clicking on it

  • horizontal_scrollbar : bool = False Allow horizontal scrollbar to appear (off by default).

  • no_focus_on_appearing : bool = False Disable taking focus when transitioning from hidden to visible state

  • no_bring_to_front_on_focus : bool = False Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)

  • no_close : bool = False

  • no_background : bool = False

  • label : str = ''

  • show : bool = True Attempt to render

def add_next_column(...)

Changes to next column.

Return Type: None

Parameters


  • Keyword Only Arguments

  • name : str = 'next_collumn'

  • show : bool = True Attempt to render

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

def add_node(...)

Adds a node to a node editor.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • show : bool = True Attempt to render

  • label : str = ''

  • draggable : bool = True Allow node to be draggable.

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • x_pos : int = 100 x position the node will start at

  • y_pos : int = 100 y position the node will start at

def add_node_attribute(...)

Adds a node attribute.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • output : bool = False Set as output attribute

  • static : bool = False Set as static attribute

  • show : bool = True Attempt to render

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

def add_node_editor(...)

Adds a node editor.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • show : bool = True Attempt to render

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • link_callback : Callable = None Callback ran when a new link is created.

  • delink_callback : Callable = None Callback ran when a link is detached.

Adds a node link between nodes.

Return Type: None

Parameters


  • node_editor : str

  • node_1 : str

  • node_2 : str

def add_pie_series(...)

Adds a pie series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • values : List[float]

  • labels : List[str]

  • x : float

  • y : float

  • radius : float

  • Keyword Only Arguments


  • normalize : bool = False

  • angle : float = 90.0

  • format : str = '%0.2f'

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_plot(...)

Adds a plot widget.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • x_axis_name : str = ''

  • y_axis_name : str = ''

  • no_legend : bool = False

  • no_menus : bool = False

  • no_box_select : bool = False

  • no_mouse_pos : bool = False

  • no_highlight : bool = False

  • no_child : bool = False

  • query : bool = False

  • crosshairs : bool = False

  • anti_aliased : bool = False

  • equal_aspects : bool = False

  • yaxis2 : bool = False

  • yaxis3 : bool = False

  • xaxis_no_gridlines : bool = False

  • xaxis_no_tick_marks : bool = False

  • xaxis_no_tick_labels : bool = False

  • xaxis_log_scale : bool = False

  • xaxis_time : bool = False

  • xaxis_invert : bool = False

  • xaxis_lock_min : bool = False

  • xaxis_lock_max : bool = False

  • yaxis_no_gridlines : bool = False

  • yaxis_no_tick_marks : bool = False

  • yaxis_no_tick_labels : bool = False

  • yaxis_log_scale : bool = False

  • yaxis_invert : bool = False

  • yaxis_lock_min : bool = False

  • yaxis_lock_max : bool = False

  • y2axis_no_gridlines : bool = False

  • y2axis_no_tick_marks : bool = False

  • y2axis_no_tick_labels : bool = False

  • y2axis_log_scale : bool = False

  • y2axis_invert : bool = False

  • y2axis_lock_min : bool = False

  • y2axis_lock_max : bool = False

  • y3axis_no_gridlines : bool = False

  • y3axis_no_tick_marks : bool = False

  • y3axis_no_tick_labels : bool = False

  • y3axis_log_scale : bool = False

  • y3axis_invert : bool = False

  • y3axis_lock_min : bool = False

  • y3axis_lock_max : bool = False

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • width : int = -1

  • height : int = -1

  • query_callback : Callable = None Callback ran when plot is queried. Should be of the form 'def Callback(sender, data)' Data is (x_min, x_max, y_min, y_max).

  • show_color_scale : bool = False

  • scale_min : float = 0.0

  • scale_max : float = 1.0

  • scale_height : int = 100

  • label : str = ''

  • show : bool = True Attempt to render

  • show_annotations : bool = True

  • show_drag_lines : bool = True

  • show_drag_points : bool = True

def add_popup(...)

Adds a popup window for an item. This command must come immediately after the item the popup is for. Must be followed by a call to end.

Return Type: None

Parameters


  • popupparent : str Parent that the popup will be assigned to.

  • name : str

  • Keyword Only Arguments


  • mousebutton : int = 1 The mouse code that will trigger the popup.

  • modal : bool = False

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • width : int = 0

  • height : int = 0

  • show : bool = True Attempt to render

def add_progress_bar(...)

Adds a progress bar.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : float = 0.0 value from 0 to 1

  • overlay : str = '' overlayed text

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = '' data source for shared data

  • width : int = 0

  • height : int = 0

  • show : bool = True Attempt to render

def add_radio_button(...)

Adds a set of radio buttons. If items is empty, nothing will be shown.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • items : List[str] = ()

  • default_value : int = 0

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • horizontal : bool = False

  • show : bool = True Attempt to render

def add_row(...)

Adds a row to the end of a table.

Return Type: None

Parameters


  • table : str

  • row : List[str]

def add_same_line(...)

Places a widget on the same line as the previous widget. Can also be used for horizontal spacing.

Return Type: None

Parameters


  • Keyword Only Arguments

  • name : str = 'sameline'

  • xoffset : float = 0.0 offset from containing window

  • spacing : float = -1.0 offset from previous widget

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • show : bool = True Attempt to render

def add_scatter_series(...)

Adds a scatter series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • x : List[float]

  • y : List[float]

  • Keyword Only Arguments


  • marker : int = 0

  • size : float = 4.0

  • weight : float = 1.0

  • outline : List[float] = (0, 0, 0, -1)

  • fill : List[float] = (0, 0, 0, -1)

  • update_bounds : bool = True update plot bounds

  • xy_data_format : bool = False split x and y

  • axis : int = 0

def add_selectable(...)

Adds a selectable.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : bool = False

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • label : str = ''

  • show : bool = True Attempt to render

  • span_columns : bool = False span all columns

def add_separator(...)

Adds a horizontal line.

Return Type: None

Parameters


  • Keyword Only Arguments

  • name : str = 'separator'

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

def add_shade_series(...)

Adds a shade series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • x : List[float]

  • y1 : List[float]

  • Keyword Only Arguments


  • y2 : List[float] = …

  • color : List[float] = (0, 0, 0, -1)

  • fill : List[float] = (0, 0, 0, -1)

  • weight : float = 1.0

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_simple_plot(...)

A simple plot for visualization of a set of values

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • value : List[float] = () Tuple of float values

  • overlay : str = '' overlays text (similar to a plot title)

  • minscale : float = 0.0 used if autoscale is false

  • maxscale : float = 0.0 used if autoscale is false

  • histogram : bool = False create a histogram

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • width : int = 0

  • height : int = 0

  • source : str = ''

  • label : str = ''

  • show : bool = True Attempt to render

def add_slider_float(...)

Adds slider for a single float value. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : float = 0.0

  • min_value : float = 0.0

  • max_value : float = 100.0

  • format : str = '%.3f'

  • vertical : bool = False sets orientation to vertical

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • height : int = 0 Height of a vertical slider

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_slider_float2(...)

Adds slider for a 2 float values. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[float] = (0.0, 0.0)

  • min_value : float = 0.0

  • max_value : float = 100.0

  • format : str = '%.3f'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_slider_float3(...)

Adds slider for a 3 float values. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[float] = (0.0, 0.0, 0.0)

  • min_value : float = 0.0

  • max_value : float = 100.0

  • format : str = '%.3f'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_slider_float4(...)

Adds slider for a 4 float values. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[float] = (0.0, 0.0, 0.0, 0.0)

  • min_value : float = 0.0

  • max_value : float = 100.0

  • format : str = '%.3f'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_slider_int(...)

Adds slider for a single int value. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : int = 0

  • min_value : int = 0

  • max_value : int = 100

  • format : str = '%d'

  • vertical : bool = False sets orientation to vertical

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • height : int = 0 Height of a vertical slider

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_slider_int2(...)

Adds slider for a 2 int values. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0)

  • min_value : int = 0

  • max_value : int = 100

  • format : str = '%d'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_slider_int3(...)

Adds slider for a 3 int values. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0, 0)

  • min_value : int = 0

  • max_value : int = 100

  • format : str = '%d'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_slider_int4(...)

Adds slider for a 4 int values. CTRL+Click to directly modify the value.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : List[int] = (0, 0, 0, 0)

  • min_value : int = 0

  • max_value : int = 100

  • format : str = '%d'

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • enabled : bool = True Display grayed out text so selectable cannot be selected

  • width : int = 0

  • no_input : bool = False Disable CTRL+Click or Enter key allowing to input text directly into the widget

  • clamped : bool = False Clamp value to min/max bounds when input manually with CTRL+Click. By default CTRL+Click allows going out of bounds.

  • label : str = ''

  • show : bool = True Attempt to render

def add_spacing(...)

Adds vertical spacing.

Return Type: None

Parameters


  • Keyword Only Arguments

  • name : str = 'spacing'

  • count : int = 1

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • show : bool = True Attempt to render

def add_stair_series(...)

Adds a stair series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • x : List[float]

  • y : List[float]

  • Keyword Only Arguments


  • color : List[float] = (0, 0, 0, -1)

  • weight : float = 1.0

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_stem_series(...)

Adds a stem series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • x : List[float]

  • y : List[float]

  • Keyword Only Arguments


  • marker : int = 0

  • size : float = 4.0

  • weight : float = 1.0

  • outline : List[float] = (0, 0, 0, -1)

  • fill : List[float] = (0, 0, 0, -1)

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_style_window(...)

Creates a style window.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • width : int = 700

  • height : int = 500

  • x_pos : int = 200 x position the window will start at

  • y_pos : int = 200 y position the window will start at

  • autosize : bool = False Autosized the window to fit it's items.

  • no_resize : bool = False Allows for the window size to be changed or fixed

  • no_title_bar : bool = False Title name for the title bar of the window

  • no_move : bool = False Allows for the window's position to be changed or fixed

  • no_scrollbar : bool = False Disable scrollbars (window can still scroll with mouse or programmatically)

  • no_collapse : bool = False Disable user collapsing window by double-clicking on it

  • horizontal_scrollbar : bool = False Allow horizontal scrollbar to appear (off by default).

  • no_focus_on_appearing : bool = False Disable taking focus when transitioning from hidden to visible state

  • no_bring_to_front_on_focus : bool = False Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)

  • no_close : bool = False

  • no_background : bool = False

  • label : str = ''

  • show : bool = True Attempt to render

def add_tab(...)

Adds a tab to a tab bar. Must be closed with the end command.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • closable : bool = False creates a button on the tab that can hide the tab

  • label : str = ''

  • show : bool = True Attempt to render

  • no_reorder : bool = False Disable reordering this tab or having another tab cross over this tab

  • leading : bool = False Enforce the tab position to the left of the tab bar (after the tab list popup button)

  • trailing : bool = False Enforce the tab position to the right of the tab bar (before the scrolling buttons)

  • no_tooltip : bool = False Disable tooltip for the given tab

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

def add_tab_bar(...)

Adds a tab bar.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • reorderable : bool = False allows for moveable tabs

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • show : bool = True Attempt to render

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

def add_tab_button(...)

Adds a tab button to a tab bar

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • label : str = ''

  • show : bool = True Attempt to render

  • no_reorder : bool = False Disable reordering this tab or having another tab cross over this tab

  • leading : bool = False Enforce the tab position to the left of the tab bar (after the tab list popup button)

  • trailing : bool = False Enforce the tab position to the right of the tab bar (before the scrolling buttons)

  • no_tooltip : bool = False Disable tooltip for the given tab

  • tip : str = '' Adds a simple tooltip

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

def add_table(...)

Adds table.

Return Type: None

Parameters


  • name : str

  • headers : List[str]

  • Keyword Only Arguments


  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • width : int = 0

  • height : int = 200

  • hide_headers : bool = False Hide headers of the table

  • show : bool = True Attempt to render

def add_text(...)

Adds text

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • wrap : int = -1 number of characters until wraping

  • color : List[float] = (0, 0, 0, -1) color of the text (rgba)

  • bullet : bool = False makes the text bulleted

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • source : str = ''

  • default_value : str = ''

  • show : bool = True Attempt to render

def add_text_point(...)

Adds a point with text to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • x : float

  • y : float

  • Keyword Only Arguments


  • vertical : bool = False

  • xoffset : int = 0.0

  • yoffset : int = 0.0

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_texture(...)

Adds a texture.

Return Type: None

Parameters


  • name : str

  • data : List[int] RGBA format

  • width : int

  • height : int

  • Keyword Only Arguments


  • format : int = 0 mvTEX_XXXX_XXXXX constants
def add_time_picker(...)

Adds a time selector widget.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • default_value : dict = {'hour': 14, 'min': 32, 'sec': 23} time dict

  • hour24 : bool = False show 24 hour clock

  • callback : Callable = None Registers a callback

  • callback_data : Any = None Callback data

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent this item will be added to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • show : bool = True Attempt to render

def add_tooltip(...)

Adds an advanced tool tip for an item. This command must come immediately after the item the tip is for.

Return Type: None

Parameters


  • tipparent : str Sets the item's tool tip to be the same as the named item's tool tip

  • name : str

  • Keyword Only Arguments


  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • show : bool = True Attempt to render

def add_tree_node(...)

Adds a tree node to add items to. Must be closed with the end command.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • label : str = ''

  • show : bool = True Attempt to render

  • tip : str = '' Adds a simple tooltip

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • default_open : bool = False

  • open_on_double_click : bool = False Need double-click to open node

  • open_on_arrow : bool = False Only open when clicking on the arrow part.

  • leaf : bool = False No collapsing, no arrow (use as a convenience for leaf nodes).

  • bullet : bool = False Display a bullet instead of arrow

def add_value(...)

Adds a value to the value storage.

Return Type: None

Parameters


  • name : str

  • value : Any

def add_vline_series(...)

Adds a infinite vertical line series to a plot.

Return Type: None

Parameters


  • plot : str

  • name : str

  • x : List[float]

  • Keyword Only Arguments


  • color : List[float] = (0, 0, 0, -1)

  • weight : float = 1.0

  • update_bounds : bool = True update plot bounds

  • axis : int = 0

def add_window(...)

Creates a new window for following items to be added to.

Return Type: None

Parameters


  • name : str

  • Keyword Only Arguments


  • width : int = -1

  • height : int = -1

  • x_pos : int = 200 x position the window will start at

  • y_pos : int = 200 y position the window will start at

  • autosize : bool = False Autosized the window to fit it's items.

  • no_resize : bool = False Allows for the window size to be changed or fixed

  • no_title_bar : bool = False Title name for the title bar of the window

  • no_move : bool = False Allows for the window's position to be changed or fixed

  • no_scrollbar : bool = False Disable scrollbars (window can still scroll with mouse or programmatically)

  • no_collapse : bool = False Disable user collapsing window by double-clicking on it

  • horizontal_scrollbar : bool = False Allow horizontal scrollbar to appear (off by default).

  • no_focus_on_appearing : bool = False Disable taking focus when transitioning from hidden to visible state

  • no_bring_to_front_on_focus : bool = False Disable bringing window to front when taking focus (e.g. clicking on it or programmatically giving it focus)

  • menubar : bool = False

  • no_close : bool = False

  • no_background : bool = False

  • label : str = ''

  • show : bool = True Attempt to render

  • collapsed : bool = False Collapse the window

  • on_close : Callable = None Callback ran when window is closed

def bring_draw_command_forward(...)

Brings draw command forward.

Return Type: None

Parameters


  • drawing : str

  • tag : str

def bring_draw_command_to_front(...)

Brings draw command to front.

Return Type: None

Parameters


  • drawing : str

  • tag : str

def cleanup_dearpygui(...)

Cleans up DearPyGui after calling setup_dearpygui.

Return Type: None

def clear_drawing(...)

Clears a drawing.

Return Type: None

Parameters


  • draw : str
def clear_item_color(...)

Clears individual color styles for an item.

Return Type: None

Parameters


  • item : str
def clear_item_style_vars(...)

Clears individual styles variables for an item.

Return Type: None

Parameters


  • item : str
def clear_log(...)

Clears the logger.

Return Type: None

Parameters


  • Keyword Only Arguments

  • logger : str = '' logger widget
def clear_plot(...)

Clears a plot.

Return Type: None

Parameters


  • plot : str

Clears selected links.

Return Type: None

Parameters


  • node_editor : str
def clear_selected_nodes(...)

Clears selected nodes.

Return Type: None

Parameters


  • node_editor : str
def clear_table(...)

Clears data in a table

Return Type: None

Parameters


  • table : str
def close_popup(...)

Closes a popup.

Return Type: None

Parameters


  • item : str
def configure_item(...)

Configures an item

Return Type: None

Parameters


  • item : str

  • **Kwargs

def decref_value(...)

Decreases the reference count of a value.

Return Type: None

Parameters


  • name : str
def decrement_texture(...)

Decrements a texture.

Return Type: None

Parameters


  • name : str
def delete_annotation(...)

Deletes an annotation

Return Type: None

Parameters


  • plot : str

  • name : str

def delete_column(...)

Delete a column in a table.

Return Type: None

Parameters


  • table : str

  • column : int

def delete_data(...)

Deletes data from storage.

Return Type: None

Parameters


  • name : str
def delete_drag_line(...)

Deletes a drag line if it exists.

Return Type: None

Parameters


  • plot : str

  • name : str

def delete_drag_point(...)

Deletes a drag point if it exists.

Return Type: None

Parameters


  • plot : str

  • name : str

def delete_draw_command(...)

Deletes a drawing item.

Return Type: None

Parameters


  • drawing : str

  • tag : str

def delete_item(...)

Deletes an item if it exists.

Return Type: None

Parameters


  • item : str

  • Keyword Only Arguments


  • children_only : bool = False delete children only

Deletes a node link if it exist.

Return Type: None

Parameters


  • node_editor : str

  • node_1 : str

  • node_2 : str

def delete_row(...)

Delete a row in a table.

Return Type: None

Parameters


  • table : str

  • row : int

def delete_series(...)

Deletes a series if it exists.

Return Type: None

Parameters


  • plot : str

  • series : str

def does_item_exist(...)

Checks if item exists.

Return Type: bool

Parameters


  • item : str
def draw_arrow(...)

Draws an arrow on a drawing.

Return Type: None

Parameters


  • drawing : str

  • p1 : List[float]

  • p2 : List[float]

  • color : List[int]

  • thickness : int

  • size : int

  • Keyword Only Arguments


  • tag : str = ''
def draw_bezier_curve(...)

Draws a bezier curve on a drawing.

Return Type: None

Parameters


  • drawing : str

  • p1 : List[float]

  • p2 : List[float]

  • p3 : List[float]

  • p4 : List[float]

  • color : List[int]

  • Keyword Only Arguments


  • thickness : float = 1.0

  • segments : int = 0

  • tag : str = ''

def draw_circle(...)

Draws a circle on a drawing.

Return Type: None

Parameters


  • drawing : str

  • center : List[float]

  • radius : float

  • color : List[int]

  • Keyword Only Arguments


  • segments : int = 0

  • thickness : float = 1.0

  • fill : List[float] = (0, 0, 0, -1)

  • tag : str = ''

def draw_image(...)

Draws an image on a drawing. p_min (top-left) and p_max (bottom-right) represent corners of the rectangle the image will be drawn to.Setting the p_min equal to the p_max will sraw the image to with 1:1 scale.uv_min and uv_max represent the normalized texture coordinates of the original image that will be shown. Using (0,0)->(1,1) texturecoordinates will generally display the entire texture.

Return Type: None

Parameters


  • drawing : str

  • file : str

  • pmin : List[float]

  • pmax : List[float]

  • Keyword Only Arguments


  • uv_min : List[float] = (0.0, 0.0) normalized texture coordinates

  • uv_max : List[float] = (1.0, 1.0) normalized texture coordinates

  • color : List[int] = (255, 255, 255, 255)

  • tag : str = ''

def draw_line(...)

Draws a line on a drawing.

Return Type: None

Parameters


  • drawing : str

  • p1 : List[float]

  • p2 : List[float]

  • color : List[int]

  • thickness : int

  • Keyword Only Arguments


  • tag : str = ''
def draw_polygon(...)

Draws a polygon on a drawing.

Return Type: None

Parameters


  • drawing : str

  • points : List[List[float]]

  • color : List[int]

  • Keyword Only Arguments


  • fill : List[float] = (0, 0, 0, -1)

  • thickness : float = 1.0

  • tag : str = ''

def draw_polyline(...)

Draws lines on a drawing.

Return Type: None

Parameters


  • drawing : str

  • points : List[List[float]]

  • color : List[int]

  • Keyword Only Arguments


  • closed : bool = False

  • thickness : float = 1.0

  • tag : str = ''

def draw_quad(...)

Draws a quad on a drawing.

Return Type: None

Parameters


  • drawing : str

  • p1 : List[float]

  • p2 : List[float]

  • p3 : List[float]

  • p4 : List[float]

  • color : List[int]

  • Keyword Only Arguments


  • fill : List[float] = (0, 0, 0, -1)

  • thickness : float = 1.0

  • tag : str = ''

def draw_rectangle(...)

Draws a rectangle on a drawing.

Return Type: None

Parameters


  • drawing : str

  • pmin : List[float]

  • pmax : List[float]

  • color : List[int]

  • Keyword Only Arguments


  • fill : List[float] = (0, 0, 0, -1)

  • rounding : float = 0.0

  • thickness : float = 1.0

  • tag : str = ''

def draw_text(...)

Draws text on a drawing.

Return Type: None

Parameters


  • drawing : str

  • pos : List[float]

  • text : str

  • Keyword Only Arguments


  • color : List[int] = (0, 0, 0, -1)

  • size : int = 10

  • tag : str = ''

def draw_triangle(...)

Draws a triangle on a drawing.

Return Type: None

Parameters


  • drawing : str

  • p1 : List[float]

  • p2 : List[float]

  • p3 : List[float]

  • color : List[int]

  • Keyword Only Arguments


  • fill : List[float] = (0, 0, 0, -1)

  • thickness : float = 1.0

  • tag : str = ''

def enable_docking(...)

Decrements a texture.

Return Type: None

Parameters


  • Keyword Only Arguments

  • shift_only : bool = True press shift for docking

  • dock_space : bool = False add explicit dockspace over viewport

def end(...)

Ends a container.

Return Type: None

def get_active_window(...)

Returns the active window name.

Return Type: str

def get_all_items(...)

Returns a list of all items.

Return Type: List[str]

def get_data(...)

Retrieves data from storage.

Return Type: object

Parameters


  • name : str
def get_dearpygui_version(...)

Returns the current version of Dear PyGui.

Return Type: str

def get_delta_time(...)

Returns time since last frame.

Return Type: float

def get_draw_command(...)

Returns an draw commands information

Return Type: dict

Parameters


  • drawing : str

  • tag : str

def get_drawing_mouse_pos(...)

Returns the current mouse position in the currently hovered drawing.

Return Type: (int, int)

def get_global_font_scale(...)

Returns the global font scale.

Return Type: float

def get_item_callback(...)

Returns an item' callback

Return Type: Callable

Parameters


  • item : str
def get_item_callback_data(...)

Returns an item' callback data

Return Type: Any

Parameters


  • item : str
def get_item_children(...)

Returns a list of an item's children.

Return Type: List[str]

Parameters


  • item : str
def get_item_configuration(...)

Returns an items configuration

Return Type: dict

Parameters


  • item : str
def get_item_parent(...)

Returns an item's parent.

Return Type: str

Parameters


  • item : str
def get_item_rect_max(...)

Returns an item's maximum allowable size. [width, height]

Return Type: [float, float]

Parameters


  • item : str
def get_item_rect_min(...)

Returns an item's minimum allowable size. [width, height]

Return Type: [float, float]

Parameters


  • item : str
def get_item_rect_size(...)

Returns an item's current size. [width, height]

Return Type: [float, float]

Parameters


  • item : str
def get_item_type(...)

Returns an item's type

Return Type: str

Parameters


  • item : str

Returns all links.

Return Type: List[List[str]]

Parameters


  • node_editor : str
def get_log_level(...)

Returns the log level.

Return Type: int

Parameters


  • Keyword Only Arguments

  • logger : str = '' logger widget
def get_main_window_size(...)

Returns the size of the main window.

Return Type: [int, int]

def get_managed_column_width(...)

Returns the width of the ith column.

Return Type: Float

Parameters


  • item : str

  • column : int

def get_mouse_drag_delta(...)

Returns the current mouse drag delta in pixels

Return Type: (float, float)

def get_mouse_pos(...)

Returns the current mouse position in relation to the active window (minus titlebar) unless local flag is unset.

Return Type: (int, int)

Parameters


  • Keyword Only Arguments

  • local : bool = True
def get_plot_mouse_pos(...)

Returns the current mouse position in the currently hovered plot.

Return Type: (int, int)

def get_plot_query_area(...)

Returns the bounding axis limits for the query area [x_min, x_max, y_min, y_max]

Return Type: List[float]

Parameters


  • plot : str
def get_plot_xlimits(...)

Returns the plots x limits

Return Type: List[float]

Parameters


  • plot : str
def get_plot_ylimits(...)

Returns the plots x limits

Return Type: List[float]

Parameters


  • plot : str

Returns selected links.

Return Type: List[List[str]]

Parameters


  • node_editor : str
def get_selected_nodes(...)

Returns selected nodes.

Return Type: List[str]

Parameters


  • node_editor : str
def get_style_antialiased_fill(...)

Gets anti-aliasing on filled shapes (rounded rectangles, circles, etc.).

Return Type: bool

def get_style_antialiased_lines(...)

Gets anti-aliasing on lines/borders.

Return Type: bool

def get_style_button_text_align(...)

Gets alignment of button text when button is larger than text. Defaults to (0.5, 0.5) (centered).

Return Type: List[float]

def get_style_child_border_size(...)

Gets thickness of border around child windows.

Return Type: float

def get_style_child_rounding(...)

Gets radius of child window corners rounding.

Return Type: float

def get_style_circle_segment_max_error(...)

Gets maximum error (in pixels) allowed when using draw_circle()or drawing rounded corner rectangles with no explicit segment count specified.

Return Type: float

def get_style_color_button_position(...)

Gets side of the color button in the ColorEdit4 widget (left/right). Defaults to mvGuiDir_Right.

Return Type: int

def get_style_curve_tessellation_tolerance(...)

Gets Tessellation tolerance.

Return Type: float

def get_style_display_safe_area_padding(...)

Gets safe area padding. Applies to popups/tooltips as well regular windows.

Return Type: List[float]

def get_style_frame_border_size(...)

Gets thickness of border around frames.

Return Type: float

def get_style_frame_padding(...)

Gets padding within a framed rectangle (used by most widgets).

Return Type: List[float]

def get_style_frame_rounding(...)

Gets radius of frame corners rounding.

Return Type: float

def get_style_global_alpha(...)

Gets global alpha applies to everything in Dear PyGui.

Return Type: float

def get_style_grab_min_size(...)

Gets minimum width/height of a grab box for slider/scrollbar.

Return Type: float

def get_style_grab_rounding(...)

Gets radius of grabs corners rounding. Set to 0.0 to have rectangular slider grabs.

Return Type: float

def get_style_indent_spacing(...)

Gets horizontal indentation when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2).

Return Type: float

def get_style_item_inner_spacing(...)

Gets horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label).

Return Type: List[float]

def get_style_item_spacing(...)

Gets horizontal and vertical spacing between widgets/lines.

Return Type: List[float]

def get_style_popup_border_size(...)

Gets thickness of border around popup/tooltip windows.

Return Type: float

def get_style_popup_rounding(...)

Gets radius of popup window corners rounding. (Note that tooltip windows use WindowRounding).

Return Type: float

def get_style_scrollbar_rounding(...)

Gets radius of grab corners for scrollbar.

Return Type: float

def get_style_scrollbar_size(...)

Gets width of the vertical scrollbar, Height of the horizontal scrollbar.

Return Type: float

def get_style_selectable_text_align(...)

Gets alignment of selectable text. Defaults to (0.0, 0.0) (top-left aligned).

Return Type: List[float]

def get_style_tab_border_size(...)

Gets thickness of border around tabs.

Return Type: float

def get_style_tab_rounding(...)

Gets radius of upper corners of a tab. Set to 0.0 to have rectangular tabs.

Return Type: float

def get_style_touch_extra_padding(...)

Get touch extra padding.

Return Type: List[float]

def get_style_window_border_size(...)

Gets thickness of border around windows.

Return Type: float

def get_style_window_menu_button_position(...)

Gets side of the collapsing/docking button in the title bar (None/Left/Right). Defaults to mvGuiDir_Left.

Return Type: int

def get_style_window_padding(...)

Gets padding within a window.

Return Type: List[float]

def get_style_window_rounding(...)

Gets radius of window corners rounding.

Return Type: float

def get_style_window_title_align(...)

Gets alignment for title bar text. Defaults to (0.0,0.5) for left-aligned,vertically centered.

Return Type: List[float]

def get_table_data(...)

Gets table data.

Return Type: List[List[str]]

Parameters


  • name : str
def get_table_item(...)

Gets a table's cell value.

Return Type: str

Parameters


  • table : str

  • row : int

  • column : int

def get_table_selections(...)

Retrieves data from storage.

Return Type: List[List[int]]

Parameters


  • table : str
def get_theme(...)

Returns the current theme.

Return Type: str

def get_theme_item(...)

Returns a theme item's color

Return Type: (float, float, float, float)

Parameters


  • item : int
def get_total_time(...)

Returns total time since app started.

Return Type: float

def get_value(...)

Returns an item's value or None if there is none.

Return Type: Any

Parameters


  • name : str
def get_windows(...)

Returns a list of windows.

Return Type: List[str]

def incref_value(...)

Increases the reference count of a value.

Return Type: None

Parameters


  • name : str
def insert_column(...)

Inserts a column into a table.

Return Type: None

Parameters


  • table : str

  • column_index : int

  • name : str

  • column : List[str]

def insert_row(...)

Inserts a row into a table.

Return Type: None

Parameters


  • table : str

  • row_index : int

  • row : List[str]

def is_dearpygui_running(...)

Checks if dearpygui is still running

Return Type: bool

def is_item_activated(...)

Checks if an item has been activated.

Return Type: bool

Parameters


  • item : str
def is_item_active(...)

Checks if an item is active.

Return Type: bool

Parameters


  • item : str
def is_item_clicked(...)

Checks if an item is clicked.

Return Type: bool

Parameters


  • item : str
def is_item_container(...)

Checks if an item is container.

Return Type: bool

Parameters


  • item : str
def is_item_deactivated(...)

Checks if an item has been deactivated.

Return Type: bool

Parameters


  • item : str
def is_item_deactivated_after_edit(...)

Checks if an item has been deactivated after editing.

Return Type: bool

Parameters


  • item : str
def is_item_edited(...)

Checks if an item has been edited.

Return Type: bool

Parameters


  • item : str
def is_item_focused(...)

Checks if an item is focused.

Return Type: bool

Parameters


  • item : str
def is_item_hovered(...)

Checks if an item is hovered.

Return Type: bool

Parameters


  • item : str
def is_item_shown(...)

Checks if an item is shown.

Return Type: bool

Parameters


  • item : str
def is_item_toggled_open(...)

Checks if an item is toggled.

Return Type: bool

Parameters


  • item : str
def is_item_visible(...)

Checks if an item is visible on screen.

Return Type: bool

Parameters


  • item : str
def is_key_down(...)

Checks if the key is down.

Return Type: bool

Parameters


  • key : int
def is_key_pressed(...)

Checks if the key is pressed.

Return Type: bool

Parameters


  • key : int
def is_key_released(...)

Checks if the key is released.

Return Type: bool

Parameters


  • key : int
def is_mouse_button_clicked(...)

Checks if the mouse button is clicked.

Return Type: bool

Parameters


  • button : int
def is_mouse_button_double_clicked(...)

Checks if the mouse button is double clicked.

Return Type: bool

Parameters


  • button : int
def is_mouse_button_down(...)

Checks if the mouse button is pressed.

Return Type: bool

Parameters


  • button : int
def is_mouse_button_dragging(...)

Checks if the mouse is dragging.

Return Type: bool

Parameters


  • button : int

  • threshold : float

def is_mouse_button_released(...)

Checks if the mouse button is released.

Return Type: bool

Parameters


  • button : int
def is_plot_queried(...)

Returns true if plot was queried

Return Type: bool

Parameters


  • plot : str
def log(...)

Logs a trace level log.

Return Type: None

Parameters


  • message : Any

  • Keyword Only Arguments


  • level : str = 'TRACE' logger widget

  • logger : str = '' logger widget

def log_debug(...)

Logs a debug level log.

Return Type: None

Parameters


  • message : Any

  • Keyword Only Arguments


  • logger : str = '' logger widget
def log_error(...)

Logs a error level log.

Return Type: None

Parameters


  • message : Any

  • Keyword Only Arguments


  • logger : str = '' logger widget
def log_info(...)

Logs a info level log.

Return Type: None

Parameters


  • message : Any

  • Keyword Only Arguments


  • logger : str = '' logger widget
def log_warning(...)

Logs a warning level log.

Return Type: None

Parameters


  • message : Any

  • Keyword Only Arguments


  • logger : str = '' logger widget
def modify_draw_command(...)

Configures an drawing command.

Return Type: None

Parameters


  • drawing : str

  • tag : str

  • **Kwargs

def move_item(...)

Moves an existing item.

Return Type: None

Parameters


  • item : str

  • Keyword Only Arguments


  • parent : str = ''

  • before : str = ''

def move_item_down(...)

Moves item down if possible and if it exists.

Return Type: None

Parameters


  • item : str
def move_item_up(...)

Moves item up if possible and if it exists.

Return Type: None

Parameters


  • item : str
def open_file_dialog(...)

Opens an 'open file' dialog.

Return Type: None

Parameters


  • Optional Arguments

  • callback : Callable = None function to call on completion

  • extensions : str = '' filters items with extensions i.e '.*, .py'

def render_dearpygui_frame(...)

Renders a DearPyGui frame. Should be called within a user's event loop. Must first call setup_dearpygui outside of event loop.

Return Type: None

def reset_xticks(...)

Sets plots x ticks and labels back to automatic

Return Type: None

Parameters


  • plot : str
def reset_yticks(...)

Sets plots y ticks and labels back to automatic

Return Type: None

Parameters


  • plot : str
def select_directory_dialog(...)

Opens a select directory dialog.

Return Type: None

Parameters


  • Optional Arguments

  • callback : Callable = None function to call on completion
def send_draw_command_back(...)

Sends draw command back.

Return Type: None

Parameters


  • drawing : str

  • tag : str

def send_draw_command_to_back(...)

Sends draw command to the back.

Return Type: None

Parameters


  • drawing : str

  • tag : str

def set_accelerator_callback(...)

Callback similar to keypress but used for accelerator keys.

Return Type: None

Parameters


  • callback : Any
def set_color_map(...)

Sets the color map of the plot's series.

Return Type: None

Parameters


  • plot : str

  • map : int

def set_exit_callback(...)

Callback to run when exiting main window.

Return Type: None

Parameters


  • callback : Any
def set_global_color(...)

Sets an color of a theme item.

Return Type: None

Parameters


  • id : int mvGuiCol_* constants

  • color : List[float]

def set_global_font_scale(...)

Changes the global font scale.

Return Type: None

Parameters


  • scale : float default is 1.0
def set_headers(...)

Sets a tables headers.

Return Type: None

Parameters


  • table : str

  • headers : List[str]

def set_individual_color(...)

Sets an color of a theme item.

Return Type: None

Parameters


  • item : str

  • id : int mvGuiCol_* constants

  • color : List[float]

def set_item_callback(...)

Sets an item's callback if applicable.

Return Type: None

Parameters


  • item : str

  • callback : Callable Registers a callback

  • Keyword Only Arguments


  • callback_data : Any = None Callback data
def set_item_callback_data(...)

Sets an item's callback data if applicable.

Return Type: None

Parameters


  • item : str

  • callback_data : Any Callback data

def set_item_color(...)

Sets an color style for a single item.

Return Type: None

Parameters


  • item : str

  • style : int mvGuiCol_* constants

  • color : List[float]

def set_item_style_var(...)

Sets an style variable for a single item.

Return Type: None

Parameters


  • item : str

  • style : int mvGuiStyleVar_* constants

  • value : List[float]

def set_key_down_callback(...)

Sets a callback for a key down event.

Return Type: None

Parameters


  • callback : Callable Registers a callback
def set_key_press_callback(...)

Sets a callback for a key press event.

Return Type: None

Parameters


  • callback : Callable Registers a callback
def set_key_release_callback(...)

Sets a callback for a key release event.

Return Type: None

Parameters


  • callback : Callable Registers a callback
def set_log_level(...)

Sets the log level.

Return Type: None

Parameters


  • level : int

  • Keyword Only Arguments


  • logger : str = '' logger widget
def set_logger_window_title(...)

Sets the title of the logger window.

Return Type: None

Parameters


  • title : str
def set_main_window_pos(...)

Sets the main window position.

Return Type: None

Parameters


  • x : int

  • y : int

def set_main_window_resizable(...)

Sets the main window to be resizable.

Return Type: None

Parameters


  • resizable : bool
def set_main_window_size(...)

Sets the main window size.

Return Type: None

Parameters


  • width : int

  • height : int

def set_main_window_title(...)

Sets the title of the main window.

Return Type: None

Parameters


  • title : str
def set_managed_column_width(...)

Sets the width of the ith column.

Return Type: None

Parameters


  • item : str

  • column : int

  • width : float

def set_mouse_click_callback(...)

Sets a callback for a mouse click event.

Return Type: None

Parameters


  • callback : Callable Registers a callback
def set_mouse_double_click_callback(...)

Sets a callback for a mouse double click event.

Return Type: None

Parameters


  • callback : Callable Registers a callback
def set_mouse_down_callback(...)

Sets a callback for a mouse down event.

Return Type: None

Parameters


  • callback : Callable Registers a callback
def set_mouse_drag_callback(...)

Sets a callback for a mouse drag event.

Return Type: None

Parameters


  • callback : Callable Registers a callback

  • threshold : float

def set_mouse_move_callback(...)

Sets a callback for a mouse move event. Data is the mouse position in local coordinates.

Return Type: None

Parameters


  • callback : Callable Registers a callback
def set_mouse_release_callback(...)

Sets a callback for a mouse release event.

Return Type: None

Parameters


  • callback : Callable Registers a callback
def set_mouse_wheel_callback(...)

Sets a callback for a mouse wheel event.

Return Type: None

Parameters


  • callback : Callable Registers a callback
def set_plot_xlimits(...)

Sets x axis limits of a plot. (can be undone with set_plot_xlimits_auto()

Return Type: None

Parameters


  • plot : str

  • xmin : float

  • xmax : float

def set_plot_xlimits_auto(...)

Sets plots x limits to be automatic.

Return Type: None

Parameters


  • plot : str
def set_plot_ylimits(...)

Sets y axis limits of a plot. (can be undone with set_plot_ylimits_auto()

Return Type: None

Parameters


  • plot : str

  • ymin : float

  • ymax : float

def set_plot_ylimits_auto(...)

Sets plots y limits to be automatic.

Return Type: None

Parameters


  • plot : str
def set_primary_window(...)

Sets the primary window to fill the viewport.

Return Type: None

Parameters


  • window : str

  • value : bool

def set_render_callback(...)

Sets the callback to be ran every frame.

Return Type: None

Parameters


  • callback : Callable Registers a callback
def set_resize_callback(...)

Sets a callback for a window resize event.

Return Type: None

Parameters


  • callback : Callable Registers a callback

  • Keyword Only Arguments


  • handler : str = '' Callback will be run when window is resized (default is viewport)
def set_start_callback(...)

Callback to run when starting main window.

Return Type: None

Parameters


  • callback : Any
def set_style_antialiased_fill(...)

Sets anti-aliasing on filled shapes (rounded rectangles, circles, etc.).

Return Type: None

Parameters


  • value : bool
def set_style_antialiased_lines(...)

Sets anti-aliasing on lines/borders. Disable if you are really tight on CPU/GPU.

Return Type: None

Parameters


  • value : bool
def set_style_button_text_align(...)

Sets alignment of button text when button is larger than text. Defaults to (0.5, 0.5) (centered).

Return Type: None

Parameters


  • x : float

  • y : float

def set_style_child_border_size(...)

Sets thickness of border around child windows. Generally set to 0.0 or 1.0. (Other values are not well tested and more CPU/GPU costly).

Return Type: None

Parameters


  • value : float
def set_style_child_rounding(...)

Sets radius of child window corners rounding. Set to 0.0 to have rectangular windows.

Return Type: None

Parameters


  • value : float
def set_style_circle_segment_max_error(...)

Sets maximum error (in pixels) allowed when using draw_circle()or drawing rounded corner rectangles with no explicit segment count specified. Decrease for higher quality but more geometry.

Return Type: None

Parameters


  • value : float
def set_style_color_button_position(...)

Sets side of the color button in the ColorEdit4 widget (left/right). Defaults to mvGuiDir_Right.

Return Type: None

Parameters


  • value : int
def set_style_curve_tessellation_tolerance(...)

Sets Tessellation tolerance.

Return Type: None

Parameters


  • value : float
def set_style_display_safe_area_padding(...)

Sets if you cannot see the edges of your screen (e.g. on a TV) increase the safe area padding. Apply to popups/tooltips as well regular windows. NB: Prefer configuring your TV sets correctly!

Return Type: None

Parameters


  • x : float

  • y : float

def set_style_frame_border_size(...)

Sets thickness of border around frames. Generally set to 0.0 or 1.0. (Other values are not well tested and more CPU/GPU costly).

Return Type: None

Parameters


  • value : float
def set_style_frame_padding(...)

Sets padding within a framed rectangle (used by most widgets).

Return Type: None

Parameters


  • x : float

  • y : float

def set_style_frame_rounding(...)

Sets radius of frame corners rounding. Set to 0.0 to have rectangular frame (used by most widgets).

Return Type: None

Parameters


  • value : float
def set_style_global_alpha(...)

Sets global alpha applies to everything in Dear PyGui.

Return Type: None

Parameters


  • value : float
def set_style_grab_min_size(...)

Sets minimum width/height of a grab box for slider/scrollbar.

Return Type: None

Parameters


  • value : float
def set_style_grab_rounding(...)

Sets radius of grabs corners rounding. Set to 0.0 to have rectangular slider grabs.

Return Type: None

Parameters


  • value : float
def set_style_indent_spacing(...)

Sets horizontal indentation when e.g. entering a tree node. Generally == (FontSize + FramePadding.x*2).

Return Type: None

Parameters


  • value : float
def set_style_item_inner_spacing(...)

Sets horizontal and vertical spacing between within elements of a composed widget (e.g. a slider and its label).

Return Type: None

Parameters


  • x : float

  • y : float

def set_style_item_spacing(...)

Sets horizontal and vertical spacing between widgets/lines.

Return Type: None

Parameters


  • x : float

  • y : float

def set_style_popup_border_size(...)

Sets thickness of border around popup/tooltip windows. Generally set to 0.0 or 1.0. (Other values are not well tested and more CPU/GPU costly).

Return Type: None

Parameters


  • value : float
def set_style_popup_rounding(...)

Sets radius of popup window corners rounding. (Note that tooltip windows use WindowRounding).

Return Type: None

Parameters


  • value : float
def set_style_scrollbar_rounding(...)

Sets radius of grab corners for scrollbar.

Return Type: None

Parameters


  • value : float
def set_style_scrollbar_size(...)

Sets width of the vertical scrollbar, Height of the horizontal scrollbar.

Return Type: None

Parameters


  • value : float
def set_style_selectable_text_align(...)

Sets alignment of selectable text. Defaults to (0.0, 0.0) (top-left aligned). It's generally important to keep this left-aligned if you want to lay multiple items on a same line.

Return Type: None

Parameters


  • x : float

  • y : float

def set_style_tab_border_size(...)

Sets thickness of border around tabs.

Return Type: None

Parameters


  • value : float
def set_style_tab_rounding(...)

Sets radius of upper corners of a tab. Set to 0.0 to have rectangular tabs.

Return Type: None

Parameters


  • value : float
def set_style_touch_extra_padding(...)

Expand reactive bounding box for touch-based system where touch position is not accurate enough. Unfortunately we don't sort widgets so priority on overlap will always be given to the first widget. So don't grow this too much!

Return Type: None

Parameters


  • x : float

  • y : float

def set_style_window_border_size(...)

Sets thickness of border around windows. Generally set to 0.0 or 1.0. (Other values are not well tested and more CPU/GPU costly).

Return Type: None

Parameters


  • value : float
def set_style_window_menu_button_position(...)

Sets side of the collapsing/docking button in the title bar (None/Left/Right). Defaults to mvGuiDir_Left.

Return Type: None

Parameters


  • value : int
def set_style_window_padding(...)

Sets padding within a window.

Return Type: None

Parameters


  • x : float

  • y : float

def set_style_window_rounding(...)

Sets Radius of window corners rounding. Set to 0.0fto have rectangular windows. Large values tend to lead to variety of artifacts and are not recommended.

Return Type: None

Parameters


  • value : float
def set_style_window_title_align(...)

Sets alignment for title bar text. Defaults to (0.0,0.5) for left-aligned,vertically centered.

Return Type: None

Parameters


  • x : float

  • y : float

def set_table_data(...)

Overwrites table data.

Return Type: None

Parameters


  • name : str

  • data : List[List[str]]

def set_table_item(...)

Sets a table's cell value.

Return Type: None

Parameters


  • table : str

  • row : int

  • column : int

  • value : str

def set_table_selection(...)

Sets a table's cell selection value.

Return Type: None

Parameters


  • table : str

  • row : int

  • column : int

  • value : bool

def set_theme(...)

Set the application's theme to a built-in theme.

Return Type: None

Parameters


  • theme : str
def set_theme_item(...)

Sets a theme item.

Return Type: None

Parameters


  • item : int mvGuiCol_* constants

  • r : int

  • g : int

  • b : int

  • a : int

def set_value(...)

Sets an item's value if applicable.

Return Type: bool

Parameters


  • name : str

  • value : Any

def set_vsync(...)

Sets vsync on or off.

Return Type: None

Parameters


  • value : bool
def set_xticks(...)

Sets plots x ticks and labels

Return Type: None

Parameters


  • plot : str

  • label_pairs : Any list of [str,float]

def set_yticks(...)

Sets plots y ticks and labels

Return Type: None

Parameters


  • plot : str

  • label_pairs : Any list of [str,float]

def setup_dearpygui(...)

Sets up DearPyGui for user controlled rendering. Only call once and you must call cleanup_deapygui when finished.

Return Type: None

def show_logger(...)

Shows the logging window. The Default log level is Trace

Return Type: None

def start_dearpygui(...)

Starts DearPyGui.

Return Type: None

Parameters


  • Keyword Only Arguments

  • primary_window : str = '' Window that will expand into viewport.
def stop_dearpygui(...)

Stops DearPyGui.

Return Type: None

def unindent(...)

Unindents following items.

Return Type: None

Parameters


  • Keyword Only Arguments

  • name : str = 'unindent'

  • offset : float = 0.0

  • parent : str = '' Parent to add this item to. (runtime adding)

  • before : str = '' This item will be displayed before the specified item in the parent. (runtime adding)

  • show : bool = True Attempt to render