plot¶
- class virtualitics_sdk.elements.plot.Plot(title, is_primary, _type, x_axis, y_axis, data, has_tooltip, orientation, data_keys, description='', color_by=None, show_title=True, show_description=True, colors=None, advanced_tooltip=None, lines=[], legend=None)¶
Bases:
Element- static is_valid_plot_type(s)¶
- Return type:
bool
- save(link, is_ssf=False)¶
Save a plot serialization into a Link.
- Parameters:
link (
Link) – The link to save the element to.
- set_content(content)¶
Validate and set content (python best practice is to set instance attributes in constructor).
- Parameters:
kwargs – new content for the Element.
- set_params(params)¶
Validate and set params (python best practice is to set instance attributes in constructor).
- Parameters:
kwargs – new params for the Element.
- to_json()¶
Convert the element to a JSON.
- Returns:
A JSON dictionary of the element.
- class virtualitics_sdk.elements.plot.PlotAxisScale(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
Enum- AUTO = 'auto'¶
- BAND = 'band'¶
- IDENTITY = 'identity'¶
- LINEAR = 'linear'¶
- LOGARITHMIC = 'log'¶
- ORDINAL = 'ordinal'¶
- POINT = 'point'¶
- POW = 'pow'¶
- QUANTILE = 'quantile'¶
- QUANTIZE = 'quantize'¶
- SEQUENTIAL = 'sequential'¶
- SQUARE_ROOT = 'sqrt'¶
- THRESHOLD = 'threshold'¶
- TIME = 'time'¶
- UTC = 'utc'¶
- class virtualitics_sdk.elements.plot.PlotAxisType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
Enum- CATEGORY = 'category'¶
- NUMBER = 'number'¶
- class virtualitics_sdk.elements.plot.PlotDataKey(_type, domain, tooltip, color=None, legend=None)¶
Bases:
object- to_json()¶
- class virtualitics_sdk.elements.plot.PlotDataType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
Enum- CATEGORY = 'category'¶
- DATE = 'date'¶
- NUMBER = 'number'¶
- class virtualitics_sdk.elements.plot.PlotOrientation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
Enum- LANDSCAPE = 'landscape'¶
- PORTRAIT = 'portrait'¶
- class virtualitics_sdk.elements.plot.PlotType(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
Enum- BAR = 'bar'¶
- LINE = 'line'¶
- PLOTLY = 'plotly'¶
- SCATTER = 'scatter'¶
- WATERFALL = 'waterfall'¶
- class virtualitics_sdk.elements.plot.TooltipStatus(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
Enum- ERROR = 'error'¶
- PENDING = 'pending'¶
- SUCCESS = 'success'¶
- class virtualitics_sdk.elements.plot.XAxis(orientation, scale, label, data_key, domain=None)¶
Bases:
object- to_json()¶
- class virtualitics_sdk.elements.plot.XAxisOrientation(value, names=None, *, module=None, qualname=None, type=None, start=1, boundary=None)¶
Bases:
Enum- BOTTOM = 'bottom'¶
- TOP = 'top'¶