RenderCustomizationObjects

DSHDLib.Editors.ProjectData. Namespace

RenderCustomizationObjects

Source:

Type Definitions

RenderCustomizationObject

Description:
  • An object containing data to overwrite the persisted project data in a specific Render request
Source:
Properties:
Name Type Description
elements Object.<string, DSHDLib.Editors.ProjectData.RenderCustomizationObjects.RenderCustomizationObjectElementUpdates> A map of data to populate based on element_id/element_name matches. element_id can be retrieved via getProjectData (e.g. finding all elements with a matching class name)
An object containing data to overwrite the persisted project data in a specific Render request
Type:
  • Object

RenderCustomizationObjectElementUpdates

Description:
  • An object containing data to overwrite on a matched element.
Source:
Properties:
Name Type Attributes Description
text string <optional>
 The replacement text to fully overwrite the matched text element. Note that this will remove any existing character specific style overrides
text_insert Object <optional>
 The text and position of new data to insert/replace in the matched text element. Note that this will preserve existing style overrides with the exception of range replacements that span multiple styles.
Properties
Name Type Description
text string The new text to insert within the existing text string
position number | Array.<number> The 0-based position to insert the new text. Can optionally be supplied as an array containing a start and end index which will overwrite the existing text in that range with the newly supplied text
text_token_map Object.<string, string> <optional>
 A map of tokens that may be present in the text of the matched text element and their replacement values. Note that this will override the text_token_map if set on the text element directly.
auto_fit bool <optional>
 A value indicating weither to update font size dynamically to fit the supplied text changes within the matched textbox's current width/line count
An object containing data to overwrite on a matched element.
Type:
  • Object