MEMBERS

bottomBuffer :number

IncisorAPI.js, line 3979

A buffer that is included when this LayoutObject is laid out within a LayoutStack. This buffer is multiplied by nc.uiZoom.totalZoom if the containing LayoutStack is configured to be affected by iuZoom.

Default Value:

• 0

height :number

IncisorAPI.js, line 3955

The height of this LayoutObject.

inheritedTypes :object

IncisorAPI.js, line 3943

Dictionary object listing all of the types this object is compatible with.

justification :string

IncisorAPI.js, line 3994

The justification of this LayoutObject within the LayoutStack that contains it (if applicable). See 'nc.constants.justifications' for a list of available values.

Default Value:

• "left"

layoutLazyUpdater :LazyUpdater

IncisorAPI.js, line 4044

The LazyUpdater in charge of laying out the contents of the SceneObject that owns this LayoutObject.

leftBuffer :number

IncisorAPI.js, line 3963

A buffer that is included when this LayoutObject is laid out within a LayoutStack. This buffer is multiplied by nc.uiZoom.totalZoom if the containing LayoutStack is configured to be affected by iuZoom.

Default Value:

• 0

overrideHeight :number

IncisorAPI.js, line 4008

An override to the height value of this LayoutObject, which would otherwise be set by the 'refreshLayoutCallback' callback function connected to this LayoutObject.

Default Value:

• undefined

overrideWidth :number

IncisorAPI.js, line 4001

An override to the width value of this LayoutObject, which would otherwise be set by the 'refreshLayoutCallback' callback function connected to this LayoutObject.

Default Value:

• undefined

refreshLayoutCallbackArgs :Array|any

IncisorAPI.js, line 4038

Parameters for the function that will be called automatically to refresh the layout of this LayoutObject and determine its layout dimensions. This function is responsible for laying out the LayoutObject's content and returning a Vector2 containing its dimensions, which will then be used to position this LayoutObject within the LayoutStack that contains it. GrapicObjects and TextBoxes automatically perform these functions internally without the need for this callback... Set this value to customize the process of laying out this SceneObject's content, and/or determining its layout width/height.

refreshLayoutCallbackName :string

IncisorAPI.js, line 4028

The name of the function that will be called automatically to refresh the layout of this LayoutObject and determine its layout dimensions. This function is responsible for laying out the LayoutObject's content and returning a Vector2 containing its dimensions, which will then be used to position this LayoutObject within the LayoutStack that contains it. GrapicObjects and TextBoxes automatically perform these functions internally without the need for this callback... Set this value to customize the process of laying out this SceneObject's content, and/or determining its layout width/height.

refreshLayoutCallbackOwner :object

IncisorAPI.js, line 4018

The owner of the function that will be called automatically to refresh the layout of this LayoutObject and determine its layout dimensions. This function is responsible for laying out the LayoutObject's content and returning a Vector2 containing its dimensions, which will then be used to position this LayoutObject within the LayoutStack that contains it. GrapicObjects and TextBoxes automatically perform these functions internally without the need for this callback... Set this value to customize the process of laying out this SceneObject's content, and/or determining its layout width/height.

rightBuffer :number

IncisorAPI.js, line 3971

A buffer that is included when this LayoutObject is laid out within a LayoutStack. This buffer is multiplied by nc.uiZoom.totalZoom if the containing LayoutStack is configured to be affected by iuZoom.

Default Value:

• 0

topBuffer :number

IncisorAPI.js, line 3987

A buffer that is included when this LayoutObject is laid out within a LayoutStack. This buffer is multiplied by nc.uiZoom.totalZoom if the containing LayoutStack is configured to be affected by iuZoom.

Default Value:

• 0

type :string

IncisorAPI.js, line 3937

Type identifier.

width :number

IncisorAPI.js, line 3949

The width of this LayoutObject.

METHODS

addSecondaryLayoutCallback(callbackOwner, callbackName, callbackArgs (opt))

IncisorAPI.js, line 4062

Adds an optional callback that occurs after this LayoutObject's layout is refreshed. This callback can be used to perform further actions that use the new layout after it is updated. It should be noted that this callback will not affect the width or height of this LayoutObject, it is only meant to be used for 'additonal styling' of the layout object using the updated layout.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback function that occurs after this LayoutObject's layout is refreshed
callbackName	string			The name of the callback function that occurs after this LayoutObject's layout is refreshed
callbackArgs	Array | any	<optional>		Args for the callback function that is triggered after this LayoutObject's layout is refreshed

informParentsOfLayoutChange()

IncisorAPI.js, line 4051

Informs the containing LayoutStack of a change in this LayoutObject's dimensions, telling the LayoutStack that it will need to refresh its Layout. Call this function whenever a custom LayoutObject's dimensions change.

removeSecondaryLayoutCallback(callbackOwner, callbackName)

IncisorAPI.js, line 4069

Removes the given secondaryLayout callback.

Parameters:

Name	Type	Attributes	Default	Description
callbackOwner	object			The object owning the callback to be removed.
callbackName	string			The name of the callback to be removed.