Skip to content

get_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_paramsT_get_drawing_object_params🔗

Short description🔗

get_drawing_object_paramsGetDrawingObjectParamsGetDrawingObjectParamsget_drawing_object_paramsT_get_drawing_object_params — Get the parameters of a drawing object.

Signature🔗

get_drawing_object_params( drawing_object DrawID, attribute.name GenParamName, out attribute.name GenParamValue )void GetDrawingObjectParams( const HTuple& DrawID, const HTuple& GenParamName, HTuple* GenParamValue )static void HOperatorSet.GetDrawingObjectParams( HTuple drawID, HTuple genParamName, out HTuple genParamValue )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]Herror T_get_drawing_object_params( const Htuple DrawID, const Htuple GenParamName, Htuple* GenParamValue )

HTuple HDrawingObject::GetDrawingObjectParams( const HTuple& GenParamName ) const

HTuple HDrawingObject::GetDrawingObjectParams( const HString& GenParamName ) const

HTuple HDrawingObject::GetDrawingObjectParams( const char* GenParamName ) const

HTuple HDrawingObject::GetDrawingObjectParams( const wchar_t* GenParamName ) const (Windows only)

HTuple HDrawingObject.GetDrawingObjectParams( HTuple genParamName )

HTuple HDrawingObject.GetDrawingObjectParams( string genParamName )

Description🔗

get_drawing_object_paramsGetDrawingObjectParams can be used to query the parameters that describe the drawing object DrawIDdrawIDdraw_id. One may specify one or several parameters which will be retrieved in the output tuple GenParamValuegenParamValuegen_param_value, in the same order as specified in the input tuple GenParamNamegenParamNamegen_param_name.

In addition to the parameters described in set_drawing_object_paramsSetDrawingObjectParams following parameters are possible for GenParamNamegenParamNamegen_param_name:

  • ‘type’: Returns the type of the drawing object. Possible return values are: 'circle'"circle", 'circle_sector'"circle_sector", 'ellipse'"ellipse", 'ellipse_sector'"ellipse_sector", 'rectangle1'"rectangle1", 'rectangle2'"rectangle2", 'line'"line", 'xld'"xld", 'text'"text"

Execution information🔗

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🔗

DrawIDdrawIDdraw_id (input_control) drawing_object → (handle)HTuple (HHandle)HDrawingObject, HTuple (IntPtr)HHandleHtuple (handle)

Handle of the drawing object.

GenParamNamegenParamNamegen_param_name (input_control) attribute.name(-array) → (string)HTuple (HString)HTuple (string)MaybeSequence[str]Htuple (char*)

Parameter names of the drawing object.

List of values: 'color', 'column', 'column1', 'column2', 'end_angle', 'font', 'length1', 'length2', 'line_style', 'line_width', 'marker_size', 'phi', 'radius', 'radius1', 'radius2', 'row', 'row1', 'row2', 'start_angle', 'string', 'type'"color", "column", "column1", "column2", "end_angle", "font", "length1", "length2", "line_style", "line_width", "marker_size", "phi", "radius", "radius1", "radius2", "row", "row1", "row2", "start_angle", "string", "type"

GenParamValuegenParamValuegen_param_value (output_control) attribute.name(-array) → (real / integer / string)HTuple (double / Hlong / HString)HTuple (double / int / long / string)Sequence[Union[float, int, str]]Htuple (double / Hlong / char*)

Parameter values.

Result🔗

get_drawing_object_paramsGetDrawingObjectParams returns 2 (H_MSG_TRUE) if the DrawIDdrawIDdraw_id is valid. Otherwise an exception is raised.

Combinations with other operators🔗

Combinations

Possible predecessors

create_drawing_object_rectangle1CreateDrawingObjectRectangle1, create_drawing_object_rectangle2CreateDrawingObjectRectangle2, create_drawing_object_ellipseCreateDrawingObjectEllipse, create_drawing_object_circleCreateDrawingObjectCircle, create_drawing_object_lineCreateDrawingObjectLine, create_drawing_object_ellipse_sectorCreateDrawingObjectEllipseSector, create_drawing_object_circle_sectorCreateDrawingObjectCircleSector, create_drawing_object_xldCreateDrawingObjectXld, create_drawing_object_textCreateDrawingObjectText, attach_drawing_object_to_windowAttachDrawingObjectToWindow

Possible successors

set_drawing_object_paramsSetDrawingObjectParams, attach_drawing_object_to_windowAttachDrawingObjectToWindow, get_drawing_object_iconicGetDrawingObjectIconic

Alternatives

get_drawing_object_iconicGetDrawingObjectIconic

See also

attach_drawing_object_to_windowAttachDrawingObjectToWindow, get_drawing_object_iconicGetDrawingObjectIconic, set_drawing_object_paramsSetDrawingObjectParams

Module🔗

Foundation