question-mark
Stuck on an issue?

Lightrun Answers was designed to reduce the constant googling that comes with debugging 3rd party libraries. It collects links to all the places you might be looking at while hunting down a tough bug.

And, if you’re still stuck at the end, we’re happy to hop on a call to see how we can help out.

Update documentation for v3

See original GitHub issue

v3 syntax is really different from v2 syntax and the docs don’t quite reflect this.

In all the docs under Axes, it’s not stated what options are available for scaleId, for instance, in the context of options.scales[scaleId].ticks

Please resolve this by stating that scaleId could be x or y (or whatever other options are available)

Issue Analytics

  • State:closed
  • Created 2 years ago
  • Comments:5 (3 by maintainers)

github_iconTop GitHub Comments

1reaction
kurklecommented, May 28, 2021

No, its not actually wrong. You are free to use any valid key as scaleId. If there is no scale config, defaults will be x and y (or r), but if there is, first id for axis is used. There are some “magic” rules to define the axis of a scale, its taken from the first letter, unless specified by the axis or position option.

This is valid for example:

options: {
  scales: {
    sales: {
      position: 'right',
      type: 'linear'
    },
    time: {
      position: 'bottom',
      type: 'time',
    }
  }
}
0reactions
sugohcommented, May 25, 2021

No, its not actually wrong. You are free to use any valid key as scaleId. If there is no scale config, defaults will be x and y (or r), but if there is, first id for axis is used. There are some “magic” rules to define the axis of a scale, its taken from the first letter, unless specified by the axis or position option.

This is valid for example:

options: {
  scales: {
    sales: {
      position: 'right',
      type: 'linear'
    },
    time: {
      position: 'right',
      type: 'time',
    }
  }
}

This is a great feature! Could you add what you just described to the docs?

I’m not the only one who encountered the same roadblock. For instance, it would specifically be helpful if the docs identified [x/y] as the default scaleId before going on to explain what you just mentioned.

Feel free to close this thread whenever you want. I don’t have anything further to add.

Read more comments on GitHub >

github_iconTop Results From Across the Web

Upgrade from V2 to V3 - SAFE Documentation
Documentation for SAFE. ... This guide shows you how to upgrade your v2 project to v3. ... Run paket to update project references:...
Read more >
Update documentation and example configs to v3 API #9735
Initial docs for v3 arrived in #9719. There is still a large body of existing example configs, either standalone or in configuration ...
Read more >
Updating to 3.0 | Capacitor Documentation
Guide for updating Capacitor from v2 to v3 in your app. ... Find the corresponding plugin documentation, keeping in mind that some plugins...
Read more >
Update V3 Txt | Plant Applications 2023 Documentation
Procedure. Navigate to the UAASecrets folder, then select and open the V3. txt file using Notepad++. Update the following details:
Read more >
Update to version 3 - Update module
This article describes how to update an existing CustomerReviews sample module from VC Platform version 2.x to 3.0.
Read more >

github_iconTop Related Medium Post

No results found

github_iconTop Related StackOverflow Question

No results found

github_iconTroubleshoot Live Code

Lightrun enables developers to add logs, metrics and snapshots to live code - no restarts or redeploys required.
Start Free

github_iconTop Related Reddit Thread

No results found

github_iconTop Related Hackernoon Post

No results found

github_iconTop Related Tweet

No results found

github_iconTop Related Dev.to Post

No results found

github_iconTop Related Hashnode Post

No results found