Note resource

Typing name : RESOURCE.gws_core.NoteResource

Brick : gws_core

Parent :

Resource that contains a rich text that can be exported to a lab note

Resource to manage a set of resources. By default the sytem create a new resource for each resource in the set when saving the set

Views

VIEW NOTE RESOURCE

Default view

View note resource content

VIEW RESOURCE

View the complete resource as json

RESOURCES LIST

List the resources

Attributes

flagged: boolname: strstyle: TypingStyletags: TagListtechnical_info: TechnicalInfoDicttitle: struid: str

Functions

__init__

Constructor, please do not overwrite this method, use the init method instead Leave the constructor without parameters.

title : str

add_blank_line

Add a blank line to the note resource content.

add_default_view_from_resource

Add a default view to the note resource content. This method is reponsible for generating the view of the input resource and the input resource will be attached to the NoteResource.

resource : Resource

resource to call the view on

title : str

view title

caption : str

view caption

parameter_name : str

if provided, the view replace the provided variable. if not, the view is append at the end of the note

create_new_resource : bool - False

add_figure_file

Add a figure to the note resource content.

file : File

file of the image

title : str

title of the figure

caption : str

caption of the figure

parameter_name : str

if provided, the figure replace the provided variable. If not, the figure is append at the end of the note

create_new_resource : bool - False

if True, a new resource is created with the file. If False, the file is used as a resource. Set False if the File resource already exist ans saved on the lab

add_figure_from_path

Add a figure to the note resource content.

image_path : str

path of the image file

title : str

title of the figure

caption : str

caption of the figure

parameter_name : str

if provided, the figure replace the provided variable. If not, the figure is append at the end of the note

add_file

Add a file to the note resource content.

file : File

file to add

parameter_name : str

if provided, the file replace the provided variable. If not, the file is append at the end of the note

create_new_resource : bool - False

if True, a new resource is created with the file. If False, the file is used as a resource. Set False if the File resource already exist ans saved on the lab

add_file_from_path

Add a file to the note resource content.

file_path : str

path of the file

parameter_name : str

if provided, the file replace the provided variable. If not, the file is append at the end of the note

add_header

Add a header to the note resource content.

header : str

header to add

level : RichTextBlockHeaderLevel

header level

add_paragraph

Add a paragraph to the note resource content.

paragraph : str

paragraph to add

add_resource

Add a resource to the set

resource : Resource

resource to add

unique_name : str

name used to store the resource in the dict. It must be unique. The resource can be retrieve by calling the get_resource method with the name. If not provided, the resource name is used

create_new_resource : bool - True

If true, a new resource is created when saving the resource. Otherwise it doesn't create a new resource but references it. In this case the resource must be an input of the task that created the ResourceSet and the resource must have been saved before

add_technical_info

Add technical information on the resource. Technical info are useful to set additional information on the resource.

technical_info : TechnicalInfo

technical information to add (key, value) this is a long description of the technical information

add_timestamp

Add a time stamp to the note resource content.

timestamp_data : RichTextBlockTimestamp

time stamp data

parameter_name : str

if provided, the time stamp replace the provided variable.

add_view

Add a view to the note resource content. In this case the resource is not attached to the NoteResource, the view is considered as standalone. This can be useful when you want to add a view of a resource that does not exist in the system (manually created resource).

view_ : View

view_config_values : Dict

config value of the view when call to_json_dict

title : str

title of the view

caption : str

caption of the view

parameter_name : str

if provided, the view replace the provided variable. If not, the view is append at the end of the note

add_view_from_resource

Add a view to the note resource content. This method is reponsible for generating the view of the input resource and the input resource will be attached to the NoteResource. To get the information of the views, once you opened the view in the application, you can click on View settings > Show view configuration

resource : Resource

resource to call the view on

view_method_name : str

name of the view method to call. View settings > Show view configuration.

config_values : Dict

config values for the views. Access it from View settings > Show view configuration.

title : str

view title

caption : str

view caption

parameter_name : str

if provided, the view replace the provided parameter. if not, the view is append at the end of the note

create_new_resource : bool - False

append_advanced_rich_text

Append a rich text (that comes from a note or note template) to the note resource.

rich_text : RichText

rich text to append to the note resource (from a note or note template)

object_type : RichTextObjectType

type of the object that has the rich text

object_id : str

id of the object that has the rich text

append_basic_rich_text

Append a basic rich content to this note resource content. It does not support file, figure, or views

rich_text : RichText

rich text to append

append_block

Append a block to the note

block : RichTextBlock

block to add

Return type : int

append_note

Append a note content to the note resource content.

note : Note

note to append

append_note_resource

Append the content of another note resource at the end of this note resource content.

note : NoteResource

note resource to append

append_note_template

Append a note template content to the note resource content.

note_template : NoteTemplate

note template to append

call_view_on_resource

Call a view method on the resource.

resource_key : str

key of the resource

view_name : str

config : Dict

Return type : CallViewResultDTO

check_resource

You can redefine this method to define custom logic to check this resource. If there is a problem with the resource, return a string that define the error, otherwise return None This method is called on output resources of a task. If there is an error returned, the task will be set to error and next proceses will not be run. It is also call when uploading a resource (usually for files or folder), if there is an error returned, the resource will not be uploaded

