/usr/include/Wt/Chart/WAxis is in libwt-dev 3.3.4+dfsg-6ubuntu1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 | // This may look like C code, but it's really -*- C++ -*-
/*
* Copyright (C) 2008 Emweb bvba, Kessel-Lo, Belgium.
*
* See the LICENSE file for terms of use.
*/
#ifndef CHART_WAXIS_H_
#define CHART_WAXIS_H_
#include <Wt/Chart/WChartGlobal>
#include <Wt/WFont>
#include <Wt/WPen>
#include <Wt/WString>
#include <Wt/WDateTime>
#include <boost/any.hpp>
#include <cfloat>
namespace Wt {
namespace Chart {
class WAbstractChartImplementation;
/*! \brief Enumeration that indicates a chart axis.
*
* \sa WCartesianChart::axis(Axis)
*
* \ingroup charts
*/
enum Axis {
XAxis = 0, //!< X axis.
YAxis = 1, //!< First Y axis (== Y1Axis).
Y1Axis = YAxis, //!< First Y axis (== YAxis).
Y2Axis = 2, //!< Second Y Axis.
OrdinateAxis = YAxis, //!< Ordinate axis (== Y1Axis for a 2D plot).
XAxis_3D = 0, //!< X axis on 3D chart.
YAxis_3D = 3, //!< Y axis on 3D chart.
ZAxis_3D = 1 /* = Y */ //!< Z axis on 3D chart.
};
/*! \brief Enumeration that indicates a logical location for an axis.
*
* The location is dependent on the values of the other axis.
*
* \sa WAxis::setLocation(AxisValue)
*
* \ingroup charts
*/
enum AxisValue {
MinimumValue = 0x1, //!< At the minimum value.
MaximumValue = 0x2, //!< At the maximum value.
ZeroValue = 0x4 //!< At the zero value (if displayed).
};
// for < 3.0.1 compatibility
typedef AxisValue AxisLocation;
W_DECLARE_OPERATORS_FOR_FLAGS(AxisValue)
/*! \brief Enumeration that indicates a scale for an axis.
*
* The scale determines how values are mapped onto an axis.
*
* \sa WAxis::setScale(AxisScale scale)
*
* \ingroup charts
*/
enum AxisScale {
/*! A category scale is set as the scale for the X axis in a \link
* Chart::CategoryChart CategoryChart\endlink, and is only
* applicable there. It lists all values, evenly spaced, and
* consecutively in the order of the model. The categories are
* converted to numbers using their ordinal (first category = 0,
* second = 1, ...).
*/
CategoryScale = 0,
/*! A linear scale is the default scale for all axes, except for the
* X scale in a CategoryScale. It maps values in a linear
* fashion on the axis.
*/
LinearScale = 1,
/*! A logarithmic scale is useful for plotting values with of a
* large range, but only works for positive values.
*/
LogScale = 2,
/*! A date scale is a special linear scale, which is useful for the
* X axis in a ScatterPlot, when the X series contain dates (of type
* WDate). The dates are converted to numbers, as Julian Days.
*/
DateScale = 3,
/*! A datetime scale is a special linear scale, which is useful for
* the X axis in a ScatterPlot, when the X series contain timedates
* (of type WDateTime). The dates are converted to numbers, as the
* number of seconds since the Unix Epoch (midnight Coordinated
* Universal Time (UTC) of January 1, 1970).
*/
DateTimeScale = 4
};
/*! \class WAxis Wt/Chart/WAxis Wt/Chart/WAxis
* \brief Class which represents an axis of a cartesian chart.
*
* A cartesian chart has two or three axes: an X axis (\link
* Chart::XAxis XAxis\endlink), a Y axis (\link Chart::YAxis
* YAxis\endlink) and optionally a second Y axis (\link Chart::Y2Axis
* Y2Axis\endlink). Each of the up to three axes in a cartesian
* chart has a unique id() that identifies which of these three axes
* it is in the enclosing chart().
*
* Use setVisible() to change the visibility of an axis,
* setGridLinesEnabled() to show grid lines for an axis. The pen
* styles for rendering the axis or grid lines may be changed using
* setPen() and setGridLinesPen(). A margin between the axis and the
* main plot area may be configured using setMargin().
*
* By default, the axis will automatically adjust its range so that
* all data will be visible. You may manually specify a range using
* setMinimum(), setMaximum or setRange(). The interval between labels
* is by default automatically adjusted depending on the axis length
* and the range, but may be manually specified using
* setLabelInterval().
*
* The axis has support for being "broken", to support displaying data
* with a few outliers which would otherwise swamp the chart. This is
* not done automatically, but instead you need to use setBreak() to
* specify the value range that needs to be omitted from the axis. The
* omission is rendered in the axis and in bars that cross the break.
*
* The labels are shown using a "%.4g" format string for numbers, and
* a suitable format for \link Chart::DateScale DateScale\endlink or
* \link Chart::DateTimeScale DateTimeScale\endlink scales, based on
* heuristics. The format may be customized using
* setLabelFormat(). The angle of the label text may be changed using
* setLabelAngle(). By default, all labels are printed horizontally.
*
* \sa WCartesianChart
*
* \ingroup charts
*/
class WT_API WAxis
{
public:
/*! \brief Constant which indicates automatic minimum calculation.
*
* \sa setMinimum()
*/
static const double AUTO_MINIMUM;
/*! \brief Constant which indicates automatic maximum calculation
*
* \sa setMaximum()
*/
static const double AUTO_MAXIMUM;
/*! \brief Destructor
*/
virtual ~WAxis();
/*! \brief Returns the axis id.
*
* \sa chart(), WCartesianChart::axis()
*/
Axis id() const { return axis_; }
/*! \brief Sets whether this axis is visible.
*
* Changes whether the axis is displayed, including ticks and
* labels. The rendering of the grid lines is controlled seperately
* by setGridLinesEnabled().
*
* The default value is true for the X axis and first Y axis, but false
* for the second Y axis.
*
* \sa setGridLinesEnabled().
*/
void setVisible(bool visible);
/*! \brief Returns whether this axis is visible.
*
* \sa setVisible()
*/
bool isVisible() const { return visible_; }
/*! \brief Sets the axis location.
*
* Configures the location of the axis, relative to values on the
* other axis (i.e. Y values for the X axis, and X values for the
* Y axis).
*
* The default value is Chart::MinimumValue.
*
* \sa location()
*/
void setLocation(AxisValue value);
/*! \brief Returns the axis location.
*
* \sa setLocation()
*/
AxisValue location() const { return location_; }
/*! \brief Sets the scale of the axis.
*
* For the X scale in a \link Chart::CategoryChart
* CategoryChart\endlink, the scale should be left unchanged to
* \link Chart::CategoryScale CategoryScale\endlink.
*
* For all other axes, the default value is \link Chart::LinearScale
* LinearScale\endlink, but this may be changed to \link
* Chart::LogScale LogScale\endlink or \link Chart::DateScale
* DateScale\endlink. \link Chart::DateScale DateScale\endlink is
* only useful for the X axis in a ScatterPlot which contains WDate
* values.
*
* \sa scale()
*/
void setScale(AxisScale scale);
/*! \brief Returns the scale of the axis.
*
* \sa setScale()
*/
AxisScale scale() const { return scale_; }
/*! \brief Sets the minimum value displayed on the axis.
*
* By default, the minimum and maximum values are determined
* automatically so that all the data can be displayed.
*
* The numerical value corresponding to a data point is
* defined by it's AxisScale type.
*
* \sa setMaximum(), setAutoLimits()
*/
void setMinimum(double minimum);
/*! \brief Returns the minimum value displayed on the axis.
*
* This returned the minimum value that was set using setMinimum(),
* or otherwise the automatically calculated (and rounded) minimum.
*
* The numerical value corresponding to a data point is defined by
* it's AxisScale type.
*
* \sa setMinimum(), setAutoLimits(), setRoundLimits()
*/
double minimum() const;
/*! \brief Sets the maximum value for the axis displayed on the axis.
*
* By default, the minimum and maximum values are determined
* automatically so that all the data can be displayed.
*
* The numerical value corresponding to a data point is
* defined by it's AxisScale type.
*
* \sa setMinimum(), setAutoLimits()
*/
void setMaximum(double maximum);
/*! \brief Returns the maximum value displayed on the axis.
*
* This returned the maximum value that was set using setMaximum(),
* or otherwise the automatically calculated (and rounded) maximum.
*
* The numerical value corresponding to a data point is defined by
* it's AxisScale type.
*
* \sa setMaximum(), setAutoLimits(), setRoundLimits()
*/
double maximum() const;
/*! \brief Sets the axis range (minimum and maximum values) manually.
*
* Specifies both minimum and maximum value for the axis. This
* automatically disables automatic range calculation.
*
* The numerical value corresponding to a data point is defined by
* it's AxisScale type.
*
* \sa setMinimum(), setMaximum()
*/
void setRange(double minimum, double maximum);
/*! \brief Sets the axis resolution.
*
* Specifies the axis resolution, in case maximum-minimum <
* resolution minimum and maximum are modified so the maximum -
* minimum = resolution
*
* The default resolution is 0, which uses a built-in epsilon.
*
* \sa resolution()
*/
void setResolution(double resolution);
/*! \brief Returns the axis resolution.
*
* \sa setResolution()
*/
double resolution() const { return resolution_; }
/*! \brief Let the minimum and/or maximum be calculated from the
* data.
*
* Using this method, you can indicate that you want to have
* automatic limits, rather than limits set manually using
* setMinimum() or setMaximum().
*
* \p locations can be Chart::MinimumValue and/or Chart::MaximumValue.
*
* The default value is Chart::MinimumValue | Chart::MaximumValue.
*/
void setAutoLimits(WFlags<AxisValue> locations);
/*! \brief Returns the limits that are calculated automatically.
*
* This returns the limits (Chart::MinimumValue and/or
* Chart::MaximumValue) that are calculated automatically from the
* data, rather than being specified manually using setMinimum()
* and/or setMaximum().
*
* \sa setAutoLimits()
*/
WFlags<AxisValue> autoLimits() const;
/*! \brief Specifies whether limits should be rounded.
*
* When enabling rounding, this has the effect of rounding down the
* minimum value, or rounding up the maximum value, to the nearest
* label interval.
*
* By default, rounding is enabled for an auto-calculated limited,
* and disabled for a manually specifed limit.
*
* \sa setAutoLimits()
*/
void setRoundLimits(WFlags<AxisValue> locations);
/*! \brief Returns whether limits should be rounded.
*
* \sa setRoundLimits()
*/
WFlags<AxisValue> roundLimits() const { return roundLimits_; }
/*! \brief Specifies a range that needs to be omitted from the axis.
*
* This is useful to display data with a few outliers which would
* otherwise swamp the chart. This is not done automatically, but
* instead you need to use setBreak() to specify the value range
* that needs to be omitted from the axis. The omission is rendered
* in the axis and in BarSeries that cross the break.
*/
void setBreak(double minimum, double maximum);
/*! \brief Sets the label interval.
*
* Specifies the interval for displaying labels (and ticks) on the axis.
* The default value is 0.0, and indicates that the interval should be
* computed automatically.
*
* The unit for the label interval is in logical units (i.e. the same as
* minimum or maximum).
*
* \sa setLabelFormat()
*/
void setLabelInterval(double labelInterval);
/*! \brief Returns the label interval.
*
* \sa setLabelInterval()
*/
double labelInterval() const { return labelInterval_; }
/*! \brief Sets a point to be included as one of the labels (if possible).
*
* The given point will be included as one of the labels, by adjusting
* the minimum value on the axis, if that minimum is auto-computed. This
* is only applicable to a Linear scale axis.
*
* The default value is 0.0.
*
* \sa setRoundLimits()
*/
void setLabelBasePoint(double point);
/*! \brief Returns the base point for labels.
*
* \sa setLabelBasePoint()
*/
double labelBasePoint() const { return labelBasePoint_; }
/*! \brief Sets the label format.
*
* Sets a format string which is used to format values, both for the
* axis labels as well as data series values
* (see WDataSeries::setLabelsEnabled()).
*
* For an axis with a \link Chart::LinearScale LinearScale\endlink
* or \link Chart::LogScale LogScale\endlink scale, the format string
* must be a format string that is accepted by snprintf() and which
* formats one double. If the format string is an empty string,
* then WLocale::toString() is used.
*
* For an axis with a \link Chart::DateScale DateScale\endlink
* scale, the format string must be a format string accepted by
* WDate::toString(), to format a date. If the format string is an
* empty string, a suitable format is chosen based on heuristics.
*
* For an axis with a \link Chart::DateTimeScale
* DateTimeScale\endlink scale, the format string must be a format
* string accepted by WDateTime::toString(), to format a date. If
* the format string is an empty string, a suitable format is chosen
* based on heuristics.
*
* The default value is "%.4g" for a numeric axis, and a suitable
* format for date(time) scales based on a heuristic taking into
* account the current axis range.
*
* \sa labelFormat()
*/
void setLabelFormat(const WString& format);
/*! \brief Returns the label format string.
*
* \sa setLabelFormat()
*/
WString labelFormat() const;
/*! \brief Sets the label angle.
*
* Sets the angle used for displaying the labels (in degrees). A 0 angle
* corresponds to horizontal text. Note that this option is only supported
* by the InlineSvgVml renderers, but not by HtmlCanvas.
*
* The default value is 0.0.
*
* \sa labelAngle()
*/
void setLabelAngle(double angle);
/*! \brief Returns the label angle.
*
* \sa setLabelAngle()
*/
double labelAngle() const { return labelAngle_; }
/*! \brief Sets the title orientation
*
* Sets the orientation used for displaying the title.
*
* The default value is Horizontal
*
* \sa titleOrientation()
*/
void setTitleOrientation(const Orientation& orientation);
/*! \brief Returns the title orientation.
*
* \sa setTitleOrientation()
*/
const Orientation& titleOrientation() const { return titleOrientation_; }
/*! \brief Sets whether gridlines are displayed for this axis.
*
* When <i>enabled</i>, gird lines are drawn for each tick on this axis,
* using the gridLinesPen().
*
* Unlike all other visual aspects of an axis, rendering of the
* gridlines is not controlled by setDisplayEnabled().
*
* \sa setGridLinesPen(), isGridLinesEnabled()
*/
void setGridLinesEnabled(bool enabled);
/*! \brief Returns whether gridlines are displayed for this axis.
*
* \sa setGridLinesEnabled()
*/
bool isGridLinesEnabled() const { return gridLines_; }
/*! \brief Changes the pen used for rendering the axis and ticks.
*
* The default value is a black pen of 0 width.
*
* \sa setGridLinesPen().
*/
void setPen(const WPen& pen);
/*! \brief Changes the pen used for rendering labels for this axis
*
* The default value is a black pen of 0 width.
*
* \sa setGridLinesPen().
* \sa setPen().
* \sa WCartesianChart::setTextPen()
*/
void setTextPen(const WPen& pen);
/*! \brief Returns the pen used for rendering the axis and ticks.
*
* \sa setPen()
*/
const WPen& pen() const { return pen_; }
/*! \brief Changes the pen used for rendering the grid lines.
*
* The default value is a gray pen of 0 width.
*
* \sa setPen(), gridLinesPen().
*/
void setGridLinesPen(const WPen& pen);
/*! \brief Returns the pen used for rendering the grid lines.
*
* \sa setGridLinesPen()
*/
const WPen& gridLinesPen() const { return gridLinesPen_; }
/*! \brief Sets the margin between the axis and the plot area.
*
* The margin is defined in pixels.
*
* The default value is 0.
*
* \sa margin()
*/
void setMargin(int pixels);
/*! \brief Returns the margin between the axis and the plot area.
*
* \sa setMargin()
*/
int margin() const { return margin_; }
/*! \brief Sets the axis title.
*
* The default title is empty.
*
* \sa title()
*/
void setTitle(const WString& title);
/*! \brief Returns the axis title.
*
* \sa setTitle()
*/
const WString& title() const { return title_; }
/*! \brief Sets the axis title font.
*
* The default title font is a 12 point Sans Serif font.
*
* \sa titleFont()
*/
void setTitleFont(const WFont& titleFont);
/*! \brief Returns the axis title font.
*
* \sa setTitleFont()
*/
const WFont& titleFont() const { return titleFont_; }
/*! \brief Sets the offset from the axis for the title label.
*/
void setTitleOffset(double offset) { titleOffset_ = offset; }
/*! \brief Returns the title offset.
*/
double titleOffset() const { return titleOffset_; }
/*! \brief Sets the axis label font.
*
* The default label font is a 10 point Sans Serif font.
*
* \sa labelFont()
*/
void setLabelFont(const WFont& labelFont);
/*! \brief Returns the axis label font.
*
* \sa setLabelFont()
*/
const WFont& labelFont() const { return labelFont_; }
/*! \brief Returns the label for a value.
*
* This returns the label text that corresponds to a given value.
*
* The default implementation uses the labelFormat() to properly represent
* the value.
*/
virtual WString label(double u) const;
/*! \brief Returns the chart to which this axis belongs.
*
* \sa WCartesianChart::axis()
*/
// WCartesianChart *chart() const { return chart_; }
int segmentCount() const { return (int)segments_.size(); }
double segmentMargin() const { return segmentMargin_; }
bool prepareRender(Orientation orientation, double length) const;
void render(WPainter& painter,
WFlags<AxisProperty> properties,
const WPointF& axisStart,
const WPointF& axisEnd,
double tickStart, double tickEnd, double labelPos,
WFlags<AlignmentFlag> labelFlags) const;
/*! \brief Returns the positions for grid lines on this axis.
*
* This returns a list of logical values at which a grid line should
* be drawn on this axis.
*/
virtual std::vector<double> gridLinePositions() const;
void renderLabel(WPainter& painter,
const WString& text, const WPointF& p,
WFlags<AlignmentFlag> flags,
double angle, int margin) const;
void setRenderMirror(bool enable) { renderingMirror_ = enable; }
protected:
/*! \brief Represents a label/tick on the axis.
*/
struct TickLabel {
/*! \brief Enumeration for a tick type */
enum TickLength { Zero, Short, Long };
/*! \brief Position on the axis. */
double u;
/*! \brief Tick length */
TickLength tickLength;
/*! \brief Label text */
WString label;
/*! \brief Creates a label tick. */
TickLabel(double v, TickLength length, const WString& l = WString());
};
WAxis();
/*! \brief Returns the label (and ticks) information for this axis.
*/
virtual void getLabelTicks(std::vector<TickLabel>& ticks, int segment) const;
private:
enum DateTimeUnit { Seconds, Minutes, Hours, Days, Months, Years };
WAbstractChartImplementation *chart_;
Axis axis_;
bool visible_;
AxisValue location_;
AxisScale scale_;
double resolution_;
double labelInterval_;
double labelBasePoint_;
WString labelFormat_;
bool defaultLabelFormat_;
bool gridLines_;
WPen pen_, gridLinesPen_;
int margin_;
double labelAngle_;
WString title_;
WFont titleFont_, labelFont_;
WFlags<AxisValue> roundLimits_;
double segmentMargin_;
double titleOffset_;
WPen textPen_;
Orientation titleOrientation_;
// for 3D charts, don't call update when the labelangle is tempor. changed
bool renderingMirror_;
struct Segment {
double minimum, maximum;
mutable double renderMinimum, renderMaximum, renderLength, renderStart;
mutable DateTimeUnit dateTimeRenderUnit;
mutable int dateTimeRenderInterval;
Segment();
};
std::vector<Segment> segments_;
mutable double renderInterval_;
void init(WAbstractChartImplementation* chart, Axis axis);
void update();
template <typename T>
bool set(T& m, const T& v);
void computeRange(const Segment& segment) const;
void setOtherAxisLocation(AxisValue otherLocation) const;
double getValue(const boost::any& v) const;
static double getDateValue(const boost::any& value);
double calcAutoNumLabels(Orientation orientation, const Segment& s) const;
WString defaultDateTimeFormat(const Segment& s) const;
double mapFromDevice(double d) const;
double mapToDevice(const boost::any& value, int segment = 0) const;
double mapToDevice(double value, int segment = 0) const;
long getDateNumber(Wt::WDateTime dt) const;
friend class WCartesianChart;
friend class WCartesian3DChart;
friend class WChart2DRenderer;
};
template <typename T>
bool WAxis::set(T& m, const T& v)
{
if (m != v) {
m = v;
update();
return true;
} else
return false;
}
}
}
#endif // CHART_WAXIS_H_
|