Editor
Introduction
Editor
widget in Supervisely allows users to input and edit code with syntax highlighting. It provides a customizable text input area with options such as language selection, input height, and some styles. Editor
widget is used for editing code snippets, as the syntax highlighting makes it easier to read and edit code for languages such as python
, json
, html
, and yaml
.
Function signature
Parameters
Parameters | Type | Description |
---|---|---|
|
| Editor default value |
|
| Specifies widget height in pixels |
|
| Specifies the visible number of lines in widget |
|
| Specifies language mode of editor |
|
| Specifies that a editor area should be read-only |
|
| Specifies displaying numbers of lines in editor |
|
| Specifies if visible highlighting active line in editor |
|
| Display button for settting editor default value |
|
| ID of the widget |
initial_text
Editor default value
type: Optional[str]
default value: ""
height_px
Specifies widgets height in pixels.
type: Optional[int]
default value: 100
height_lines
Specifies the visible number of lines in widget. If specified it overwrites height_px
. If >= 1000, all lines will be displayed
type: Optional[int]
default value: None
language_mode
Specifies language mode of editor.
type: Optional[Literal['json', 'html', 'plain_text', 'yaml', 'python']]
default value: json
readonly
Specifies that a editor area should be read-only.
type: Optional[bool]
default value: False
show_line_numbers
Specifies displaying numbers of lines in editor.
type: Optional[bool]
default value: True
highlight_active_line
Specifies if visible highlighting active line in editor.
type: Optional[bool]
default value: True
restore_default_button
Display button for settting editor default value.
type: Optional[bool]
default value: True
widget_id
ID of the widget.
type: Optional[str]
default value: None
Methods and attributes
Attributes and Methods | Description |
---|---|
| Get or set |
| Display line numbers or code snippet. |
| Hide line numbers or code snippet. |
| Returns input value data. |
| Set input value data. |
Mini App Example
You can find this example in our Github repository:
ui-widgets-demos/blob/master/text elements/003_editor/src/main.py
Import libraries
Init API client
First, we load environment variables with credentials and init API for communicating with Supervisely Instance:
Initialize Editor
widget
Editor
widgetInitialize widgets we will use in this demo
Create app layout
Prepare a layout for app using Card
widget with the content
parameter and place widgets that we've just created in the Container
widget.
Create app using layout
Create an app object with layout parameter.
Add functions to control widgets from python code
Last updated