Selva Compute API Reference - v2.1.0
    Preparing search index...

    Class DimensionStyle

    Hierarchy (View Summary)

    Index

    Constructors

    constructor

    Properties

    alternateBelowLine alternateLengthFactor arrowBlockId1 arrowBlockId2 arrowLength arrowType1 arrowType2 baselineSpacing centermarkSize dimensionLineExtension drawForward drawTextMask extensionLineExtension extensionLineOffset fixedExtensionLength fixedExtensionLengthOn hasFieldOverrides id isChild isValid isValidWithLog leaderArrowBlockId leaderArrowLength leaderArrowType leaderHasLanding leaderLandingLength lengthFactor name parentId stackHeightScale suppressArrow1 suppressArrow2 suppressExtension1 suppressExtension2 textGap textHeight textRotation textUnderlined toleranceHeightScale toleranceLowerValue toleranceUpperValue userStringCount

    Methods

    clearAllFieldOverrides encode getFont getUserString getUserStrings isChildOf rdkXml scaleLengthValues setFont setUserString toJSON decode

    Constructors

    Properties

    alternateBelowLine: boolean
    alternateLengthFactor: number
    arrowBlockId1: string
    arrowBlockId2: string
    arrowLength: number
    arrowType1: ArrowheadTypes
    arrowType2: ArrowheadTypes
    baselineSpacing: number
    centermarkSize: number
    dimensionLineExtension: number
    drawForward: boolean
    drawTextMask: boolean
    extensionLineExtension: number
    extensionLineOffset: number
    fixedExtensionLength: number
    fixedExtensionLengthOn: any
    hasFieldOverrides: boolean

    Checks if any fields in this DimensionStyle are overrides

    id: string
    isChild: boolean

    Tests if this DimensionStyle is a child of any other DimensionStyle

    isValid: boolean

    Tests an object to see if it is valid.

    isValidWithLog: [boolean, string]

    ...

    leaderArrowBlockId: string
    leaderArrowLength: number
    leaderArrowType: ArrowheadTypes
    leaderHasLanding: boolean
    leaderLandingLength: number
    lengthFactor: number
    name: string
    parentId: string

    Get or Set the Id of this DimensionStyle's parent. If ParentId is Guid.Empty, this DimensionStyle has no parent

    stackHeightScale: number
    suppressArrow1: boolean
    suppressArrow2: boolean
    suppressExtension1: boolean
    suppressExtension2: boolean
    textGap: number
    textHeight: number
    textRotation: number
    textUnderlined: boolean
    toleranceHeightScale: number
    toleranceLowerValue: number
    toleranceUpperValue: number
    userStringCount: number

    Gets the amount of user strings.

    Methods

    • Returns void

      Sets all the fields in this DimensionStyle to be not overridden Does not change any dimstyle_id's or parent_id's

    • ...

      Returns void

    • ...

      Returns Font

    • Parameters

      • key: string

        id used to retrieve the string.

      Returns string

      string associated with the key if successful. null if no key was found.

      Gets user string from this geometry.

    • Returns string[]

      Gets a copy of all (user key string, user value string) pairs attached to this geometry.

    • Parameters

      • id: string

      Returns boolean

      True if this is a child of the DimensionStyle with Parent False otherwise.

      Tests if this DimensionStyle is a child of a specific DimensionStyle

    • ...

      Returns string

    • Parameters

      • scale: number

      Returns void

      Scales all length values by 'scale'

    • ...

      Parameters

      • name: string

      Returns void

    • Parameters

      • key: string

        id used to retrieve this string.

      • value: string

        string associated with key.

      Returns boolean

      true if successful, false if not.

      Attach a user string (key,value combination) to this geometry.

    • Returns string

      Create a JSON string representation of this object

    • Parameters

      • json: object

        A json formatted object in the following format (values are orientative):

        {
        		version: 10000,
        		archive3dm: 60,
        		opennurbs: -1877964208,
        		data: 'encoded 3dm object data'
        }

      Returns CommonObject

      Decodes a Rhino Object

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods