Class Linetype

Hierarchy (view full)

ModelComponent
- Linetype

Constructors

constructor

new Linetype(): Linetype
Returns Linetype
Inherited from ModelComponent.constructor

Properties

id

id: string

Gets or sets the ID of the current instance.

index

index: number

isSystemComponent

isSystemComponent: boolean

True if this model component is a system constant. An incomplete list of system constant model components is below:ON_ModelComponent::Unset ON_InstanceDefinition::Empty ON_Linetype::UnsetON_Linetype::ContinuousON_Linetype::ByLayerON_Linetype::ByParent ON_Layer::UnsetON_Layer::Default ON_TextStyle::UnsetON_TextStyle::DefaultON_TextStyle::ByLayerON_TextStyle::ByParent ON_DimStyle::UnsetON_DimStyle::DefaultON_DimStyle::DefaultInchDecimalON_DimStyle::DefaultInchFractionalON_DimStyle::DefaultFootInchArchitectureON_DimStyle::DefaultMillimeterSmallON_DimStyle::DefaultMillimeterLargeON_DimStyle::DefaultMillimeterArchitecture

isValid

isValid: boolean

Tests an object to see if it is valid.

isValidWithLog

isValidWithLog: [boolean, string]

...

name

name: string

The name of this linetype.

patternLength

patternLength: number

Total length of one repeat of the pattern.

segmentCount

segmentCount: number

Number of segments in the pattern.

userStringCount

userStringCount: number

Gets the amount of user strings.

Methods

appendSegment

appendSegment(length, isSolid): number
Parameters
- length: number
  The length of the segment to be added.
- isSolid: boolean
  If true, the length is interpreted as a line. If false, then the length is interpreted as a space.
Returns number
Index of the added segment.

Description
Adds a segment to the pattern.
- Defined in rhino3dm.d.ts:4125

clearId

clearId(): void
Returns void
Description
Resets the HasId property of the model component to false, if possible.
Inherited from ModelComponent.clearId
- Defined in rhino3dm.d.ts:4849

clearPattern

clearPattern(): boolean
...

Returns boolean
- Defined in rhino3dm.d.ts:4133

dataCRC

dataCRC(currentRemainder): number
Parameters
- currentRemainder: number
  The current remainder value.
Returns number
The updated remainder value.

Description
Increments the Cyclic Redundancy Check value by this instance.
Inherited from ModelComponent.dataCRC
- Defined in rhino3dm.d.ts:4844

encode

encode(): void
...

Returns void
Inherited from ModelComponent.encode
- Defined in rhino3dm.d.ts:1489

getSegment

getSegment(index): object
Parameters
- index: number
  Zero based index of the segment.
Returns object
[void, number, boolean] (void) (number) The length of the segment in millimeters. (boolean) If the length is interpreted as a line, true is assigned during the call to this out parameter. If the length is interpreted as a space, then false is assigned during the call to this out parameter.

Description
Gets the segment information at a index.
- Defined in rhino3dm.d.ts:4108

getUserString

getUserString(key): string
Parameters
- key: string
  id used to retrieve the string.
Returns string
string associated with the key if successful. null if no key was found.

Description
Gets user string from this geometry.
Inherited from ModelComponent.getUserString
- Defined in rhino3dm.d.ts:1521

getUserStrings

getUserStrings(): string[]
Returns string[]
Description
Gets a copy of all (user key string, user value string) pairs attached to this geometry.
Inherited from ModelComponent.getUserStrings
- Defined in rhino3dm.d.ts:1526

rdkXml

rdkXml(): string
...

Returns string
Inherited from ModelComponent.rdkXml
- Defined in rhino3dm.d.ts:1528

removeSegment

removeSegment(index): boolean
Parameters
- index: number
  Zero based index of the segment to remove.
Returns boolean
true if the segment index was removed.

Description
Removes a segment in the linetype.
- Defined in rhino3dm.d.ts:4131

setSegment

setSegment(index, length, isSolid): boolean
Parameters
- index: number
  Zero based index of the segment.
- length: number
  The length of the segment to be added in millimeters.
- isSolid: boolean
  If true, the length is interpreted as a line. If false, then the length is interpreted as a space.
Returns boolean
true if the operation was successful; otherwise false.

Description
Sets the length and type of the segment at index.
- Defined in rhino3dm.d.ts:4117

setUserString

setUserString(key, value): boolean
Parameters
- key: string
  id used to retrieve this string.
- value: string
  string associated with key.
Returns boolean
true if successful, false if not.

Description
Attach a user string (key,value combination) to this geometry.
Inherited from ModelComponent.setUserString
- Defined in rhino3dm.d.ts:1515

toJSON

toJSON(): string
Returns string
Description
Create a JSON string representation of this object
Inherited from ModelComponent.toJSON
- Defined in rhino3dm.d.ts:1494

`Static` border

border(): Linetype
...

Returns Linetype
- Defined in rhino3dm.d.ts:4135

`Static` byLayer

byLayer(): Linetype
...

Returns Linetype
- Defined in rhino3dm.d.ts:4137

`Static` byParent

byParent(): Linetype
...

Returns Linetype
- Defined in rhino3dm.d.ts:4139

`Static` center

center(): Linetype
...

Returns Linetype
- Defined in rhino3dm.d.ts:4141

`Static` continuous

continuous(): Linetype
...

Returns Linetype
- Defined in rhino3dm.d.ts:4143

`Static` dashdot

dashdot(): Linetype
...

Returns Linetype
- Defined in rhino3dm.d.ts:4145

`Static` dashed

dashed(): Linetype
...

Returns Linetype
- Defined in rhino3dm.d.ts:4147

`Static` decode

decode(json): CommonObject
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
Description
Decodes a Rhino Object
Inherited from ModelComponent.decode
- Defined in rhino3dm.d.ts:1508

`Static` dots

dots(): Linetype
...

Returns Linetype
- Defined in rhino3dm.d.ts:4149

`Static` hidden

hidden(): Linetype
...

Returns Linetype
- Defined in rhino3dm.d.ts:4151

Class Linetype

Hierarchy (view full)

Index

Constructors

Properties

Methods

Constructors

constructor

Returns Linetype

Properties

id

index

isSystemComponent

isValid

isValidWithLog

name

patternLength

segmentCount

userStringCount

Methods

appendSegment

Parameters

Returns number

Description

clearId

Returns void

Description

clearPattern

Returns boolean

dataCRC

Parameters

Returns number

Description

encode

Returns void

getSegment

Parameters

Returns object

Description

getUserString

Parameters

Returns string

Description

getUserStrings

Returns string[]

Description

rdkXml

Returns string

removeSegment

Parameters

Returns boolean

Description

setSegment

Parameters

Returns boolean

Description

setUserString

Parameters

Returns boolean

Description

toJSON

Returns string

Description

Static border

Returns Linetype

Static byLayer

Returns Linetype

Static byParent

Returns Linetype

Static center

Returns Linetype

Static continuous

Returns Linetype

Static dashdot

Returns Linetype

Static dashed

Returns Linetype

Static decode

Parameters

Returns CommonObject

`Static` border

`Static` byLayer

`Static` byParent

`Static` center

`Static` continuous

`Static` dashdot

`Static` dashed

`Static` decode

`Static` dots

`Static` hidden