Skip to content

SetLevelElevationN.md

Latest commit

 

History

History
56 lines (46 loc) · 1.41 KB

SetLevelElevationN.md

File metadata and controls

56 lines (46 loc) · 1.41 KB
Raw

SetLevelElevationN

Description

Sets the elevation of a Story Level relative to its Story.

FUNCTION SetLevelElevationN(
				storyHandle  : HANDLE;
				levelType    : STRING;
				newElevation : REAL): BOOLEAN;
def vs.SetLevelElevationN(storyHandle, levelType, newElevation):
    return BOOLEAN

Parameters

Name Type Description
storyHandle HANDLE The handle of the Story with the desired Story Level.
levelType STRING The level type of the Story Level to change the elevation of.
newElevation REAL The new elevation for the Story Level. The elevation is in document units.

Examples

resultOK := SetLevelElevationN(storyHandle, 'Example', 1.0);
import vs

# Sets the elevation of a Story Level relative to its Story.
storyHandle = vs.FSActLayer()  # handle to the first selected object on the active layer
levelType = 'Example'
newElevation = 0.0

ok = vs.SetLevelElevationN(storyHandle, levelType, newElevation)
if ok:
    vs.Message('SetLevelElevationN succeeded')
else:
    vs.Message('SetLevelElevationN failed')

See Also

VS Functions: CreateStory | AddStoryLevelN | RemoveStoryLevel | AddLevelFromTemplate | GetLevelElevationN

Version

Availability: from Vectorworks 2025

Category