insightSetParameters()

Home > @gooddata/sdk-model > insightSetParameters

insightSetParameters() function

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

Gets a new insight that 'inherits' all data from the provided insight but has different parameter values.

Signature:

export declare function insightSetParameters<T extends IInsightDefinition>(insight: T, parameters?: IInsightParameterValue[]): T;

Parameters

Parameter	Type	Description
insight	T	insight to work with
parameters	IInsightParameterValue[]	(Optional) parameter values to apply to the insight (defaults to empty array)

Returns:

T

always a new instance

Remarks

New parameter values will be used in the new insight as-is, no merging with existing values.