Viewer - Interaction
    Preparing search index...

    Class GridRestrictionApi

    Hierarchy

    • AbstractSnapRestrictionApi
      • GridRestrictionApi
    Index

    Constructors

    constructor

    Accessors

    enabled enabledEditable gridUnit gridUnitEditable id priority

    Constructors

    • Parameters

      • restriction: GridRestriction

      Returns GridRestrictionApi

    Accessors

    • get enabled(): boolean

      Whether the restriction is enabled or not.

      Returns boolean

    • set enabled(value: boolean): void

      Whether the restriction is enabled or not.

      Parameters

      • value: boolean

      Returns void

    • get enabledEditable(): boolean

      If the enabling or disabling of the restriction is allowed to the end user. If it is not editable, the default value for enabling or disabling the restriction is used.

      Returns boolean

    • get gridUnit(): number

      Returns number

    • set gridUnit(value: number): void

      Parameters

      • value: number

      Returns void

    • get gridUnitEditable(): boolean

      Returns boolean

    • get id(): string

      The unique identifier of the restriction.

      Returns string

    • get priority(): number

      The priority of the restriction.

      Returns number

    • set priority(value: number): void

      The priority of the restriction.

      Parameters

      • value: number

      Returns void

    Settings

    Member Visibility

    On This Page

    Constructors
    Accessors