StiMargin Class

Namespace: Stimulsoft.Report.Dashboard

Describes the class that realizes object margin.

Inheritance

Implements: ICloneable, IStiJsonReportObject

Constructors

Constructor Description
constructor(number left, number top, number right, number bottom) Creates a new object of the type StiMargin.

constructor(left: number, top: number, right: number, bottom: number)

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.

Properties

Property Type Description
isEmpty boolean  

Methods

Method Returns Description
clone any Creates a new object that is a copy of the current instance.
create static StiMargin Creates a new object of the type StiMargin.
equals boolean Tests to see whether the specified object is a SizeD with the same dimensions as this SizeD.
loadFromJsonObject void  
loadFromXml void  
saveToJsonObject StiJson  

Method Details

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.

create static

create(all: any): StiMargin

Creates a new object of the type StiMargin.

Parameters

  • all (any) — The margin size for all sides of the object.

Returns StiMargin

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

Parameters

loadFromXml

loadFromXml(xmlNode: XmlNode): void

Parameters

saveToJsonObject

saveToJsonObject(defLeft: any, defTop: any, defRight: any, defBotttom: any): StiJson

Parameters

  • defLeft (any)
  • defTop (any)
  • defRight (any)
  • defBotttom (any)

Returns StiJson

Fields

Field Type Description
bottom any Gets or sets bottom margin size on the object.
left any Gets or sets left margin size on the object.
right any Gets or sets right margin size on the object.
top any Gets or sets top margin size on the object.