Interface DrawingTemplates

Readonlystore

apply

• apply(ids: readonly string[], values: DrawingTemplateValues): number

• Apply a look to the editable drawings among ids as one undo step. Returns how many changed.

  Parameters

  • ids: readonly string[]
  • values: DrawingTemplateValues

  Returns number

capture

• capture(drawing: Drawing): DrawingTemplateValues

• The look of a drawing: every setting its schema declares, except the words it says and where it is.

  Parameters

  • drawing: Drawing

  Returns DrawingTemplateValues

catalog

• catalog(): null | DrawingTemplateCatalog

• The catalog as last loaded or committed; null until the first load lands, or when it failed.

  Returns null | DrawingTemplateCatalog

clearDefault

• clearDefault(tool: string): Promise<void>

• Forget a tool's default.

  Parameters

  • tool: string

  Returns Promise<void>

defaultFor

• defaultFor(tool: string): undefined | DrawingTemplateValues

• The look new drawings of tool start with, if one was saved.

  Parameters

  • tool: string

  Returns undefined | DrawingTemplateValues

destroy

• destroy(): void

• Returns void

removeTemplate

• removeTemplate(templateId: string): Promise<void>

• Parameters

  • templateId: string

  Returns Promise<void>

saveDefault

• saveDefault(id: string): Promise<void>

• Save the look of drawing id as its tool's default.

  Parameters

  • id: string

  Returns Promise<void>

saveTemplate

• saveTemplate(id: string, name: string): Promise<DrawingTemplate>

• Save the look of drawing id under name.

  Parameters

  • id: string
  • name: string

  Returns Promise<DrawingTemplate>

subscribe

• subscribe(listener: () => void): () => void

• Called after the held catalog changes. Returns the unsubscribe.

  Parameters

  • listener: () => void

  Returns () => void

templatesFor

• templatesFor(tool: string): DrawingTemplate[]

• The saved templates of one tool, in the order they were saved.

  Parameters

  • tool: string

  Returns DrawingTemplate[]