Difference between revisions of "CAPicture"

Revision as of 00:14, 2 June 2017

CAPicture holds an in-memory image. A CAPicture is obtained when a computed result contains images. In these cases, the image acts as an atom, contained in one cell of an array, for example, and when you access that cell using CATable::GetDataByElements, CATable::GetDataByLabels, CATable::AtomicValue or CATable::GetSafeArray, the cells with images will be returned as CAPicture objects. When CARenderingStyle::PictureAsText is true, then CAPicture objects are not returned.

With a CAPicture, you can write the image to a file or to a stream.

The width of the image, in pixels.

The height of the graph image, in pixels.

Saves the in-memory image to a given file, in a given format.

Writes the in-memory image to the given stream, in the requested format.

@@ Line 8: / Line 8: @@
 ''new to [[Analytica 5.0]]''
-In progress...
+[[CAPicture]] holds an in-memory image. A [[CAPicture]] is obtained when a computed result contains images. In these cases, the image acts as an atom, contained in one cell of an array, for example, and when you access that cell using [[CATable::GetDataByElements]], [[CATable::GetDataByLabels]], [[CATable::AtomicValue]] or [[CATable::GetSafeArray]], the cells with images will be returned as [[CAPicture]] objects. When [[CARenderingStyle::PictureAsText]] is true, then [[CAPicture]] objects are not returned.
+With a [[CAPicture]], you can write the image to a file or to a stream.
 == Properties ==
+=== {get,put} int [[CAPicture::Width|Width]] ===
+The width of the image, in pixels.
+=== {get,put} int [[CAPicture::Height|Height]] ===
+The height of the graph image, in pixels.
 == Methods ==
+=== bool [[CAPicture::ToFile|ToFile]]( string filename, string mimeType ) ===
+Saves the in-memory image to a given file, in a given format.
+=== bool [[CAPicture::ToStream|ToStream]]( IStream stream, string mimeType ) ===
+Writes the in-memory image to the given stream, in the requested format.
 == See Also ==