Represents the options used to generate a ChartImage. More...
| Header: | #include <ChartImageParameters.h> |
| Since: | Esri::ArcGISRuntime 200.3 |
| Inherits: | Esri::ArcGISRuntime::Object |
Public Functions
| ChartImageParameters(int width, int height, QObject *parent = nullptr) | |
| virtual | ~ChartImageParameters() override |
| int | height() const |
| bool | isGenerateLegend() const |
| float | screenScale() const |
| void | setGenerateLegend(bool generateLegend) |
| void | setScreenScale(float screenScale) |
| void | setStyle(Esri::ArcGISRuntime::ChartImageStyle style) |
| Esri::ArcGISRuntime::ChartImageStyle | style() const |
| int | width() const |
Detailed Description
See also ChartImage and PopupMedia::generateChartAsync.
Member Function Documentation
ChartImageParameters::ChartImageParameters (int width, int height, QObject *parent = nullptr)
Creates a ChartImageParameters with the specified width and height.
- width - The width of the expected chart image in physical pixels.
- height - The height of the expected chart image in physical pixels.
- parent - The optional parent QObject.
[override virtual] ChartImageParameters::~ChartImageParameters ()
Destructor.
int ChartImageParameters::height() const
Returns the height of the expected chart image in physical pixels.
bool ChartImageParameters::isGenerateLegend () const
Returns true if the legend should be included in the chart.
The default value is true.
float ChartImageParameters::screenScale () const
Returns the number of pixels per DIP (sometimes referred to as screen density or device pixel ratio).
This parameter controls the font sizes, margins and line thicknesses for the chart to be readable at the specified screen scale.
The default screen scale is 1.
See also setScreenScale().
void ChartImageParameters::setGenerateLegend (bool generateLegend )
Sets the generateLegend to generateLegend.
See also isGenerateLegend.
void ChartImageParameters::setScreenScale (float screenScale )
Sets the screenScale to screenScale.
See also screenScale.
void ChartImageParameters::setStyle (Esri::ArcGISRuntime::ChartImageStyle style)
Sets the style to style.
See also style.
Esri::ArcGISRuntime::ChartImageStyle ChartImageParameters::style() const
Returns the style used to generate the ChartImage.
The default style is ChartImageStyle::Neutral.
See also setStyle().
int ChartImageParameters::width() const
Returns the width of the expected chart image in physical pixels.