Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

docs: add JSDoc for attributes [skip ci] #487

Merged
merged 2 commits into from
Jul 20, 2020
Merged

docs: add JSDoc for attributes [skip ci] #487

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
4ca4029
docs: add JSDoc for attributes [skip ci]
web-padawan Jul 17, 2020
bb60072
docs: add missing annotations [skip ci]
web-padawan Jul 20, 2020
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/vaadin-chart-series.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -140,6 +140,7 @@
* Sets the value to a series bound by 'unit' property.
* Otherwise sets the value to the first series.
* Undefined by default (determined from data).
* @attr {number} value-min
*/
valueMin: {
type: Number,
Expand All @@ -149,6 +150,7 @@
/**
* Value-axis maximum-value.
* See the 'valueMin'
* @attr {number} value-max
*/
valueMax: {
type: Number,
Expand Down Expand Up @@ -212,6 +214,7 @@
* The height of the neck, the lower part of the funnel.
* A number defines pixel width, a percentage string defines a percentage of the plot area height. Defaults to 30%.
* Note that this property only applies for "funnel" charts.
* @attr {number | string} neck-position
* @type {number | string}
*/
neckPosition: {
Expand All @@ -223,6 +226,7 @@
* The width of the neck, the lower part of the funnel.
* A number defines pixel width, a percentage string defines a percentage of the plot area width. Defaults to 30%.
* Note that this property only applies for "funnel" charts.
* @attr {number | string} neck-width
* @type {number | string}
*/
neckWidth: {
Expand Down
6 changes: 6 additions & 0 deletions src/vaadin-chart.html
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -330,6 +330,7 @@

/**
* Category-axis maximum value. Defaults to `undefined`.
* @attr {number} category-max
*/
categoryMax: {
type: Number,
Expand All @@ -338,6 +339,7 @@

/**
* Category-axis minimum value. Defaults to `undefined`.
* @attr {number} category-min
*/
categoryMin: {
type: Number,
Expand All @@ -352,6 +354,7 @@
*
* Defaults to `undefined`
*
* @attr {left|right|top|bottom} category-position
* @type {ChartCategoryPosition | undefined}
*/
categoryPosition: {
Expand All @@ -362,6 +365,7 @@
/**
* Specifies whether to hide legend or show.
* Legend configuration can be set up via additionalOptions property
* @attr {boolean} no-legend
*/
noLegend: {
type: Boolean,
Expand All @@ -373,6 +377,7 @@
* Possible values are null, "normal" or "percent".
* If "stack" property is not defined on the vaadin-chart-series elements, then series will be put into
* the default stack.
* @attr {normal|percent} stacking
* @type {ChartStacking | undefined}
*/
stacking: {
Expand Down Expand Up @@ -438,6 +443,7 @@

/**
* Specifies the message displayed on a chart without displayable data.
* @attr {string} empty-text
* @type {string}
*/
emptyText: {
Expand Down