Skip to content

Latest commit

 

History

History
42 lines (33 loc) · 2.23 KB

Render.md

File metadata and controls

42 lines (33 loc) · 2.23 KB

Render

Configures the representation of data sets returned by the query API.

Properties

Name Type Description Notes
mode RenderMode [optional]
roll_up bool move up attributes on rows (or columns) that are the same for all rows (or columns) to a table attribute. Levels enumerated in 'hierarchical' are excluded. [optional]
hierarchical Hierarchical [optional]
value_key str if set, use this key in the value object to report data values [optional]
show_levels bool if set, report the levels used in the data values (either hierarchical or flat) [optional]
iso_timestamp bool if set, render timestamps in a row or column index with both epoch and iso representations [optional]
row_key str if set, use this key as name of the row-dimension for single-dimensional rows [optional]
column_key str if set, use this key as name of the column-dimension for single-dimensional columns [optional]
header_array HeaderArrayOption [optional]
data_axis DataAxisOption [optional]
key_seperator str character used to concatenate multi-key columns or rows when required [optional]
key_skip_empty bool skip empty values in concatenating multi-key column or row headers [optional]
include_window_spec bool if set, include window specification in render modes that support it [optional]

Example

from waylay.services.queries.models.render import Render

# TODO update the JSON string below
json = "{}"
# create an instance of Render from a JSON string
render_instance = Render.from_json(json)
# print the JSON string representation of the object
print Render.to_json()

# convert the object into a dict
render_dict = render_instance.to_dict()
# create an instance of Render from a dict
render_form_dict = render.from_dict(render_dict)

[Back to Model list] [Back to API list] [Back to README]