Return type : Optional

clear_resources

Clear the resources

clone

Clone the resource to create a new instance with a new id. It copies the RFields.

Return type : ResourceType

delete_parameter

Delete a parameter.

parameter_name : str

parameter name

export_as_lab_note

Export the note as a note. The note is automatically saved in the database.

title : str

scenario_id : str

Id of the scenario to associate the note with

folder_id : str

Return type : Note

get_block_at_index

Get the block at the specified index

index : int

index of the block

Return type : RichTextBlock

get_block_by_id

Get the block by id

block_id : str

id of the block

Return type : RichTextBlock

get_block_index_by_id

Get the index of the block by id

block_id : str

id of the block

Return type : int

get_blocks

Get the blocks of the note resource

Return type : List

get_blocks_by_type

Get the blocks of the note resource by type

block_type : RichTextBlockType

type of the block

Return type : List

get_default_name

You can redefine this method to set a name of the resource. When saving the resource the name will be saved automatically This can be useful to distinguish this resource from another one or to search for the resource

Return type : str

get_default_style

Get the default style of the resource

Return type : TypingStyle

get_figure

Get the figure of the note as a File resource.

filename : str

filename of the figure

Return type : File

get_file

Get the file of the note as a File resource.

filename : str

filename of the file

Return type : File

get_file_path

Get the path of the file.

filename : str

filename of the file

Return type : str

get_model_id

Get the id of the resource model in the database. It is provided by the system for input resources of a task.

Return type : str

get_name

Get the name of the resource or the default name if the name is None

Return type : str

get_resource

Return the resource with the given name

resource_name : str

name of the resource

Return type : Resource

get_resource_model_ids

Return the resource model ids of the sub resources

Return type : Set

get_resource_models

Return the resource models of the sub resources list

Return type : List[ResourceModel]

get_resource_or_none

Return the resource with the given name or None if not found

resource_name : str

name of the resource

Return type : gws_core.resource.resource.Resource | None

get_resources

Return the sub resources as a dict

Return type : Dict

get_resources_as_set

Return the sub resources as a set

Return type : Set

get_rich_text

Return type : RichText

get_technical_info

Get the technical information of the resource

key : str

key of the technical information

Return type : TechnicalInfo

has_resource_model

Return true if the resource with the given id is in the resource list

resource_model_id : str

id of the ResourceModel

Return type : bool

init

This can be overwritten to perform custom initialization of the resource. This method is called after the init (constructor) of the resource. The values of RFields are set when this method is called.

replace_resources_by_model_id

Replace current resources by the resources in the dict

resources : Dict

dict where key is the resource model id and value is the resource

resource_exists

Return true if the resource with the given name exists in the dict

resource_name : str

name of the resource

Return type : Resource

save_new_children_resources

resource_origin : ResourceOrigin

scenario : Scenario

task_model : TaskModel

port_name : str

Return type : List[ResourceModel]

set_name

Set the name of the resource. You can override this method to force a format for the name of the resource.

name : Optional

name to format

set_parameter

Set the value of a parameter.

parameter_name : str

parameter name

value : Any

value of the parameter. This is convert to str

replace_block : bool - False

if True, the block containing the parameter is replaced by a new block with the value

to_markdown

Convert the note resource to markdown.

Return type : str

classname @classmethod

Returns the name of the class

slugify : bool - False

True to slugify the class name if True

snakefy : bool - False

True to snakefy the class name if True

replace_uppercase : bool - False

Replace upper cases by "-" if True

Return type : str

copy_style @classmethod

Copy the style of the resource with the possibility to override some properties. Useful when settings the style for a task based on the resource style.

icon_technical_name : str

technical name of the icon if provided, the icon_type must also be provided

icon_type : TypingIconType

type of the icon if provided, the icon_technical_name must also be provided

background_color : str

background color

icon_color : TypingIconColor

icon color

Return type : TypingStyle

full_classname @classmethod

Returns the full name of the class

slugify : bool - False

Slugify the returned class name if True

snakefy : bool - False

Snakefy the returned class name if True

Return type : str

get_brick_name @classmethod

Return type : str

get_brick_version @classmethod

Return type : Version

get_human_name @classmethod

Get the human name of the object

Return type : str

get_short_description @classmethod

Get the short description of the object

Return type : str

get_style @classmethod

Get the style of the object

Return type : TypingStyle

get_typing_name @classmethod

Get the typing name of the object Ex: 'RESOURCE.gws_core.Table'

Return type : str

get_typing_name_obj @classmethod

Return type : TypingNameObj

inheritors @classmethod

Get all the classes that inherit this class

Return type : List

from_note @staticmethod

Create a note resource from a note.

note : Note

note to create the note resource from

title : str

title of the note resource. If none the title of note is used

Return type : NoteResource

from_note_template @staticmethod

Create a note resource from a note template.

note_template : NoteTemplate

note template to create the note resource from

title : str

title of the note resource. If none the title of note template is used

Return type : NoteResource

Have you developed a brick?