Insight

An insight defines how display live data on control panel tiles.

Attributes

NameTypeDescription
namestrName of the insight displayed on the tile.

Methods

add_condition()

add a condition to the conditions.

NameTypeDefaultDescription
conditiondict

return:

update_condition()

update a condition at the specified index.

NameTypeDefaultDescription
indexintindex of the condition to update.
conditiondictnew condition to replace the existing one.

remove_condition()

remove a condition from the conditions list.

NameTypeDefaultDescription
indexintindex of the condition to remove.

clear_conditions()

remove all conditions from the list.

api_id()

return current object id on Web API format.

endpoint()

return endpoint name used to contact backend.

from_json()

load the object from a dict originating of a JSON format.

NameTypeDefaultDescription
objobject to load information from.

set_id()

specify the id_value neutrally

NameTypeDefaultDescription
id_value

return:

to_json()

transform current object into a dict that could be JSONIFY.

NameTypeDefaultDescription
targetstrNone

return: dumpable dict.