Class ParagraphStyleController

The ParagraphStyleController is responsible for all communication regarding paragraph styles. Methods inside this controller can be called by window.SDK.paragraphStyle.{method-name}

Hierarchy

ParagraphStyleController

Index

Methods

create duplicate getAll getById move remove rename update

Methods

create

create(): Promise<EditorResponse<string>>
This method creates a new paragraph style

Returns
the id of new paragraph style

Returns Promise<EditorResponse<string>>
- Defined in src/controllers/ParagraphStyleController.ts:45

duplicate

duplicate(id: string): Promise<EditorResponse<string>>
This method duplicates a paragraph style

Returns
the new paragraph style id
Parameters
- id: string
  
  the id of a specific paragraph style
Returns Promise<EditorResponse<string>>
- Defined in src/controllers/ParagraphStyleController.ts:55

getAll

getAll(): Promise<EditorResponse<ParagraphStyle[]>>
This method returns the list of paragraph styles

Returns

Returns Promise<EditorResponse<ParagraphStyle[]>>
- Defined in src/controllers/ParagraphStyleController.ts:26

getById

getById(id: string): Promise<EditorResponse<ParagraphStyle>>
This method returns a paragraph style by id

Returns
Parameters
- id: string
  
  the id of a specific paragraph style
Returns Promise<EditorResponse<ParagraphStyle>>
- Defined in src/controllers/ParagraphStyleController.ts:36

move

move(order: number, ids: string[]): Promise<EditorResponse<null>>
This method changes positions of paragraph styles

Returns
Parameters
- order: number
  
  the position of the paragraph styles
- ids: string[]
  
  the list of paragraph style ids
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/ParagraphStyleController.ts:100

remove

remove(id: string): Promise<EditorResponse<null>>
This method removes a paragraph style

Returns
Parameters
- id: string
  
  the id of a specific paragraph style
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/ParagraphStyleController.ts:89

rename

rename(id: string, name: string): Promise<EditorResponse<null>>
This method renames a paragraph style

Returns
Parameters
- id: string
  
  the id of a specific paragraph style
- name: string
  
  the new name of the paragraph style
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/ParagraphStyleController.ts:79

update

update(id: string, properties: ParagraphStyleUpdate): Promise<EditorResponse<null>>
This method updates a paragraph style

Returns
Parameters
- id: string
  
  the id of a specific paragraph style
- properties: ParagraphStyleUpdate
  
  The new paragraph style properties
Returns Promise<EditorResponse<null>>
- Defined in src/controllers/ParagraphStyleController.ts:66

Generated using TypeDoc