RichText

Class to manipulate the rich texts content

:return: [description] :rtype: [type]

Attributes

blocks: listeditor_version: strversion: int

Functions

__init__

Initialize self. See help(type(self)) for accurate signature.

rich_text_dto : gws_core.impl.rich_text.rich_text_types.RichTextDTO | None

target_version : int | None

add_code

Add a code block to the rich text content

code : str

language : str - ''

Return type : RichTextBlock

add_figure

Add a figure to the rich text content

figure_data : RichTextBlockFigure

parameter_name : str | None

Return type : RichTextBlock

add_file

Add a file to the rich text content

file_data : RichTextBlockFile

parameter_name : str | None

Return type : RichTextBlock

add_file_view

Add a view to a rich text content. This view is not associated with a resource

file_view : RichTextBlockViewFile

view to add

parameter_name : str | None

name of the parameter where to insert the block. If None, the block is appended

Return type : RichTextBlock

add_formula

Add a math formula to the rich text content

formula : str

parameter_name : str | None

name of the parameter where to insert the block. If None, the block is appended

Return type : RichTextBlock

add_header

Add a header to the rich text content

text : str

level : RichTextBlockHeaderLevel

Return type : RichTextBlock

add_hint

Add a hint to the rich text content

content : str

hint text

hint_type : Literal - info

type of hint ('info', 'warning', or 'science')

Return type : RichTextBlock

add_html

Add an HTML block to the rich text content

html : str

Return type : RichTextBlock

add_iframe

Add an iframe to the rich text content

url : str

iframe_height : int

Return type : RichTextBlock

add_list

Add a list to the rich text content

data : RichTextBlockList

Return type : RichTextBlock

add_note_resource_view

Add a view to a rich text content used in note. This requires the note to call the view

resource_view : RichTextBlockNoteResourceView

view to add

parameter_name : str | None

name of the parameter where to insert the block. If None, the block is appended

Return type : RichTextBlock

add_paragraph

Add a paragraph to the rich text content

text : str

Return type : RichTextBlock

add_quote

Add a quote to the rich text content

text : str

caption : str | None

Return type : RichTextBlock

add_resource_view

resource_view : RichTextBlockResourceView

parameter_name : str | None

Return type : RichTextBlock

add_table

Add a table to the rich text content

data : RichTextBlockTable

Return type : RichTextBlock

add_timestamp

Add a timestamp to the rich text content

timestamp_data : RichTextBlockTimestamp

parameter_name : str | None

Return type : RichTextBlock

add_video

Add a video to the rich text content

url : str

caption : str | None

Return type : RichTextBlock

append_block

Append a block to the rich text content

block : RichTextBlock

block to add

Return type : int

append_rich_text

rich_text : RichText

delete_parameter

Delete the parameter in the rich text content text

parameter_name : str

diff

Compare this rich text (old) with another rich text (new) and return the differences.

Blocks are matched by their id. If a block's id exists in both but the type changed, it is treated as deleted + added (not modified).

other : RichText

the new version to compare against

Return type : RichTextDiff

generate_id

Return type : str

get_associated_resources

Return type : set

get_block_at_index

Get the block at the given index

index : int

Return type : RichTextBlock

get_block_by_id

Get the block by its id

block_id : str

id of the block

Return type : gws_core.impl.rich_text.rich_text_types.RichTextBlock | None

get_block_index_by_id

Get the block index by its id

block_id : str

id of the block

Return type : int

get_blocks

Return type : list

get_blocks_by_type

Get the blocks of the given type

block_type : gws_core.impl.rich_text.block.rich_text_block.RichTextBlockTypeStandard | str

Return type : list

get_figures_data

Return type : list

get_file_views_data

Return type : list

get_files_data

Return type : list

get_resource_views_data

Return type : list

has_view_config

Check if the rich text contains a resource view with the given view_config_id

view_config_id : str

Return type : bool

insert_block_after_id

Insert a block after the block with the given id

after_block_id : str

id of the block after which to insert

block : RichTextBlock

block to insert

insert_block_at_index

Insert an element in the rich text content at the given index

index : int

block : RichTextBlock

insert_multiple_blocks_after_id

Insert multiple blocks after the block with the given id. Blocks are inserted in order so they appear in the same order as the list.

after_block_id : str

id of the block after which to insert

blocks : list

blocks to insert

is_empty

Return type : bool

move_block

Move a block to after another block. If after_block_id is None, move to the beginning.

block_id : str

id of the block to move

after_block_id : str | None

id of the block after which to place it, or None for the beginning

remove_block_at_index

Remove an element from the rich text content

block_index : int

Return type : RichTextBlock

remove_block_by_id

Remove a block by its id

block_id : str

replace_block_at_index

Replace a block at the given index

index : int

block : RichTextBlock

replace_block_by_id

Replace a block by its id

block_id : str

block : RichTextBlock

replace_resource_views_with_parameters

Method to remove the resource view from the rich text content and replace it when parameters. Useful when creating a template (because templates can't have resource views)

serialize

Serialize the object into a json object. For SerializableRField, this method is called when the resource is saved.

Return type : dict

set_parameter

Replace the parameter in the rich text content text

parameter_name : str

value : str

replace_block : bool - False

to_dto

Convert the rich text to a DTO.

convert_special_blocks : bool - False

If True, blocks that extend RichTextBlockDataSpecial are converted to RichTextBlockHTML by calling their to_html() method. This is useful for rendering special blocks in contexts where they are not natively supported.

Return type : RichTextDTO

to_dto_json_dict

Return type : dict

to_json_file

file_path : str

to_markdown

Convert the rich text content to markdown

include_block_comments : bool - False

If True, add an HTML comment before each block with the block type and id (e.g. ). Useful for mapping markdown sections back to their block IDs.

Return type : str

create_block @classmethod

Create a block

id_ : str

data : RichTextBlockDataBase

Return type : RichTextBlock

create_formula @classmethod

summary

id_ : str

id of the block

formula : str

math formula using the KaTeX syntax

Return type : RichTextBlock

create_header @classmethod

Create a paragraph block

id_ : str

text : str

level : RichTextBlockHeaderLevel

Return type : RichTextBlock

create_list @classmethod

Create a list block

id_ : str

data : RichTextBlockList

Return type : RichTextBlock

create_paragraph @classmethod

Create a paragraph block

id_ : str

text : str

Return type : RichTextBlock

create_rich_text_dto @classmethod

blocks : list

Return type : RichTextDTO

create_timestamp @classmethod

Create a timestamp block

id_ : str

data : RichTextBlockTimestamp

Return type : RichTextBlock

deserialize @classmethod

Deserialize the object from a json object. For SerializableRField, this method is called when the RField is loaded.

data : dict

json object generated by the serialize method

Return type : RichText

from_json @classmethod

data : dict

Return type : RichText

from_json_file @classmethod

file_path : str

Return type : RichText

is_rich_text_json @classmethod

Check if the given data is a valid rich text json

data : dict

json object

Return type : bool

Have you developed a brick?