All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages
pdftron::Layout::Chart Class Reference

#include <ContentTree.h>

+ Inheritance diagram for pdftron::Layout::Chart:

Public Member Functions

 ~Chart ()
 
void Destroy ()
 
void SetWidth (double width)
 
double GetWidth ()
 
void SetHeight (double height)
 
double GetHeight ()
 
void SetDefinition (const UString &definition)
 
- Public Member Functions inherited from pdftron::Layout::ContentNode
 ~ContentNode ()
 
void Destroy ()
 
ContentNodeIterator GetContentNodeIterator ()
 
- Public Member Functions inherited from pdftron::Layout::ContentElement
 ~ContentElement ()
 
void Destroy ()
 
ElementRef< List > AsList () const
 
ElementRef< ListItem > AsListItem () const
 
ElementRef< ContentNode > AsContentNode () const
 
ElementRef< TextRun > AsTextRun () const
 
ElementRef< PageNumber > AsPageNumber () const
 
ElementRef< Shape > AsShape () const
 
ElementRef< Float > AsFloat () const
 
ElementRef< Chart > AsChart () const
 
ElementRef< Paragraph > AsParagraph () const
 
ElementRef< Table > AsTable () const
 
ElementRef< TableRow > AsTableRow () const
 
ElementRef< TableCell > AsTableCell () const
 
TextStyledElement GetTextStyledElement ()
 

Friends

class Paragraph
 
class ElementRef< Chart >
 

Additional Inherited Members

- Public Attributes inherited from pdftron::Layout::ContentElement
TRN_ContentElement m_impl
 
- Protected Member Functions inherited from pdftron::Layout::ContentNode
 ContentNode (TRN_ContentNode impl)
 
- Protected Member Functions inherited from pdftron::Layout::ContentElement
 ContentElement (TRN_ContentElement impl)
 

Detailed Description

A Chart is a content element that displays a chart described by a JSON definition string.

Definition at line 1042 of file ContentTree.h.

Constructor & Destructor Documentation

pdftron::Layout::Chart::~Chart ( )

Member Function Documentation

void pdftron::Layout::Chart::Destroy ( )
double pdftron::Layout::Chart::GetHeight ( )

Get the chart height in points.

Returns
The chart height in points.
double pdftron::Layout::Chart::GetWidth ( )

Get the chart width in points.

Returns
The chart width in points.
void pdftron::Layout::Chart::SetDefinition ( const UString &  definition)

Set the chart definition, a JSON string describing the whole chart (type, title, theme, categories and data series).

The definition replaces the chart entirely: any previously applied definition and any styling derived from it is discarded. The chart width and height are not part of the definition and are preserved.

Parameters
definitionThe JSON chart definition.
void pdftron::Layout::Chart::SetHeight ( double  height)

Set the chart height in points.

Parameters
heightThe chart height in points.
void pdftron::Layout::Chart::SetWidth ( double  width)

Set the chart width in points.

Parameters
widthThe chart width in points.

Friends And Related Function Documentation

friend class ElementRef< Chart >
friend

Definition at line 1045 of file ContentTree.h.

friend class Paragraph
friend

Definition at line 1044 of file ContentTree.h.


The documentation for this class was generated from the following file: