Api

IExternalSaveLoadAdapter

Download Markdown

Integration guide · Reference index

Public contract reference. This declaration describes types and callback shapes; availability is constrained by the linked integration guide and the runtime capability. Legacy product-specific fields are not a promise of implementation.

getAllCharts

getAllCharts(): Promise<ChartMetaInfo[]>;

Use the type signature above and the integration guide for the owning capability.

removeChart

removeChart<T extends number | string>(id: T): Promise<void>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`id`	`T`	Yes

saveChart

saveChart(chartData: ChartData): Promise<string>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`chartData`	`ChartData`	Yes

getChartContent

getChartContent(chartId: number): Promise<string>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`chartId`	`number`	Yes

getAllStudyTemplates

getAllStudyTemplates(): Promise<StudyTemplateMetaInfo[]>;

Use the type signature above and the integration guide for the owning capability.

removeStudyTemplate

removeStudyTemplate(studyTemplateInfo: StudyTemplateMetaInfo): Promise<void>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`studyTemplateInfo`	`StudyTemplateMetaInfo`	Yes

saveStudyTemplate

saveStudyTemplate(studyTemplateData: StudyTemplateData): Promise<void>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`studyTemplateData`	`StudyTemplateData`	Yes

getStudyTemplateContent

getStudyTemplateContent(
    studyTemplateInfo: StudyTemplateMetaInfo,
  ): Promise<string>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`studyTemplateInfo`	`StudyTemplateMetaInfo`	Yes

getDrawingTemplates

getDrawingTemplates(toolName: string): Promise<string[]>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`toolName`	`string`	Yes

loadDrawingTemplate

loadDrawingTemplate(toolName: string, templateName: string): Promise<string>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`toolName`	`string`	Yes
`templateName`	`string`	Yes

removeDrawingTemplate

removeDrawingTemplate(toolName: string, templateName: string): Promise<void>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`toolName`	`string`	Yes
`templateName`	`string`	Yes

saveDrawingTemplate

saveDrawingTemplate(
    toolName: string,
    templateName: string,
    content: string,
  ): Promise<void>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`toolName`	`string`	Yes
`templateName`	`string`	Yes
`content`	`string`	Yes

getChartTemplateContent

getChartTemplateContent(templateName: string): Promise<ChartTemplate>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`templateName`	`string`	Yes

getAllChartTemplates

getAllChartTemplates(): Promise<string[]>;

Use the type signature above and the integration guide for the owning capability.

saveChartTemplate

saveChartTemplate(
    newName: string,
    theme: ChartTemplateContent,
  ): Promise<void>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`newName`	`string`	Yes
`theme`	`ChartTemplateContent`	Yes

removeChartTemplate

removeChartTemplate(templateName: string): Promise<void>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`templateName`	`string`	Yes

saveLineToolsAndGroups

saveLineToolsAndGroups(
    layoutId: string | undefined,
    chartId: string | number,
    state: LineToolsAndGroupsState,
  ): Promise<void>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`layoutId`	`string \| undefined`	Yes
`chartId`	`string \| number`	Yes
`state`	`LineToolsAndGroupsState`	Yes

loadLineToolsAndGroups

loadLineToolsAndGroups(
    layoutId: string | undefined,
    chartId: string | number,
    requestType: LineToolsAndGroupsLoadRequestType,
    requestContext: LineToolsAndGroupsLoadRequestContext,
  ): Promise<Partial<LineToolsAndGroupsState> | null>;

Use the type signature above and the integration guide for the owning capability.

Parameter	Type	Required
`layoutId`	`string \| undefined`	Yes
`chartId`	`string \| number`	Yes
`requestType`	`LineToolsAndGroupsLoadRequestType`	Yes
`requestContext`	`LineToolsAndGroupsLoadRequestContext`	Yes

On this page

getAllCharts removeChart saveChart getChartContent getAllStudyTemplates removeStudyTemplate saveStudyTemplate getStudyTemplateContent getDrawingTemplates loadDrawingTemplate removeDrawingTemplate saveDrawingTemplate getChartTemplateContent getAllChartTemplates saveChartTemplate removeChartTemplate saveLineToolsAndGroups loadLineToolsAndGroups Related types