Login
Back to bricks list
Introduction Version

Plotly resource

RESOURCE
Typing name :  RESOURCE.gws_core.PlotlyResource Brick :  gws_core
Parent :
Resource

Plotly resource

Resource that contains a plotly figure.

Ex : import plotly.express as px figure = px.scatter(source, x="A", y="B") resource = PlotlyResource(figure)

Views

VIEW PLOT - default_view()Default view
View interactive plotly figure
VIEW RESOURCE - view_as_json()
View the complete resource as json

Functions

__INIT__

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

Parameters:
NameTypeDefault valueDescription
figureFigure None
ADD_TECHNICAL_INFO

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

Parameters:
NameTypeDefault valueDescription
technical_infoTechnicalInfo Technical information to add (key, value)
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:
Union[str, NoneType]
CLONE

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

Return type:
ResourceType
EQUALS
Parameters:
NameTypeDefault valueDescription
otherobject
Return type:
bool
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_FIGURE
Return type:
Figure
GET_TECHNICAL_INFO

Get the technical information of the resource

Parameters:
NameTypeDefault valueDescription
keystr Key of the technical information
Return type:
TechnicalInfo
INIT

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