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.

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

return values for axis labels #1865

Closed
blazespinnaker opened this issue Jan 11, 2021 · 1 comment
Closed

return values for axis labels #1865

blazespinnaker opened this issue Jan 11, 2021 · 1 comment

Comments

@blazespinnaker
Copy link

blazespinnaker commented Jan 11, 2021

 Get and set axis labels.
..
labels: function(labels: {x?: string, y?: string, y2?: string}): void {
		const $$ = this.internal;

		if (arguments.length) {
			Object.keys(labels).forEach(axisId => {
				$$.axis.setLabelText(axisId, labels[axisId]);
			});

			$$.axis.updateLabels();
		}
	},

should this return a value? I put

return [$$.axis.owner.config.axis_y_label, $$.axis.owner.config.axis_y2_label];

in my code, but not sure if that's best so not doing a PR. Guidance here would be appreciated.

Btw, Is there a list of the TODOs from c3 kept somewhere? This was one of them.

Furthermore, would it be possible to give more headline credit to the c3 project on the front page?

The way c3 is being buried, historically and credit wise, we can't really blame them if they do a reverse fork at this point.

C3 had some very good ideas that this project has leveraged (docs + examples, fairly simple and accessible API), not to mention all that code (the above is verbatim from c3, minus the TODO comment). I'd like to use this project but I don't feel that great because of the lack of credit given to c3.

Plus maybe they will link to billboard if there was more credit given.

@netil
Copy link
Member

netil commented Jan 14, 2021

Hi @blazespinnaker, axis.labels() not return any value, but as the API description "Get and set axis labels.", returning value will be more reasonable.

Furthermore, would it be possible to give more headline credit to the c3 project on the front page?

The description of the fork was maintained almost 2yrs, since the start of the project, and I removed(51cdbf4) it, because at certain point in terms of the codebase and the functionalities literally I can say C3.js and billboard.js are different libraries now.
(but, anyone can still find the history easily by reading "Why we decided to start billboard.js?")

If you take a look on the examples, docs, and the source code(also the internal architecture), you'll notice the differences done.

checkout also the C3 and Billboard issue as the reference.

netil added a commit to netil/billboard.js that referenced this issue Jan 14, 2021
The API description states return values, but it wasn't.
Make return axis' label text object when .axis.labels() is called.

Ref naver#1865
@netil netil closed this as completed in efa5174 Jan 14, 2021
github-actions bot pushed a commit that referenced this issue Jan 20, 2021
# [2.2.0-next.7](2.2.0-next.6...2.2.0-next.7) (2021-01-20)

### Bug Fixes

* **api:** fix incorrect legend text positioning ([f1ede3f](f1ede3f)), closes [#1888](#1888)
* **api:** fix zoom for timesries axis ([0421a50](0421a50)), closes [#1868](#1868)
* **point:** fix usePoint defs id value ([6df4653](6df4653)), closes [#1887](#1887)
* **text:** data labels are working in Internet Explorer again ([865224e](865224e)), closes [#1877](#1877)

### Features

* **api:** make return values for axis.labels() ([efa5174](efa5174)), closes [#1865](#1865)
github-actions bot pushed a commit that referenced this issue Jan 26, 2021
# [2.2.0](2.1.4...2.2.0) (2021-01-26)

### Bug Fixes

* **api:** fix incorrect legend text positioning ([f1ede3f](f1ede3f)), closes [#1888](#1888)
* **api:** fix zoom for timesries axis ([0421a50](0421a50)), closes [#1868](#1868)
* **arc:** fix setting color value ([fad9e86](fad9e86)), closes [#1857](#1857) [#1847](#1847)
* **axis:** fix incorrect tick interval calculation ([1a96f3e](1a96f3e)), closes [#1896](#1896)
* **axis:** rotated horizontal xAxisHeight is calculated correctly after loading new data ([ef2754f](ef2754f)), closes [#1786](#1786) [#1787](#1787)
* **bar:** fix bar width on zoom ([25e987a](25e987a)), closes [#1907](#1907)
* **bar:** fix bar width rendering for 'total' data key ([eacaecb](eacaecb)), closes [#1818](#1818)
* **browser:** fix referencing global order ([8f84cb3](8f84cb3)), closes [#1778](#1778)
* **browser:** fix retrieving global ([3474ac0](3474ac0)), closes [#1826](#1826)
* **color:** fix color callback mismatch ([86ef214](86ef214)), closes [#1847](#1847)
* **data:** fix data.order to work for arc types ([3a716a0](3a716a0)), closes [#1863](#1863)
* **eventrect:** fix resizing event rect element after .load() ([12bf547](12bf547)), closes [#1864](#1864)
* **eventRect:** fix data.onclick work for scatter/bubble ([109c87d](109c87d)), closes [#1795](#1795)
* **point:** fix usePoint defs id value ([6df4653](6df4653)), closes [#1887](#1887)
* **radar:** fix data label text position ([c69d674](c69d674)), closes [#1871](#1871)
* **text:** data labels are working in Internet Explorer again ([865224e](865224e)), closes [#1877](#1877)
* **tooltip:** fix arc's tooltip interaction ([a8586a3](a8586a3)), closes [#1859](#1859)
* **types:** fix .load() data type ([7108e7b](7108e7b)), closes [#1848](#1848)

### Features

* **api:** make return values for axis.labels() ([efa5174](efa5174)), closes [#1865](#1865)
* **data:** Intent to ship data.label multiline ([8903aa6](8903aa6)), closes [#1784](#1784)
* **data.labels.colors:** Add callback support ([ac1affa](ac1affa)), closes [#1845](#1845)
* **gauge:** added support for drawing gauge from 'startingAngle' to 'arcLength' ([25954ad](25954ad)), closes [#1633](#1633) [#1803](#1803) [#1849](#1849)
* **gauge:** Intent to ship gauge.background ([632c600](632c600)), closes [#1804](#1804)
* **pie:** Intent to ship pie.outerRadius ([ca67418](ca67418)), closes [#1825](#1825)
* **point:** Intent to ship point.opacity ([fc5ad35](fc5ad35)), closes [#1867](#1867)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants