Chartific
Creates a new Chart
Constructor parameters
Name | Type | Description | Required? |
---|---|---|---|
_x |
Real |
the x position of the top-left corner | Yes |
_y |
Real |
the y position of the top-left corner | Yes |
_width |
Real |
the width of the chart | Yes |
_height |
Real |
the height of the chart | Yes |
Methods
add_series(_series_idx)
add a Series to the chart The rules for allowing adding a series to a chart are: For scatter plots, all series must be scatter plots. For pies, all series must be pies. The render will only draw the first one. * For histograms, bars and lines, all series must be of one of these three types. The categories shown will be taken from the first series.
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_series_idx |
Series |
the Series reference | Yes |
autofit()
recalculates the min and max X and Y canvas in order to automatically fit the series
canvas_to_x(_x, [_clamp])
converts a canvas x coordinate to GUI coordinate
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x |
Real |
the canvas x point | Yes |
Real
The corresponding GUI coordinate for _x
canvas_to_y(_y, [_clamp])
converts a canvas y coordinate to GUI coordinate
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y |
Real |
the canvas y point | Yes |
Real
The corresponding GUI coordinate for _y
clear_series()
deletes all series from the chart
delete_series(_series_name)
deletes a Series from the charg by name
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_series_name |
String |
the Series name | Yes |
destroy()
destroys the chart, freeing up the involved surface
export_chart(_file)
exports the current chart to a PNG file
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_file |
String |
the file to export the chart to | Yes |
f(_func, _x_min, _x_max, [_param], [_num])
creates a struct with an array of points (for X) and the result of evaluating the supplied function over those points (for Y)
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_func |
Asset.GMFunction |
the function to evaluate | Yes |
_x_min |
Real |
the minimum value of x | Yes |
_x_max |
Real |
the maximum value of x | Yes |
_param |
Any |
a single number/value, an array or a struct with parameters for the function to evaluate. This will depend on how the function itself is implemented. By default undefined. | No |
_num |
Any |
the number of points to generate for X (within [x_min, x_max]) | No |
Struct
A struct containing two arrays, one for X and one for Y
format_number(_value, [_prefix], [_suffix], [_thousands], [_decimal], [_positive_left_sign], [_positive_right_sign], [_negative_left_sign], [_negative_right_sign], [_precision])
formats a number for display with the specified parameters
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_value |
Real |
the number to format | Yes |
_prefix |
String |
the prefix to use, for example "$". Default configured in Chartific's config script | No |
_suffix |
String |
the suffix to use, for example "bn". Default configured in Chartific's config script | No |
_thousands |
String |
the thousands separator to use, for example ",". Default configured in Chartific's config script | No |
_decimal |
String |
the decimal point character to use, for example ".". Default configured in Chartific's config script | No |
_positive_left_sign |
String |
the positive left sign to use, for example "+". Default configured in Chartific's config script | No |
_positive_right_sign |
String |
the positive right sign to use, for example "^". Default configured in Chartific's config script | No |
_negative_left_sign |
String |
the negative left sign to use, for example "(". Default configured in Chartific's config script | No |
_negative_right_sign |
String |
the negative right sign to use, for example ")". Default configured in Chartific's config script | No |
_precision |
Real |
the number of decimal digits to format | No |
String
the formatted number
get_axis_arrow_width()
Gets the value of axis_arrow_width
Any
the value of axis_arrow_width
get_axis_color()
Gets the value of axis_color
Any
the value of axis_color
get_axis_has_arrows()
Gets the value of axis_has_arrows
Any
the value of axis_has_arrows
get_axis_minmax_x_label_angle()
Gets the value of axis_minmax_x_label_angle
Any
the value of axis_minmax_x_label_angle
get_axis_minmax_x_label_color()
Gets the value of axis_minmax_x_label_color
Any
the value of axis_minmax_x_label_color
get_axis_minmax_x_label_font()
Gets the value of axis_minmax_x_label_font
Any
the value of axis_minmax_x_label_font
get_axis_minmax_x_label_halign()
Gets the value of axis_minmax_x_label_halign
Any
the value of axis_minmax_x_label_halign
get_axis_minmax_x_label_margin()
Gets the value of axis_minmax_x_label_margin
Any
the value of axis_minmax_x_label_margin
get_axis_minmax_x_label_valign()
Gets the value of axis_minmax_x_label_valign
Any
the value of axis_minmax_x_label_valign
get_axis_minmax_y_label_angle()
Gets the value of axis_minmax_y_label_angle
Any
the value of axis_minmax_y_label_angle
get_axis_minmax_y_label_color()
Gets the value of axis_minmax_y_label_color
Any
the value of axis_minmax_y_label_color
get_axis_minmax_y_label_font()
Gets the value of axis_minmax_y_label_font
Any
the value of axis_minmax_y_label_font
get_axis_minmax_y_label_halign()
Gets the value of axis_minmax_y_label_halign
Any
the value of axis_minmax_y_label_halign
get_axis_minmax_y_label_margin()
Gets the value of axis_minmax_y_label_margin
Any
the value of axis_minmax_y_label_margin
get_axis_minmax_y_label_valign()
Gets the value of axis_minmax_y_label_valign
Any
the value of axis_minmax_y_label_valign
get_axis_title_x()
Gets the value of axis_title_x
Any
the value of axis_title_x
get_axis_title_x_angle()
Gets the value of axis_title_x_angle
Any
the value of axis_title_x_angle
get_axis_title_x_color()
Gets the value of axis_title_x_color
Any
the value of axis_title_x_color
get_axis_title_x_font()
Gets the value of axis_title_x_font
Any
the value of axis_title_x_font
get_axis_title_x_halign()
Gets the value of axis_title_x_halign
Any
the value of axis_title_x_halign
get_axis_title_x_offset_x()
Gets the value of axis_title_x_offset_x
Any
the value of axis_title_x_offset_x
get_axis_title_x_offset_y()
Gets the value of axis_title_x_offset_y
Any
the value of axis_title_x_offset_y
get_axis_title_x_valign()
Gets the value of axis_title_x_valign
Any
the value of axis_title_x_valign
get_axis_title_y()
Gets the value of axis_title_y
Any
the value of axis_title_y
get_axis_title_y_angle()
Gets the value of axis_title_y_angle
Any
the value of axis_title_y_angle
get_axis_title_y_color()
Gets the value of axis_title_y_color
Any
the value of axis_title_y_color
get_axis_title_y_font()
Gets the value of axis_title_y_font
Any
the value of axis_title_y_font
get_axis_title_y_halign()
Gets the value of axis_title_y_halign
Any
the value of axis_title_y_halign
get_axis_title_y_offset_x()
Gets the value of axis_title_y_offset_x
Any
the value of axis_title_y_offset_x
get_axis_title_y_offset_y()
Gets the value of axis_title_y_offset_y
Any
the value of axis_title_y_offset_y
get_axis_title_y_valign()
Gets the value of axis_title_y_valign
Any
the value of axis_title_y_valign
get_axis_width()
Gets the value of axis_width
Any
the value of axis_width
get_bar_category_spacing()
Gets the value of bar_category_spacing
Any
the value of bar_category_spacing
get_bar_is_stacked()
Gets the value of bar_is_stacked
Any
the value of bar_is_stacked
get_bar_margin()
Gets the value of bar_margin
Any
the value of bar_margin
get_bar_series_spacing_within_category()
Gets the value of bar_series_spacing_within_category
Any
the value of bar_series_spacing_within_category
get_canvas_fill_alpha()
Gets the value of canvas_fill_alpha
Any
the value of canvas_fill_alpha
get_canvas_fill_color()
Gets the value of canvas_fill_color
Any
the value of canvas_fill_color
get_canvas_fill_color2()
Gets the value of canvas_fill_color2
Any
the value of canvas_fill_color2
get_canvas_fill_color3()
Gets the value of canvas_fill_color3
Any
the value of canvas_fill_color3
get_canvas_fill_color4()
Gets the value of canvas_fill_color4
Any
the value of canvas_fill_color4
get_canvas_margin_x()
Gets the value of canvas_margin_x
Any
the value of canvas_margin_x
get_canvas_margin_y()
Gets the value of canvas_margin_y
Any
the value of canvas_margin_y
get_canvas_outline_color()
Gets the value of canvas_outline_color
Any
the value of canvas_outline_color
get_convert_bar_pie_to_relative()
Gets the value of convert_bar_pie_to_relative
Any
the value of convert_bar_pie_to_relative
get_height()
Gets the value of height
Any
the value of height
get_interactive()
Gets the value of interactive
Any
the value of interactive
get_legend_box_alpha()
Gets the value of legend_box_alpha
Any
the value of legend_box_alpha
get_legend_box_color()
Gets the value of legend_box_color
Any
the value of legend_box_color
get_legend_box_offset_x()
Gets the value of legend_box_offset_x
Any
the value of legend_box_offset_x
get_legend_box_offset_y()
Gets the value of legend_box_offset_y
Any
the value of legend_box_offset_y
get_legend_box_outline_color()
Gets the value of legend_box_outline_color
Any
the value of legend_box_outline_color
get_legend_color()
Gets the value of legend_color
Any
the value of legend_color
get_legend_font()
Gets the value of legend_font
Any
the value of legend_font
get_legend_is_vertical()
Gets the value of legend_is_vertical
Any
the value of legend_is_vertical
get_legend_margin()
Gets the value of legend_margin
Any
the value of legend_margin
get_legend_series_marker_size()
Gets the value of legend_series_marker_size
Any
the value of legend_series_marker_size
get_legend_spacing()
Gets the value of legend_spacing
Any
the value of legend_spacing
get_major_x_gridline_color()
Gets the value of major_x_gridline_color
Any
the value of major_x_gridline_color
get_major_x_gridline_label_angle()
Gets the value of major_x_gridline_label_angle
Any
the value of major_x_gridline_label_angle
get_major_x_gridline_label_color()
Gets the value of major_x_gridline_label_color
Any
the value of major_x_gridline_label_color
get_major_x_gridline_label_font()
Gets the value of major_x_gridline_label_font
Any
the value of major_x_gridline_label_font
get_major_x_gridline_label_halign()
Gets the value of major_x_gridline_label_halign
Any
the value of major_x_gridline_label_halign
get_major_x_gridline_label_margin()
Gets the value of major_x_gridline_label_margin
Any
the value of major_x_gridline_label_margin
get_major_x_gridline_label_valign()
Gets the value of major_x_gridline_label_valign
Any
the value of major_x_gridline_label_valign
get_major_x_gridline_unit()
Gets the value of major_x_gridline_unit
Any
the value of major_x_gridline_unit
get_major_x_gridline_width()
Gets the value of major_x_gridline_width
Any
the value of major_x_gridline_width
get_major_y_gridline_color()
Gets the value of major_y_gridline_color
Any
the value of major_y_gridline_color
get_major_y_gridline_label_angle()
Gets the value of major_y_gridline_label_angle
Any
the value of major_y_gridline_label_angle
get_major_y_gridline_label_color()
Gets the value of major_y_gridline_label_color
Any
the value of major_y_gridline_label_color
get_major_y_gridline_label_font()
Gets the value of major_y_gridline_label_font
Any
the value of major_y_gridline_label_font
get_major_y_gridline_label_halign()
Gets the value of major_y_gridline_label_halign
Any
the value of major_y_gridline_label_halign
get_major_y_gridline_label_margin()
Gets the value of major_y_gridline_label_margin
Any
the value of major_y_gridline_label_margin
get_major_y_gridline_label_valign()
Gets the value of major_y_gridline_label_valign
Any
the value of major_y_gridline_label_valign
get_major_y_gridline_unit()
Gets the value of major_y_gridline_unit
Any
the value of major_y_gridline_unit
get_major_y_gridline_width()
Gets the value of major_y_gridline_width
Any
the value of major_y_gridline_width
get_minor_x_gridline_color()
Gets the value of minor_x_gridline_color
Any
the value of minor_x_gridline_color
get_minor_x_gridline_label_angle()
Gets the value of minor_x_gridline_label_angle
Any
the value of minor_x_gridline_label_angle
get_minor_x_gridline_label_color()
Gets the value of minor_x_gridline_label_color
Any
the value of minor_x_gridline_label_color
get_minor_x_gridline_label_font()
Gets the value of minor_x_gridline_label_font
Any
the value of minor_x_gridline_label_font
get_minor_x_gridline_label_halign()
Gets the value of minor_x_gridline_label_halign
Any
the value of minor_x_gridline_label_halign
get_minor_x_gridline_label_margin()
Gets the value of minor_x_gridline_label_margin
Any
the value of minor_x_gridline_label_margin
get_minor_x_gridline_label_valign()
Gets the value of minor_x_gridline_label_valign
Any
the value of minor_x_gridline_label_valign
get_minor_x_gridline_unit()
Gets the value of minor_x_gridline_unit
Any
the value of minor_x_gridline_unit
get_minor_x_gridline_width()
Gets the value of minor_x_gridline_width
Any
the value of minor_x_gridline_width
get_minor_y_gridline_color()
Gets the value of minor_y_gridline_color
Any
the value of minor_y_gridline_color
get_minor_y_gridline_label_angle()
Gets the value of minor_y_gridline_label_angle
Any
the value of minor_y_gridline_label_angle
get_minor_y_gridline_label_color()
Gets the value of minor_y_gridline_label_color
Any
the value of minor_y_gridline_label_color
get_minor_y_gridline_label_font()
Gets the value of minor_y_gridline_label_font
Any
the value of minor_y_gridline_label_font
get_minor_y_gridline_label_halign()
Gets the value of minor_y_gridline_label_halign
Any
the value of minor_y_gridline_label_halign
get_minor_y_gridline_label_margin()
Gets the value of minor_y_gridline_label_margin
Any
the value of minor_y_gridline_label_margin
get_minor_y_gridline_label_valign()
Gets the value of minor_y_gridline_label_valign
Any
the value of minor_y_gridline_label_valign
get_minor_y_gridline_unit()
Gets the value of minor_y_gridline_unit
Any
the value of minor_y_gridline_unit
get_minor_y_gridline_width()
Gets the value of minor_y_gridline_width
Any
the value of minor_y_gridline_width
get_real_time()
Gets the value of real_time
Any
the value of real_time
get_series()
Gets the value of series
Any
the value of series
get_series(_series_name)
access the Series by name
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_series_name |
String |
the Series name | Yes |
Series
returns the Series in the position, or -1 if invalid
get_series_names()
Gets the value of series_names
Any
the value of series_names
get_series_order()
Gets the value of series_order
Any
the value of series_order
get_show_legend()
Gets the value of show_legend
Any
the value of show_legend
get_stats(_array, [_num_bins])
calculates summary statistics for a numeric array, optionally also calculating histogram bins for plotting
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_array |
Array |
the array | Yes |
_num_bins |
Array |
=0] the number of bins to create the histogram. If zero (default) no histogram will be computed | Yes |
Struct
A struct containing the following:> numeric - whether Chartific interpreted the variable as numeric
> count - the number of data points
> count_distinct - the number of different data points
If the series is numeric, it will contain the following stats:
> sum - the sum of values
> max - the maximum value
> min - the minimum value
> arg_max - the (first) index for which the maximum value occurs
> arg_min - the (first) index for which the minimum value occurs
> average - the mean or average value
> variance - the population variance of the data
> variance_sample - the sample variance of the data
> std_dev - the population standard deviation of the data
> std_dev_sample - the sample standard deviation of the data
> percentiles - an 101-based array. Each index i corresponds to the ith percentile (index 0 is equal to 0).
> median - the median of the distribution. Equal to percentiles[50]
> iqr - inter-quartile range. Equal to percentiles[75] - percentiles[25]
> quartile_1 - 1st quartile of the distribution. Equal to percentiles[25]
> quartile_3 - 3rd quartile of the distribution. Equal to percentiles[75]
> range - range of the distribution. Equal to max-min.
Also if the array is non-numeric it will contain the following arrays:
> grouped_category - array with the distinct values of the input array
> grouped_count - array with the counts of the distinct values of the input array
Additionally, if _num_bins is greater than zero:
> histogram - an array of size = _num_bins with the counts per bin
> histogram_stats - a struct of this type representing the histogram array stats Calculate standard deviation
get_surface()
Gets the value of surface
Any
the value of surface
get_title()
Gets the value of title
Any
the value of title
get_title_angle()
Gets the value of title_angle
Any
the value of title_angle
get_title_color()
Gets the value of title_color
Any
the value of title_color
get_title_font()
Gets the value of title_font
Any
the value of title_font
get_title_halign()
Gets the value of title_halign
Any
the value of title_halign
get_title_offset_x()
Gets the value of title_offset_x
Any
the value of title_offset_x
get_title_offset_y()
Gets the value of title_offset_y
Any
the value of title_offset_y
get_title_valign()
Gets the value of title_valign
Any
the value of title_valign
get_tooltip_alpha()
Gets the value of tooltip_alpha
Any
the value of tooltip_alpha
get_tooltip_background_color()
Gets the value of tooltip_background_color
Any
the value of tooltip_background_color
get_tooltip_background_color2()
Gets the value of tooltip_background_color2
Any
the value of tooltip_background_color2
get_tooltip_background_color3()
Gets the value of tooltip_background_color3
Any
the value of tooltip_background_color3
get_tooltip_background_color4()
Gets the value of tooltip_background_color4
Any
the value of tooltip_background_color4
get_tooltip_label_angle()
Gets the value of tooltip_label_angle
Any
the value of tooltip_label_angle
get_tooltip_label_color()
Gets the value of tooltip_label_color
Any
the value of tooltip_label_color
get_tooltip_label_font()
Gets the value of tooltip_label_font
Any
the value of tooltip_label_font
get_tooltip_label_halign()
Gets the value of tooltip_label_halign
Any
the value of tooltip_label_halign
get_tooltip_label_valign()
Gets the value of tooltip_label_valign
Any
the value of tooltip_label_valign
get_tooltip_max_distance()
Gets the value of tooltip_max_distance
Any
the value of tooltip_max_distance
get_tooltip_outline_color()
Gets the value of tooltip_outline_color
Any
the value of tooltip_outline_color
get_tooltip_padding()
Gets the value of tooltip_padding
Any
the value of tooltip_padding
get_tooltip_spacing_x()
Gets the value of tooltip_spacing_x
Any
the value of tooltip_spacing_x
get_tooltip_spacing_y()
Gets the value of tooltip_spacing_y
Any
the value of tooltip_spacing_y
get_width()
Gets the value of width
Any
the value of width
get_x()
Gets the value of x
Any
the value of x
get_x_label_angle()
Gets the value of x_label_angle
Any
the value of x_label_angle
get_x_label_color()
Gets the value of x_label_color
Any
the value of x_label_color
get_x_label_font()
Gets the value of x_label_font
Any
the value of x_label_font
get_x_label_halign()
Gets the value of x_label_halign
Any
the value of x_label_halign
get_x_label_margin()
Gets the value of x_label_margin
Any
the value of x_label_margin
get_x_label_valign()
Gets the value of x_label_valign
Any
the value of x_label_valign
get_x_max()
Gets the value of x_max
Any
the value of x_max
get_x_min()
Gets the value of x_min
Any
the value of x_min
get_y()
Gets the value of y
Any
the value of y
get_y_label_angle()
Gets the value of y_label_angle
Any
the value of y_label_angle
get_y_label_color()
Gets the value of y_label_color
Any
the value of y_label_color
get_y_label_font()
Gets the value of y_label_font
Any
the value of y_label_font
get_y_label_halign()
Gets the value of y_label_halign
Any
the value of y_label_halign
get_y_label_margin()
Gets the value of y_label_margin
Any
the value of y_label_margin
get_y_label_valign()
Gets the value of y_label_valign
Any
the value of y_label_valign
get_y_max()
Gets the value of y_max
Any
the value of y_max
get_y_min()
Gets the value of y_min
Any
the value of y_min
plot()
plots the chart to screen and processes tooltips
set_axis_arrow_width(_axis_arrow_width)
Sets the value of axis_arrow_width
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_arrow_width |
Any |
the value to set | Yes |
Struct
self
set_axis_color(_axis_color)
Sets the value of axis_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_color |
Any |
the value to set | Yes |
Struct
self
set_axis_has_arrows(_axis_has_arrows)
Sets the value of axis_has_arrows
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_has_arrows |
Any |
the value to set | Yes |
Struct
self
set_axis_minmax_x_label_angle(_axis_minmax_x_label_angle)
Sets the value of axis_minmax_x_label_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_minmax_x_label_angle |
Any |
the value to set | Yes |
Struct
self
set_axis_minmax_x_label_color(_axis_minmax_x_label_color)
Sets the value of axis_minmax_x_label_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_minmax_x_label_color |
Any |
the value to set | Yes |
Struct
self
set_axis_minmax_x_label_font(_axis_minmax_x_label_font)
Sets the value of axis_minmax_x_label_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_minmax_x_label_font |
Any |
the value to set | Yes |
Struct
self
set_axis_minmax_x_label_halign(_axis_minmax_x_label_halign)
Sets the value of axis_minmax_x_label_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_minmax_x_label_halign |
Any |
the value to set | Yes |
Struct
self
set_axis_minmax_x_label_margin(_axis_minmax_x_label_margin)
Sets the value of axis_minmax_x_label_margin
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_minmax_x_label_margin |
Any |
the value to set | Yes |
Struct
self
set_axis_minmax_x_label_valign(_axis_minmax_x_label_valign)
Sets the value of axis_minmax_x_label_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_minmax_x_label_valign |
Any |
the value to set | Yes |
Struct
self
set_axis_minmax_y_label_angle(_axis_minmax_y_label_angle)
Sets the value of axis_minmax_y_label_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_minmax_y_label_angle |
Any |
the value to set | Yes |
Struct
self
set_axis_minmax_y_label_color(_axis_minmax_y_label_color)
Sets the value of axis_minmax_y_label_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_minmax_y_label_color |
Any |
the value to set | Yes |
Struct
self
set_axis_minmax_y_label_font(_axis_minmax_y_label_font)
Sets the value of axis_minmax_y_label_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_minmax_y_label_font |
Any |
the value to set | Yes |
Struct
self
set_axis_minmax_y_label_halign(_axis_minmax_y_label_halign)
Sets the value of axis_minmax_y_label_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_minmax_y_label_halign |
Any |
the value to set | Yes |
Struct
self
set_axis_minmax_y_label_margin(_axis_minmax_y_label_margin)
Sets the value of axis_minmax_y_label_margin
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_minmax_y_label_margin |
Any |
the value to set | Yes |
Struct
self
set_axis_minmax_y_label_valign(_axis_minmax_y_label_valign)
Sets the value of axis_minmax_y_label_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_minmax_y_label_valign |
Any |
the value to set | Yes |
Struct
self
set_axis_title_x(_axis_title_x)
Sets the value of axis_title_x
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_x |
Any |
the value to set | Yes |
Struct
self
set_axis_title_x_angle(_axis_title_x_angle)
Sets the value of axis_title_x_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_x_angle |
Any |
the value to set | Yes |
Struct
self
set_axis_title_x_color(_axis_title_x_color)
Sets the value of axis_title_x_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_x_color |
Any |
the value to set | Yes |
Struct
self
set_axis_title_x_font(_axis_title_x_font)
Sets the value of axis_title_x_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_x_font |
Any |
the value to set | Yes |
Struct
self
set_axis_title_x_halign(_axis_title_x_halign)
Sets the value of axis_title_x_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_x_halign |
Any |
the value to set | Yes |
Struct
self
set_axis_title_x_offset_x(_axis_title_x_offset_x)
Sets the value of axis_title_x_offset_x
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_x_offset_x |
Any |
the value to set | Yes |
Struct
self
set_axis_title_x_offset_y(_axis_title_x_offset_y)
Sets the value of axis_title_x_offset_y
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_x_offset_y |
Any |
the value to set | Yes |
Struct
self
set_axis_title_x_valign(_axis_title_x_valign)
Sets the value of axis_title_x_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_x_valign |
Any |
the value to set | Yes |
Struct
self
set_axis_title_y(_axis_title_y)
Sets the value of axis_title_y
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_y |
Any |
the value to set | Yes |
Struct
self
set_axis_title_y_angle(_axis_title_y_angle)
Sets the value of axis_title_y_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_y_angle |
Any |
the value to set | Yes |
Struct
self
set_axis_title_y_color(_axis_title_y_color)
Sets the value of axis_title_y_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_y_color |
Any |
the value to set | Yes |
Struct
self
set_axis_title_y_font(_axis_title_y_font)
Sets the value of axis_title_y_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_y_font |
Any |
the value to set | Yes |
Struct
self
set_axis_title_y_halign(_axis_title_y_halign)
Sets the value of axis_title_y_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_y_halign |
Any |
the value to set | Yes |
Struct
self
set_axis_title_y_offset_x(_axis_title_y_offset_x)
Sets the value of axis_title_y_offset_x
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_y_offset_x |
Any |
the value to set | Yes |
Struct
self
set_axis_title_y_offset_y(_axis_title_y_offset_y)
Sets the value of axis_title_y_offset_y
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_y_offset_y |
Any |
the value to set | Yes |
Struct
self
set_axis_title_y_valign(_axis_title_y_valign)
Sets the value of axis_title_y_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_title_y_valign |
Any |
the value to set | Yes |
Struct
self
set_axis_width(_axis_width)
Sets the value of axis_width
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_axis_width |
Any |
the value to set | Yes |
Struct
self
set_bar_category_spacing(_bar_category_spacing)
Sets the value of bar_category_spacing
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_bar_category_spacing |
Any |
the value to set | Yes |
Struct
self
set_bar_is_stacked(_bar_is_stacked)
Sets the value of bar_is_stacked
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_bar_is_stacked |
Any |
the value to set | Yes |
Struct
self
set_bar_margin(_bar_margin)
Sets the value of bar_margin
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_bar_margin |
Any |
the value to set | Yes |
Struct
self
set_bar_series_spacing_within_category(_bar_series_spacing_within_category)
Sets the value of bar_series_spacing_within_category
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_bar_series_spacing_within_category |
Any |
the value to set | Yes |
Struct
self
set_canvas_fill_alpha(_canvas_fill_alpha)
Sets the value of canvas_fill_alpha
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_canvas_fill_alpha |
Any |
the value to set | Yes |
Struct
self
set_canvas_fill_color(_canvas_fill_color)
Sets the value of canvas_fill_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_canvas_fill_color |
Any |
the value to set | Yes |
Struct
self
set_canvas_fill_color2(_canvas_fill_color2)
Sets the value of canvas_fill_color2
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_canvas_fill_color2 |
Any |
the value to set | Yes |
Struct
self
set_canvas_fill_color3(_canvas_fill_color3)
Sets the value of canvas_fill_color3
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_canvas_fill_color3 |
Any |
the value to set | Yes |
Struct
self
set_canvas_fill_color4(_canvas_fill_color4)
Sets the value of canvas_fill_color4
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_canvas_fill_color4 |
Any |
the value to set | Yes |
Struct
self
set_canvas_margin_x(_canvas_margin_x)
Sets the value of canvas_margin_x
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_canvas_margin_x |
Any |
the value to set | Yes |
Struct
self
set_canvas_margin_y(_canvas_margin_y)
Sets the value of canvas_margin_y
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_canvas_margin_y |
Any |
the value to set | Yes |
Struct
self
set_canvas_outline_color(_canvas_outline_color)
Sets the value of canvas_outline_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_canvas_outline_color |
Any |
the value to set | Yes |
Struct
self
set_convert_bar_pie_to_relative(_convert_bar_pie_to_relative)
Sets the value of convert_bar_pie_to_relative
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_convert_bar_pie_to_relative |
Any |
the value to set | Yes |
Struct
self
set_height(_height)
Sets the value of height
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_height |
Any |
the value to set | Yes |
Struct
self
set_interactive(_interactive)
Sets the value of interactive
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_interactive |
Any |
the value to set | Yes |
Struct
self
set_legend_box_alpha(_legend_box_alpha)
Sets the value of legend_box_alpha
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_legend_box_alpha |
Any |
the value to set | Yes |
Struct
self
set_legend_box_color(_legend_box_color)
Sets the value of legend_box_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_legend_box_color |
Any |
the value to set | Yes |
Struct
self
set_legend_box_offset_x(_legend_box_offset_x)
Sets the value of legend_box_offset_x
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_legend_box_offset_x |
Any |
the value to set | Yes |
Struct
self
set_legend_box_offset_y(_legend_box_offset_y)
Sets the value of legend_box_offset_y
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_legend_box_offset_y |
Any |
the value to set | Yes |
Struct
self
set_legend_box_outline_color(_legend_box_outline_color)
Sets the value of legend_box_outline_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_legend_box_outline_color |
Any |
the value to set | Yes |
Struct
self
set_legend_color(_legend_color)
Sets the value of legend_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_legend_color |
Any |
the value to set | Yes |
Struct
self
set_legend_font(_legend_font)
Sets the value of legend_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_legend_font |
Any |
the value to set | Yes |
Struct
self
set_legend_is_vertical(_legend_is_vertical)
Sets the value of legend_is_vertical
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_legend_is_vertical |
Any |
the value to set | Yes |
Struct
self
set_legend_margin(_legend_margin)
Sets the value of legend_margin
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_legend_margin |
Any |
the value to set | Yes |
Struct
self
set_legend_series_marker_size(_legend_series_marker_size)
Sets the value of legend_series_marker_size
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_legend_series_marker_size |
Any |
the value to set | Yes |
Struct
self
set_legend_spacing(_legend_spacing)
Sets the value of legend_spacing
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_legend_spacing |
Any |
the value to set | Yes |
Struct
self
set_major_x_gridline_color(_major_x_gridline_color)
Sets the value of major_x_gridline_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_x_gridline_color |
Any |
the value to set | Yes |
Struct
self
set_major_x_gridline_label_angle(_major_x_gridline_label_angle)
Sets the value of major_x_gridline_label_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_x_gridline_label_angle |
Any |
the value to set | Yes |
Struct
self
set_major_x_gridline_label_color(_major_x_gridline_label_color)
Sets the value of major_x_gridline_label_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_x_gridline_label_color |
Any |
the value to set | Yes |
Struct
self
set_major_x_gridline_label_font(_major_x_gridline_label_font)
Sets the value of major_x_gridline_label_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_x_gridline_label_font |
Any |
the value to set | Yes |
Struct
self
set_major_x_gridline_label_halign(_major_x_gridline_label_halign)
Sets the value of major_x_gridline_label_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_x_gridline_label_halign |
Any |
the value to set | Yes |
Struct
self
set_major_x_gridline_label_margin(_major_x_gridline_label_margin)
Sets the value of major_x_gridline_label_margin
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_x_gridline_label_margin |
Any |
the value to set | Yes |
Struct
self
set_major_x_gridline_label_valign(_major_x_gridline_label_valign)
Sets the value of major_x_gridline_label_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_x_gridline_label_valign |
Any |
the value to set | Yes |
Struct
self
set_major_x_gridline_unit(_major_x_gridline_unit)
Sets the value of major_x_gridline_unit
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_x_gridline_unit |
Any |
the value to set | Yes |
Struct
self
set_major_x_gridline_width(_major_x_gridline_width)
Sets the value of major_x_gridline_width
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_x_gridline_width |
Any |
the value to set | Yes |
Struct
self
set_major_y_gridline_color(_major_y_gridline_color)
Sets the value of major_y_gridline_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_y_gridline_color |
Any |
the value to set | Yes |
Struct
self
set_major_y_gridline_label_angle(_major_y_gridline_label_angle)
Sets the value of major_y_gridline_label_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_y_gridline_label_angle |
Any |
the value to set | Yes |
Struct
self
set_major_y_gridline_label_color(_major_y_gridline_label_color)
Sets the value of major_y_gridline_label_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_y_gridline_label_color |
Any |
the value to set | Yes |
Struct
self
set_major_y_gridline_label_font(_major_y_gridline_label_font)
Sets the value of major_y_gridline_label_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_y_gridline_label_font |
Any |
the value to set | Yes |
Struct
self
set_major_y_gridline_label_halign(_major_y_gridline_label_halign)
Sets the value of major_y_gridline_label_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_y_gridline_label_halign |
Any |
the value to set | Yes |
Struct
self
set_major_y_gridline_label_margin(_major_y_gridline_label_margin)
Sets the value of major_y_gridline_label_margin
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_y_gridline_label_margin |
Any |
the value to set | Yes |
Struct
self
set_major_y_gridline_label_valign(_major_y_gridline_label_valign)
Sets the value of major_y_gridline_label_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_y_gridline_label_valign |
Any |
the value to set | Yes |
Struct
self
set_major_y_gridline_unit(_major_y_gridline_unit)
Sets the value of major_y_gridline_unit
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_y_gridline_unit |
Any |
the value to set | Yes |
Struct
self
set_major_y_gridline_width(_major_y_gridline_width)
Sets the value of major_y_gridline_width
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_major_y_gridline_width |
Any |
the value to set | Yes |
Struct
self
set_minor_x_gridline_color(_minor_x_gridline_color)
Sets the value of minor_x_gridline_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_x_gridline_color |
Any |
the value to set | Yes |
Struct
self
set_minor_x_gridline_label_angle(_minor_x_gridline_label_angle)
Sets the value of minor_x_gridline_label_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_x_gridline_label_angle |
Any |
the value to set | Yes |
Struct
self
set_minor_x_gridline_label_color(_minor_x_gridline_label_color)
Sets the value of minor_x_gridline_label_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_x_gridline_label_color |
Any |
the value to set | Yes |
Struct
self
set_minor_x_gridline_label_font(_minor_x_gridline_label_font)
Sets the value of minor_x_gridline_label_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_x_gridline_label_font |
Any |
the value to set | Yes |
Struct
self
set_minor_x_gridline_label_halign(_minor_x_gridline_label_halign)
Sets the value of minor_x_gridline_label_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_x_gridline_label_halign |
Any |
the value to set | Yes |
Struct
self
set_minor_x_gridline_label_margin(_minor_x_gridline_label_margin)
Sets the value of minor_x_gridline_label_margin
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_x_gridline_label_margin |
Any |
the value to set | Yes |
Struct
self
set_minor_x_gridline_label_valign(_minor_x_gridline_label_valign)
Sets the value of minor_x_gridline_label_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_x_gridline_label_valign |
Any |
the value to set | Yes |
Struct
self
set_minor_x_gridline_unit(_minor_x_gridline_unit)
Sets the value of minor_x_gridline_unit
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_x_gridline_unit |
Any |
the value to set | Yes |
Struct
self
set_minor_x_gridline_width(_minor_x_gridline_width)
Sets the value of minor_x_gridline_width
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_x_gridline_width |
Any |
the value to set | Yes |
Struct
self
set_minor_y_gridline_color(_minor_y_gridline_color)
Sets the value of minor_y_gridline_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_y_gridline_color |
Any |
the value to set | Yes |
Struct
self
set_minor_y_gridline_label_angle(_minor_y_gridline_label_angle)
Sets the value of minor_y_gridline_label_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_y_gridline_label_angle |
Any |
the value to set | Yes |
Struct
self
set_minor_y_gridline_label_color(_minor_y_gridline_label_color)
Sets the value of minor_y_gridline_label_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_y_gridline_label_color |
Any |
the value to set | Yes |
Struct
self
set_minor_y_gridline_label_font(_minor_y_gridline_label_font)
Sets the value of minor_y_gridline_label_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_y_gridline_label_font |
Any |
the value to set | Yes |
Struct
self
set_minor_y_gridline_label_halign(_minor_y_gridline_label_halign)
Sets the value of minor_y_gridline_label_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_y_gridline_label_halign |
Any |
the value to set | Yes |
Struct
self
set_minor_y_gridline_label_margin(_minor_y_gridline_label_margin)
Sets the value of minor_y_gridline_label_margin
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_y_gridline_label_margin |
Any |
the value to set | Yes |
Struct
self
set_minor_y_gridline_label_valign(_minor_y_gridline_label_valign)
Sets the value of minor_y_gridline_label_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_y_gridline_label_valign |
Any |
the value to set | Yes |
Struct
self
set_minor_y_gridline_unit(_minor_y_gridline_unit)
Sets the value of minor_y_gridline_unit
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_y_gridline_unit |
Any |
the value to set | Yes |
Struct
self
set_minor_y_gridline_width(_minor_y_gridline_width)
Sets the value of minor_y_gridline_width
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_minor_y_gridline_width |
Any |
the value to set | Yes |
Struct
self
set_real_time(_real_time)
Sets the value of real_time
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_real_time |
Any |
the value to set | Yes |
Struct
self
set_series_names(_series_names)
Sets the value of series_names
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_series_names |
Any |
the value to set | Yes |
Struct
self
set_series_order(_series_order)
Sets the value of series_order
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_series_order |
Any |
the value to set | Yes |
Struct
self
set_show_legend(_show_legend)
Sets the value of show_legend
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_show_legend |
Any |
the value to set | Yes |
Struct
self
set_title(_title)
Sets the value of title
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_title |
Any |
the value to set | Yes |
Struct
self
set_title_angle(_title_angle)
Sets the value of title_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_title_angle |
Any |
the value to set | Yes |
Struct
self
set_title_color(_title_color)
Sets the value of title_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_title_color |
Any |
the value to set | Yes |
Struct
self
set_title_font(_title_font)
Sets the value of title_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_title_font |
Any |
the value to set | Yes |
Struct
self
set_title_halign(_title_halign)
Sets the value of title_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_title_halign |
Any |
the value to set | Yes |
Struct
self
set_title_offset_x(_title_offset_x)
Sets the value of title_offset_x
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_title_offset_x |
Any |
the value to set | Yes |
Struct
self
set_title_offset_y(_title_offset_y)
Sets the value of title_offset_y
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_title_offset_y |
Any |
the value to set | Yes |
Struct
self
set_title_valign(_title_valign)
Sets the value of title_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_title_valign |
Any |
the value to set | Yes |
Struct
self
set_tooltip_alpha(_tooltip_alpha)
Sets the value of tooltip_alpha
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_alpha |
Any |
the value to set | Yes |
Struct
self
set_tooltip_background_color(_tooltip_background_color)
Sets the value of tooltip_background_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_background_color |
Any |
the value to set | Yes |
Struct
self
set_tooltip_background_color2(_tooltip_background_color2)
Sets the value of tooltip_background_color2
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_background_color2 |
Any |
the value to set | Yes |
Struct
self
set_tooltip_background_color3(_tooltip_background_color3)
Sets the value of tooltip_background_color3
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_background_color3 |
Any |
the value to set | Yes |
Struct
self
set_tooltip_background_color4(_tooltip_background_color4)
Sets the value of tooltip_background_color4
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_background_color4 |
Any |
the value to set | Yes |
Struct
self
set_tooltip_label_angle(_tooltip_label_angle)
Sets the value of tooltip_label_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_label_angle |
Any |
the value to set | Yes |
Struct
self
set_tooltip_label_color(_tooltip_label_color)
Sets the value of tooltip_label_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_label_color |
Any |
the value to set | Yes |
Struct
self
set_tooltip_label_font(_tooltip_label_font)
Sets the value of tooltip_label_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_label_font |
Any |
the value to set | Yes |
Struct
self
set_tooltip_label_halign(_tooltip_label_halign)
Sets the value of tooltip_label_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_label_halign |
Any |
the value to set | Yes |
Struct
self
set_tooltip_label_valign(_tooltip_label_valign)
Sets the value of tooltip_label_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_label_valign |
Any |
the value to set | Yes |
Struct
self
set_tooltip_max_distance(_tooltip_max_distance)
Sets the value of tooltip_max_distance
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_max_distance |
Any |
the value to set | Yes |
Struct
self
set_tooltip_outline_color(_tooltip_outline_color)
Sets the value of tooltip_outline_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_outline_color |
Any |
the value to set | Yes |
Struct
self
set_tooltip_padding(_tooltip_padding)
Sets the value of tooltip_padding
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_padding |
Any |
the value to set | Yes |
Struct
self
set_tooltip_spacing_x(_tooltip_spacing_x)
Sets the value of tooltip_spacing_x
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_spacing_x |
Any |
the value to set | Yes |
Struct
self
set_tooltip_spacing_y(_tooltip_spacing_y)
Sets the value of tooltip_spacing_y
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_tooltip_spacing_y |
Any |
the value to set | Yes |
Struct
self
set_width(_width)
Sets the value of width
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_width |
Any |
the value to set | Yes |
Struct
self
set_x(_x)
Sets the value of x
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x |
Any |
the value to set | Yes |
Struct
self
set_x_label_angle(_x_label_angle)
Sets the value of x_label_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x_label_angle |
Any |
the value to set | Yes |
Struct
self
set_x_label_color(_x_label_color)
Sets the value of x_label_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x_label_color |
Any |
the value to set | Yes |
Struct
self
set_x_label_font(_x_label_font)
Sets the value of x_label_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x_label_font |
Any |
the value to set | Yes |
Struct
self
set_x_label_halign(_x_label_halign)
Sets the value of x_label_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x_label_halign |
Any |
the value to set | Yes |
Struct
self
set_x_label_margin(_x_label_margin)
Sets the value of x_label_margin
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x_label_margin |
Any |
the value to set | Yes |
Struct
self
set_x_label_valign(_x_label_valign)
Sets the value of x_label_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x_label_valign |
Any |
the value to set | Yes |
Struct
self
set_x_max(_x_max)
Sets the value of x_max
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x_max |
Any |
the value to set | Yes |
Struct
self
set_x_min(_x_min)
Sets the value of x_min
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x_min |
Any |
the value to set | Yes |
Struct
self
set_y(_y)
Sets the value of y
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y |
Any |
the value to set | Yes |
Struct
self
set_y_label_angle(_y_label_angle)
Sets the value of y_label_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y_label_angle |
Any |
the value to set | Yes |
Struct
self
set_y_label_color(_y_label_color)
Sets the value of y_label_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y_label_color |
Any |
the value to set | Yes |
Struct
self
set_y_label_font(_y_label_font)
Sets the value of y_label_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y_label_font |
Any |
the value to set | Yes |
Struct
self
set_y_label_halign(_y_label_halign)
Sets the value of y_label_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y_label_halign |
Any |
the value to set | Yes |
Struct
self
set_y_label_margin(_y_label_margin)
Sets the value of y_label_margin
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y_label_margin |
Any |
the value to set | Yes |
Struct
self
set_y_label_valign(_y_label_valign)
Sets the value of y_label_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y_label_valign |
Any |
the value to set | Yes |
Struct
self
set_y_max(_y_max)
Sets the value of y_max
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y_max |
Any |
the value to set | Yes |
Struct
self
set_y_min(_y_min)
Sets the value of y_min
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y_min |
Any |
the value to set | Yes |
Struct
self
update()
forces a refresh of the chart, if not in real time
x_to_canvas(_x, [_clamp])
converts a GUI x coordinate to canvas coordinates
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x |
Real |
the GUI x point | Yes |
_clamp |
Boolean |
whether the clamp the resulting canvas coordinate to the canvas [x_min, x_max] | No |
Real
The corresponding canvas coordinate for _x
y_to_canvas(_y, [_clamp])
converts a GUI y coordinate to canvas coordinates
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y |
Real |
the GUI y point | Yes |
_clamp |
Boolean |
whether the clamp the resulting canvas coordinate to the canvas [y_min, y_max] | No |
Real
The corresponding canvas coordinate for _y
Struct return value
Chart
self
Creates a new Series
Constructor parameters
Name | Type | Description | Required? |
---|---|---|---|
_name |
String |
the name of the series | No |
_x_array |
Array |
the X values array - empty by default. If importing from file, leave empty | No |
_y_array |
Array |
the Y values array - empty by default. If importing from file, leave empty | No |
_type |
Enum |
the type of the series, according to the CHARTIFIC_TYPE enum | No |
Methods
add_point(_x, _y, [_x_label], [_y_label])
Adds a point to the Series
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x |
Real |
The x value | Yes |
_y |
Real |
The y value | Yes |
_x_label |
String |
The x label (empty by default) | No |
_y_label |
String |
The y label (empty by default) | No |
export_to_file(_file, [_delimiter], [_export_header], [_x_name], [_y_name])
Exports a series to a flat file
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_file |
String |
The file name | Yes |
_delimiter |
String |
The delimiter to use - by default "," | No |
_export_header |
Boolean |
Whether to include a header row with the names of the columns - by default, false | No |
_x_name |
String |
The name of the X column | No |
_y_name |
String |
The name of the Y column | No |
get_bar_alpha()
Gets the value of bar_alpha
Any
the value of bar_alpha
get_bar_color()
Gets the value of bar_color
Any
the value of bar_color
get_bar_color2()
Gets the value of bar_color2
Any
the value of bar_color2
get_bar_color3()
Gets the value of bar_color3
Any
the value of bar_color3
get_bar_color4()
Gets the value of bar_color4
Any
the value of bar_color4
get_bar_outline_color()
Gets the value of bar_outline_color
Any
the value of bar_outline_color
get_labels_decimal()
Gets the value of labels_decimal
Any
the value of labels_decimal
get_labels_decimal_precision()
Gets the value of labels_decimal_precision
Any
the value of labels_decimal_precision
get_labels_negative_prefix()
Gets the value of labels_negative_prefix
Any
the value of labels_negative_prefix
get_labels_negative_suffix()
Gets the value of labels_negative_suffix
Any
the value of labels_negative_suffix
get_labels_positive_prefix()
Gets the value of labels_positive_prefix
Any
the value of labels_positive_prefix
get_labels_positive_suffix()
Gets the value of labels_positive_suffix
Any
the value of labels_positive_suffix
get_labels_prefix()
Gets the value of labels_prefix
Any
the value of labels_prefix
get_labels_suffix()
Gets the value of labels_suffix
Any
the value of labels_suffix
get_labels_thousands()
Gets the value of labels_thousands
Any
the value of labels_thousands
get_line_color()
Gets the value of line_color
Any
the value of line_color
get_line_width()
Gets the value of line_width
Any
the value of line_width
get_name()
Gets the value of name
Any
the value of name
get_num_bins()
Gets the value of num_bins
Any
the value of num_bins
get_parent_canvas()
Gets the value of parent_canvas
Any
the value of parent_canvas
get_pie_alpha()
Gets the value of pie_alpha
Any
the value of pie_alpha
get_pie_donut_radius()
Gets the value of pie_donut_radius
Any
the value of pie_donut_radius
get_pie_label_separation()
Gets the value of pie_label_separation
Any
the value of pie_label_separation
get_pie_offset_x()
Gets the value of pie_offset_x
Any
the value of pie_offset_x
get_pie_offset_y()
Gets the value of pie_offset_y
Any
the value of pie_offset_y
get_pie_radius()
Gets the value of pie_radius
Any
the value of pie_radius
get_pie_slice_colors()
Gets the value of pie_slice_colors
Any
the value of pie_slice_colors
get_pie_slice_roundness_factor()
Gets the value of pie_slice_roundness_factor
Any
the value of pie_slice_roundness_factor
get_point_color()
Gets the value of point_color
Any
the value of point_color
get_point_highlight_color()
Gets the value of point_highlight_color
Any
the value of point_highlight_color
get_point_highlight_outline_color()
Gets the value of point_highlight_outline_color
Any
the value of point_highlight_outline_color
get_point_highlight_shape()
Gets the value of point_highlight_shape
Any
the value of point_highlight_shape
get_point_highlight_width()
Gets the value of point_highlight_width
Any
the value of point_highlight_width
get_point_label_angle()
Gets the value of point_label_angle
Any
the value of point_label_angle
get_point_label_color()
Gets the value of point_label_color
Any
the value of point_label_color
get_point_label_font()
Gets the value of point_label_font
Any
the value of point_label_font
get_point_label_halign()
Gets the value of point_label_halign
Any
the value of point_label_halign
get_point_label_offset_x()
Gets the value of point_label_offset_x
Any
the value of point_label_offset_x
get_point_label_offset_y()
Gets the value of point_label_offset_y
Any
the value of point_label_offset_y
get_point_label_valign()
Gets the value of point_label_valign
Any
the value of point_label_valign
get_point_outline_color()
Gets the value of point_outline_color
Any
the value of point_outline_color
get_point_shape()
Gets the value of point_shape
Any
the value of point_shape
get_point_width()
Gets the value of point_width
Any
the value of point_width
get_visible()
Gets the value of visible
Any
the value of visible
get_y_max_padding_percent()
Gets the value of y_max_padding_percent
Any
the value of y_max_padding_percent
get_y_min_padding_percent()
Gets the value of y_min_padding_percent
Any
the value of y_min_padding_percent
import_from_file(_file, [_delimiter], [_skip_header], [_x_col_index], [_y_col_index], [_x_is_numeric], [_y_is_numeric], [_series_type])
description
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_file |
String |
the fully-qualified file name | Yes |
_delimiter |
String |
the character to use as delimiter - by default, comma (,) | No |
_skip_header |
Boolean |
whether to skip the first line - by default, false | No |
_x_col_index |
Real |
index of the column to consider for the X dimension - by default, 0 | No |
_y_col_index |
Real |
index of the column to consider for the Y dimension - by default, 1 | No |
_x_is_numeric |
Boolean |
whether X will be numeric - by default, true | No |
_y_is_numeric |
Boolean |
whether Y will be numeric - by default, true | No |
_row_limit |
Real |
optionally specify a maximum number of rows to consider - by default, no limit | No |
_function_x |
Asset.GMFunction |
an optional function to apply to each value for the X column | No |
_function_y |
Asset.GMFunction |
an optional function to apply to each value for the Y column | No |
_series_type |
Enum |
the type of the series to import, according to CHARTIFIC_TYPE enum - by default, SCATTER_PLOT | No |
Series
self
set_bar_alpha(_bar_alpha)
Sets the value of bar_alpha
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_bar_alpha |
Any |
the value to set | Yes |
Struct
self
set_bar_color(_bar_color)
Sets the value of bar_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_bar_color |
Any |
the value to set | Yes |
Struct
self
set_bar_color2(_bar_color2)
Sets the value of bar_color2
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_bar_color2 |
Any |
the value to set | Yes |
Struct
self
set_bar_color3(_bar_color3)
Sets the value of bar_color3
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_bar_color3 |
Any |
the value to set | Yes |
Struct
self
set_bar_color4(_bar_color4)
Sets the value of bar_color4
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_bar_color4 |
Any |
the value to set | Yes |
Struct
self
set_bar_outline_color(_bar_outline_color)
Sets the value of bar_outline_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_bar_outline_color |
Any |
the value to set | Yes |
Struct
self
set_data(_x_array, _y_array, [_x_label_array], [_y_label_array])
Sets the Series data arrays
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_x_array |
Array |
the X values array | No |
_y_array |
Array |
the Y values array | No |
_x_label_array |
Array |
the X labels array, use for Bar/Line/Pie. Only use either x_label_array or y_label_array, not both | No |
_y_label_array |
Array |
the Y labels array, use for Bar/Line/Pie. Only use either x_label_array or y_label_array, not both | No |
set_histogram_bins(_n)
Sets the number of histograms bins for this Series
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_n |
Real |
The number of bins | Yes |
set_labels_decimal(_labels_decimal)
Sets the value of labels_decimal
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_labels_decimal |
Any |
the value to set | Yes |
Struct
self
set_labels_decimal_precision(_labels_decimal_precision)
Sets the value of labels_decimal_precision
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_labels_decimal_precision |
Any |
the value to set | Yes |
Struct
self
set_labels_negative_prefix(_labels_negative_prefix)
Sets the value of labels_negative_prefix
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_labels_negative_prefix |
Any |
the value to set | Yes |
Struct
self
set_labels_negative_suffix(_labels_negative_suffix)
Sets the value of labels_negative_suffix
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_labels_negative_suffix |
Any |
the value to set | Yes |
Struct
self
set_labels_positive_prefix(_labels_positive_prefix)
Sets the value of labels_positive_prefix
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_labels_positive_prefix |
Any |
the value to set | Yes |
Struct
self
set_labels_positive_suffix(_labels_positive_suffix)
Sets the value of labels_positive_suffix
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_labels_positive_suffix |
Any |
the value to set | Yes |
Struct
self
set_labels_prefix(_labels_prefix)
Sets the value of labels_prefix
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_labels_prefix |
Any |
the value to set | Yes |
Struct
self
set_labels_suffix(_labels_suffix)
Sets the value of labels_suffix
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_labels_suffix |
Any |
the value to set | Yes |
Struct
self
set_labels_thousands(_labels_thousands)
Sets the value of labels_thousands
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_labels_thousands |
Any |
the value to set | Yes |
Struct
self
set_line_color(_line_color)
Sets the value of line_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_line_color |
Any |
the value to set | Yes |
Struct
self
set_line_width(_line_width)
Sets the value of line_width
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_line_width |
Any |
the value to set | Yes |
Struct
self
set_name(_name)
Sets the value of name
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_name |
Any |
the value to set | Yes |
Struct
self
set_num_bins(_num_bins)
Sets the value of num_bins
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_num_bins |
Any |
the value to set | Yes |
Struct
self
set_parent_canvas(_parent_canvas)
Sets the value of parent_canvas
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_parent_canvas |
Any |
the value to set | Yes |
Struct
self
set_pie_alpha(_pie_alpha)
Sets the value of pie_alpha
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_pie_alpha |
Any |
the value to set | Yes |
Struct
self
set_pie_donut_radius(_pie_donut_radius)
Sets the value of pie_donut_radius
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_pie_donut_radius |
Any |
the value to set | Yes |
Struct
self
set_pie_label_separation(_pie_label_separation)
Sets the value of pie_label_separation
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_pie_label_separation |
Any |
the value to set | Yes |
Struct
self
set_pie_offset_x(_pie_offset_x)
Sets the value of pie_offset_x
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_pie_offset_x |
Any |
the value to set | Yes |
Struct
self
set_pie_offset_y(_pie_offset_y)
Sets the value of pie_offset_y
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_pie_offset_y |
Any |
the value to set | Yes |
Struct
self
set_pie_radius(_pie_radius)
Sets the value of pie_radius
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_pie_radius |
Any |
the value to set | Yes |
Struct
self
set_pie_slice_colors(_pie_slice_colors)
Sets the value of pie_slice_colors
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_pie_slice_colors |
Any |
the value to set | Yes |
Struct
self
set_pie_slice_roundness_factor(_pie_slice_roundness_factor)
Sets the value of pie_slice_roundness_factor
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_pie_slice_roundness_factor |
Any |
the value to set | Yes |
Struct
self
set_point_color(_point_color)
Sets the value of point_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_color |
Any |
the value to set | Yes |
Struct
self
set_point_highlight_color(_point_highlight_color)
Sets the value of point_highlight_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_highlight_color |
Any |
the value to set | Yes |
Struct
self
set_point_highlight_outline_color(_point_highlight_outline_color)
Sets the value of point_highlight_outline_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_highlight_outline_color |
Any |
the value to set | Yes |
Struct
self
set_point_highlight_shape(_point_highlight_shape)
Sets the value of point_highlight_shape
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_highlight_shape |
Any |
the value to set | Yes |
Struct
self
set_point_highlight_width(_point_highlight_width)
Sets the value of point_highlight_width
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_highlight_width |
Any |
the value to set | Yes |
Struct
self
set_point_label_angle(_point_label_angle)
Sets the value of point_label_angle
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_label_angle |
Any |
the value to set | Yes |
Struct
self
set_point_label_color(_point_label_color)
Sets the value of point_label_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_label_color |
Any |
the value to set | Yes |
Struct
self
set_point_label_font(_point_label_font)
Sets the value of point_label_font
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_label_font |
Any |
the value to set | Yes |
Struct
self
set_point_label_halign(_point_label_halign)
Sets the value of point_label_halign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_label_halign |
Any |
the value to set | Yes |
Struct
self
set_point_label_offset_x(_point_label_offset_x)
Sets the value of point_label_offset_x
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_label_offset_x |
Any |
the value to set | Yes |
Struct
self
set_point_label_offset_y(_point_label_offset_y)
Sets the value of point_label_offset_y
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_label_offset_y |
Any |
the value to set | Yes |
Struct
self
set_point_label_valign(_point_label_valign)
Sets the value of point_label_valign
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_label_valign |
Any |
the value to set | Yes |
Struct
self
set_point_outline_color(_point_outline_color)
Sets the value of point_outline_color
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_outline_color |
Any |
the value to set | Yes |
Struct
self
set_point_shape(_point_shape)
Sets the value of point_shape
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_shape |
Any |
the value to set | Yes |
Struct
self
set_point_width(_point_width)
Sets the value of point_width
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_point_width |
Any |
the value to set | Yes |
Struct
self
set_visible(_visible)
Sets the value of visible
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_visible |
Any |
the value to set | Yes |
Struct
self
set_y_max_padding_percent(_y_max_padding_percent)
Sets the value of y_max_padding_percent
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y_max_padding_percent |
Any |
the value to set | Yes |
Struct
self
set_y_min_padding_percent(_y_min_padding_percent)
Sets the value of y_min_padding_percent
Parameters
Name | Type | Description | Required? |
---|---|---|---|
_y_min_padding_percent |
Any |
the value to set | Yes |
Struct
self
Struct return value
Series
self