get_drawing_object_paramsT_get_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_params (Operator)
get_drawing_object_paramsT_get_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_params — Get the parameters of a drawing object.
Signature
def get_drawing_object_params(draw_id: HHandle, gen_param_name: MaybeSequence[str]) -> Sequence[Union[float, int, str]]
def get_drawing_object_params_s(draw_id: HHandle, gen_param_name: MaybeSequence[str]) -> Union[float, int, str]
Description
get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_params can be used to query the parameters that
describe the drawing object DrawIDDrawIDDrawIDdrawIDdraw_id. One may specify one or several
parameters which will be retrieved in the output tuple GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value,
in the same order as specified in the input tuple GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name.
In addition to the parameters described in set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParamsset_drawing_object_params
following parameters are possible for GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name:
- 'type':
Returns the type of the drawing object. Possible return values are:
'circle'"circle""circle""circle""circle", 'circle_sector'"circle_sector""circle_sector""circle_sector""circle_sector", 'ellipse'"ellipse""ellipse""ellipse""ellipse", 'ellipse_sector'"ellipse_sector""ellipse_sector""ellipse_sector""ellipse_sector",
'rectangle1'"rectangle1""rectangle1""rectangle1""rectangle1", 'rectangle2'"rectangle2""rectangle2""rectangle2""rectangle2", 'line'"line""line""line""line", 'xld'"xld""xld""xld""xld", 'text'"text""text""text""text"
Execution Information
- Multithreading type: reentrant (runs in parallel with non-exclusive operators).
- Multithreading scope: global (may be called from any thread).
- Processed without parallelization.
Parameters
DrawIDDrawIDDrawIDdrawIDdraw_id (input_control) drawing_object → HDrawingObject, HTupleHHandleHTupleHtuple (handle) (IntPtr) (HHandle) (handle)
Handle of the drawing object.
GenParamNameGenParamNameGenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → HTupleMaybeSequence[str]HTupleHtuple (string) (string) (HString) (char*)
Parameter names of the drawing object.
List of values:
'color'"color""color""color""color", 'column'"column""column""column""column", 'column1'"column1""column1""column1""column1", 'column2'"column2""column2""column2""column2", 'end_angle'"end_angle""end_angle""end_angle""end_angle", 'font'"font""font""font""font", 'length1'"length1""length1""length1""length1", 'length2'"length2""length2""length2""length2", 'line_style'"line_style""line_style""line_style""line_style", 'line_width'"line_width""line_width""line_width""line_width", 'marker_size'"marker_size""marker_size""marker_size""marker_size", 'phi'"phi""phi""phi""phi", 'radius'"radius""radius""radius""radius", 'radius1'"radius1""radius1""radius1""radius1", 'radius2'"radius2""radius2""radius2""radius2", 'row'"row""row""row""row", 'row1'"row1""row1""row1""row1", 'row2'"row2""row2""row2""row2", 'start_angle'"start_angle""start_angle""start_angle""start_angle", 'string'"string""string""string""string", 'type'"type""type""type""type"
GenParamValueGenParamValueGenParamValuegenParamValuegen_param_value (output_control) attribute.name(-array) → HTupleSequence[Union[float, int, str]]HTupleHtuple (real / integer / string) (double / int / long / string) (double / Hlong / HString) (double / Hlong / char*)
Parameter values.
Result
get_drawing_object_paramsget_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_params returns 2 (
H_MSG_TRUE)
, if the DrawIDDrawIDDrawIDdrawIDdraw_id is valid.
Otherwise an exception is raised.
Possible Predecessors
create_drawing_object_rectangle1create_drawing_object_rectangle1CreateDrawingObjectRectangle1CreateDrawingObjectRectangle1create_drawing_object_rectangle1,
create_drawing_object_rectangle2create_drawing_object_rectangle2CreateDrawingObjectRectangle2CreateDrawingObjectRectangle2create_drawing_object_rectangle2,
create_drawing_object_ellipsecreate_drawing_object_ellipseCreateDrawingObjectEllipseCreateDrawingObjectEllipsecreate_drawing_object_ellipse,
create_drawing_object_circlecreate_drawing_object_circleCreateDrawingObjectCircleCreateDrawingObjectCirclecreate_drawing_object_circle,
create_drawing_object_linecreate_drawing_object_lineCreateDrawingObjectLineCreateDrawingObjectLinecreate_drawing_object_line,
create_drawing_object_ellipse_sectorcreate_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSectorCreateDrawingObjectEllipseSectorcreate_drawing_object_ellipse_sector,
create_drawing_object_circle_sectorcreate_drawing_object_circle_sectorCreateDrawingObjectCircleSectorCreateDrawingObjectCircleSectorcreate_drawing_object_circle_sector,
create_drawing_object_xldcreate_drawing_object_xldCreateDrawingObjectXldCreateDrawingObjectXldcreate_drawing_object_xld,
create_drawing_object_textcreate_drawing_object_textCreateDrawingObjectTextCreateDrawingObjectTextcreate_drawing_object_text,
attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window
Possible Successors
set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParamsset_drawing_object_params,
attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window,
get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicget_drawing_object_iconic
Alternatives
get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicget_drawing_object_iconic
See also
attach_drawing_object_to_windowattach_drawing_object_to_windowAttachDrawingObjectToWindowAttachDrawingObjectToWindowattach_drawing_object_to_window,
get_drawing_object_iconicget_drawing_object_iconicGetDrawingObjectIconicGetDrawingObjectIconicget_drawing_object_iconic,
set_drawing_object_paramsset_drawing_object_paramsSetDrawingObjectParamsSetDrawingObjectParamsset_drawing_object_params
Module
Foundation