Class StiMargin

Describes the class that realizes object margin.

Hierarchy

  • StiMargin

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

  • new StiMargin(left: number, top: number, right: number, bottom: number): StiMargin

  • Creates a new object of the type StiMargin.

    Parameters

    • left: number

      Left margin size on the object.

    • top: number

      Top margin size on the object.

    • right: number

      Right margin size on the object.

    • bottom: number

      Bottom margin size on the object.

    Returns StiMargin

Properties

bottom

bottom: number = 3

Gets or sets bottom margin size on the object.

left

left: number = 3

Gets or sets left margin size on the object.

right

right: number = 3

Gets or sets right margin size on the object.

top

top: number = 3

Gets or sets top margin size on the object.

Static empty

empty: StiMargin = StiMargin.create()

Accessors

isEmpty

  • get isEmpty(): boolean

  • Returns boolean

Methods

clone

  • clone(): any

  • Creates a new object that is a copy of the current instance.

    Returns any

    A new object that is a copy of this instance.

equals

  • equals(obj: any): boolean

  • Tests to see whether the specified object is a SizeD with the same dimensions as this SizeD.

    Parameters

    • obj: any

      The Object to test.

    Returns boolean

    This method returns true if obj is a SizeD and has the same width and height as this SizeD; otherwise, false.

loadFromJsonObject

  • loadFromJsonObject(jObject: StiJson): void

loadFromXml

  • loadFromXml(xmlNode: XmlNode): void

  • Parameters

    Returns void

saveToJsonObject

  • saveToJsonObject(defLeft?: number, defTop?: number, defRight?: number, defBotttom?: number): StiJson

  • Parameters

    • Default value defLeft: number = 3
    • Default value defTop: number = 3
    • Default value defRight: number = 3
    • Default value defBotttom: number = 3

    Returns StiJson

Static create

  • Creates a new object of the type StiMargin.

    Parameters

    • Default value all: number = 3

      The margin size for all sides of the object.

    Returns StiMargin

Generated using TypeDoc