Home > SCH_PrimitiveAttribute > modify

SCH_PrimitiveAttribute.modify() method

This API is provided as a beta preview for developers and may change based on feedback that we receive. Do not use this API in a production environment.

Modify Property

Signature

function modify(
	primitiveId: string | ISCH_PrimitiveAttribute,
	property: {
		x?: number | null;
		y?: number | null;
		rotation?: number | null;
		color?: string | null;
		fontName?: string | null;
		fontSize?: number | null;
		bold?: boolean | null;
		italic?: boolean | null;
		underLine?: boolean | null;
		alignMode?: ESCH_PrimitiveTextAlignMode | null;
		fillColor?: string | null;
		key?: string;
		value?: string;
		keyVisible?: boolean | null;
		valueVisible?: boolean | null;
	},
): Promise<ISCH_PrimitiveAttribute | undefined>;

Parameters

Parameter	Type	Description
primitiveId	string | ISCH_PrimitiveAttribute	Primitive ID
property	{ x?: number | null; y?: number | null; rotation?: number | null; color?: string | null; fontName?: string | null; fontSize?: number | null; bold?: boolean | null; italic?: boolean | null; underLine?: boolean | null; alignMode?: ESCH_PrimitiveTextAlignMode | null; fillColor?: string | null; key?: string; value?: string; keyVisible?: boolean | null; valueVisible?: boolean | null }	Modify Parameter

Returns

Promise<ISCH_PrimitiveAttribute | undefined>

Attribute primitive object