UNPKG

@shapediver/viewer.session

Version:

This is the npm package for the ShapeDiver Viewer Session API. For more information on ShapeDiver, please visit our [homepage](https://shapediver.com/).

40 lines 1.8 kB
import { ResParameterGroup, ResStructureType } from "@shapediver/sdk.geometry-api-sdk-v2"; import { IParameter } from "@shapediver/viewer.session-engine.session-engine"; import { PARAMETER_TYPE, PARAMETER_VISUALIZATION } from "@shapediver/viewer.shared.types"; import { IParameterApi } from "../../interfaces/parameter/IParameterApi"; export declare class ParameterApi<T> implements IParameterApi<T> { #private; constructor(parameter: IParameter<T>); get choices(): string[] | undefined; get decimalplaces(): number | undefined; get defval(): string; get displayname(): string | undefined; set displayname(value: string | undefined); get expression(): string | undefined; get format(): string[] | undefined; get group(): ResParameterGroup | undefined; get hidden(): boolean; set hidden(value: boolean); get id(): string; get max(): number | undefined; get min(): number | undefined; get name(): string; get order(): number | undefined; set order(value: number | undefined); get sessionValue(): T | string; set sessionValue(value: T | string); get settings(): Record<string, any> | undefined; get structure(): ResStructureType | undefined; get tooltip(): string | undefined; set tooltip(value: string | undefined); get type(): PARAMETER_TYPE; get value(): T | string; set value(value: T | string); get visualization(): PARAMETER_VISUALIZATION | undefined; isValid(value: unknown, throwError?: boolean): boolean; resetToDefaultValue(): void; resetToSessionValue(): void; stringify(value?: unknown): string; } export declare const isParameterApi: (obj: unknown) => obj is IParameterApi<unknown>; //# sourceMappingURL=ParameterApi.d.ts.map