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

Jump to bottom

Update charts.md #7609

Merged
merged 1 commit into from Jul 12, 2020
Merged

Update charts.md #7609

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
12 changes: 4 additions & 8 deletions docs/docs/developers/charts.md
View file
Open in desktop
Expand Up @@ -29,12 +29,8 @@ Dataset controllers must implement the following interface.
// Create elements for each piece of data in the dataset. Store elements in an array on the dataset as dataset.metaData
addElements: function() {},

// Create a single element for the data at the given index and reset its state
addElementAndReset: function(index) {},

// Draw the representation of the dataset
// @param ease : if specified, this number represents how far to transition elements. See the implementation of draw() in any of the provided controllers to see how this should be used
draw: function(ease) {},
draw: function() {},

// Remove hover styling from the given element
removeHoverStyle: function(element, datasetIndex, index) {},
Expand All @@ -43,8 +39,8 @@ Dataset controllers must implement the following interface.
setHoverStyle: function(element, datasetIndex, index) {},

// Update the elements in response to new data
// @param reset : if true, put the elements into a reset state so they can animate to their final values
update: function(reset) {}
// @param mode : update mode, core calls this method using any of `'active'`, `'hide'`, `'reset'`, `'resize'`, `'show'` or `undefined`
update: function(mode) {}
}
```

Expand All @@ -53,7 +49,7 @@ The following methods may optionally be overridden by derived dataset controller
```javascript
{
// Initializes the controller
initialize: function(chart, datasetIndex) {},
initialize: function() {},

// Ensures that the dataset represented by this controller is linked to a scale. Overridden to helpers.noop in the polar area and doughnut controllers as these
// chart types using a single scale
Expand Down