Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Ranges

Hierarchy

Implements

Index

Constructors

constructor

  • new Ranges(folderId: number, pageId: number, pageAccessRights?: undefined | string): Ranges
  • Parameters

    • folderId: number
    • pageId: number
    • Optional pageAccessRights: undefined | string

    Returns Ranges

Properties

Private _folderId

_folderId: number

Private _pageId

_pageId: number

Private _ranges

_ranges: IPageRangeItem[] = []

List of ranges in collection

type

{Array}

listeners

listeners: IListeners = []

onListeners

onListeners: any

Accessors

EVENT_UPDATED

  • get EVENT_UPDATED(): string
  • Returns string

TYPE_FREEZING_RANGE

  • get TYPE_FREEZING_RANGE(): string
  • Returns string

TYPE_PERMISSION_RANGE

  • get TYPE_PERMISSION_RANGE(): string
  • Returns string

ranges

  • Getter for list of ranges

    Returns IPageRangeItem[]

Methods

addRange

  • Adds range to collection. Also prevents duplicate names

    Parameters

    Returns this

emit

  • emit(name: string, args?: any): void
  • Parameters

    • name: string
    • Optional args: any

    Returns void

off

  • off(name: string, callback: any): void
  • Parameters

    • name: string
    • callback: any

    Returns void

on

  • on(name: string, callback: any): void
  • Parameters

    • name: string
    • callback: any

    Returns void

parse

  • Parse range data loaded from service into range collection

    Parameters

    • pageAccessRights: string

    Returns IPageRangeItem[]

register

  • register(callback: any): void
  • Parameters

    • callback: any

    Returns void

removeEvent

  • removeEvent(): void

removeEvents

  • removeEvents(): void

removeRange

  • removeRange(rangeName: string): this
  • Removes range from collection

    Parameters

    • rangeName: string

    Returns this

save

  • save(): Promise<any>
  • Save ranges to a page

    Returns Promise<any>

setRanges

  • Rewrites current collection of ranges with given ranges

    Parameters

    Returns this

unRegister

  • unRegister(callback: any): void
  • Parameters

    • callback: any

    Returns void

Generated using TypeDoc