takeScreenshotInputParameters#
- class hvpy.parameters.takeScreenshotInputParameters(**data)[source]#
Bases:
HvpyParameters
Handles the input parameters of the
takeScreenshot
API.- date#
Desired datetime of the image.
- imageScale#
Image scale in arcseconds per pixel.
- layers#
Image datasource layer(s) to include in the screenshot.
- events#
List feature/event types and FRMs to use to annotate the movie. Use the empty string to indicate that no feature/event annotations should be shown. Default is
None
, optional.
- scaleX#
Horizontal offset of the image scale indicator in arcseconds with respect to the center of the Sun. Default is
None
, optional.
- scaleY#
Vertical offset of the image scale indicator in arcseconds with respect to the center of the Sun. Default is
None
, optional.
- width#
Width of the field of view in pixels. Used in conjunction width
x0
,``y0``, andheight
. Default isNone
, optional.
- height#
Height of the field of view in pixels. Used in conjunction width
x0
,``y0``, andwidth
. Default isNone
, optional.
- x0#
The horizontal offset of the center of the field of view from the center of the Sun. Used in conjunction with
y0
,width
, andheight
. Default isNone
, optional.
- y0#
The vertical offset of the center of the field of view from the center of the Sun. Used in conjunction with
x0
,width
, andheight
. Default isNone
, optional.
- x1#
The horizontal offset of the top-left corner of the field of view with respect to the center of the Sun (in arcseconds). Used in conjunction with
y1
,x2
, andy2
. Default isNone
, optional.
- y1#
The vertical offset of the top-left corner of the field of view with respect to the center of the Sun (in arcseconds). Used in conjunction with
x1
,x2
, andy2
. Default isNone
, optional.
- x2#
The horizontal offset of the bottom-right corner of the field of view with respect to the center of the Sun (in arcseconds). Used in conjunction with
x1
,y1
, andy2
. Default isNone
, optional.
- y2#
The vertical offset of the bottom-right corner of the field of view with respect to the center of the Sun (in arcseconds). Used in conjunction with
x1
,y1
, andx2
. Default isNone
, optional.
- display#
Set to true to directly output binary PNG image data. Default is
False
(which outputs a JSON object), optional.
- watermark#
Overlay a watermark consisting of a Helioviewer logo, the datasource abbreviation(s) and timestamp(s) displayed in the screenshot. Default is
False
, optional. Optional.
- callback#
Wrap the response object in a function call of your choosing. Default is
None
(no wrapping), optional.
References