Create text insight¶
UI • interface
Create a new insight using only plain text.
Usage¶
The following are the step's expected inputs and outputs and their specific types.
create_text_insight({"param": value})
where the object {"param": value}
is optional in most cases and if present may contain any of the parameters described in the
corresponding section below.
Parameters¶
title: string
Title of the insight.
elements: array[object]
Type and appearance of an insight's elements. A list in which each item is an object configuring the appearance of a particular insight element.
Items in elements
kind: string
Specify the type of element.
Must be one of:
"TITLE"
,
"DESCRIPTION"
,
"CHART"
,
"GRAPH"
,
"STATS"
,
"LEGEND"
,
"LEGEND_COLOR_SCALE"
text: string
The text shown for this insight element.
layout: object
The element's position and size. The position refers to the top-left corner of the rectangle representing the insight element, while the size is given by its width and height. For reference, the entire insight is 12 units wide and 9 units high, and the origin (0, 0) of the x/y coordinates is in its top-left corner.
Items in layout
x: integer
Horizontal position of the element's top-left corner. In increments of 1; 0 being the left-most and 8 the right-most position.
Range: -1 ≤ x ≤ 11
y: integer
Vertical position of the element's top-left corner. In increments of 1; 0 being the top-most and 11 the bottom-most position.
Range: 0 ≤ y ≤ 11
w: integer
The width of the element (in increments of 1).
Range: 1 ≤ w ≤ 12
h: integer
The height of the element (in increments of 1).
Range: 1 ≤ h ≤ 9
column: string
Name of the column containing the data to be used in this insight element. Required if the element is of type CHART or STATS.