diff --git a/formats/advanced-mode.md b/formats/advanced-mode.md new file mode 100644 index 0000000..7cef3b6 --- /dev/null +++ b/formats/advanced-mode.md @@ -0,0 +1,18 @@ +# Advanced mode + +## User doc + +- ***{|\_\_LODEX_WIDTH\_\_|}*** + - Lodex custom variable for Vega and Vega-Lite charts, + this variable is replaced by the width of the parent container before the chart is rendered +- ***{|\_\_LODEX_HEIGHT\_\_|}*** + - Lodex custom variable for Vega and Vega-Lite charts, + this variable is replaced by the height of the parent container before the chart is rendered +- ***container*** + - Vega and Vega-Lite variables, tell Vega to use the size of the parent container, + this variable can be used with `width` and `height` and is highly recommended to be used in any diagram + +## Technical doc + +*TODO* + diff --git a/formats/bar-chart.md b/formats/bar-chart.md new file mode 100644 index 0000000..dcd30e4 --- /dev/null +++ b/formats/bar-chart.md @@ -0,0 +1,54 @@ +# Bar chart - Docs / Notes + +## User doc + +### Input data type + +`_id`, `value` pair only + +### Parameters non-advanced + +- ***Display tooltip*** + - type: *boolean* + - Enable or disable the tooltip on the chart + - Tooltip: Category title + - type: *string* + - Set the name of the category of the tooltip (similar to a prefix) + - Tooltip: Category title + - type: *string* + - Set the name of the value of the tooltip (similar to a prefix) +- ***Color set*** + - type: *HTML colour code list* + - Colour set to colour the bar of the chart +- ***direction*** + - type: *`horizontal` or `vertical`* + - Change the direction of the bar +- ***display category axis in diagonal*** + - type: *boolean* + - Display category with an angle of 45° +- ***display value axis in diagonal*** + - type: *boolean* + - Display category with an angle of 45° +- ***force rounded-up value in axis*** + - type: *boolean* + - Rounded up axis value +- ***Display value*** + - type: *boolean* + - If enabled, display the value on the bar, or if disabled, display the value on the axis +- ***Resolving overlap of axis labels*** + - type: *boolean* + - Try to avoid overlapping labels +- ***scale*** + - type: *`linear` or `logarithmic`* + - Chart scale +- ***bars' width*** + - type: *number* + - Set the size of the bar, if the size is set to 0 or less, the size will be set to auto + +### Parameters advanced + +- see [advanced-mode](advanced-mode.md) + +## Technical doc + +*TODO* \ No newline at end of file